xml-parse.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: pastore Status: ready -->
<!-- CREDITS: darvina -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.xml-parse">
 <refnamediv>
  <refname>xml_parse</refname>
  <refpurpose>Inizia il parsing di un documento XML</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>xml_parse</methodname>
   <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>is_final</parameter><initializer>false</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>xml_parse</function> esegue il parsing di un documento XML. Gli handler
   configurati per la gestione degli eventi saranno richiamati ogni volta che si renderà necessario.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>parser</parameter></term>
     <listitem>
      <para>
       Un riferimento al parser XML da utilizzare.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       Segmento di dati da analizzare. Un documento può essere elaborato
       a segmenti richiamando <function>xml_parse</function> diverse volte con nuovi dati,
       con il parametro <parameter>e_finale</parameter> settato e
       &true; quando si elabora l'ultimo segmento.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>is_final</parameter></term>
     <listitem>
      <para>
       Se valorizzato a &true;, il parametro <parameter>data</parameter> rappresenta
       l'ultimo segmento dei dati inviati al parser.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Restituisce 1 in caso di successo o 0 in caso di fallimento.
  </para>
  <para>
   In caso di parsing non riuscito, si possono recuperare informazioni sull'errore con
   <function>xml_get_error_code</function>,
   <function>xml_error_string</function>,
   <function>xml_get_current_line_number</function>,
   <function>xml_get_current_column_number</function> e
   <function>xml_get_current_byte_index</function>.
  </para>
  <note>
   <para>
    Gli errori nelle entità sono riportati alla fine dei dati quindi solo se
    <parameter>is_final</parameter> è impostato a &true;.
   </para>
  </note>
 </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
-->