xml-set-unparsed-entity-decl-handler.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.xml-set-unparsed-entity-decl-handler" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>xml_set_unparsed_entity_decl_handler</refname>
  <refpurpose>
   Set up unparsed entity declaration handler
  </refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>true</type><methodname>xml_set_unparsed_entity_decl_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>
   Sets the unparsed entity declaration handler function for the XML parser
   <parameter>parser</parameter>.
  </para>
  <para>
   The <parameter>handler</parameter> will be called if the XML parser
   encounters an external entity declaration with an NDATA declaration, like
   the following:
   <programlisting role="xml">
<![CDATA[
<!ENTITY <parameter>name</parameter> {<parameter>publicId</parameter> | <parameter>systemId</parameter>}
        NDATA <parameter>notationName</parameter>
]]>
   </programlisting>
  </para>
  <para>
   See <link xlink:href="&url.rec-xml;#sec-external-ent">section 4.2.2 of
   the XML 1.0 spec</link> for the definition of notation declared
   external entities.
  </para> 
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &xml.parser.param;
    <varlistentry>
     <term><parameter>handler</parameter></term>
     <listitem>
      &xml.handler.description;
      <para>
       The signature of the handler must be:
       <methodsynopsis>
        <type>void</type><methodname><replaceable>handler</replaceable></methodname>
        <methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
        <methodparam><type>string</type><parameter>entity_name</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>
        <methodparam><type class="union"><type>string</type><type>false</type></type><parameter>notation_name</parameter></methodparam>
       </methodsynopsis>
       <variablelist>
        &xml.handler.parser.param;
        <varlistentry>
         <term><parameter>entity_name</parameter></term>
         <listitem>
          <simpara>
           The name of the entity that is about to be defined.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>base</parameter></term>
         <listitem>
          <simpara>
           This is the base for resolving the system identifier
           (<parameter>systemId</parameter>) of the external entity.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>system_id</parameter></term>
         <listitem>
          <simpara>
           System identifier for the external entity.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>public_id</parameter></term>
         <listitem>
          <simpara> 
           Public identifier for the external entity.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>notation_name</parameter></term>
         <listitem>
          <simpara> 
           Name of the notation of this entity (see
           <function>xml_set_notation_decl_handler</function>).
          </simpara>
         </listitem>
        </varlistentry>
       </variablelist>
      </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;
    </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
-->