xml-parser-get-option.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.xml-parser-get-option" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>xml_parser_get_option</refname>
  <refpurpose>Get options from an XML parser</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>
   Gets an option value from an XML parser.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>parser</parameter></term>
     <listitem>
      <simpara>
       A reference to the XML parser to get an option from.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>option</parameter></term>
     <listitem>
      <simpara>
       Which option to fetch. <constant>XML_OPTION_CASE_FOLDING</constant>,
       <constant>XML_OPTION_PARSE_HUGE</constant>,
       <constant>XML_OPTION_SKIP_TAGSTART</constant>, <constant>XML_OPTION_SKIP_WHITE</constant>
       and <constant>XML_OPTION_TARGET_ENCODING</constant> are available.
       See <function>xml_parser_set_option</function> for their description.
      </simpara>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the option's value.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Throws a <classname>ValueError</classname> when an invalid value is passed
   to <parameter>option</parameter>.
  </para>
  <para>
   Prior to PHP 8.0.0, passing an invalid value to
   <parameter>option</parameter> generated a <constant>E_WARNING</constant>
   as well as making the function return &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>
       The function now returns a boolean for boolean options.
      </entry>
     </row>
     &xml.changelog.parser-param;
     <row>
      <entry>8.0.0</entry>
      <entry>
       A <classname>ValueError</classname> is now thrown if
       <parameter>option</parameter> is invalid.
      </entry>
     </row>
     <row>
      <entry>7.1.24, 7.2.12, 7.3.0</entry>
      <entry>
       <parameter>options</parameter> now supports <constant>XML_OPTION_SKIP_TAGSTART</constant>
       and <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
-->