mb-convert-encoding.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: c1f37a6c270aadbbb3da56a3973ffd62197adf2b Maintainer: daijie Status: ready -->
<!-- CREDITS: mowangjuanzi, Luffy -->
<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>
   转换 <type>string</type> 从 <parameter>from_encoding</parameter> 或当前内部编码转换到 <parameter>to_encoding</parameter>。
   当参数 <parameter>string</parameter> 是 &array; 时，将递归转换它所有的 &string; 值。
  </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> 的编码。可以将多个编码指定为 &array;
       或逗号分隔列表，在这种情况下，将使用与 <function>mb_detect_encoding</function> 相同的算法来猜测正确的编码。
      </para>
      <para>
       如果 <parameter>from_encoding</parameter> 被省略或为 &null;，则将使用 <link linkend="ini.mbstring.internal-encoding">mbstring.internal_encoding
       设置</link>，否则使用 <link linkend="ini.default-charset">default_charset 设置</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>
   编码后的 <type>string</type>。
   成功时返回编码后的 &string; 或 &array;，&return.falseforfailure;。
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   当 <parameter>to_encoding</parameter> 或 <parameter>from_encoding</parameter> 为无效的编码时，
   PHP 8.0.0 起将抛出 <classname>ValueError</classname>；
   而在 PHP 8.0.0 之前的版本里，会产生一个 <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.2.0</entry>
      <entry>
       <function>mb_convert_encoding</function>
       将不再返回以下非文本编码：<literal>"Base64"</literal>、<literal>"QPrint"</literal>、<literal>"UUencode"</literal>、<literal>"HTML entities"</literal>、<literal>"7 bit"</literal> 和 <literal>"8 bit"</literal>。
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       现在，当 <parameter>to_encoding</parameter> 为无效编码时，
       <function>mb_convert_encoding</function> 会抛出 <classname>ValueError</classname>。
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       现在，当 <parameter>from_encoding</parameter> 为无效编码时，
       <function>mb_convert_encoding</function> 会抛出 <classname>ValueError</classname>。
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       现在 <parameter>from_encoding</parameter> 可以传入 null。
      </entry>
     </row>
     <row>
      <entry>7.2.0</entry>
      <entry>
       现在该函数的 <parameter>string</parameter> 参数同时能接受 &array; 类型。
       在此之前，仅支持 &string;。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>mb_convert_encoding</function> 示例</title>
    <programlisting role="php" annotations="non-interactive">
<![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 中自动检测编码，并转换 str 到 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");
?>
]]>
    </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
-->