<!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>Convert character code in variable(s)</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mb-convert-kana.html">mb_convert_kana</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mb-decode-mimeheader.html">mb_decode_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-convert-variables" class="refentry">
<div class="refnamediv">
<h1 class="refname">mb_convert_variables</h1>
<p class="verinfo">(PHP 4 >= 4.0.6, PHP 5)</p><p class="refpurpose"><span class="refname">mb_convert_variables</span> — <span class="dc-title">Convert character code in variable(s)</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.mb-convert-variables-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>mb_convert_variables</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$to_encoding</code></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">$from_encoding</code></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 reference">&$vars</code></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 reference">&$...</code></span>
] )</div>
<p class="para rdfs-comment">
Converts
character encoding of variables <em><code class="parameter">vars</code></em> in
encoding <em><code class="parameter">from_encoding</code></em> to encoding
<em><code class="parameter">to_encoding</code></em>.
</p>
<p class="para">
<span class="function"><strong>mb_convert_variables()</strong></span> join strings in Array
or Object to detect encoding, since encoding detection tends to
fail for short strings. Therefore, it is impossible to mix
encoding in single array or object.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.mb-convert-variables-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">to_encoding</code></em></span>
<dd>
<p class="para">
The encoding that the <span class="type"><a href="language.types.string.html" class="type string">string</a></span> is being converted to.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">from_encoding</code></em></span>
<dd>
<p class="para">
<em><code class="parameter">from_encoding</code></em> is specified as an <span class="type"><a href="language.types.array.html" class="type array">array</a></span>
or comma separated <span class="type"><a href="language.types.string.html" class="type string">string</a></span>, it tries to detect encoding from
<em><code class="parameter">from-coding</code></em>. When <em><code class="parameter">from_encoding</code></em>
is omitted, <em>detect_order</em> is used.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">vars</code></em></span>
<dd>
<p class="para">
<em><code class="parameter">vars</code></em> is the reference to the
variable being converted. String, Array and Object are accepted.
<span class="function"><strong>mb_convert_variables()</strong></span> assumes all parameters
have the same encoding.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">...</code></em></span>
<dd>
<p class="para">
Additional <em><code class="parameter">vars</code></em>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.mb-convert-variables-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The character encoding before conversion for success,
or <strong><code>FALSE</code></strong> for failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.mb-convert-variables-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2703">
<p><strong>Example #1 <span class="function"><strong>mb_convert_variables()</strong></span> example</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">/* Convert variables $post1, $post2 to internal encoding */<br /></span><span style="color: #0000BB">$interenc </span><span style="color: #007700">= </span><span style="color: #0000BB">mb_internal_encoding</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$inputenc </span><span style="color: #007700">= </span><span style="color: #0000BB">mb_convert_variables</span><span style="color: #007700">(</span><span style="color: #0000BB">$interenc</span><span style="color: #007700">, </span><span style="color: #DD0000">"ASCII,UTF-8,SJIS-win"</span><span style="color: #007700">, </span><span style="color: #0000BB">$post1</span><span style="color: #007700">, </span><span style="color: #0000BB">$post2</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mb-convert-kana.html">mb_convert_kana</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mb-decode-mimeheader.html">mb_decode_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>
