Files
2025-03-06 10:37:25 -03:00

238 lines
6.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 9b1673cf114a1e10c4563ab9223cb56aed552b89 Maintainer: leonardolara Status: ready --><!-- CREDITS: leonardolara -->
<refentry xml:id="function.utf8-encode" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>utf8_encode</refname>
<refpurpose>Converte uma string ISO-8859-1 em 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 função converte a string <parameter>string</parameter> da codificação
<literal>ISO-8859-1</literal> para a <literal>UTF-8</literal>.
</para>
<note>
<para>
Esta função não tenta descobrir a codificação da string fornecida,
ela assume que esteja codificada como ISO-8859-1 (também conhecida como "Latin 1")
e converte-a para UTF-8. Como toda sequência de bytes é uma string ISO-8859-1
válida, isto nunca irá resultar em erro, mas não irá resultar em uma string útil
se uma codificação diferente era a intenção.
</para>
<para>
Muitas páginas da web que dizem usar a codificação <literal>ISO-8859-1</literal>
na verdade usam a codificação similar <literal>Windows-1252</literal>,
e os navegadores irão interpretar as páginas <literal>ISO-8859-1</literal> como
<literal>Windows-1252</literal>. <literal>Windows-1252</literal> apresenta
caracteres imprimíveis adicionais, como o símbolo do Euro
(<literal></literal>) e aspas inglesas (<literal></literal>
<literal></literal>), ao invés de certos caracteres de controle
<literal>ISO-8859-1</literal>. Esta função não converterá esses caracteres
<literal>Windows-1252</literal> corretamente. Use uma função diferente
se a conversão de <literal>Windows-1252</literal> for requerida.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem>
<para>
Uma string em ISO-8859-1.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retorna a conversão em UTF-8 da <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 função foi descontinuada.
</entry>
</row>
<row>
<entry>7.2.0</entry>
<entry>
Esta função foi movida de extensão XML para o núcleo do PHP.
Em versões anteriores, estava disponível somente se a extensão XML estivesse instalada.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Exemplo básico</title>
<programlisting role="php">
<![CDATA[
<?php
// Converte a string 'Zoë' de ISO 8859-1 para 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">
&reftitle.notes;
<note>
<title>Descontinuação e alternativas</title>
<para>
Esta função foi <emphasis>descontinuada</emphasis> a partir do PHP 8.2.0,
e será removida em uma versão futura. Usos existentes devem ser verificados
e substituídos com alternativas apropriadas.
</para>
<para>
Funcionalidade similar pode ser obtida com <function>mb_convert_encoding</function>,
que suporta ISO-8859-1 e muitas outras codificações de caracteres.
<informalexample>
<programlisting role="php">
<![CDATA[
<?php
$iso8859_1_string = "\xEB"; // 'ë' (e com trema) em 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"; // a mesma string em ISO-8859-7 representa 'λ' (letra grega lambda minúscula)
$utf8_string = mb_convert_encoding($iso8859_7_string, 'UTF-8', 'ISO-8859-7');
echo bin2hex($utf8_string), "\n";
$windows_1252_string = "\x80"; // '€' (símbolo do Euro) em Windows-1252, mas não em 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>
Outros exemplos que podem estar disponíveis dependendo das extensões instaladas são
<methodname>UConverter::transcode</methodname> e <function>iconv</function>.
</para>
<para>
Todos os exemplos a seguir dão o mesmo resultado:
<informalexample>
<programlisting role="php">
<![CDATA[
<?php
$iso8859_1_string = "\x5A\x6F\xEB"; // 'Zoë' em 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>
<!-- 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
-->