utf8-encode.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 9b1673cf114a1e10c4563ab9223cb56aed552b89 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.utf8-encode" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>utf8_encode</refname>
  <refpurpose>Convierte una cadena ISO-8859-1 a UTF-8</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_encode</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
  </methodsynopsis>
  <para>
   Esta función convierte la cadena <parameter>string</parameter> desde
   la codificación <literal>ISO-8859-1</literal> a <literal>UTF-8</literal>.
  </para>

  <note>
   <para>
    Esta función no intenta adivinar la codificación actual de la cadena de caracteres
    proporcionada, asume que está codificada en ISO-8859-1 (también conocido como
    "Latin 1") y la convierte a UTF-8. Dado que cada secuencia de bytes es una cadena
    de caracteres ISO-8859-1 válida, nunca habrá errores, pero no resultará
    en una cadena de caracteres útil si se esperaba una codificación diferente.
   </para>
   <para>
    Muchas páginas web marcadas como que utilizan la codificación de caracteres
    <literal>ISO-8859-1</literal> utilizan efectivamente una codificación similar
    a <literal>Windows-1252</literal>, y los navegadores web interpretarán
    las páginas web <literal>ISO-8859-1</literal> como
    <literal>Windows-1252</literal>. Las características adicionales
    de <literal>Windows-1252</literal> son caracteres imprimibles,
    tales como el signo euro (<literal>€</literal>) y las comillas curvas
    (<literal>“</literal> <literal>”</literal>), en lugar de algunos
    caracteres de control de <literal>ISO-8859-1</literal>. Esta función
    no convertirá estos caracteres <literal>Windows-1252</literal>
    correctamente. Utilice una función diferente si se necesita una conversión
    <literal>Windows-1252</literal>.
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       Una cadena ISO-8859-1.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve la versión UTF-8 de <parameter>string</parameter>.
  </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>
        Esta función ha sido declarada obsoleta.
       </entry>
      </row>
      <row>
       <entry>7.2.0</entry>
       <entry>
        Esta función fue movida al núcleo de PHP,
        anteriormente, era necesario instalar la extensión XML
        para utilizarla.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Ejemplo de uso</title>
   <programlisting role="php">
<![CDATA[
<?php
// Convierte la cadena 'Zoë' de ISO 8859-1 a UTF-8
$iso8859_1_string = "\x5A\x6F\xEB";
$utf8_string = utf8_encode($iso8859_1_string);
echo bin2hex($utf8_string), "\n";
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
5a6fc3ab
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="notes">
  <title>Notas</title>
  <note>
    <title>Obsolescencia y alternativas</title>
    <para>
      Esta función está <emphasis>obsoleta</emphasis> a partir de PHP 8.2.0
      y será eliminada en una versión futura. Los usos existentes deberían ser verificados
      y reemplazados por alternativas apropiadas.
    </para>
    <para>
      Una funcionalidad similar puede ser obtenida con <function>mb_convert_encoding</function>,
      que soporta ISO-8859-1 y muchos otros juegos de caracteres.
      <informalexample>
        <programlisting role="php">
<![CDATA[
<?php
$iso8859_1_string = "\xEB"; // 'ë' (e con diéresis) en ISO-8859-1
$utf8_string = mb_convert_encoding($iso8859_1_string, 'UTF-8', 'ISO-8859-1');
echo bin2hex($utf8_string), "\n";

$iso8859_7_string = "\xEB"; // la misma cadena en ISO-8859-7 representa 'λ' (lambda minúscula griega)
$utf8_string = mb_convert_encoding($iso8859_7_string, 'UTF-8', 'ISO-8859-7');
echo bin2hex($utf8_string), "\n";

$windows_1252_string = "\x80"; // '€' (signo euro) en Windows-1252, pero no en ISO-8859-1
$utf8_string = mb_convert_encoding($windows_1252_string, 'UTF-8', 'Windows-1252');
echo bin2hex($utf8_string), "\n";
?>
          ]]>
        </programlisting>
        &example.outputs;
        <screen>
<![CDATA[
c3ab
cebb
e282ac
]]>
        </screen>
      </informalexample>
    </para>
    <para>
      Otras opciones pueden estar disponibles dependiendo de las extensiones instaladas,
      tales como <methodname>UConverter::transcode</methodname> y <function>iconv</function>.
    </para>
    <para>
      Los siguientes ejemplos dan todos el mismo resultado:
      <informalexample>
        <programlisting role="php">
<![CDATA[
<?php
$iso8859_1_string = "\x5A\x6F\xEB"; // 'Zoë' en ISO-8859-1

$utf8_string = utf8_encode($iso8859_1_string);
echo bin2hex($utf8_string), "\n";

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

$utf8_string = UConverter::transcode($iso8859_1_string, 'UTF8', 'ISO-8859-1');
echo bin2hex($utf8_string), "\n";

$utf8_string = iconv('ISO-8859-1', 'UTF-8', $iso8859_1_string);
echo bin2hex($utf8_string), "\n";
?>
          ]]>
        </programlisting>
        &example.outputs;
        <screen>
<![CDATA[
5a6fc3ab
5a6fc3ab
5a6fc3ab
5a6fc3ab
]]>
        </screen>
      </informalexample>
    </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>utf8_decode</function></member>
    <member><function>mb_convert_encoding</function></member>
    <member><methodname>UConverter::transcode</methodname></member>
    <member><function>iconv</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>