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

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

<section xml:id="xmlreader.intro">

&reftitle.intro;

<para>

XMLReader 拡張モジュールは、プル型の XML パーサーです。ドキュメント

ストリーム内をカーソル風に進んでいき、その途中の各ノードで立ち止まります。

</para>

</section>

<section xml:id="xmlreader.synopsis">

&reftitle.classsynopsis;

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

<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>処理命令 (Processing Instruction) ノード</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>Whitespace ノード</para>

</listitem>

</varlistentry>

<varlistentry xml:id="xmlreader.constants.significant-whitespace">

<term><constant>XMLReader::SIGNIFICANT_WHITESPACE</constant></term>

<listitem>

<para>Significant Whitespace ノード</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>