doc-fr/reference/misc/functions/exit.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 86e6094e86b84a51d00ab217ac50ce8dde33d82a Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->

<refentry xml:id="function.exit" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>exit</refname>
  <refpurpose>Affiche un message et termine le script courant</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>
   Termine le script courant.
   Les <link linkend="function.register-shutdown-function">fonctions d'extinction</link>
   et les <link linkend="language.oop5.decon.destructor">destructeurs d'objets</link>
   seront toujours exécutés même si <literal>exit</literal> est appelé.
  </para>
  <para>
   <literal>exit</literal> est une construction de langage et peut être
   appelé sans parenthèse si aucun paramètre <parameter>status</parameter>
   n'est passé.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>status</parameter></term>
     <listitem>
      <para>
       Si <parameter>status</parameter> est une &string;, cette fonction affichera
       le <parameter>status</parameter> juste avant de sortir.
      </para>
      <para>
       Si le paramètre <parameter>status</parameter> est un &integer;, cette valeur
       pourra être utilisée comme statut de sortie et ne sera pas affichée. Le statut
       de sortie peut être dans l'intervalle 0-255, le statut de sortie 255 est réservé
       par PHP et ne doit pas être utilisé. Le statut 0 est utilisé pour terminer le
       programme avec succès.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

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

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

$filename = '/path/to/data-file';
$file = fopen($filename, 'r')
    or exit("Impossible d'ouvrir le fichier ($filename)");

?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Exemple avec <literal>exit</literal> et un code d'erreur</title>
    <programlisting role="php">
<![CDATA[
<?php

// Quitte normalement
exit;
exit();
exit(0);

// Quitte avec un code d'erreur
exit(1);
exit(0376); // octal

?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Exemple d'exécution des fonctions d'extinction et des
     destructeurs d'objets</title>
    <programlisting role="php">
<![CDATA[
<?php
class Foo
{
    public function __destruct()
    {
        echo 'Destructeur : ' . __METHOD__ . '()' . PHP_EOL;
    }
}

function shutdown()
{
    echo 'Arrêt : ' . __FUNCTION__ . '()' . PHP_EOL;
}

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

exit();
echo 'Ceci ne sera jamais affiché.';
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
 <![CDATA[
 Arrêt : shutdown()
 Destructeur : Foo::__destruct()
 ]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &note.language-construct;
  <note>
   <para>
    Cette construction de langage est équivalente à
    <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
-->