1
0
mirror of https://github.com/php/doc-ja.git synced 2026-03-26 08:02:15 +01:00
Files
archived-doc-ja/reference/xml/functions/xml-parser-set-option.xml
2024-11-17 14:57:48 +09:00

199 lines
6.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 9acfa18973f304f8f2d531f28dd12b12c2b84f8b Maintainer: hirokawa Status: ready -->
<refentry xml:id="function.xml-parser-set-option" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>xml_parser_set_option</refname>
<refpurpose>XML パーサのオプションを設定する</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>xml_parser_set_option</methodname>
<methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
<methodparam><type>int</type><parameter>option</parameter></methodparam>
<methodparam><type class="union"><type>string</type><type>int</type><type>bool</type></type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
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>option</parameter></term>
<listitem>
<para>
設定するオプション。以下を参照ください。
</para>
<para>
次のオプションが利用可能です。
<table>
<title>XML パーサオプション</title>
<tgroup cols="3">
<thead>
<row>
<entry>オプション定数</entry>
<entry>データ型</entry>
<entry>説明</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>XML_OPTION_CASE_FOLDING</constant></entry>
<entry>bool</entry>
<entry>
XMLパーサの<link linkend="xml.case-folding">大文字変換
</link> を有効にするかどうかを制御する。デフォルトで有効。
</entry>
</row>
<row>
<entry><constant>XML_OPTION_PARSE_HUGE</constant></entry>
<entry>bool</entry>
<entry>
10 MB を超えるドキュメントの解析を許可する。
この設定は DoS 攻撃に繋がる可能性があるため、
ドキュメントサイズに制限を設けている場合にのみ有効にすべきです。
libxml2 を使用している場合のみ利用可能です。
</entry>
</row>
<row>
<entry><constant>XML_OPTION_SKIP_TAGSTART</constant></entry>
<entry>integer</entry>
<entry>
タグ名の最初の何文字を読み飛ばすかどうかを設定する。
</entry>
</row>
<row>
<entry><constant>XML_OPTION_SKIP_WHITE</constant></entry>
<entry>bool</entry>
<entry>
空白文字からなる値を読み飛ばすかどうかを設定する。
</entry>
</row>
<row>
<entry><constant>XML_OPTION_TARGET_ENCODING</constant></entry>
<entry>string</entry>
<entry>
XML パーサについてどの <link linkend="xml.encoding">ターゲット
エンコーディング</link> を使用するかを設定する。デフォルトでは、
<function>xml_parser_create</function> により使用されたソース
エンコーディングと同じエンコーディングが設定されます。
サポートされるターゲットエンコーディングは、
<literal>ISO-8859-1</literal>, <literal>US-ASCII</literal>,
<literal>UTF-8</literal> です。
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
そのオプションの新しい設定値。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
成功した場合に &true; を返します。
失敗した場合、&false; を返します。
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
無効な値を <parameter>option</parameter>
に渡すと、<classname>ValueError</classname> がスローされます。
</para>
<para>
PHP 8.0.0 より前のバージョンでは、
無効な値を <parameter>option</parameter>
に渡すと <constant>E_WARNING</constant> が発生し、&false; を返していました。
</para>
</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>
<constant>XML_OPTION_PARSE_HUGE</constant> が追加されました。
</entry>
</row>
<row>
<entry>8.3.0</entry>
<entry>
<parameter>value</parameter> パラメータは、
boolean の値を受け入れるようになりました。
<constant>XML_OPTION_CASE_FOLDING</constant>
<constant>XML_OPTION_SKIP_WHITE</constant>
boolean の値を受け入れるようになっています。
</entry>
</row>
&xml.changelog.parser-param;
<row>
<entry>8.0.0</entry>
<entry>
<parameter>option</parameter> が無効な値の場合、
<classname>ValueError</classname> がスローされるようになりました。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</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
-->