1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
<refentry id="function.mb-detect-order">
<refnamediv>
<refname>mb_detect_order</refname>
<refpurpose>
Set/Get character encoding detection order
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>mb_detect_order</methodname>
<methodparam choice="opt"><type>mixed</type><parameter>encoding_list</parameter></methodparam>
</methodsynopsis>
<para>
<function>mb_detect_order</function> sets automatic character
encoding detection order to <parameter>encoding_list</parameter>.
It returns &true; for success,
&false; for failure.
</para>
<para>
<parameter>encoding_list</parameter> is array or comma separated
list of character encoding. ("auto" is expanded to
"ASCII, JIS, UTF-8, EUC-JP, SJIS")
</para>
<para>
If <parameter>encoding_list</parameter> is omitted, it returns
current character encoding detection order as array.
</para>
<para>
This setting affects <function>mb_detect_encoding</function> and
<function>mb_send_mail</function>.
</para>
<note>
<para>
<literal>mbstring</literal> currently implements following
encoding detection filters. If there is an invalid byte sequence
for following encoding, 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>
<para>
<example>
<title>Useless detect order example</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>
</note>
<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>
See also <function>mb_internal_encoding</function>,
<function>mb_http_input</function>,
<function>mb_http_output</function> and
<function>mb_send_mail</function>.
</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:"../../../../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
-->
|
