mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-22 03:48:55 +00:00
35699a52ac
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@338834 c90b9560-bf6c-de11-be94-00142212c4b1
152 lines
4.3 KiB
XML
152 lines
4.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.mb-detect-order" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>mb_detect_order</refname>
|
|
<refpurpose>Set/Get character encoding detection order</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>mixed</type><methodname>mb_detect_order</methodname>
|
|
<methodparam choice="opt"><type>mixed</type><parameter>encoding_list</parameter><initializer>mb_detect_order()</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Sets the automatic character
|
|
encoding detection order to <parameter>encoding_list</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>encoding_list</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
<parameter>encoding_list</parameter> is an <type>array</type> or
|
|
comma separated list of character encoding. See <link
|
|
linkend="mbstring.supported-encodings">supported encodings</link>.
|
|
</para>
|
|
<para>
|
|
If <parameter>encoding_list</parameter> is omitted, it returns
|
|
the current character encoding detection order as array.
|
|
</para>
|
|
<para>
|
|
This setting affects <function>mb_detect_encoding</function> and
|
|
<function>mb_send_mail</function>.
|
|
</para>
|
|
<para>
|
|
<literal>mbstring</literal> currently implements the following
|
|
encoding detection filters. If there is an invalid byte sequence
|
|
for the following encodings, encoding detection will fail.
|
|
</para>
|
|
<simpara>
|
|
<literal>UTF-8</literal>, <literal>UTF-7</literal>,
|
|
<literal>ASCII</literal>,
|
|
<literal>EUC-JP</literal>,<literal>SJIS</literal>,
|
|
<literal>eucJP-win</literal>, <literal>SJIS-win</literal>,
|
|
<literal>JIS</literal>, <literal>ISO-2022-JP</literal>
|
|
</simpara>
|
|
<para>
|
|
For <literal>ISO-8859-*</literal>, <literal>mbstring</literal>
|
|
always detects as <literal>ISO-8859-*</literal>.
|
|
</para>
|
|
<para>
|
|
For <literal>UTF-16</literal>, <literal>UTF-32</literal>,
|
|
<literal>UCS2</literal> and <literal>UCS4</literal>, encoding
|
|
detection will fail always.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
When setting the encoding detection order, &true; is returned on success or &false; on failure.
|
|
</para>
|
|
<para>
|
|
When getting the encoding detection order, an ordered array of the encodings is returned.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>mb_detect_order</function> examples</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
/* Set detection order by enumerated list */
|
|
mb_detect_order("eucjp-win,sjis-win,UTF-8");
|
|
|
|
/* Set detection order by array */
|
|
$ary[] = "ASCII";
|
|
$ary[] = "JIS";
|
|
$ary[] = "EUC-JP";
|
|
mb_detect_order($ary);
|
|
|
|
/* Display current detection order */
|
|
echo implode(", ", mb_detect_order());
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title>Example showing useless detect orders</title>
|
|
<programlisting>
|
|
<![CDATA[
|
|
; Always detect as ISO-8859-1
|
|
detect_order = ISO-8859-1, UTF-8
|
|
|
|
; Always detect as UTF-8, since ASCII/UTF-7 values are
|
|
; valid for UTF-8
|
|
detect_order = UTF-8, ASCII, UTF-7
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>mb_internal_encoding</function></member>
|
|
<member><function>mb_http_input</function></member>
|
|
<member><function>mb_http_output</function></member>
|
|
<member><function>mb_send_mail</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
|
|
-->
|