php-doc-en/reference/xml/functions/xml-set-notation-decl-handler.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
  <refentry id="function.xml-set-notation-decl-handler">
   <refnamediv>
    <refname>xml_set_notation_decl_handler</refname>
    <refpurpose>set up notation declaration handler</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <methodsynopsis>
     <type>bool</type><methodname>xml_set_notation_decl_handler</methodname>
     <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
     <methodparam><type>string</type><parameter>handler</parameter></methodparam>
    </methodsynopsis>
    <para>
     Sets the notation declaration handler function for the XML parser
     <parameter>parser</parameter>.  <parameter>handler</parameter> is
     a string containing the name of a function that must exist when
     <function>xml_parse</function> is called for
     <parameter>parser</parameter>.
    </para>
    <para>
     A notation declaration is part of the document's DTD and has the
     following format: <programlisting role="xml">&lt;!NOTATION
     <parameter>name</parameter> {<parameter>system_id</parameter> |
     <parameter>public_id</parameter>}&gt;</programlisting> See <ulink
     url="&url.rec-xml;#Notations">section 4.7 of the XML 1.0
     spec</ulink> for the definition of notation declarations.
    </para>
    <para>
     The function named by <parameter>handler</parameter> must accept
     five parameters:
     <methodsynopsis>
      <methodname><replaceable>handler</replaceable></methodname>
      <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
      <methodparam><type>string</type><parameter>notation_name</parameter></methodparam>
      <methodparam><type>string</type><parameter>base</parameter></methodparam>
      <methodparam><type>string</type><parameter>system_id</parameter></methodparam>
      <methodparam><type>string</type><parameter>public_id</parameter></methodparam>
     </methodsynopsis>
     <variablelist>
      <varlistentry>
       <term>
        <parameter>parser</parameter>
       </term> 
       <listitem>
        <simpara>
         The first parameter, <replaceable>parser</replaceable>, is a
         reference to the XML parser calling the handler.
        </simpara>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><parameter>notation_name</parameter></term>
       <listitem>
        <simpara>
         This is the notation's <parameter>name</parameter>, as per
         the notation format described above.
        </simpara>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term>
        <parameter>base</parameter>
       </term>
       <listitem>
        <simpara>
         This is the base for resolving the system identifier
         (<parameter>system_id</parameter>) of the notation declaration.
         Currently this parameter will always be set to an empty string.
        </simpara>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><parameter>system_id</parameter></term>
       <listitem>
        <simpara>
         System identifier of the external notation declaration.
        </simpara>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term>
        <parameter>public_id</parameter>
       </term>
       <listitem>
        <simpara>
         Public identifier of the external notation declaration.
        </simpara>
       </listitem>
      </varlistentry>
     </variablelist>
    </para>
    <para>
     If a handler function is set to an empty string, or &false;, the handler
     in question is disabled.
    </para>
    <para>
     &true; is returned if the handler is set up, &false; if
     <parameter>parser</parameter> is not a parser.
    </para>
    &note.func-callback;
   </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:"../../../../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
-->