utf8-decode.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 9b1673cf114a1e10c4563ab9223cb56aed552b89 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.utf8-decode" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>utf8_decode</refname>
  <refpurpose>
   Convertit une chaîne UTF-8 en ISO-8859-1, en remplaçant les caractères invalides ou non représentables.
  </refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  &warn.deprecated.function-8-2-0;
 </refsynopsisdiv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier role="attribute">#[\Deprecated]</modifier>
   <type>string</type><methodname>utf8_decode</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>utf8_decode</function> décode la chaîne
   <parameter>string</parameter>, en supposant qu'elle est au format
   <literal>UTF-8</literal>, et la convertit au format
   <literal>ISO-8859-1</literal>. Les octets dans la chaîne qui ne sont pas
   valides en <literal>UTF-8</literal> et les caractères <literal>UTF-8</literal>
   qui n'existent pas en <literal>ISO-8859-1</literal> (qui sont, les caractères
   au-dessus de <literal>U+00FF</literal>) sont remplacés par <literal>?</literal>.
  </para>

  <note>
   <para>
    De nombreuses pages Web marquées comme utilisant l'encodage de caratères
    <literal>ISO-8859-1</literal> utilisent effectivement un encodage similaire
    à <literal>Windows-1252</literal>, et les navigateurs Web interpréterons
    les pages Web <literal>ISO-8859-1</literal> comme
    <literal>Windows-1252</literal>. Les caractéristiques supplémentaires
    de <literal>Windows-1252</literal> sont des caractères imprimables,
    tels que le signe euro (<literal>€</literal>) et les guillemets bouclés
    (<literal>“</literal> <literal>”</literal>), à la place de certains
    caractères de contrôle de l'<literal>ISO-8859-1</literal>. Cette fonction
    ne convertira pas ces caractères <literal>Windows-1252</literal>
    correctement. Utilisez une fonction différente si une conversion
    <literal>Windows-1252</literal> est nécessaire.
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       La chaîne encodée UTF-8.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne la chaîne <parameter>string</parameter> convertie en ISO-8859-1.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.2.0</entry>
       <entry>
        Cette fonction a été rendue obsolète.
       </entry>
      </row>
      <row>
       <entry>7.2.0</entry>
       <entry>
        Cette fonction a été déplacée dans le cœur de PHP ; auparavant, il était
        nécessaire d'installer l'extension XML pour l'utiliser.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Exemple d'utilisation</title>
   <programlisting role="php">
<![CDATA[
<?php
// Convertit la chaîne 'Zoë' de UTF-8 à ISO 8859-1
$utf8_string = "\x5A\x6F\xC3\xAB";
$iso8859_1_string = utf8_decode($utf8_string);
echo bin2hex($iso8859_1_string), "\n";

// Les séquences UTF-8 non valides sont remplacées par '?'
$invalid_utf8_string = "\xC3";
$iso8859_1_string = utf8_decode($invalid_utf8_string);
var_dump($iso8859_1_string);

// Les caractères qui n'existent pas dans la norme ISO 8859-1,
// tels que '€' (signe de l'euro) sont égalements remplacés par '?'
$utf8_string = "\xE2\x82\xAC";
$iso8859_1_string = utf8_decode($utf8_string);
var_dump($iso8859_1_string);
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
5a6feb
string(1) "?"
string(1) "?"
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="notes">
  <title>Notes</title>
  <note>
    <title>Dépréciation et alternatives</title>
    <para>
      Cette fonction est <emphasis>obsolète</emphasis> à partir de PHP 8.2.0
      et sera supprimée dans une version future. Les utilisations existantes devraient être vérifiées
      et remplacées par des alternatives appropriées.
    </para>
    <para>
      Une fonctionnalité similaire peut être obtenue avec <function>mb_convert_encoding</function>,
      qui prend en charge ISO-8859-1 et de nombreux autres encodages de caractères.
      <informalexample>
        <programlisting role="php">
<![CDATA[
<?php
$utf8_string = "\xC3\xAB"; // 'ë' (e with diaeresis) in UTF-8
$iso8859_1_string = mb_convert_encoding($utf8_string, 'ISO-8859-1', 'UTF-8');
echo bin2hex($iso8859_1_string), "\n";

$utf8_string = "\xCE\xBB"; // 'λ' (Greek lower-case lambda) in UTF-8
$iso8859_7_string = mb_convert_encoding($utf8_string, 'ISO-8859-7', 'UTF-8');
echo bin2hex($iso8859_7_string), "\n";

$utf8_string = "\xE2\x82\xAC"; // '€' (Euro sign) in UTF-8 (not present in ISO-8859-1)
$windows_1252_string = mb_convert_encoding($utf8_string, 'Windows-1252', 'UTF-8');
echo bin2hex($windows_1252_string), "\n";
?>
          ]]>
        </programlisting>
        &example.outputs;
        <screen>
<![CDATA[
eb
eb
80
]]>
        </screen>
      </informalexample>
    </para>
    <para>
      D'autres options peuvent être disponibles en fonction des extensions installées,
      telles que <methodname>UConverter::transcode</methodname> et <function>iconv</function>.
    </para>
    <para>
      Les exemples suivants donnent tous le même résultat :
      <informalexample>
        <programlisting role="php">
<![CDATA[
<?php
$utf8_string = "\x5A\x6F\xC3\xAB"; // 'Zoë' in UTF-8
$iso8859_1_string = utf8_decode($utf8_string);
echo bin2hex($iso8859_1_string), "\n";

$iso8859_1_string = mb_convert_encoding($utf8_string, 'ISO-8859-1', 'UTF-8');
echo bin2hex($iso8859_1_string), "\n";

$iso8859_1_string = iconv('UTF-8', 'ISO-8859-1', $utf8_string);
echo bin2hex($iso8859_1_string), "\n";

$iso8859_1_string = UConverter::transcode($utf8_string, 'ISO-8859-1', 'UTF8');
echo bin2hex($iso8859_1_string), "\n";
?>
          ]]>
        </programlisting>
        &example.outputs;
        <screen>
<![CDATA[
5a6feb
5a6feb
5a6feb
5a6feb
]]>
        </screen>
      </informalexample>
      En spécifiant <literal>'?'</literal> comme option <literal>'to_subst'</literal> pour <methodname>UConverter::transcode</methodname>,
      on obtient le même résultat que <function>utf8_decode</function> pour les chaînes qui sont invalides ou qui ne peuvent pas être représentées en ISO 8859-1.
      <informalexample>
        <programlisting role="php">
<![CDATA[
<?php
$utf8_string = "\xE2\x82\xAC"; // € (Euro Sign) does not exist in ISO 8859-1
$iso8859_1_string = UConverter::transcode(
    $utf8_string, 'ISO-8859-1', 'UTF-8', ['to_subst' => '?']
);
var_dump($iso8859_1_string);
?>
          ]]>
        </programlisting>
        &example.outputs;
        <screen>
<![CDATA[
sring(1) "?"
]]>
        </screen>
      </informalexample>
    </para>
  </note>
</refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>utf8_encode</function></member>
    <member><function>mb_convert_encoding</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
-->