xml-parser-get-option.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 9acfa18973f304f8f2d531f28dd12b12c2b84f8b Maintainer: hirokawa Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.xml-parser-get-option" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>xml_parser_get_option</refname>
  <refpurpose>XML パーサからオプションを得る</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>int</type><type>bool</type></type><methodname>xml_parser_get_option</methodname>
   <methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
   <methodparam><type>int</type><parameter>option</parameter></methodparam>
  </methodsynopsis>
  <para>
   XML パーサからオプションの値を取得します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>parser</parameter></term>
     <listitem>
      <simpara>
       オプションを取得する XML パーサへのリファレンス。
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>option</parameter></term>
     <listitem>
      <simpara>
       取得するオプション。<constant>XML_OPTION_CASE_FOLDING</constant>,
       <constant>XML_OPTION_PARSE_HUGE</constant>,
       <constant>XML_OPTION_SKIP_TAGSTART</constant>, <constant>XML_OPTION_SKIP_WHITE</constant>
       あるいは <constant>XML_OPTION_TARGET_ENCODING</constant> が使用可能です。
       詳細は <function>xml_parser_set_option</function> を参照ください。
      </simpara>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   オプションの値を返します。
  </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.3.0</entry>
      <entry>
       この関数は、boolean のオプションを返すようになりました。
      </entry>
     </row>
     &xml.changelog.parser-param;
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>option</parameter> が無効な値の場合、
       <classname>ValueError</classname> がスローされるようになりました。
      </entry>
     </row>
     <row>
      <entry>7.1.24, 7.2.12, 7.3.0</entry>
      <entry>
       <parameter>options</parameter> が
       新たに <constant>XML_OPTION_SKIP_TAGSTART</constant>
       と <constant>XML_OPTION_SKIP_WHITE</constant> をサポートしました。
      </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
-->