<!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 "kana" one from another ("zen-kaku", "han-kaku" and more)</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mb-convert-encoding.html">mb_convert_encoding</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mb-convert-variables.html">mb_convert_variables</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-kana" class="refentry">
<div class="refnamediv">
<h1 class="refname">mb_convert_kana</h1>
<p class="verinfo">(PHP 4 >= 4.0.6, PHP 5)</p><p class="refpurpose"><span class="refname">mb_convert_kana</span> — <span class="dc-title">Convert "kana" one from another ("zen-kaku", "han-kaku" and more)</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.mb-convert-kana-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>mb_convert_kana</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$str</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$option</code><span class="initializer"> = "KV"</span></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$encoding</code><span class="initializer"> = mb_internal_encoding()</span></span>
]] )</div>
<p class="para rdfs-comment">
Performs a "han-kaku" - "zen-kaku" conversion for <span class="type"><a href="language.types.string.html" class="type string">string</a></span> <em><code class="parameter">str</code></em>.
This function is only useful for Japanese.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.mb-convert-kana-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">str</code></em></span>
<dd>
<p class="para">
The <span class="type"><a href="language.types.string.html" class="type string">string</a></span> being converted.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">option</code></em></span>
<dd>
<p class="para">
The conversion option.
</p>
<p class="para">
Specify with a combination of following options.
<table class="doctable table">
<caption><strong>Applicable Conversion Options</strong></caption>
<thead>
<tr>
<th>Option</th>
<th>Meaning</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td><em>r</em></td>
<td>
Convert "zen-kaku" alphabets to "han-kaku"
</td>
</tr>
<tr>
<td><em>R</em></td>
<td>
Convert "han-kaku" alphabets to "zen-kaku"
</td>
</tr>
<tr>
<td><em>n</em></td>
<td>
Convert "zen-kaku" numbers to "han-kaku"
</td>
</tr>
<tr>
<td><em>N</em></td>
<td>
Convert "han-kaku" numbers to "zen-kaku"
</td>
</tr>
<tr>
<td><em>a</em></td>
<td>
Convert "zen-kaku" alphabets and numbers to "han-kaku"
</td>
</tr>
<tr>
<td><em>A</em></td>
<td>
Convert "han-kaku" alphabets and numbers to "zen-kaku"
(Characters included in "a", "A" options are
U+0021 - U+007E excluding U+0022, U+0027, U+005C, U+007E)
</td>
</tr>
<tr>
<td><em>s</em></td>
<td>
Convert "zen-kaku" space to "han-kaku" (U+3000 -> U+0020)
</td>
</tr>
<tr>
<td><em>S</em></td>
<td>
Convert "han-kaku" space to "zen-kaku" (U+0020 -> U+3000)
</td>
</tr>
<tr>
<td><em>k</em></td>
<td>
Convert "zen-kaku kata-kana" to "han-kaku kata-kana"
</td>
</tr>
<tr>
<td><em>K</em></td>
<td>
Convert "han-kaku kata-kana" to "zen-kaku kata-kana"
</td>
</tr>
<tr>
<td><em>h</em></td>
<td>
Convert "zen-kaku hira-gana" to "han-kaku kata-kana"
</td>
</tr>
<tr>
<td><em>H</em></td>
<td>
Convert "han-kaku kata-kana" to "zen-kaku hira-gana"
</td>
</tr>
<tr>
<td><em>c</em></td>
<td>
Convert "zen-kaku kata-kana" to "zen-kaku hira-gana"
</td>
</tr>
<tr>
<td><em>C</em></td>
<td>
Convert "zen-kaku hira-gana" to "zen-kaku kata-kana"
</td>
</tr>
<tr>
<td><em>V</em></td>
<td>
Collapse voiced sound notation and convert them into a character. Use with "K","H"
</td>
</tr>
</tbody>
</table>
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">encoding</code></em></span>
<dd>
<p class="para">The <em><code class="parameter">encoding</code></em>
parameter is the character encoding. If it is omitted, the internal character
encoding value will be used.</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.mb-convert-kana-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The converted <span class="type"><a href="language.types.string.html" class="type string">string</a></span>.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.mb-convert-kana-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2702">
<p><strong>Example #1 <span class="function"><strong>mb_convert_kana()</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 all "kana" to "zen-kaku" "kata-kana" */<br /></span><span style="color: #0000BB">$str </span><span style="color: #007700">= </span><span style="color: #0000BB">mb_convert_kana</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">, </span><span style="color: #DD0000">"KVC"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Convert "han-kaku" "kata-kana" to "zen-kaku" "kata-kana" <br /> and "zen-kaku" alpha-numeric to "han-kaku" */<br /></span><span style="color: #0000BB">$str </span><span style="color: #007700">= </span><span style="color: #0000BB">mb_convert_kana</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">, </span><span style="color: #DD0000">"KVa"</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-encoding.html">mb_convert_encoding</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mb-convert-variables.html">mb_convert_variables</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>
