mb-convert-encoding.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 99d758bd259fa80c2828cf8cc250984cb683ee8f Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi,mumumu -->
<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>ある文字エンコーディングの文字列を、別の文字エンコーディングに変換する</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>
   文字列 <parameter>string</parameter> の文字エンコーディングを、
   <parameter>from_encoding</parameter> または現在の内部エンコーディングから
   <parameter>to_encoding</parameter> に変換します。
   <parameter>string</parameter> が配列の場合、それに含まれる全ての文字列型の値が再帰的に変換されます。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       変換する &string; または &array;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>to_encoding</parameter></term>
     <listitem>
      <para>
       変換したい文字エンコーディング。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>from_encoding</parameter></term>
     <listitem>
      <para>
       <parameter>string</parameter> を解釈するのに使われている
       現在の文字エンコーディング。
       配列またはカンマ区切りの文字列とすることで、
       複数のエンコーディングを指定できます。
       この場合、正しいエンコーディングを
       <function>mb_detect_encoding</function>
       と同じアルゴリズムで推測します。
      </para>
      <para>
       <parameter>from_encoding</parameter> が &null; だったり、
       指定されなかった場合は、
       <link linkend="ini.mbstring.internal-encoding">mbstring.internal_encoding setting</link> が設定されていた場合、それを使います。
       設定されていない場合は、
       <link linkend="ini.default-charset">default_charset setting</link>
       を使います。
      </para>
      <para>
       <parameter>to_encoding</parameter>
       や <parameter>from_encoding</parameter>
       に指定できる値は、
       <link linkend="mbstring.supported-encodings">
       サポートされる文字エンコーディング</link>を参照ください。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功時に、変換後の文字列または配列を返します。
   &return.falseforfailure;
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   PHP 8.0.0 以降では、
   <parameter>to_encoding</parameter> または
   <parameter>from_encoding</parameter> に不正なエンコーディングが渡された場合、
   <classname>ValueError</classname> がスローされるようになりました。
   これより前のバージョンでは、
   <constant>E_WARNING</constant> が発生していました。
  </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.1.0</entry>
      <entry>
       SJISの<emphasis>\</emphasis>(<literal>\x5C</literal>) と <emphasis>~</emphasis>(<literal>\x7E</literal>) が
       <emphasis>¥</emphasis>(<literal>\u{00A5}</literal>) と <emphasis>‾</emphasis>(<literal>\u{203E}</literal>) に
       マッピングされるようになりました。SJIS-WINとしても知られるCP932はこの変更の影響を受けません。
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>to_encoding</parameter> に不正なエンコーディングが渡された場合、
       <classname>ValueError</classname> がスローされるようになりました。
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>from_encoding</parameter> に不正なエンコーディングが渡された場合、
       <classname>ValueError</classname> がスローされるようになりました。
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>from_encoding</parameter> は、nullable になりました。
      </entry>
     </row>
     <row>
      <entry>7.2.0</entry>
      <entry>
       この関数は、 <parameter>string</parameter> に
       配列を受け入れるようになりました。
       これより前のバージョンでは、文字列のみがサポートされていました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>mb_convert_encoding</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
/* 内部文字エンコーディングからSJISに変換 */
$str = mb_convert_encoding($str, "SJIS");

/* EUC-JPからUTF-7に変換 */
$str = mb_convert_encoding($str, "UTF-7", "EUC-JP");

/* JIS, eucjp-win, sjis-winの順番で自動検出し、UCS-2LEに変換 */
$str = mb_convert_encoding($str, "UCS-2LE", "JIS, eucjp-win, sjis-win");

/* mbstring.language が "Japanese" の場合 "auto" は、"ASCII,JIS,UTF-8,EUC-JP,SJIS" に展開される */
$str = mb_convert_encoding($str, "EUC-JP", "auto");

/* PHP 8.0以前と互換性のあるSJISからUTF-8への変換 */
$str = strtr(mb_convert_encoding($input, 'UTF-8', 'SJIS'), ['¥' => '\\', '‾' => '~']);
?>
]]>
    </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
-->