php-doc-en/reference/xml/functions/xml-parser-set-option.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
  <refentry id="function.xml-parser-set-option">
   <refnamediv>
    <refname>xml_parser_set_option</refname>
    <refpurpose>Set options in an XML parser</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <methodsynopsis>
     <type>bool</type><methodname>xml_parser_set_option</methodname>
     <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
     <methodparam><type>int</type><parameter>option</parameter></methodparam>
     <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
    </methodsynopsis>
    <para>
     <variablelist>
      <varlistentry>
       <term><parameter>parser</parameter></term>
       <listitem>
        <simpara>
         A reference to the XML parser to set an option in.
        </simpara>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><parameter>option</parameter></term>
       <listitem>
        <simpara>
         Which option to set.  See below.
        </simpara>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><parameter>value</parameter></term>
       <listitem>
        <simpara>
         The option's new value.
        </simpara>
       </listitem>
      </varlistentry>
     </variablelist>
    </para>
    <para>
     This function returns &false; if <parameter>parser</parameter> does not
     refer to a valid parser, or if the option could not be set.  Else the
     option is set and &true; is returned.
    </para>
    <para>
     The following options are available:
     <table>
      <title>XML parser options</title>
      <tgroup cols="3">
       <thead>
        <row>
         <entry>Option constant</entry>
         <entry>Data type</entry>
         <entry>Description</entry>
        </row>
       </thead>
       <tbody>
        <row>
         <entry>XML_OPTION_CASE_FOLDING</entry>
         <entry>integer</entry>
         <entry>
          Controls whether <link
          linkend="xml.case-folding">case-folding</link> is enabled for this
          XML parser.  Enabled by default.
         </entry>
        </row>
        <row>
         <entry>XML_OPTION_SKIP_TAGSTART</entry>
         <entry>integer</entry> 
         <entry>
          Specify how many characters should be skipped in the beginning of a
          tag name.
         </entry>
        </row>
        <row>
         <entry>XML_OPTION_SKIP_WHITE</entry>
         <entry>integer</entry> 
         <entry>
          Whether to skip values consisting of whitespace characters.
         </entry>
        </row>
        <row>
         <entry>XML_OPTION_TARGET_ENCODING</entry>
         <entry>string</entry> 
         <entry>
          Sets which <link linkend="xml.encoding">target encoding</link> to
          use in this XML parser.  By default, it is set to the same as the
          source encoding used by <function>xml_parser_create</function>.
          Supported target encodings are <literal>ISO-8859-1</literal>,
          <literal>US-ASCII</literal> and <literal>UTF-8</literal>.
         </entry>
        </row>
       </tbody>
      </tgroup>
     </table>
    </para>
   </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:"../../../../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
-->