archived-doc-es/reference/xml/functions/xml-parser-set-option.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 9acfa18973f304f8f2d531f28dd12b12c2b84f8b Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.xml-parser-set-option" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>xml_parser_set_option</refname>
  <refpurpose>Establece las opciones de un analizador 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>
   Establece las opciones de un analizador XML.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>parser</parameter></term>
     <listitem>
      <para>
       Una referencia a un analizador XML.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>option</parameter></term>
     <listitem>
      <para>
       La opción a modificar. Ver más abajo.
      </para>
      <para>
       Las siguientes opciones están disponibles:
       <table>
        <title>Opciones del analizador XML</title>
        <tgroup cols="3">
         <thead>
          <row>
           <entry>Opción</entry>
           <entry>Tipo de datos</entry>
           <entry>Descripción</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><constant>XML_OPTION_CASE_FOLDING</constant></entry>
           <entry>bool</entry>
           <entry>
            Controla el manejo de la <link linkend="xml.case-folding">caja</link>
            de las etiquetas de este analizador XML. Por omisión, está activado.
           </entry>
          </row>
          <row>
           <entry><constant>XML_OPTION_PARSE_HUGE</constant></entry>
           <entry>bool</entry>
           <entry>
            Permite analizar documentos de más de 10 MB.
            Esta opción solo debe activarse si el tamaño del documento está
            limitado, ya que de lo contrario podría conducir a un ataque de denegación de servicio (DoS).
            Esta opción solo está disponible al usar libxml2.
           </entry>
          </row>
          <row>
           <entry><constant>XML_OPTION_SKIP_TAGSTART</constant></entry>
           <entry>bool</entry>
           <entry>
            Especifica cuántos caracteres deben omitirse al inicio del nombre de la etiqueta.
           </entry>
          </row>
          <row>
           <entry><constant>XML_OPTION_SKIP_WHITE</constant></entry>
           <entry>&integer;</entry>
           <entry>
            Omite o no los valores que contienen caracteres en blanco.
           </entry>
          </row>
          <row>
           <entry><constant>XML_OPTION_TARGET_ENCODING</constant></entry>
           <entry>string</entry>
           <entry>
            Modifica la <link linkend="xml.encoding">codificación de destino</link>
            utilizada por este analizador XML. Por omisión, es la que
            se especificó al llamar a
            <function>xml_parser_create</function>. Las codificaciones soportadas
            son <literal>ISO-8859-1</literal>, <literal>US-ASCII</literal>
            y <literal>UTF-8</literal>.
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       El nuevo valor de la opción.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve &true; en caso de éxito o &false; en caso de fallo.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Lanza una <classname>ValueError</classname> cuando se pasa un valor inválido
   a <parameter>option</parameter>.
  </para>
  <para>
   Antes de PHP 8.0.0, pasar un valor inválido a <parameter>option</parameter>
   generaba una advertencia <constant>E_WARNING</constant>
   y hacía que la función devolviera el valor &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>
       Se añadió la opción <constant>XML_OPTION_PARSE_HUGE</constant>.
      </entry>
     </row>
     <row>
      <entry>8.3.0</entry>
      <entry>
       El parámetro <parameter>value</parameter> ahora también acepta valores booleanos.
       Las opciones <constant>XML_OPTION_CASE_FOLDING</constant> y <constant>XML_OPTION_SKIP_WHITE</constant>
       ahora son opciones booleanas.
      </entry>
     </row>
      &xml.changelog.parser-param;
     <row>
      <entry>8.0.0</entry>
      <entry>
       Ahora se lanza una excepción <classname>ValueError</classname> si
       la <parameter>option</parameter> es inválida.
      </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
-->