mb-detect-order.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 92f1b8b177eb5730382abf9f27bae868f1bb636f Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.mb-detect-order" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>mb_detect_order</refname>
  <refpurpose>Lit/modifie l'ordre de détection des encodages</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>bool</type></type><methodname>mb_detect_order</methodname>
   <methodparam choice="opt"><type class="union"><type>array</type><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Remplace l'ordre de détection des encodages courant par <parameter>encoding</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>encoding</parameter></term>
     <listitem>
      <para>
       <parameter>encoding</parameter> est un tableau, ou une liste d'encodages
       séparés par une virgule. Voir les <link
       linkend="mbstring.supported-encodings">encodages supportés</link>.
      </para>
      <para>
       Si <parameter>encoding</parameter> est omis ou &null;, <function>mb_detect_order</function>
       retourne l'ordre de détection courant des encodages dans un tableau.
      </para>
      <para>
       Ce paramétrage affecte les fonctions <function>mb_detect_encoding</function> et
       <function>mb_send_mail</function>.
      </para>
      <para>
       Actuellement, <literal>mbstring</literal> supporte les filtres
       de détections ci-dessous. Si une séquence d'octets est invalide
       pour l'un des filtres suivants, la détection échouera.
      </para>
      <simpara>
       <literal>UTF-8</literal>, <literal>UTF-7</literal>,
       <literal>ASCII</literal>,
       <literal>EUC-JP</literal>,<literal>SJIS</literal>,
       <literal>eucJP-win</literal>, <literal>SJIS-win</literal>,
       <literal>JIS</literal>, <literal>ISO-2022-JP</literal> 
      </simpara>
      <para>
       Pour <literal>ISO-8859-*</literal>, <literal>mbstring</literal>
       détecte toujours <literal>ISO-8859-*</literal>.
      </para>
      <para>
       Pour <literal>UTF-16</literal>, <literal>UTF-32</literal>,
       <literal>UCS2</literal> et <literal>UCS4</literal> la détection
       échouera toujours.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Lors de la définition de l'ordre de détection de codage, &true; est retourné en cas de succès ou &false; en cas d'échec. 
  </para>
  <para>
   Lors de l'obtention de l'ordre de détection de l'encodage, un tableau ordonné des encodages est retourné.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &mbstring.changelog.encoding-nullable;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>mb_detect_order</function></title>
    <programlisting role="php">
<![CDATA[
<?php
/* Remplace l'ordre de détection par une liste énumérée */
mb_detect_order("eucjp-win,sjis-win,UTF-8");

/* Remplace l'ordre de détection par un tableau */
$ary[] = "ASCII";
$ary[] = "JIS";
$ary[] = "EUC-JP";
mb_detect_order($ary);

/* Affiche l'ordre de détection courant */
echo implode(", ", mb_detect_order());
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Exemple d'ordre de détection inutile</title>
    <programlisting>
<![CDATA[
; Toujours détecté comme ISO-8859-1
detect_order = ISO-8859-1, UTF-8

; Toujours détecté comme UTF-8, depuis que les valeurs ASCII/UTF-7
; sont valides pour UTF-8
detect_order = UTF-8, ASCII, UTF-7
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mb_internal_encoding</function></member>
    <member><function>mb_http_input</function></member>
    <member><function>mb_http_output</function></member>
    <member><function>mb_send_mail</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->