reference/mbstring/functions/mb-encode-numericentity.xml
a3db55f0df6a17d473f65ce207ef3f778011cdfe
a3db55f0df6a17d473f65ce207ef3f778011cdfe
...
...
@@ -10,14 +10,14 @@
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>string</type><methodname>mb_encode_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>
16
-
<methodparam choice="opt"><type>bool</type><parameter>is_hex</parameter><initializer>FALSE</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
+
<methodparam choice="opt"><type>bool</type><parameter>hex</parameter><initializer>&false;</initializer></methodparam>
17
17
</methodsynopsis>
18
18
<para>
19
19
Converts
20
-
specified character codes in <type>string</type> <parameter>str</parameter>
20
+
specified character codes in <type>string</type> <parameter>string</parameter>
21
21
from character code to HTML numeric character reference.
22
22
</para>
23
23
</refsect1>
...
...
@@ -27,7 +27,7 @@
27
27
<para>
28
28
<variablelist>
29
29
<varlistentry>
30
-
<term><parameter>str</parameter></term>
30
+
<term><parameter>string</parameter></term>
31
31
<listitem>
32
32
<para>
33
33
The <type>string</type> being encoded.
...
...
@@ -35,10 +35,10 @@
35
35
</listitem>
36
36
</varlistentry>
37
37
<varlistentry>
38
-
<term><parameter>convmap</parameter></term>
38
+
<term><parameter>map</parameter></term>
39
39
<listitem>
40
40
<para>
41
-
<parameter>convmap</parameter> is array specifies code area to
41
+
<parameter>map</parameter> is array specifies code area to
42
42
convert.
43
43
</para>
44
44
</listitem>
...
...
@@ -50,9 +50,11 @@
50
50
</listitem>
51
51
</varlistentry>
52
52
<varlistentry>
53
-
<term><parameter>is_hex</parameter></term>
53
+
<term><parameter>hex</parameter></term>
54
54
<listitem>
55
55
<para>
56
+
Whether the returned entity reference should be in hexadecimal notation
57
+
(otherwise it is in decimal notation).
56
58
</para>
57
59
</listitem>
58
60
</varlistentry>
...
...
@@ -69,33 +71,26 @@
69
71
70
72
<refsect1 role="changelog">
71
73
&reftitle.changelog;
72
-
<para>
73
-
<informaltable>
74
-
<tgroup cols="2">
75
-
<thead>
76
-
<row>
77
-
<entry>&Version;</entry>
78
-
<entry>&Description;</entry>
79
-
</row>
80
-
</thead>
81
-
<tbody>
82
-
<row>
83
-
<entry>5.4.0</entry>
84
-
<entry>
85
-
Added <parameter>is_hex</parameter> parameter.
86
-
</entry>
87
-
</row>
88
-
</tbody>
89
-
</tgroup>
90
-
</informaltable>
91
-
</para>
74
+
<informaltable>
75
+
<tgroup cols="2">
76
+
<thead>
77
+
<row>
78
+
<entry>&Version;</entry>
79
+
<entry>&Description;</entry>
80
+
</row>
81
+
</thead>
82
+
<tbody>
83
+
&mbstring.changelog.encoding-nullable;
84
+
</tbody>
85
+
</tgroup>
86
+
</informaltable>
92
87
</refsect1>
93
88
94
89
<refsect1 role="examples">
95
90
&reftitle.examples;
96
91
<para>
97
92
<example>
98
-
<title><parameter>convmap</parameter> example</title>
93
+
<title><parameter>map</parameter> example</title>
99
94
<programlisting role="php">
100
95
<![CDATA[
101
96
<?php
...
...
@@ -112,10 +107,7 @@ $convmap = array (
112
107
</programlisting>
113
108
</example>
114
109
</para>
115
-
</refsect1>
116
110
117
-
<refsect1 role="examples">
118
-
&reftitle.examples;
119
111
<para>
120
112
<example>
121
113
<title><function>mb_encode_numericentity</function> example</title>
...
...
@@ -157,7 +149,6 @@ $str = mb_encode_numericentity($str, $convmap, "sjis-win");
157
149
</refsect1>
158
150
159
151
</refentry>
160
-
161
152
<!-- Keep this comment at the end of the file
162
153
Local variables:
163
154
mode: sgml
164
155