archived-doc-es/reference/info/functions/assert-options.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: yago Status: ready -->
<refentry xml:id="function.assert-options" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>assert_options</refname>
  <refpurpose>Establecer/obtener valores de las directivas relacionadas con las aserciones</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>assert_options</methodname>
   <methodparam><type>int</type><parameter>what</parameter></methodparam>
   <methodparam choice="opt"><type>mixed</type><parameter>value</parameter></methodparam>
  </methodsynopsis>
  <para>
   Se utiliza para establecer el valor de las diferentes opciones de la función <function>assert</function>
   o consultar su valor actual.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>what</parameter></term>
     <listitem>
      <para>
       <table>
        <title>Assert Options</title>
        <tgroup cols="4">
         <thead>
          <row>
           <entry>Opción</entry>
           <entry>Configuración inicial</entry>
           <entry>Valor predeterminado</entry>
           <entry>Descripción </entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>ASSERT_ACTIVE</entry>
           <entry>assert.active</entry>
           <entry>1</entry>
           <entry>Activa la función <function>assert</function></entry>
          </row>
          <row>
           <entry>ASSERT_WARNING</entry>
           <entry>assert.warning</entry>
           <entry>1</entry>
           <entry>Cada vez que una aserción falla se genera una advertencia</entry>
          </row>
          <row>
           <entry>ASSERT_BAIL</entry>
           <entry>assert.bail</entry>
           <entry>0</entry>
           <entry>Termina la ejecución cuando falla una aserción</entry>
          </row>
          <row>
           <entry>ASSERT_QUIET_EVAL</entry>
           <entry>assert.quiet_eval</entry>
           <entry>0</entry>
           <entry>
            Desactiva la directiva error_reporting durante la evaluación de la aserción
            </entry>
          </row>
          <row>
           <entry>ASSERT_CALLBACK</entry>
           <entry>assert.callback</entry>
           <entry>(&null;)</entry>
           <entry>Función que se encargará de gestionar las aserciones cuando fallen</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       Nuevo valor para la directiva.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve el valor original de cualquiera de las opciones o &false; en caso de error. 
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
   <title>Ejemplo de <function>assert_options</function></title>
   <programlisting role="php">
<![CDATA[
<?php
// Esta es nuestra función manejadora 
// de los fallos en un aserción
function assert_failure()
{
    echo 'Assert failed';
}

// Esta es nuestra función de test
function test_assert($parameter)
{
    assert(is_bool($parameter));
}

// Establecemos nuestras propias opciones para gestionar las aserciones
// Activamos las aserciones
assert_options(ASSERT_ACTIVE,   true);
// Si una aserción falla se detiene la ejecución
assert_options(ASSERT_BAIL,     true);
// Si una aserción falla NO se genera una advertencia
assert_options(ASSERT_WARNING,  false);
// Establecemos la función 'assert_failure' como manejadora (callback) de las aserciones 
assert_options(ASSERT_CALLBACK, 'assert_failure');

// Creamos una aserción la cual queremos que falle
test_assert(1);

// Este código nunca se ejecuta porque ASSERT_BAIL 
// está a TRUE
echo 'Never reached';
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>assert</function></member>
   </simplelist>
  </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:"~/.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
-->