php-doc-en/reference/xml/functions/xml-set-element-handler.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.xml-set-element-handler" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>xml_set_element_handler</refname>
  <refpurpose>Set up start and end element handlers</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>xml_set_element_handler</methodname>
   <methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
   <methodparam><type>callable</type><parameter>start_handler</parameter></methodparam>
   <methodparam><type>callable</type><parameter>end_handler</parameter></methodparam>
  </methodsynopsis>
  <para>
   Sets the element handler functions for the XML <parameter>parser</parameter>.
   <parameter>start_handler</parameter> and
   <parameter>end_handler</parameter> are strings containing
   the names of functions that must exist when <function>xml_parse</function>
   is called for <parameter>parser</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>parser</parameter></term>
     <listitem>
      <para>
       A reference to the XML parser to set up start and end element handler functions.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>start_handler</parameter></term>
     <listitem>
      <para>
       The function named by <parameter>start_handler</parameter>
       must accept three parameters:
       <methodsynopsis>
        <methodname><replaceable>start_element_handler</replaceable></methodname>
        <methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
        <methodparam><type>string</type><parameter>name</parameter></methodparam>
        <methodparam><type>array</type><parameter>attribs</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>name</parameter></term>
         <listitem>
          <simpara>
           The second parameter, <parameter>name</parameter>, contains the name
           of the element for which this handler is called.If <link
           linkend="xml.case-folding">case-folding</link> is in effect for this
           parser, the element name will be in uppercase letters.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>attribs</parameter></term>
         <listitem>
          <simpara>
           The third parameter, <parameter>attribs</parameter>, contains an
           associative array with the element's attributes (if any).The keys
           of this array are the attribute names, the values are the attribute
           values.Attribute names are <link
           linkend="xml.case-folding">case-folded</link> on the same criteria as
           element names.Attribute values are <emphasis>not</emphasis>
           case-folded.
          </simpara>
          <simpara>
           The original order of the attributes can be retrieved by walking
           through <parameter>attribs</parameter> the normal way, using
           <function>each</function>.The first key in the array was the first
           attribute, and so on.
          </simpara>
         </listitem>
        </varlistentry>
       </variablelist>
      </para>
      &note.func-callback;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>end_handler</parameter></term>
     <listitem>
      <para>
       The function named by <parameter>end_handler</parameter>
       must accept two parameters:
       <methodsynopsis>
        <methodname><replaceable>end_element_handler</replaceable></methodname>
        <methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
        <methodparam><type>string</type><parameter>name</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>name</parameter></term>
         <listitem>
          <simpara>
           The second parameter, <parameter>name</parameter>, contains the name
           of the element for which this handler is called.If <link
           linkend="xml.case-folding">case-folding</link> is in effect for this
           parser, the element name will be in uppercase letters.
          </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>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

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

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
      &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
-->