<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<!-- EN-Revision: a60ef65239113c7871643be68ada91081376c936 Maintainer: takagi Status: ready -->

<!-- CREDITS: hirokawa,mumumu -->

<refentry xml:id="function.mb-encode-numericentity" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">

<refnamediv>

<refname>mb_encode_numericentity</refname>

<refpurpose>文字を HTML 数値エンティティにエンコードする</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>string</type><methodname>mb_encode_numericentity</methodname>

<methodparam><type>string</type><parameter>string</parameter></methodparam>

<methodparam><type>array</type><parameter>map</parameter></methodparam>

<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>

<methodparam choice="opt"><type>bool</type><parameter>hex</parameter><initializer>&false;</initializer></methodparam>

</methodsynopsis>

<para>

<parameter>string</parameter>の中で指定した文字コードを

文字コードから HTML 数値エンティティに変換します。

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>string</parameter></term>

<listitem>

<para>

エンコードする文字列。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>map</parameter></term>

<listitem>

<para>

<parameter>map</parameter> は、変換するコード領域を指定する配列です。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>encoding</parameter></term>

<listitem>

&mbstring.encoding.parameter;

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>hex</parameter></term>

<listitem>

<para>

返されたエンティティのリファレンスが16進記法であるべきかどうか

(&false; の場合、10進記法です)

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

変換後の文字列を返します。

</para>

</refsect1>

<refsect1 role="errors">

&reftitle.errors;

<simpara>

<parameter>map</parameter> が整数のリストでない場合、

<exceptionname>ValueError</exceptionname> がスローされます。

</simpara>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>8.4.0</entry>

<entry>

<parameter>map</parameter> が整数のリストでない場合、

<function>mb_encode_numericentity</function> は

<exceptionname>ValueError</exceptionname> をスローするようになりました。

</entry>

</row>

&mbstring.changelog.encoding-nullable;

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title><parameter>map</parameter> の例</title>

<programlisting role="php">

<![CDATA[

<?php

$convmap = array (

int start_code1, int end_code1, int offset1, int mask1,

int start_code2, int end_code2, int offset2, int mask2,

........

int start_codeN, int end_codeN, int offsetN, int maskN );

// Specify Unicode value for start_codeN and end_codeN

// Add offsetN to value and take bit-wise 'AND' with maskN, then

// it converts value to numeric string reference.

?>

]]>

</programlisting>

</example>

</para>

<para>

<example>

<title><function>mb_encode_numericentity</function> の例</title>

<programlisting role="php">

<![CDATA[

<?php

$str = "aAæÆあア𩸽";

/* Convert all UTF8 characters up to 4 bytes to HTML numeric character reference */

$convmap = [0, 0x1FFFFF, 0, 0x10FFFF];

var_dump(mb_encode_numericentity($str, $convmap, "utf8"));

/* Converts only 2-byte and 4-byte UTF8 characters to HTML numeric character reference */

$convmap = [

0x80, 0x7FF, 0, 0x10FFFF,

0x10000, 0x1FFFFF, 0, 0x10FFFF,

];

var_dump(mb_encode_numericentity($str, $convmap, "utf8"));

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

string(46) "&#97;&#65;&#230;&#198;&#12354;&#12450;&#40509;"

string(28) "aA&#230;&#198;あア&#40509;"

]]>

</screen>

</example>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>mb_decode_numericentity</function></member>

</simplelist>

</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

-->