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

<refentry xml:id="xmlreader.xml" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>XMLReader::XML</refname>

<refpurpose>パースする XML を含むデータを設定する</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis role="XMLReader">

<modifier>public</modifier> <modifier>static</modifier> <type>XMLReader</type><methodname>XMLReader::XML</methodname>

<methodparam><type>string</type><parameter>source</parameter></methodparam>

<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>

<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>

</methodsynopsis>

<methodsynopsis role="XMLReader">

<modifier>public</modifier> <type>bool</type><methodname>XMLReader::XML</methodname>

<methodparam><type>string</type><parameter>source</parameter></methodparam>

<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>

<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>

</methodsynopsis>

<para>

パースする XML を含むデータを設定します。

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>source</parameter></term>

<listitem>

<para>

パースされる XML を含む文字列。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>encoding</parameter></term>

<listitem>

<para>

ドキュメントのエンコーディングあるいは &null;。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>flags</parameter></term>

<listitem>

<para>

<link linkend="libxml.constants">LIBXML_*</link> 定数のビットマスク。

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

&return.success;

staticメソッドとしてコールされた場合には

<classname>XMLReader</classname> を返します。

&return.falseforfailure;

</para>

</refsect1>

<refsect1 role="errors">

&reftitle.errors;

<itemizedlist>

<listitem>

<simpara>

無効な <parameter>encoding</parameter> を指定すると、

<exceptionname>ValueError</exceptionname> がスローされます。

</simpara>

</listitem>

<listitem>

<simpara>

このメソッドは、staticメソッドとしてコールすることが出来ます。

しかし、PHP 8.0.0 より前のバージョンでは、

staticメソッドとしてコールすると <constant>E_DEPRECATED</constant> が発生していました。

</simpara>

</listitem>

</itemizedlist>

</refsect1>

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

無効な <parameter>encoding</parameter> を指定すると、

<exceptionname>ValueError</exceptionname> がスローされるようになりました。

</entry>

</row>

<row>

<entry>8.0.0</entry>

<entry>

<methodname>XMLReader::XML</methodname> は、staticメソッドとして宣言されるようになりました。

しかし、<classname>XMLReader</classname> のインスタンス経由でも呼び出すことができます。

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><methodname>XMLReader::open</methodname></member>

<member><methodname>XMLReader::close</methodname></member>

</simplelist>

</para>

</refsect1>

</refentry>