archived-doc-fr/reference/mbstring/functions/mb-convert-encoding.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c1f37a6c270aadbbb3da56a3973ffd62197adf2b Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.mb-convert-encoding" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>mb_convert_encoding</refname>
  <refpurpose>Convertir une chaîne d'un codage de caractères à un autre</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>string</type><type>false</type></type><methodname>mb_convert_encoding</methodname>
   <methodparam><type class="union"><type>array</type><type>string</type></type><parameter>string</parameter></methodparam>
   <methodparam><type>string</type><parameter>to_encoding</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>array</type><type>string</type><type>null</type></type><parameter>from_encoding</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Convertit la <parameter>string</parameter> à partir de <parameter>from_encoding</parameter>,
   ou l'encodage interne actuel, en <parameter>to_encoding</parameter>.
   Si <parameter>string</parameter> est un &array;, toutes ses valeurs &string;
   seront converties récursivement.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       La &string; ou &array; à convertir.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>to_encoding</parameter></term>
     <listitem>
      <para>
       L'encodage désiré du résultat.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>from_encoding</parameter></term>
     <listitem>
      <para>
       L'encodage actuel utilisé pour interpréter la <parameter>string</parameter>.
       Plusieurs encodages peuvent être spécifiés sous forme de tableau (&array;) ou de liste séparée par des virgules.
       Dans ce cas, l'encodage correct sera deviné en utilisant le
       même algorithme que <function>mb_detect_encoding</function>.
      </para>
      <para>
       Si <parameter>from_encoding</parameter> est omis ou &null;, le
       paramètre <link linkend="ini.mbstring.internal-encoding">mbstring.internal_encoding</link>
       sera utilisé s'il est défini, sinon le paramètre <link linkend="ini.default-charset">default_charset</link> sera utilisé.
      </para>
      <para>
       Voir <link linkend="mbstring.supported-encodings">encodages pris en charge</link>
       pour les valeurs valides de <parameter>to_encoding</parameter>
       et <parameter>from_encoding</parameter>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   La &string; ou &array; encodé en cas de succès, &return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   À partir de PHP 8.0.0, une <classname>ValueError</classname> est lancée si la
   valeur de <parameter>to_encoding</parameter> ou
   <parameter>from_encoding</parameter> est un encodage invalide.
   Antérieur à PHP 8.0.0, une <constant>E_WARNING</constant> était émise à la place.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.2.0</entry>
      <entry>
       <function>mb_convert_encoding</function> ne renverra plus
       les encodages non textuels suivants :
       <literal>"Base64"</literal>, <literal>"QPrint"</literal>,
       <literal>"UUencode"</literal>, <literal>"HTML entities"</literal>,
       <literal>"7 bit"</literal> et <literal>"8 bit"</literal>.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <function>mb_convert_encoding</function> lancera désormais une
       <classname>ValueError</classname> quand
       un encodage invalide est passé à <parameter>to_encoding</parameter>.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <function>mb_convert_encoding</function> lancera désormais une
       <classname>ValueError</classname> quand
       un encodage invalide est passé à <parameter>from_encoding</parameter>.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>from_encoding</parameter> est désormais nullable.
      </entry>
     </row>
     <row>
      <entry>7.2.0</entry>
      <entry>
       Cette fonction accepte désormais un &array; en tant que
       <parameter>string</parameter>.
       Auparavant, seulement les &string; étaient supportées.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>mb_convert_encoding</function></title>
    <programlisting role="php" annotations="non-interactive">
<![CDATA[
<?php
/* Convertit l'encodage interne vers SJIS */
$str = mb_convert_encoding($str, "SJIS");

/* Convertit EUC-JP en UTF-7 */
$str = mb_convert_encoding($str, "UTF-7", "EUC-JP");

/* Détecte automatiquement un encodage entre JIS, eucjp-win ou sjis-win,
   Puis convertit en UCS-2LE */
$str = mb_convert_encoding($str, "UCS-2LE", "JIS, eucjp-win, sjis-win");

/* Si mbstring.language est "Japanese", "auto" est étendu à "ASCII,JIS,UTF-8,EUC-JP,SJIS" */
$str = mb_convert_encoding($str, "EUC-JP", "auto");
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mb_detect_order</function></member>
    <member><methodname>UConverter::transcode</methodname></member>
    <member><function>iconv</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
-->