archived-doc-ru/reference/xmlreader/xmlreader.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 66eeca1e7e130615865b8badbd67c5171bf60c9a Maintainer: mch Status: ready -->
<!-- Reviewed: no -->
<reference xml:id="class.xmlreader" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
 <title>Класс XMLReader</title>
 <titleabbrev>XMLReader</titleabbrev>

 <partintro>

<!-- {{{ XMLReader intro -->
  <section xml:id="xmlreader.intro">
   &reftitle.intro;
   <para>
    Модуль XMLReader — Pull-парсер XML-документов.
    Класс-читатель действует как курсор, который двигается вперёд по потоку документа и по пути останавливается
    на каждом узле.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="xmlreader.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis class="class">
    <ooclass>
     <classname>XMLReader</classname>
    </ooclass>

    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="xmlreader.constants.none">XMLReader::NONE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="xmlreader.constants.element">XMLReader::ELEMENT</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="xmlreader.constants.attribute">XMLReader::ATTRIBUTE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="xmlreader.constants.text">XMLReader::TEXT</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="xmlreader.constants.cdata">XMLReader::CDATA</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="xmlreader.constants.entity-ref">XMLReader::ENTITY_REF</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="xmlreader.constants.entity">XMLReader::ENTITY</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="xmlreader.constants.pi">XMLReader::PI</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="xmlreader.constants.comment">XMLReader::COMMENT</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="xmlreader.constants.doc">XMLReader::DOC</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="xmlreader.constants.doc-type">XMLReader::DOC_TYPE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="xmlreader.constants.doc-fragment">XMLReader::DOC_FRAGMENT</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="xmlreader.constants.notation">XMLReader::NOTATION</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="xmlreader.constants.whitespace">XMLReader::WHITESPACE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="xmlreader.constants.significant-whitespace">XMLReader::SIGNIFICANT_WHITESPACE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="xmlreader.constants.end-element">XMLReader::END_ELEMENT</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="xmlreader.constants.end-entity">XMLReader::END_ENTITY</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="xmlreader.constants.xml-declaration">XMLReader::XML_DECLARATION</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="xmlreader.constants.loaddtd">XMLReader::LOADDTD</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="xmlreader.constants.defaultattrs">XMLReader::DEFAULTATTRS</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="xmlreader.constants.validate">XMLReader::VALIDATE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="xmlreader.constants.subst-entities">XMLReader::SUBST_ENTITIES</varname>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>int</type>
     <varname linkend="xmlreader.props.attributecount">attributeCount</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>string</type>
     <varname linkend="xmlreader.props.baseuri">baseURI</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>int</type>
     <varname linkend="xmlreader.props.depth">depth</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>bool</type>
     <varname linkend="xmlreader.props.hasattributes">hasAttributes</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>bool</type>
     <varname linkend="xmlreader.props.hasvalue">hasValue</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>bool</type>
     <varname linkend="xmlreader.props.isdefault">isDefault</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>bool</type>
     <varname linkend="xmlreader.props.isemptyelement">isEmptyElement</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>string</type>
     <varname linkend="xmlreader.props.localname">localName</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>string</type>
     <varname linkend="xmlreader.props.name">name</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>string</type>
     <varname linkend="xmlreader.props.namespaceuri">namespaceURI</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>int</type>
     <varname linkend="xmlreader.props.nodetype">nodeType</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>string</type>
     <varname linkend="xmlreader.props.prefix">prefix</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>string</type>
     <varname linkend="xmlreader.props.value">value</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>string</type>
     <varname linkend="xmlreader.props.xmllang">xmlLang</varname>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.xmlreader')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='XMLReader'])">
     <xi:fallback/>
    </xi:include>
   </classsynopsis>
<!-- }}} -->

  </section>

