xml-set-element-handler.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 5faa7a6747bca628b3bdcc9f93aec5603b65581f Maintainer: carlos Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.xml-set-element-handler">
 <refnamediv>
  <refname>xml_set_element_handler</refname>
  <refpurpose>Configura los manejadores para los elementos de inicio y final</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>xml_set_element_handler</methodname>
   <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
   <methodparam><type>callable</type><parameter>start_element_handler</parameter></methodparam>
   <methodparam><type>callable</type><parameter>end_element_handler</parameter></methodparam>
  </methodsynopsis>
  <para>
   Configura las funciones de los manejadores de elementos.
   <parameter>start_element_handler</parameter> y
   <parameter>end_element_handler</parameter> son strings que contienen los nombres de funciones que deben existir cuando <function>xml_parse</function> sea llamado por <parameter>parser</parameter>.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>parser</parameter></term>
     <listitem>
      <para>
       Identificador del recurso del intérprete XML para el que se van a configurar las funciones del manejador de elementos de inicio y final.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>start_element_handler</parameter></term>
     <listitem>
      <para>
       La función llamada mediante <parameter>start_element_handler</parameter> debe aceptar tres parámetros:
       <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>
          El primer parámetro, <replaceable>parser</replaceable>, hace referencia al intérprete XML que llama al manejador.
         </simpara>
        </listitem>
       </varlistentry>
       <varlistentry>
        <term><parameter>name</parameter></term>
        <listitem>
         <simpara>
          El segundo parámetro, <parameter>name</parameter>, contiene el nombre del elemento por el cual el manejador es llamado. Si <link
          linkend="xml.case-folding">case-folding</link> está activado para este intérprete, el elemento name estará en letras mayúsculas.
         </simpara>
        </listitem>
       </varlistentry>
       <varlistentry>
        <term><parameter>attribs</parameter></term>
        <listitem>
         <simpara>
          El tercer parámetro<parameter>attribs</parameter>, contiene un array asociativo con los atributos del elemento (si hay alguno). Las claves de este array son los nombres de atributo, los valores son los valores de los atributos.
          Los nombres de los atributos están en mayúsculas <link linkend="xml.case-folding">case-folded</link> siguiendo el mismo criterio que los nombres de los elementos.
          Los valores de los atributos <emphasis>no</emphasis> sufren las consecuencias de case-folding.
         </simpara>
         <simpara>
          El orden original de los atributos puede ser recuperado recorriendo <parameter>attribs</parameter> de manera normal, usando <function>each</function>. La primera clave en el array es el primer atributo, y así sucesivamente.
         </simpara>
        </listitem>
       </varlistentry>
      </variablelist>
     </para>
     &note.func-callback;
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>end_element_handler</parameter></term>
    <listitem>
     <para>
      La función llamada mediante <parameter>end_element_handler</parameter> debe aceptar dos parámetros:
      <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>
          El primer parámetro, <replaceable>parser</replaceable>, hace referencia al intérprete XML que llama al manejador.
         </simpara>
        </listitem>
       </varlistentry>
       <varlistentry>
        <term><parameter>name</parameter></term>
        <listitem>
         <simpara>
          El segundo parámetro, <parameter>name</parameter>, contiene el nombre del elemento por el cual el manejador es llamado. Si <link
          linkend="xml.case-folding">case-folding</link> está activado para este intérprete, el elemento name estará en letras mayúsculas.
         </simpara>
        </listitem>
       </varlistentry>
      </variablelist>
     </para>
     <para>
      Si la función del manejador se configura como una cadena vacia, o &false;, el manejador en cuestión se deshabilita.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </para>
</refsect1>

<refsect1 role="returnvalues">
 &reftitle.returnvalues;
 <para>
  &return.success;
 </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
     -->