reference/mbstring/functions/mb-decode-numericentity.xml
d6f54016d62904cfd8200604aadd5e3f0d9bad97
d6f54016d62904cfd8200604aadd5e3f0d9bad97
...
...
@@ -10,13 +10,13 @@
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>string</type><methodname>mb_decode_numericentity</methodname>
13
-
<methodparam><type>string</type><parameter>str</parameter></methodparam>
14
-
<methodparam><type>array</type><parameter>convmap</parameter></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><type>array</type><parameter>map</parameter></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
18
Convert numeric string reference of <type>string</type>
19
-
<parameter>str</parameter> in a specified block to character.
19
+
<parameter>string</parameter> in a specified block to character.
20
20
</para>
21
21
</refsect1>
22
22
...
...
@@ -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 decoded.
...
...
@@ -33,10 +33,10 @@
33
33
</listitem>
34
34
</varlistentry>
35
35
<varlistentry>
36
-
<term><parameter>convmap</parameter></term>
36
+
<term><parameter>map</parameter></term>
37
37
<listitem>
38
38
<para>
39
-
<parameter>convmap</parameter> is an <type>array</type> that specifies
39
+
<parameter>map</parameter> is an <type>array</type> that specifies
40
40
the code area to convert.
41
41
</para>
42
42
</listitem>
...
...
@@ -47,6 +47,14 @@
47
47
&mbstring.encoding.parameter;
48
48
</listitem>
49
49
</varlistentry>
50
+
<varlistentry>
51
+
<term><parameter>is_hex</parameter></term>
52
+
<listitem>
53
+
<para>
54
+
This parameter is not used.
55
+
</para>
56
+
</listitem>
57
+
</varlistentry>
50
58
</variablelist>
51
59
</para>
52
60
</refsect1>
...
...
@@ -58,18 +66,51 @@
58
66
</para>
59
67
</refsect1>
60
68
69
+
<refsect1 role="errors">
70
+
&reftitle.errors;
71
+
<simpara>
72
+
Throws a <exceptionname>ValueError</exceptionname> if
73
+
<parameter>map</parameter> is not a list of &integer;s.
74
+
</simpara>
75
+
</refsect1>
76
+
77
+
<refsect1 role="changelog">
78
+
&reftitle.changelog;
79
+
<informaltable>
80
+
<tgroup cols="2">
81
+
<thead>
82
+
<row>
83
+
<entry>&Version;</entry>
84
+
<entry>&Description;</entry>
85
+
</row>
86
+
</thead>
87
+
<tbody>
88
+
<row>
89
+
<entry>8.4.0</entry>
90
+
<entry>
91
+
<function>mb_decode_numericentity</function> now throws a
92
+
<exceptionname>ValueError</exceptionname> if <parameter>map</parameter>
93
+
is not a list of &integer;s.
94
+
</entry>
95
+
</row>
96
+
&mbstring.changelog.encoding-nullable;
97
+
</tbody>
98
+
</tgroup>
99
+
</informaltable>
100
+
</refsect1>
101
+
61
102
<refsect1 role="examples">
62
103
&reftitle.examples;
63
104
<para>
64
105
<example>
65
-
<title><parameter>convmap</parameter> example</title>
66
-
<programlisting role="php">
106
+
<title><parameter>map</parameter> example</title>
107
+
<programlisting>
67
108
<![CDATA[
68
109
<?php
69
110
$convmap = array (
70
111
int start_code1, int end_code1, int offset1, int mask1,
71
112
int start_code2, int end_code2, int offset2, int mask2,
72
-
........
113
+
// ........
73
114
int start_codeN, int end_codeN, int offsetN, int maskN );
74
115
// Specify Unicode value for start_codeN and end_codeN
75
116
// Add offsetN to value and take bit-wise 'AND' with maskN,
...
...
@@ -82,7 +123,7 @@ $convmap = array (
82
123
83
124
<para>
84
125
<example>
85
-
<title><parameter>convmap</parameter> example escapes JavaScript string</title>
126
+
<title><parameter>map</parameter> example escapes JavaScript string</title>
86
127
<programlisting role="php">
87
128
<![CDATA[
88
129
<?php
...
...
@@ -160,7 +201,6 @@ var_dump(escape_javascript_string($msg));
160
201
</refsect1>
161
202
162
203
</refentry>
163
-
164
204
<!-- Keep this comment at the end of the file
165
205
Local variables:
166
206
mode: sgml
167
207