<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<refentry id="function.xml-set-element-handler">
 <refnamediv>
  <refname>xml_set_element_handler</refname>
  <refpurpose>Set up start and end element handlers</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>bool</type><methodname>xml_set_element_handler</methodname>
   <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
   <methodparam><type>callback</type><parameter>start_element_handler</parameter></methodparam>
   <methodparam><type>callback</type><parameter>end_element_handler</parameter></methodparam>
  </methodsynopsis>
  <para>
   Sets the element handler functions for the XML parser
   <parameter>parser</parameter>.
   <parameter>start_element_handler</parameter> and
   <parameter>end_element_handler</parameter> are strings containing
   the names of functions that must exist when
   <function>xml_parse</function> is called for
   <parameter>parser</parameter>.
  </para>
  <para>
   The function named by <parameter>start_element_handler</parameter>
   must accept three parameters:
   <methodsynopsis>
    <methodname><replaceable>start_element_handler</replaceable></methodname>
    <methodparam><type>resource</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>
  <para>
   The function named by <parameter>end_element_handler</parameter>
   must accept two parameters:
   <methodsynopsis>
     <methodname><replaceable>end_element_handler</replaceable></methodname>
     <methodparam><type>resource</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>
  <para>
   &true; is returned if the handlers are 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
-->