htmlspecialchars.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: eabde0419cf90f596f60db00e31fcb6ebe41ac55 Maintainer: daijie Status: ready -->
<!-- CREDITS: mowangjuanzi -->
<refentry xml:id="function.htmlspecialchars" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>htmlspecialchars</refname>
  <refpurpose>将特殊字符转换为 HTML 实体</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>htmlspecialchars</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>
   某类字符在 HTML 中有特殊用处，如需保持原意，需要用 HTML 实体来表达。
   本函数会返回字符转义后的表达。
   如需转换子字符串中所有关联的名称实体，使用 <function>htmlentities</function> 代替本函数。
  </para>
  <para>
   如果传入字符的字符编码和最终的文档是一致的，则用函数处理的输入适合绝大多数 HTML 文档环境。
   然而，如果输入的字符编码和最终包含字符的文档是不一样的，
   想要保留字符（以数字或名称实体的形式），本函数以及 <function>htmlentities</function> 
   （仅编码名称实体对应的子字符串）可能不够用。
   这种情况可以使用 <function>mb_encode_numericentity</function> 代替。
  </para>
  <para>
   <table>
    <title>执行转换</title>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>字符</entry>
       <entry>替换后</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry><literal>&amp;</literal> (&amp; 符号)</entry>
       <entry><literal>&amp;amp;</literal></entry>
      </row>
      <row>
       <entry><literal>&quot;</literal> (双引号)</entry>
       <entry><literal>&amp;quot;</literal>，除非设置了 <constant>ENT_NOQUOTES</constant></entry>
      </row>
      <row>
       <entry><literal>'</literal> (单引号)</entry>
       <entry>
         设置了 <constant>ENT_QUOTES</constant> 后，
        <literal>&amp;#039;</literal>
        (如果是 <constant>ENT_HTML401</constant>) ，或者 <literal>&amp;apos;</literal> (如果是
        <constant>ENT_XML1</constant>、 <constant>ENT_XHTML</constant> 或
        <constant>ENT_HTML5</constant>)。
       </entry>
      </row>
      <row>
       <entry><literal>&lt;</literal> (小于)</entry>
       <entry><literal>&amp;lt;</literal></entry>
      </row>
      <row>
       <entry><literal>&gt;</literal> (大于)</entry>
       <entry><literal>&amp;gt;</literal></entry>
      </row>
     </tbody>
    </tgroup>
   </table>
  </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>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>
            替换无效的代码单元序列为 Unicode 代替符（Replacement Character），
            U+FFFD (UTF-8) 或者 &amp;#xFFFD; (其他)，而不是返回空字符串。
           </entry>
          </row>
          <row>
           <entry><constant>ENT_DISALLOWED</constant></entry>
           <entry>
            为文档的无效代码点替换为  Unicode 代替符（Replacement Character）：
            U+FFFD (UTF-8)，或 &amp;#xFFFD;（其他），而不是把它们留在原处。
            比如以下情况下就很有用：要保证 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;
      <para>
       本函数使用效果上，如果 <parameter>string</parameter> 对以下字符编码是有效的，
       <literal>ISO-8859-1</literal>、 <literal>ISO-8859-15</literal>、
       <literal>UTF-8</literal>、 <literal>cp866</literal>、
       <literal>cp1251</literal>、 <literal>cp1252</literal>、
       <literal>KOI8-R</literal> 将具有相同的效果。
       也就是说，在这些编码里，
       受 <function>htmlspecialchars</function> 影响的字符会占据相同的位置。
      </para>
      &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>
   转换后的 <type>string</type>。
  </para>
  <para>
   如果指定的编码 <parameter>encoding</parameter> 里，
   <parameter>string</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>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>htmlspecialchars</function> 例子</title>
    <programlisting role="php">
<![CDATA[
<?php
$new = htmlspecialchars("<a href='test'>Test</a>", ENT_QUOTES);
echo $new; // &lt;a href=&#039;test&#039;&gt;Test&lt;/a&gt;
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    注意，本函数不会转换以上列表以外的实体。
    完整转换请参见 <function>htmlentities</function>。
   </para>
  </note>
  <note>
   <para>
    如果 <parameter>flags</parameter> 的设置模糊易混淆，将遵循以下规则：
   </para>
   <para>
    <itemizedlist>
     <listitem>
      <simpara>
       当 <constant>ENT_COMPAT</constant>、<constant>ENT_QUOTES</constant>、<constant>ENT_NOQUOTES</constant> 都没设置，
       默认就是 <constant>ENT_NOQUOTES</constant>。
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       如果设置不止一个 <constant>ENT_COMPAT</constant>、 <constant>ENT_QUOTES</constant>、
       <constant>ENT_NOQUOTES</constant> ，优先级最高的是 <constant>ENT_QUOTES</constant>，
       其次是 <constant>ENT_COMPAT</constant>。
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       当 <constant>ENT_HTML401</constant>、 <constant>ENT_HTML5</constant>、
       <constant>ENT_XHTML</constant>、 <constant>ENT_XML1</constant> 都没设置，默认是
       <constant>ENT_HTML401</constant>。
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       如果设置不止一个 <constant>ENT_HTML401</constant>、 <constant>ENT_HTML5</constant>、
       <constant>ENT_XHTML</constant>、 <constant>ENT_XML1</constant>，
       优先级最高的是
       <constant>ENT_HTML5</constant> 其次是 <constant>ENT_XHTML</constant>、<constant>ENT_XML1</constant> 和 <constant>ENT_HTML401</constant>。
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       如果设置不止一个 <constant>ENT_DISALLOWED</constant>、 <constant>ENT_IGNORE</constant>、
       <constant>ENT_SUBSTITUTE</constant>，优先级最高的是 <constant>ENT_IGNORE</constant>，
       其次是 <constant>ENT_SUBSTITUTE</constant>。
      </simpara>
     </listitem>
    </itemizedlist>
   </para>
  </note>
 </refsect1>

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