mb-convert-kana.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mb-convert-kana" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>mb_convert_kana</refname>
  <refpurpose>Convert "kana" one from another ("zen-kaku", "han-kaku" and more)</refpurpose>
 </refnamediv>
   
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>mb_convert_kana</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>mode</parameter><initializer>"KV"</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Performs a "han-kaku" - "zen-kaku" conversion for <type>string</type> <parameter>string</parameter>. 
   This function is only useful for Japanese.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       The <type>string</type> being converted.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       The conversion option.
      </para>
      <para>
       Specify with a combination of following options.
       <table>
        <title>Applicable Conversion Options</title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Option</entry>
           <entry>Meaning</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><literal>r</literal></entry>
           <entry>
            Convert "zen-kaku" alphabets to "han-kaku"
           </entry>
          </row>
          <row>
           <entry><literal>R</literal></entry>
           <entry>
            Convert "han-kaku" alphabets to "zen-kaku"
           </entry>
          </row>
          <row>
           <entry><literal>n</literal></entry>
           <entry>
            Convert "zen-kaku" numbers to "han-kaku"
           </entry>
          </row>
          <row>
           <entry><literal>N</literal></entry>
           <entry>
            Convert "han-kaku" numbers to "zen-kaku"
           </entry>
          </row>
          <row>
           <entry><literal>a</literal></entry>
           <entry>
            Convert "zen-kaku" alphabets and numbers to "han-kaku"
           </entry>
          </row>
          <row>
           <entry><literal>A</literal></entry>
           <entry>
            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)
           </entry>
          </row>
          <row>
           <entry><literal>s</literal></entry>
           <entry>
            Convert "zen-kaku" space to "han-kaku" (U+3000 -> U+0020)
           </entry>
          </row>
          <row>
           <entry><literal>S</literal></entry>
           <entry>
            Convert "han-kaku" space to "zen-kaku" (U+0020 -> U+3000)
           </entry>
          </row>
          <row>
           <entry><literal>k</literal></entry>
           <entry>
            Convert "zen-kaku kata-kana" to "han-kaku kata-kana"
           </entry>
          </row>
          <row>
           <entry><literal>K</literal></entry>
           <entry>
            Convert "han-kaku kata-kana" to "zen-kaku kata-kana"
           </entry>
          </row>
          <row>
           <entry><literal>h</literal></entry>
           <entry>
            Convert "zen-kaku hira-gana" to "han-kaku kata-kana"
           </entry>
          </row>
          <row>
           <entry><literal>H</literal></entry>
           <entry>
            Convert "han-kaku kata-kana" to "zen-kaku hira-gana"
           </entry>
          </row>
          <row>
           <entry><literal>c</literal></entry>
           <entry>
           Convert "zen-kaku kata-kana" to "zen-kaku hira-gana"
           </entry>
          </row>
          <row>
           <entry><literal>C</literal></entry>
           <entry>
            Convert "zen-kaku hira-gana" to "zen-kaku kata-kana"
           </entry>
          </row>
          <row>
           <entry><literal>V</literal></entry>
           <entry>
            Collapse voiced sound notation and convert them into a character. Use with "K","H"
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>encoding</parameter></term>
     <listitem>
      &mbstring.encoding.parameter;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   The converted <type>string</type>.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Throws a <classname>ValueError</classname> if the combination of
   different <parameter>mode</parameter>s is invalid.
   For example <literal>"sS"</literal>.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.2.0</entry>
       <entry>
        A <classname>ValueError</classname> is now thrown if the
        combination of different <parameter>mode</parameter>s is invalid.
       </entry>
     </row>
     &mbstring.changelog.encoding-nullable;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>mb_convert_kana</function> example</title>
   <programlisting role="php">
<![CDATA[
<?php
/* Convert all "han-kaku" "kata-kana" to "zen-kaku" "hira-gana" */
echo mb_convert_kana('ﾔﾏﾀﾞ ﾊﾅｺ', "HV") . "\n";

/* Convert "han-kaku" "kata-kana" to "zen-kaku" "kata-kana" 
   and "zen-kaku" alphanumeric to "han-kaku" */
echo mb_convert_kana('ｺｳｻﾞﾊﾞﾝｺﾞｳ ０１２３４５６', "KVa") . "\n";
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
やまだ はなこ
コウザバンゴウ 0123456
]]>
   </screen>
  </example>
 </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:"~/.phpdoc/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
-->