Source of: /manual/en/function.mb-convert-kana.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.mbstring.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.mb-convert-kana.php',
1 => 'mb_convert_kana',
),
'up' =>
array (
0 => 'ref.mbstring.php',
1 => 'Multibyte String Functions',
),
'prev' =>
array (
0 => 'function.mb-convert-encoding.php',
1 => 'mb_convert_encoding',
),
'next' =>
array (
0 => 'function.mb-convert-variables.php',
1 => 'mb_convert_variables',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<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>
<a name="function.mb-convert-kana.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><b>mb_convert_kana</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$str</tt></span>
[, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$option</tt></span>
[, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$encoding</tt></span>
]] )</div>
<p class="para rdfs-comment">
Performs a "han-kaku" - "zen-kaku" conversion for <a href="language.types.string.php" class="type string">string</a> <i><tt class="parameter">str</tt></i>
.
This function is only useful for Japanese.
</p>
</div>
<a name="function.mb-convert-kana.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">str</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The <a href="language.types.string.php" class="type string">string</a> being converted.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">option</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The conversion option. The default value is <i>"KV"</i>.
</p>
<p class="para">
Specify with a combination of following options. The default
value is <i>KV</i>.
</p><table class="doctable table">
<caption><b>Applicable Conversion Options</b></caption>
<thead valign="middle">
<tr valign="middle">
<th>Option</th>
<th>Meaning</th>
</tr>
</thead>
<tbody valign="middle" class="tbody">
<tr valign="middle">
<td align="left"><i>r</i></td>
<td align="left">
Convert "zen-kaku" alphabets to "han-kaku"
</td>
</tr>
<tr valign="middle">
<td align="left"><i>R</i></td>
<td align="left">
Convert "han-kaku" alphabets to "zen-kaku"
</td>
</tr>
<tr valign="middle">
<td align="left"><i>n</i></td>
<td align="left">
Convert "zen-kaku" numbers to "han-kaku"
</td>
</tr>
<tr valign="middle">
<td align="left"><i>N</i></td>
<td align="left">
Convert "han-kaku" numbers to "zen-kaku"
</td>
</tr>
<tr valign="middle">
<td align="left"><i>a</i></td>
<td align="left">
Convert "zen-kaku" alphabets and numbers to "han-kaku"
</td>
</tr>
<tr valign="middle">
<td align="left"><i>A</i></td>
<td align="left">
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 valign="middle">
<td align="left"><i>s</i></td>
<td align="left">
Convert "zen-kaku" space to "han-kaku" (U+3000 -> U+0020)
</td>
</tr>
<tr valign="middle">
<td align="left"><i>S</i></td>
<td align="left">
Convert "han-kaku" space to "zen-kaku" (U+0020 -> U+3000)
</td>
</tr>
<tr valign="middle">
<td align="left"><i>k</i></td>
<td align="left">
Convert "zen-kaku kata-kana" to "han-kaku kata-kana"
</td>
</tr>
<tr valign="middle">
<td align="left"><i>K</i></td>
<td align="left">
Convert "han-kaku kata-kana" to "zen-kaku kata-kana"
</td>
</tr>
<tr valign="middle">
<td align="left"><i>h</i></td>
<td align="left">
Convert "zen-kaku hira-gana" to "han-kaku kata-kana"
</td>
</tr>
<tr valign="middle">
<td align="left"><i>H</i></td>
<td align="left">
Convert "han-kaku kata-kana" to "zen-kaku hira-gana"
</td>
</tr>
<tr valign="middle">
<td align="left"><i>c</i></td>
<td align="left">
Convert "zen-kaku kata-kana" to "zen-kaku hira-gana"
</td>
</tr>
<tr valign="middle">
<td align="left"><i>C</i></td>
<td align="left">
Convert "zen-kaku hira-gana" to "zen-kaku kata-kana"
</td>
</tr>
<tr valign="middle">
<td align="left"><i>V</i></td>
<td align="left">
Collapse voiced sound notation and convert them into a character. Use with "K","H"
</td>
</tr>
</tbody>
</table>
<p>
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">encoding</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">The <i><tt class="parameter">encoding</tt></i>
parameter is the character encoding. If it is omitted, the internal character
encoding value will be used.</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.mb-convert-kana.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The converted <a href="language.types.string.php" class="type string">string</a>.
</p>
</div>
<a name="function.mb-convert-kana.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>mb_convert_kana()</b> example</b></p>
<div class="example-contents programlisting">
<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>
</p>
</div>
</div><?php manual_footer(); ?>