File: mb-convert-kana.xml

package info (click to toggle)
php-doc 20140201-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 74,084 kB
  • ctags: 4,040
  • sloc: xml: 998,137; php: 20,812; cpp: 500; sh: 177; makefile: 63; awk: 28
file content (210 lines) | stat: -rw-r--r-- 6,038 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 331340 $ -->
<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><initializer>"KV"</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></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.
      </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="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
-->