mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 10:28:54 +00:00
2bed4f6ded
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@189137 c90b9560-bf6c-de11-be94-00142212c4b1
97 lines
2.9 KiB
XML
97 lines
2.9 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.7 $ -->
|
|
<refentry id="function.xml-parse">
|
|
<refnamediv>
|
|
<refname>xml_parse</refname>
|
|
<refpurpose>Start parsing an XML document</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></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>xml_parse</function> parses an XML document. The handlers for
|
|
the configured events are called as many times as necessary.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>parser</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A reference to the XML parser to use.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>data</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
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>is_final</parameter> parameter is set and
|
|
&true; when the last data is parsed.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>is_final</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
If set and &true;, <parameter>data</parameter> is the last piece of
|
|
data sent in this parse.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
<para>
|
|
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>
|
|
<note>
|
|
<para>
|
|
Entity errors are reported at the end of the data thus only if
|
|
<parameter>is_final</parameter> is set and &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:"../../../../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
|
|
-->
|