archived-doc-ru/reference/mbstring/functions/mb-encode-numericentity.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: a60ef65239113c7871643be68ada91081376c936 Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<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>
       Кодируемая строка (<type>string</type>).
      </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>
       Параметр указывает, возвращать ли HTML-сущность
       в шестнадцатеричной нотации; иначе числовая ссылка на символ возвращается в десятичной нотации.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает преобразованную строку (<type>string</type>).
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <simpara>
   Функция теперь выбрасывает ошибку <exceptionname>ValueError</exceptionname>,
   если список <parameter>map</parameter> содержит значения кроме &integer;.
  </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>
       Функция <function>mb_encode_numericentity</function> теперь выбрасывает
       ошибку <exceptionname>ValueError</exceptionname>, если список <parameter>map</parameter>
       содержит значения кроме &integer;.
      </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
);
// Значения start_codeN и end_codeN определяют диапазон кодовых точек Юникода.
// К кодовой точке исходного символа добавляется смещение offsetN и выполняется побитовая операция 'И' со значением маски maskN,
// а полученное значение затем преобразовывается в числовую HTML-сущность.

?>
]]>
    </programlisting>
   </example>
  </para>

  <para>
   <example>
    <title>Пример кодирования символа функцией <function>mb_encode_numericentity</function></title>
    <programlisting role="php">
<![CDATA[
<?php

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

/* Преобразование каждого UTF8-символа длиной до 4 байтов в числовую HTML-сущность */
$convmap = [0, 0x1FFFFF, 0, 0x10FFFF];
var_dump(mb_encode_numericentity($str, $convmap, "utf8"));

/* Преобразование только 2- и 4-байтовых UTF8-символов в числовую HTML-сущность */
$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
-->