htmlentities.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 06394ea77c2f8972e3884c00bede861ef5eb04da Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.htmlentities" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>htmlentities</refname>
  <refpurpose>Преобразовывает возможные символы в HTML-сущности</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>htmlentities</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401</initializer></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>double_encode</parameter><initializer>&true;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Функция работает идентично функции <function>htmlspecialchars</function>,
   за исключением того, что функция <function>htmlentities</function>
   преобразовывает в HTML-сущности каждый символ, для которого в таблице перевода
   содержится эквивалентная HTML-сущность.
   Таблицу перевода, которую использует эта функция и которая зависит
   от констант, которые передали в параметр <parameter>flags</parameter>,
   возвращает функция <function>get_html_translation_table</function>.
  </para>
  <para>
   Функция <function>html_entity_decode</function> выполняет обратное
   преобразование — декодирует HTML-сущности в символы.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       Входная строка.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Битовая маска из следующих флагов, которые определяют, как обрабатывать
       кавычки, неправильные последовательности кодовых единиц
       и тип документа. Маска по умолчанию:
       <literal>ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401</literal>.
       <table>
        <title>
         Доступные константы параметра <parameter>flags</parameter>
        </title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Название константы</entry>
           <entry>Описание</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><constant>ENT_COMPAT</constant></entry>
           <entry>Преобразовывает двойные кавычки, одинарные кавычки не изменяются.</entry>
          </row>
          <row>
           <entry><constant>ENT_QUOTES</constant></entry>
           <entry>Преобразовывает как двойные, так и одинарные кавычки.</entry>
          </row>
          <row>
           <entry><constant>ENT_NOQUOTES</constant></entry>
           <entry>Оставляет без изменения как двойные, так и одинарные кавычки.</entry>
          </row>
          <row>
           <entry><constant>ENT_IGNORE</constant></entry>
           <entry>
            Без предупреждения отбрасывает неправильные последовательности кодовых единиц
            вместо возврата пустой строки. Передача этого флага не рекомендуется,
            поскольку это <link xlink:href="&url.delete.nonchars;">небезопасно</link>.
           </entry>
          </row>
          <row>
           <entry><constant>ENT_SUBSTITUTE</constant></entry>
           <entry>
            Заменяет неправильные последовательности кодовых единиц символом замены
            Юникода вместо возврата пустой строки: U+FFFD для строк в кодировке UTF-8
            и &amp;#FFFD; для строк в других кодировках.
           </entry>
          </row>
          <row>
           <entry><constant>ENT_DISALLOWED</constant></entry>
           <entry>
            Заменяет неверные кодовые точки для заданного типа документа символом
            замены юникода U+FFFD для строк в кодировке UTF-8 или &amp;#FFFD;
            для строк в других кодировках вместо того, чтобы оставлять всё как есть.
            Это бывает полезно для правильного оформления XML-документов,
            в которые встроили внешнее содержимое.
           </entry>
          </row>
          <row>
           <entry><constant>ENT_HTML401</constant></entry>
           <entry>
            Обрабатывает код по правилам стандарта HTML 4.01.
           </entry>
          </row>
          <row>
           <entry><constant>ENT_XML1</constant></entry>
           <entry>
            Обрабатывает код по правилам стандарта XML 1.
           </entry>
          </row>
          <row>
           <entry><constant>ENT_XHTML</constant></entry>
           <entry>
            Обрабатывает код по правилам стандарта XHTML.
           </entry>
          </row>
          <row>
           <entry><constant>ENT_HTML5</constant></entry>
           <entry>
            Обрабатывает код по правилам стандарта HTML 5.
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>encoding</parameter></term>
     <listitem>
      &strings.parameter.encoding;
      &reference.strings.charsets;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>double_encode</parameter></term>
     <listitem>
      <para>
       Когда параметр <parameter>double_encode</parameter> отключён,
       PHP не будет кодировать существующие HTML-сущности.
       По умолчанию функция преобразовывает каждый символ.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает преобразованную строку.
  </para>
  <para>
   Функция вернёт пустую строку, если входная строка <parameter>string</parameter>
   содержит недопустимую для кодировки <parameter>encoding</parameter>
   последовательность кодовых единиц,
   если только не установили флаг <constant>ENT_IGNORE</constant>
   или <constant>ENT_SUBSTITUTE</constant>.
  </para>
 </refsect1>

  <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.1.0</entry>
      <entry>
       Значение по умолчанию параметра <parameter>flags</parameter>
       изменили с <constant>ENT_COMPAT</constant>
       на <constant>ENT_QUOTES</constant> | <constant>ENT_SUBSTITUTE</constant> | <constant>ENT_HTML401</constant>.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       Параметр <parameter>encoding</parameter> теперь принимает значение null.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования функции <function>htmlentities</function></title>
    <programlisting role="php">
<![CDATA[
<?php

$str = "A 'quote' is <b>bold</b>";

echo htmlentities($str);
echo "\n\n";
echo htmlentities($str, ENT_COMPAT);

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
A &#039;quote&#039; is &lt;b&gt;bold&lt;/b&gt;

A 'quote' is &lt;b&gt;bold&lt;/b&gt;
]]>
    </screen>
   </example>
  </para>

  <para>
   <example>
    <title>Передача флага <constant>ENT_IGNORE</constant></title>
    <programlisting role="php">
<![CDATA[
<?php

$str = "\x8F!!!";

// Выводит пустую строку
echo htmlentities($str, ENT_QUOTES, "UTF-8");

// Выводит "!!!"
echo htmlentities($str, ENT_QUOTES | ENT_IGNORE, "UTF-8");

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

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>html_entity_decode</function></member>
    <member><function>get_html_translation_table</function></member>
    <member><function>htmlspecialchars</function></member>
    <member><function>nl2br</function></member>
    <member><function>urlencode</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
-->