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

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id='function.xml-set-start-namespace-decl-handler'>
 <refnamediv>
  <refname>xml_set_start_namespace_decl_handler</refname>
  <refpurpose>
   Set up start namespace declaration handler
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>xml_set_start_namespace_decl_handler</methodname>
   <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
   <methodparam><type>callable</type><parameter>handler</parameter></methodparam>
  </methodsynopsis>
  <para>
   Set a handler to be called when a namespace is declared. Namespace
   declarations occur inside start tags. But the namespace declaration start
   handler is called before the start tag handler for each namespace declared
   in that start tag.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>parser</parameter></term>
     <listitem>
      <para>
       A reference to the XML parser.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>handler</parameter></term>
     <listitem>
      <para>
       <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>
       The function named by <parameter>handler</parameter> must accept
       three parameters, and should return an integer value. If the
       value returned from the handler is &false; (which it will be if no
       value is returned), the XML parser will stop parsing and
       <function>xml_get_error_code</function> will return
       <constant>XML_ERROR_EXTERNAL_ENTITY_HANDLING</constant>.
       <methodsynopsis>
        <methodname><replaceable>handler</replaceable></methodname>
        <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
        <methodparam><type>string</type><parameter>prefix</parameter></methodparam>
        <methodparam><type>string</type><parameter>uri</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>prefix</parameter></term>
         <listitem>
          <simpara>
           The prefix is a string used to reference the namespace within an XML object.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>uri</parameter></term>
         <listitem>
          <simpara>
           Uniform Resource Identifier (URI) of namespace.
          </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>
      &note.func-callback;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>xml_set_end_namespace_decl_handler</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
-->