<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Set/Get character encoding detection order</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mb-detect-encoding.html">mb_detect_encoding</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mb-encode-mimeheader.html">mb_encode_mimeheader</a></div>
<div class="up"><a href="ref.mbstring.html">Multibyte String Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.mb-detect-order" class="refentry">
<div class="refnamediv">
<h1 class="refname">mb_detect_order</h1>
<p class="verinfo">(PHP 4 >= 4.0.6, PHP 5)</p><p class="refpurpose"><span class="refname">mb_detect_order</span> — <span class="dc-title">Set/Get character encoding detection order</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.mb-detect-order-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>mb_detect_order</strong></span>
([ <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$encoding_list</code><span class="initializer"> = mb_detect_order()</span></span>
] )</div>
<p class="para rdfs-comment">
Sets the automatic character
encoding detection order to <em><code class="parameter">encoding_list</code></em>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.mb-detect-order-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">encoding_list</code></em></span>
<dd>
<p class="para">
<em><code class="parameter">encoding_list</code></em> is an <span class="type"><a href="language.types.array.html" class="type array">array</a></span> or
comma separated list of character encoding. See <a href="mbstring.supported-encodings.html" class="link">supported encodings</a>.
</p>
<p class="para">
If <em><code class="parameter">encoding_list</code></em> is omitted, it returns
the current character encoding detection order as array.
</p>
<p class="para">
This setting affects <span class="function"><a href="function.mb-detect-encoding.html" class="function">mb_detect_encoding()</a></span> and
<span class="function"><a href="function.mb-send-mail.html" class="function">mb_send_mail()</a></span>.
</p>
<p class="para">
<em>mbstring</em> currently implements the following
encoding detection filters. If there is an invalid byte sequence
for the following encodings, encoding detection will fail.
</p>
<span class="simpara">
<em>UTF-8</em>, <em>UTF-7</em>,
<em>ASCII</em>,
<em>EUC-JP</em>,<em>SJIS</em>,
<em>eucJP-win</em>, <em>SJIS-win</em>,
<em>JIS</em>, <em>ISO-2022-JP</em>
</span>
<p class="para">
For <em>ISO-8859-*</em>, <em>mbstring</em>
always detects as <em>ISO-8859-*</em>.
</p>
<p class="para">
For <em>UTF-16</em>, <em>UTF-32</em>,
<em>UCS2</em> and <em>UCS4</em>, encoding
detection will fail always.
</p>
<p class="para">
<div class="example" id="example-2706">
<p><strong>Example #1 Useless detect order example</strong></p>
<div class="example-contents">
<div class="cdata"><pre>
; 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
</pre></div>
</div>
</div>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.mb-detect-order-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.mb-detect-order-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2707">
<p><strong>Example #2 <span class="function"><strong>mb_detect_order()</strong></span> examples</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">/* Set detection order by enumerated list */<br /></span><span style="color: #0000BB">mb_detect_order</span><span style="color: #007700">(</span><span style="color: #DD0000">"eucjp-win,sjis-win,UTF-8"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Set detection order by array */<br /></span><span style="color: #0000BB">$ary</span><span style="color: #007700">[] = </span><span style="color: #DD0000">"ASCII"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$ary</span><span style="color: #007700">[] = </span><span style="color: #DD0000">"JIS"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$ary</span><span style="color: #007700">[] = </span><span style="color: #DD0000">"EUC-JP"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">mb_detect_order</span><span style="color: #007700">(</span><span style="color: #0000BB">$ary</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Display current detection order */<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">implode</span><span style="color: #007700">(</span><span style="color: #DD0000">", "</span><span style="color: #007700">, </span><span style="color: #0000BB">mb_detect_order</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.mb-detect-order-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.mb-internal-encoding.html" class="function" rel="rdfs-seeAlso">mb_internal_encoding()</a> - Set/Get internal character encoding</span></li>
<li class="member"> <span class="function"><a href="function.mb-http-input.html" class="function" rel="rdfs-seeAlso">mb_http_input()</a> - Detect HTTP input character encoding</span></li>
<li class="member"> <span class="function"><a href="function.mb-http-output.html" class="function" rel="rdfs-seeAlso">mb_http_output()</a> - Set/Get HTTP output character encoding</span></li>
<li class="member"> <span class="function"><a href="function.mb-send-mail.html" class="function" rel="rdfs-seeAlso">mb_send_mail()</a> - Send encoded mail</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mb-detect-encoding.html">mb_detect_encoding</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mb-encode-mimeheader.html">mb_encode_mimeheader</a></div>
<div class="up"><a href="ref.mbstring.html">Multibyte String Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
