xml-set-unparsed-entity-decl-handler.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 3db49ee0a331a657dd97b539a749f53d3965b593 Maintainer: carlos Status: ready -->
<refentry xml:id="function.xml-set-unparsed-entity-decl-handler" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>xml_set_unparsed_entity_decl_handler</refname>
  <refpurpose>Configura el manejador de declaración de entidades no analizadas</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>xml_set_unparsed_entity_decl_handler</methodname>
   <methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
   <methodparam><type>callable</type><parameter>handler</parameter></methodparam>
  </methodsynopsis>
  <para>Configura la función del manejador de declaración de entidades no analizadas para el intérprete XML <parameter>parser</parameter>.
  </para>
  <para>
   El <parameter>handler</parameter> será llamado si el intérprete XML encuentra una declaración de entidad externa con una declaración NDATA, como la siguiente:
   <programlisting role="xml">
<![CDATA[
<!ENTITY <parameter>name</parameter> {<parameter>publicId</parameter> | <parameter>systemId</parameter>}
        NDATA <parameter>notationName</parameter>
]]>
   </programlisting>
  </para>
  <para>
   Para la definición de notación de NDATA ver <link xlink:href="&url.rec-xml;#sec-external-ent">sección 4.2.2 de las especificaciones XML 1.0</link>.
  </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 va a configurar la función del manejador de declaración de entidades no analizadas.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>handler</parameter></term>
     <listitem>
      <para>
       <parameter>handler</parameter> es un string que contiene el nombre de una función que debe existir cuando <function>xml_parse</function> es llamado por <parameter>parser</parameter>.
      </para>
      <para>
       La función llamada mediante <parameter>handler</parameter> debe aceptar seis parámetros:              <methodsynopsis>
        <methodname><replaceable>handler</replaceable></methodname>
        <methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
        <methodparam><type>string</type><parameter>entity_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>
        <methodparam><type>string</type><parameter>notation_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>entity_name</parameter></term>
         <listitem>
          <simpara>
    El nombre de la entidad que está a punto de definirse.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>base</parameter></term>
         <listitem>
          <simpara>
    Esta es la base para resolver el identificador de sistema (<parameter>system_id</parameter>) de la declaración de notación. Actualmente este parámetro siempre se establecerá como una cadena vacia.

          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>system_id</parameter></term>
         <listitem>
          <simpara>
    Identificador de sistema de la declaración de notación externa.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>public_id</parameter></term>
         <listitem>
          <simpara>
    Identificador público de la declaración de notación externa.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>notation_name</parameter></term>
         <listitem>
          <simpara>
           Nombre de la notación de esta entidad (ver <function>xml_set_notation_decl_handler</function>).
          </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>
      &note.func-callback;
     </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
-->