archived-doc-es/reference/misc/functions/exit.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 84b8fca68fc762fefe85acde180a38b2e77a28b9 Maintainer: yago Status: ready -->
<refentry xml:id="function.exit" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>exit</refname>
  <refpurpose>Imprime un mensaje y termina el script actual</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>exit</methodname>
   <methodparam choice="opt"><type>string</type><parameter>status</parameter></methodparam>
  </methodsynopsis>
  <methodsynopsis>
   <type>void</type><methodname>exit</methodname>
   <methodparam><type>int</type><parameter>status</parameter></methodparam>
  </methodsynopsis>
  <para>
   Finaliza la ejecución del script.
  <link linkend="function.register-shutdown-function">Funciones shutdown</link>
   y <link linkend="language.oop5.decon.destructor">Objectos destructores</link>
   siempre serán ejecutados incluso si se llama a la función <literal>exit</literal>.   
  </para>
  <para>
   <literal>exit</literal> es una construcción de lenguaje y puede ser llamada
   sin paréntesis si no se le pasa <parameter>status</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>status</parameter></term>
     <listitem>
      <para>
       Si <parameter>status</parameter> es una cadena, esta función imprime
       el <parameter>status</parameter> justo antes de salir.
      </para>
      <para>
       Si <parameter>status</parameter> es un valor <type>integer</type>,
       ese valor será usado también como el status de salida y no se mostrará. Los status de
       salida deben estar en el rango 0 a 254, el status de salida 255 es
       reservado por PHP y no debe ser usado. El status 0 es usado para
       finalizar el programa de forma satisfactoria.
      </para>
      <note>
       <simpara>
        PHP &gt;= 4.2.0 NO imprime el <parameter>status</parameter> si es un
        valor <type>integer</type>.
       </simpara>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <literal>exit</literal></title>
    <programlisting role="php">
<![CDATA[
<?php

$nombre_archivo = '/ruta/hacia/archivo-datos';
$archivo = fopen($nombre_archivo, 'r')
    or exit("no se pudo abrir el archivo ($nombre_archivo)");

?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Ejemplo de status de <literal>exit</literal></title>
    <programlisting role="php">
<![CDATA[
<?php

//finalizar el programa normalmente
exit;
exit();
exit(0);

//finalizar con un código de error
exit(1);
exit(0376); //octal

?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Las funciones Shutdown y los destructores se ejecutan igualmente</title>
    <programlisting role="php">
<![CDATA[
<?php
class Foo
{
    public function __destruct()
    {
        echo 'Destruct: ' . __METHOD__ . '()' . PHP_EOL;
    }
}

function shutdown()
{
    echo 'Shutdown: ' . __FUNCTION__ . '()' . PHP_EOL;
}

$foo = new Foo();
register_shutdown_function('shutdown');

exit();
echo 'Esto no se mostrará.';
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
 <![CDATA[
 Shutdown: shutdown()
 Destruct: Foo::__destruct()
 ]]>
    </screen>
   </example>
  </para>
 </refsect1>  

 <refsect1 role="notes">
  &reftitle.notes;

  &note.language-construct;

  <note>
   <para>
    Esta construcción de lenguaje es equivalente a <function>die</function>.
   </para>
  </note>
 </refsect1>

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