<?xml version="1.0" encoding="utf-8"?>

<!-- EN-Revision: b47e4bea197126359815c5e43403c4b77a0aaaa7 Maintainer: tmn Status: ready -->

<!-- Reviewed: no -->

<refentry xml:id="function.xml-parse" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>xml_parse</refname>

<refpurpose>Запускает разбор XML-документа</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>int</type><methodname>xml_parse</methodname>

<methodparam><type>XMLParser</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> разбирает XML-документ. Обработчики

запрограммированных событий вызываются столько раз, сколько потребуется.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>parser</parameter></term>

<listitem>

<para>

Ссылка на XML-анализатор.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>data</parameter></term>

<listitem>

<para>

Часть данных для разбора. Для разбора документа по частям

функцию <function>xml_parse</function> вызывают несколько раз с новыми данными,

пока аргумент <parameter>is_final</parameter> не получит

значение &true;, это сообщит анализатору, что разбирается последняя часть

документа.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>is_final</parameter></term>

<listitem>

<para>

При установке значения &true; функция расценивает значение параметра <parameter>data</parameter>

как последнюю часть разбора.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Функция возвращает значение 1, если выполнилась успешно, иначе значение 0.

</para>

<para>

При ошибках разбора информацию об ошибках получают

функциями <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>

и <function>xml_get_current_byte_index</function>.

</para>

<note>

<para>

Отдельные ошибки наподобие ошибок при разборе сущностей выдаются

в конце разбора и получить такие ошибки получится

только при установке для параметра <parameter>is_final</parameter> значения &true;.

</para>

</note>

</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>

<refsect1 role="examples">

&reftitle.examples;

<example xml:id="xml_parse.example.chunked">

<title>Пример разбора по частям больших XML-документов</title>

<para>

Следующий пример показывает, как считывать и разбирать по частям большие XML-документы,

поэтому не требуется держать весь документ в памяти.

Обработку ошибок в примере опустили для краткости.

</para>

<programlisting role="php">

<![CDATA[

<?php

$stream = fopen('examples/book-simple.xml', 'r');

$parser = xml_parser_create();

xml_set_element_handler(

$parser,

function ($parser, $name, $attributes) {

echo $name, PHP_EOL;

},

function ($parser, $name) {

echo $name, PHP_EOL;

}

);

while (($data = fread($stream, 16384))) {

xml_parse($parser, $data); // Разобрать текущую часть

}

xml_parse($parser, '', true); // Завершить разбор

fclose($stream);

]]>

</programlisting>

</example>

</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

-->