mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-23 04:18:56 +00:00
a3db55f0df
Also, one example section is enough. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@352035 c90b9560-bf6c-de11-be94-00142212c4b1
157 lines
4.4 KiB
XML
157 lines
4.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<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>Convert character encoding</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>
|
|
Converts the character encoding of <parameter>string</parameter>
|
|
to <parameter>to_encoding</parameter>
|
|
from optionally <parameter>from_encoding</parameter>.
|
|
If <parameter>string</parameter> is an &array;, all its &string; values will be
|
|
converted recursively.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>string</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The &string; or &array; being encoded.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>to_encoding</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The type of encoding that <parameter>string</parameter> is being converted to.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>from_encoding</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Is specified by character code names before conversion. It is either
|
|
an <type>array</type>, or a comma separated enumerated list.
|
|
If <parameter>from_encoding</parameter> is not specified, the internal
|
|
encoding will be used.
|
|
<!-- link to internal encoding info -->
|
|
</para>
|
|
<para>
|
|
See <link linkend="mbstring.supported-encodings">supported
|
|
encodings</link>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
The encoded &string; or &array; on success, &return.falseforfailure;.
|
|
</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.0.0</entry>
|
|
<entry>
|
|
<parameter>from_encoding</parameter> is nullable now.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>7.2.0</entry>
|
|
<entry>
|
|
This function now also accepts an &array; as <parameter>string</parameter>.
|
|
Formerly, only &string;s have been supported.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>mb_convert_encoding</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
/* Convert internal character encoding to SJIS */
|
|
$str = mb_convert_encoding($str, "SJIS");
|
|
|
|
/* Convert EUC-JP to UTF-7 */
|
|
$str = mb_convert_encoding($str, "UTF-7", "EUC-JP");
|
|
|
|
/* Auto detect encoding from JIS, eucjp-win, sjis-win, then convert str to UCS-2LE */
|
|
$str = mb_convert_encoding($str, "UCS-2LE", "JIS, eucjp-win, sjis-win");
|
|
|
|
/* "auto" is expanded to "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>
|
|
</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
|
|
-->
|