reference/mbstring/functions/mb-convert-kana.xml
68e632fcb78f682de178cbcac63ee648426e0c30
...
...
@@ -10,12 +10,12 @@
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>string</type><methodname>mb_convert_kana</methodname>
13
-
<methodparam><type>string</type><parameter>str</parameter></methodparam>
14
-
<methodparam choice="opt"><type>string</type><parameter>option</parameter><initializer>"KV"</initializer></methodparam>
15
-
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
13
+
<methodparam><type>string</type><parameter>string</parameter></methodparam>
14
+
<methodparam choice="opt"><type>string</type><parameter>mode</parameter><initializer>"KV"</initializer></methodparam>
15
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
16
16
</methodsynopsis>
17
17
<para>
18
-
Performs a "han-kaku" - "zen-kaku" conversion for <type>string</type> <parameter>str</parameter>.
18
+
Performs a "han-kaku" - "zen-kaku" conversion for <type>string</type> <parameter>string</parameter>.
19
19
This function is only useful for Japanese.
20
20
</para>
21
21
</refsect1>
...
...
@@ -25,7 +25,7 @@
25
25
<para>
26
26
<variablelist>
27
27
<varlistentry>
28
-
<term><parameter>str</parameter></term>
28
+
<term><parameter>string</parameter></term>
29
29
<listitem>
30
30
<para>
31
31
The <type>string</type> being converted.
...
...
@@ -33,7 +33,7 @@
33
33
</listitem>
34
34
</varlistentry>
35
35
<varlistentry>
36
-
<term><parameter>option</parameter></term>
36
+
<term><parameter>mode</parameter></term>
37
37
<listitem>
38
38
<para>
39
39
The conversion option.
...
...
@@ -165,6 +165,39 @@
165
165
</para>
166
166
</refsect1>
167
167

168
+
<refsect1 role="errors">
169
+
&reftitle.errors;
170
+
<para>
171
+
Throws a <classname>ValueError</classname> if the combination of
172
+
different <parameter>mode</parameter>s is invalid.
173
+
For example <literal>"sS"</literal>.
174
+
</para>
175
+
</refsect1>
176
+

177
+
<refsect1 role="changelog">
178
+
&reftitle.changelog;
179
+
<informaltable>
180
+
<tgroup cols="2">
181
+
<thead>
182
+
<row>
183
+
<entry>&Version;</entry>
184
+
<entry>&Description;</entry>
185
+
</row>
186
+
</thead>
187
+
<tbody>
188
+
<row>
189
+
<entry>8.2.0</entry>
190
+
<entry>
191
+
A <classname>ValueError</classname> is now thrown if the
192
+
combination of different <parameter>mode</parameter>s is invalid.
193
+
</entry>
194
+
</row>
195
+
&mbstring.changelog.encoding-nullable;
196
+
</tbody>
197
+
</tgroup>
198
+
</informaltable>
199
+
</refsect1>
200
+

168
201
<refsect1 role="examples">
169
202
&reftitle.examples;
170
203
<para>
...
...
@@ -177,7 +210,7 @@
177
210
$str = mb_convert_kana($str, "KVC");
178
211

179
212
/* Convert "han-kaku" "kata-kana" to "zen-kaku" "kata-kana"
180
-
and "zen-kaku" alpha-numeric to "han-kaku" */
213
+
and "zen-kaku" alphanumeric to "han-kaku" */
181
214
$str = mb_convert_kana($str, "KVa");
182
215
?>
183
216
]]>
...
...
@@ -187,7 +220,6 @@ $str = mb_convert_kana($str, "KVa");
187
220
</refsect1>
188
221

189
222
</refentry>
190
-

191
223
<!-- Keep this comment at the end of the file
192
224
Local variables:
193
225
mode: sgml
194
226