Source of: /manual/en/function.mb-encode-numericentity.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.mbstring.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.mb-encode-numericentity.php',
1 => 'mb_encode_numericentity',
),
'up' =>
array (
0 => 'ref.mbstring.php',
1 => 'Multibyte String Functions',
),
'prev' =>
array (
0 => 'function.mb-encode-mimeheader.php',
1 => 'mb_encode_mimeheader',
),
'next' =>
array (
0 => 'function.mb-ereg-match.php',
1 => 'mb_ereg_match',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.mb-encode-numericentity" class="refentry">
<div class="refnamediv">
<h1 class="refname">mb_encode_numericentity</h1>
<p class="verinfo">(PHP 4 >= 4.0.6, PHP 5)</p><p class="refpurpose"><span class="refname">mb_encode_numericentity</span> — <span class="dc-title">Encode character to HTML numeric string reference</span></p>
</div>
<a name="function.mb-encode-numericentity.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><b>mb_encode_numericentity</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$str</tt></span>
, <span class="methodparam"><span class="type">array</span> <tt class="parameter">$convmap</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$encoding</tt></span>
)</div>
<p class="para rdfs-comment">
Converts
specified character codes in <a href="language.types.string.php" class="type string">string</a> <i><tt class="parameter">str</tt></i>
from HTML numeric character reference to character code.
</p>
</div>
<a name="function.mb-encode-numericentity.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">str</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The <a href="language.types.string.php" class="type string">string</a> being encoded.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">convmap</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
<i><tt class="parameter">convmap</tt></i>
is array specifies code area to
convert.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">encoding</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">The <i><tt class="parameter">encoding</tt></i>
parameter is the character encoding. If it is omitted, the internal character
encoding value will be used.</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.mb-encode-numericentity.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The converted <a href="language.types.string.php" class="type string">string</a>.
</p>
</div>
<a name="function.mb-encode-numericentity.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <i><tt class="parameter">convmap</tt></i>
example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
$convmap = array (<br /> int start_code1, int end_code1, int offset1, int mask1,<br /> int start_code2, int end_code2, int offset2, int mask2,<br /> ........<br /> int start_codeN, int end_codeN, int offsetN, int maskN );<br />// Specify Unicode value for start_codeN and end_codeN<br />// Add offsetN to value and take bit-wise 'AND' with maskN, then<br />// it converts value to numeric string reference.</span>
</code></div>
</div>
</div><p>
</p>
</div>
<a name="function.mb-encode-numericentity.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #2 <b>mb_encode_numericentity()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">/* Convert Left side of ISO-8859-1 to HTML numeric character reference */<br /></span><span style="color: #0000BB">$convmap </span><span style="color: #007700">= array(</span><span style="color: #0000BB">0x80</span><span style="color: #007700">, </span><span style="color: #0000BB">0xff</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">0xff</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$str </span><span style="color: #007700">= </span><span style="color: #0000BB">mb_encode_numericentity</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">, </span><span style="color: #0000BB">$convmap</span><span style="color: #007700">, </span><span style="color: #DD0000">"ISO-8859-1"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Convert user defined SJIS-win code in block 95-104 to numeric<br /> string reference */<br /></span><span style="color: #0000BB">$convmap </span><span style="color: #007700">= array(<br /> </span><span style="color: #0000BB">0xe000</span><span style="color: #007700">, </span><span style="color: #0000BB">0xe03e</span><span style="color: #007700">, </span><span style="color: #0000BB">0x1040</span><span style="color: #007700">, </span><span style="color: #0000BB">0xffff</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">0xe03f</span><span style="color: #007700">, </span><span style="color: #0000BB">0xe0bb</span><span style="color: #007700">, </span><span style="color: #0000BB">0x1041</span><span style="color: #007700">, </span><span style="color: #0000BB">0xffff</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">0xe0bc</span><span style="color: #007700">, </span><span style="color: #0000BB">0xe0fa</span><span style="color: #007700">, </span><span style="color: #0000BB">0x1084</span><span style="color: #007700">, </span><span style="color: #0000BB">0xffff</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">0xe0fb</span><span style="color: #007700">, </span><span style="color: #0000BB">0xe177</span><span style="color: #007700">, </span><span style="color: #0000BB">0x1085</span><span style="color: #007700">, </span><span style="color: #0000BB">0xffff</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">0xe178</span><span style="color: #007700">, </span><span style="color: #0000BB">0xe1b6</span><span style="color: #007700">, </span><span style="color: #0000BB">0x10c8</span><span style="color: #007700">, </span><span style="color: #0000BB">0xffff</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">0xe1b7</span><span style="color: #007700">, </span><span style="color: #0000BB">0xe233</span><span style="color: #007700">, </span><span style="color: #0000BB">0x10c9</span><span style="color: #007700">, </span><span style="color: #0000BB">0xffff</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">0xe234</span><span style="color: #007700">, </span><span style="color: #0000BB">0xe272</span><span style="color: #007700">, </span><span style="color: #0000BB">0x110c</span><span style="color: #007700">, </span><span style="color: #0000BB">0xffff</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">0xe273</span><span style="color: #007700">, </span><span style="color: #0000BB">0xe2ef</span><span style="color: #007700">, </span><span style="color: #0000BB">0x110d</span><span style="color: #007700">, </span><span style="color: #0000BB">0xffff</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">0xe2f0</span><span style="color: #007700">, </span><span style="color: #0000BB">0xe32e</span><span style="color: #007700">, </span><span style="color: #0000BB">0x1150</span><span style="color: #007700">, </span><span style="color: #0000BB">0xffff</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">0xe32f</span><span style="color: #007700">, </span><span style="color: #0000BB">0xe3ab</span><span style="color: #007700">, </span><span style="color: #0000BB">0x1151</span><span style="color: #007700">, </span><span style="color: #0000BB">0xffff </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$str </span><span style="color: #007700">= </span><span style="color: #0000BB">mb_encode_numericentity</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">, </span><span style="color: #0000BB">$convmap</span><span style="color: #007700">, </span><span style="color: #DD0000">"sjis-win"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
<a name="function.mb-encode-numericentity.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.mb-decode-numericentity.php" class="function" rel="rdfs-seeAlso">mb_decode_numericentity()</a> - Decode HTML numeric string reference to character</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>