mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 06:18:56 +00:00
af4410a7e1
still using this, after discussion on the phpdoc list. From now on, manual.ced will need to be found at ~/.phpdoc/manual.ced. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288721 c90b9560-bf6c-de11-be94-00142212c4b1
211 lines
5.9 KiB
XML
211 lines
5.9 KiB
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>str</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>option</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Performs a "han-kaku" - "zen-kaku" conversion for <type>string</type> <parameter>str</parameter>.
|
|
This function is only useful for Japanese.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>str</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The <type>string</type> being converted.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>option</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The conversion option. The default value is <literal>"KV"</literal>.
|
|
</para>
|
|
<para>
|
|
Specify with a combination of following options. The default
|
|
value is <literal>KV</literal>.
|
|
<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="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>mb_convert_kana</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
/* Convert all "kana" to "zen-kaku" "kata-kana" */
|
|
$str = mb_convert_kana($str, "KVC");
|
|
|
|
/* Convert "han-kaku" "kata-kana" to "zen-kaku" "kata-kana"
|
|
and "zen-kaku" alpha-numeric to "han-kaku" */
|
|
$str = mb_convert_kana($str, "KVa");
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</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
|
|
-->
|