mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 02:48:56 +00:00
86 lines
2.8 KiB
XML
86 lines
2.8 KiB
XML
|
<?xml version="1.0" encoding="iso-8859-1"?>
|
||
|
|
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
|
||
|
|
<refentry id="function.xml-parse">
|
||
|
|
<refnamediv>
|
||
|
|
<refname>xml_parse</refname>
|
||
|
|
<refpurpose>start parsing an XML document</refpurpose>
|
||
|
|
</refnamediv>
|
||
|
|
<refsect1>
|
||
|
|
<title>Description</title>
|
||
|
|
<methodsynopsis>
|
||
|
|
<type>int</type><methodname>xml_parse</methodname>
|
||
|
|
<methodparam><type>int</type><parameter>parser</parameter></methodparam>
|
||
|
|
<methodparam><type>string</type><parameter>data</parameter></methodparam>
|
||
|
|
<methodparam choice="opt"><type>int</type><parameter>isFinal</parameter></methodparam>
|
||
|
|
</methodsynopsis>
|
||
|
|
<para>
|
||
|
|
<variablelist>
|
||
|
|
<varlistentry>
|
||
|
|
<term><parameter>parser</parameter></term>
|
||
|
|
<listitem>
|
||
|
|
<simpara>
|
||
|
|
A reference to the XML parser to use.
|
||
|
|
</simpara>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
<varlistentry>
|
||
|
|
<term><parameter>data</parameter></term>
|
||
|
|
<listitem>
|
||
|
|
<simpara>
|
||
|
|
Chunk of data to parse. A document may be parsed piece-wise
|
||
|
|
by calling <function>xml_parse</function> several times with
|
||
|
|
new data, as long as the <parameter>isFinal</parameter>
|
||
|
|
parameter is set and &true; when the last data is parsed.
|
||
|
|
</simpara>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
<varlistentry>
|
||
|
|
<term><parameter>isFinal</parameter> (optional)</term>
|
||
|
|
<listitem>
|
||
|
|
<simpara>
|
||
|
|
If set and &true;, <parameter>data</parameter> is the last
|
||
|
|
piece of data sent in this parse.
|
||
|
|
</simpara>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
</variablelist>
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
When the XML document is parsed, the handlers for the configured
|
||
|
|
events are called as many times as necessary, after which this
|
||
|
|
function returns &true; or &false;.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
&true; is returned if the parse was successful, &false; if it was not
|
||
|
|
successful, or if <parameter>parser</parameter> does not refer to
|
||
|
|
a valid parser. For unsuccessful parses, error information can
|
||
|
|
be retrieved with <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> and
|
||
|
|
<function>xml_get_current_byte_index</function>.
|
||
|
|
</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:"../../../../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
|
||
|
|
-->
|