xml-set-external-entity-ref-handler.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 18aa2012f6fa1e5b09733147e02911d16e06d4a1 Maintainer: HonestQiao Status: ready -->
<!-- CREDITS: mowangjuanzi, Luffy -->
<refentry xml:id="function.xml-set-external-entity-ref-handler" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>xml_set_external_entity_ref_handler</refname>
  <refpurpose>设置外部实体引用处理程序</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>true</type><methodname>xml_set_external_entity_ref_handler</methodname>
   <methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
   <methodparam><type class="union"><type>callable</type><type>string</type><type>null</type></type><parameter>handler</parameter></methodparam>
  </methodsynopsis>
  <para>
   为 XML 解析器 <parameter>parser</parameter> 设置外部实体引用处理函数。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &xml.parser.param;
    <varlistentry>
     <term><parameter>handler</parameter></term>
     <listitem>
      &xml.handler.description;
      <para>
       处理程序的签名必须是：
       <methodsynopsis>
        <type>bool</type><methodname><replaceable>handler</replaceable></methodname>
        <methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
        <methodparam><type>string</type><parameter>open_entity_names</parameter></methodparam>
        <methodparam><type class="union"><type>string</type><type>false</type></type><parameter>base</parameter></methodparam>
        <methodparam><type>string</type><parameter>system_id</parameter></methodparam>
        <methodparam><type class="union"><type>string</type><type>false</type></type><parameter>public_id</parameter></methodparam>
       </methodsynopsis>
       <variablelist>
        &xml.handler.parser.param;
        <varlistentry>
         <term><parameter>open_entity_names</parameter></term>
         <listitem>
          <simpara>
           为该实体的解析开放的实体名列表（包括被指向的实体名），这些实体名由空格隔开。
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>base</parameter></term>
         <listitem>
          <simpara>
          这个参数是解析外部实体的系统标识符（<parameter>system_id</parameter>）的基础。
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>system_id</parameter></term>
         <listitem>
          <simpara>
           在实体定义声明中指定的系统标识符。
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>public_id</parameter></term>
         <listitem>
          <simpara>
           在实体定义声明中指定的公共标识符，如果未指定任何标识符，则该字符串为空。公共标识符中的空格将按照 XML 的要求被正常化。
          </simpara>
         </listitem>
        </varlistentry>
       </variablelist>
      </para>
      <para>
       如果实体已经处理，则处理程序应返回 &true;，否则返回 &false;。当返回 &false; 时，XML
       解析器将停止解析并且 <function>xml_get_error_code</function> 将返回
       <constant>XML_ERROR_EXTERNAL_ENTITY_HANDLING</constant>。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.true.always;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &xml.changelog.handler-param;
     &xml.changelog.parser-param;
     <row>
      <entry>7.3.0</entry>
      <entry>
       如果扩展是针对 libxml 构建的，则不再忽略 <parameter>handler</parameter> 的返回值。以前，会忽略返回值，且解析也从不停止。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </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
-->