utf8-encode.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b676d0b9c968ebb0b7429835f2f6bd364275eed1 Maintainer: hirokawa Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.utf8-encode" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>utf8_encode</refname>
  <refpurpose>ISO-8859-1 文字列を UTF-8 に変換する</refpurpose>
 </refnamediv>

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

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>utf8_encode</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
  </methodsynopsis>
  <para>
   この関数は、文字列 <parameter>string</parameter> を <literal>ISO-8859-1</literal>
   エンコードから <literal>UTF-8</literal> へ変換します。
  </para>
  <note>
   <para>
    この関数は、指定された文字列の現在の文字エンコーディングを推測しません。
    代わりに、
    ISO-8859-1 ("Latin 1" とも呼ばれています)
    としてエンコードされていると解釈し、UTF-8 に変換します。
    全てのバイト列は有効な ISO-8859-1 の文字列であるため、
    この関数は決してエラーになりません。
    しかし、異なるエンコーディングを意図していた場合、
    有用な結果にはならないでしょう。
   </para>
   <para>
    <literal>ISO-8859-1</literal> 文字エンコーディングを使っているとマークされている
    多くの Web ページが、実際にはそれと似た <literal>Windows-1252</literal> を使っており、
    Web ブラウザは <literal>ISO-8859-1</literal> Web ページを <literal>Windows-1252</literal>
    として解釈しています。<literal>Windows-1252</literal> は
    <literal>ISO-8859-1</literal> のある制御文字の代わりに、ユーロ記号
    (<literal>€</literal>) や curly quote (<literal>“</literal>
    <literal>”</literal>) を印字可能な文字として追加しています。
    この関数はそうした <literal>Windows-1252</literal> 文字を正しく変換しません。
    <literal>Windows-1252</literal> の変換が必要な場合は、別の関数を使ってください。
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       ISO-8859-1 形式の文字列。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <parameter>string</parameter> を UTF-8 に変換した結果を返します。
  </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>
        この関数は、推奨されなくなりました。
       </entry>
      </row>
      <row>
       <entry>7.2.0</entry>
       <entry>
        この関数は、XML拡張モジュール から PHP のコアに移動しました。
        これより前のバージョンでは、
        この関数は XML拡張モジュール をインストールしていた場合にのみ利用可能でした。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>基本的な例</title>
   <programlisting role="php">
<![CDATA[
<?php
// Convert the string 'Zoë' from ISO 8859-1 to 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>この関数は推奨されません。代替については下記のとおりです。</title>
   <para>
    この関数は、PHP 8.2.0 以降は <emphasis>推奨されなくなり</emphasis>、
    将来のバージョンで削除される予定です。
    この関数を使っているコードをチェックし、適切な代替に置き換えるべきです。
   </para>
   <para>
    この関数と似た機能は、
    <function>mb_convert_encoding</function> で実現できます。
    この関数は、ISO-8859-1 と、多くの他の文字エンコーディングをサポートしています。
    <informalexample>
     <programlisting role="php">
 <![CDATA[
<?php
$iso8859_1_string = "\xEB"; // 'ë' (e with diaeresis) in 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"; // the same string in ISO-8859-7 represents 'λ' (Greek lower-case lambda)
$utf8_string = mb_convert_encoding($iso8859_7_string, 'UTF-8', 'ISO-8859-7');
echo bin2hex($utf8_string), "\n";

$windows_1252_string = "\x80"; // '€' (Euro sign) in Windows-1252, but not in 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>
    他の代替として、インストールされている拡張機能に依存した関数ですが、
    <methodname>UConverter::transcode</methodname> と <function>iconv</function>
    が挙げられます。
   </para>
   <para>
    次のコードは、いずれも同じ結果を返します:
    <informalexample>
     <programlisting role="php">
<![CDATA[
<?php
$iso8859_1_string = "\x5A\x6F\xEB"; // 'Zoë' in 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
-->