<!-- {{{ XMLReader properties -->
  <section xml:id="xmlreader.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="xmlreader.props.attributecount">
     <term><varname>attributeCount</varname></term>
     <listitem>
      <para>
       Количество атрибутов в узле
      </para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="xmlreader.props.baseuri">
     <term><varname>baseURI</varname></term>
     <listitem>
      <para>Базовый URI-идентификатор узла</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="xmlreader.props.depth">
     <term><varname>depth</varname></term>
     <listitem>
      <para>Глубина узла в дереве, начиная с 0</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="xmlreader.props.hasattributes">
     <term><varname>hasAttributes</varname></term>
     <listitem>
      <para>Указывает, содержит ли узел атрибуты</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="xmlreader.props.hasvalue">
     <term><varname>hasValue</varname></term>
     <listitem>
      <para>Указывает, содержит ли узел текстовое значение</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="xmlreader.props.isdefault">
     <term><varname>isDefault</varname></term>
     <listitem>
      <para>Указывает, относится ли значение атрибута к значениям по умолчанию из DTD-определения</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="xmlreader.props.isemptyelement">
     <term><varname>isEmptyElement</varname></term>
     <listitem>
       <para>Указывает, содержит ли узел тег пустого элемента</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="xmlreader.props.localname">
     <term><varname>localName</varname></term>
     <listitem>
      <para>Локальное имя узла</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="xmlreader.props.name">
     <term><varname>name</varname></term>
     <listitem>
      <para>Полное имя узла</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="xmlreader.props.namespaceuri">
     <term><varname>namespaceURI</varname></term>
     <listitem>
      <para>URI-идентификатор пространства имён, который связан с узлом</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="xmlreader.props.nodetype">
     <term><varname>nodeType</varname></term>
     <listitem>
      <para>Тип узла </para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="xmlreader.props.prefix">
     <term><varname>prefix</varname></term>
     <listitem>
      <para>Префикс пространства имён, который связан с узлом</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="xmlreader.props.value">
     <term><varname>value</varname></term>
     <listitem>
      <para>Текстовое значение узла</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="xmlreader.props.xmllang">
     <term><varname>xmlLang</varname></term>
     <listitem>
      <para>Языковая область действия атрибута xml:lang, которой принадлежит узел</para>
     </listitem>
    </varlistentry>

   </variablelist>
  </section>
<!-- }}} -->

  <!-- {{{ XMLReader constants -->
  <section xml:id="xmlreader.constants">
   &reftitle.constants;
   <section xml:id="xmlreader.constants.types">
    <title>Типы узлов, которые распознаёт парсер XMLReader</title>
    <variablelist>

     <varlistentry xml:id="xmlreader.constants.none">
      <term><constant>XMLReader::NONE</constant></term>
      <listitem>
       <para>Нет типа узла</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="xmlreader.constants.element">
      <term><constant>XMLReader::ELEMENT</constant></term>
      <listitem>
       <para>Начало элемента</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="xmlreader.constants.attribute">
      <term><constant>XMLReader::ATTRIBUTE</constant></term>
      <listitem>
       <para>Узел атрибута</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="xmlreader.constants.text">
      <term><constant>XMLReader::TEXT</constant></term>
      <listitem>
       <para>Текстовый узел</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="xmlreader.constants.cdata">
      <term><constant>XMLReader::CDATA</constant></term>
      <listitem>
       <para>Узел CDATA</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="xmlreader.constants.entity-ref">
      <term><constant>XMLReader::ENTITY_REF</constant></term>
      <listitem>
       <para>Узел ссылки на сущность</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="xmlreader.constants.entity">
      <term><constant>XMLReader::ENTITY</constant></term>
      <listitem>
       <para>Узел объявления сущности</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="xmlreader.constants.pi">
      <term><constant>XMLReader::PI</constant></term>
      <listitem>
       <para>Узел инструкций обработки</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="xmlreader.constants.comment">
      <term><constant>XMLReader::COMMENT</constant></term>
      <listitem>
       <para>Узел комментария</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="xmlreader.constants.doc">
      <term><constant>XMLReader::DOC</constant></term>
      <listitem>
       <para>Узел документа</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="xmlreader.constants.doc-type">
      <term><constant>XMLReader::DOC_TYPE</constant></term>
      <listitem>
       <para>Узел типа документа</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="xmlreader.constants.doc-fragment">
      <term><constant>XMLReader::DOC_FRAGMENT</constant></term>
      <listitem>
       <para>Узел фрагмента документа</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="xmlreader.constants.notation">
      <term><constant>XMLReader::NOTATION</constant></term>
      <listitem>
       <para>Узел нотации</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="xmlreader.constants.whitespace">
      <term><constant>XMLReader::WHITESPACE</constant></term>
      <listitem>
       <para>Пробельный узел</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="xmlreader.constants.significant-whitespace">
      <term><constant>XMLReader::SIGNIFICANT_WHITESPACE</constant></term>
      <listitem>
       <para>Значимый пробельный узел</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="xmlreader.constants.end-element">
      <term><constant>XMLReader::END_ELEMENT</constant></term>
      <listitem>
       <para>Завершение элемента</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="xmlreader.constants.end-entity">
      <term><constant>XMLReader::END_ENTITY</constant></term>
      <listitem>
       <para>Завершение сущности</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="xmlreader.constants.xml-declaration">
      <term><constant>XMLReader::XML_DECLARATION</constant></term>
      <listitem>
       <para>Узел XML-объявления</para>
      </listitem>
     </varlistentry>

    </variablelist>
   </section>

   <section xml:id="xmlreader.constants.options">
    <title>Опции парсера XMLReader</title>

    <variablelist>

     <varlistentry xml:id="xmlreader.constants.loaddtd">
      <term><constant>XMLReader::LOADDTD</constant></term>
      <listitem>
       <para>Загружать DTD-определение, но не проверять</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="xmlreader.constants.defaultattrs">
      <term><constant>XMLReader::DEFAULTATTRS</constant></term>
      <listitem>
       <para>Загружать DTD-определение и атрибуты по умолчанию, но не проверять</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="xmlreader.constants.validate">
      <term><constant>XMLReader::VALIDATE</constant></term>
      <listitem>
       <para>Загружать DTD-определение и проверять при разборе</para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="xmlreader.constants.subst-entities">
      <term><constant>XMLReader::SUBST_ENTITIES</constant></term>
      <listitem>
       <para>Заменять сущности и разворачивать ссылки</para>
      </listitem>
     </varlistentry>

    </variablelist>
   </section>
  </section>

  <section role="changelog">
   &reftitle.changelog;
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.4.0</entry>
       <entry>
        Константы класса стали типизированными.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </section>
<!-- }}} -->
 </partintro>

 &reference.xmlreader.entities.xmlreader;

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