archived-doc-fr/reference/errorfunc/functions/debug-backtrace.xml

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

<refentry xml:id="function.debug-backtrace" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>debug_backtrace</refname>
  <refpurpose>Génère le contexte de débogage</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>debug_backtrace</methodname>
   <methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>DEBUG_BACKTRACE_PROVIDE_OBJECT</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>limit</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>debug_backtrace</function> génère un contexte de débogage PHP.
  </para>
 </refsect1>
 
 <refsect1 role="parameters"><!-- {{{ -->
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       Depuis PHP 5.3.6, ce paramètre est un masque d'options suivantes :
       <table>
        <title>Options pour la fonction <function>debug_backtrace</function></title>
        <tgroup cols="2">
         <tbody>
          <row>
           <entry>DEBUG_BACKTRACE_PROVIDE_OBJECT</entry>
           <entry>
            Si l'on doit ou non peupler l'index "object".
           </entry>
          </row>
          <row>
           <entry>DEBUG_BACKTRACE_IGNORE_ARGS</entry>
           <entry>
            Si l'on doit ou non omettre l'index "args" et donc tous les arguments
            de la fonction/méthode pour économiser de la mémoire.
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
       Avant PHP 5.3.6, les seules valeurs reconnues sont &true; ou &false;,
       ce qui revenait à, respectivement, définir ou non l'option
       <constant>DEBUG_BACKTRACE_PROVIDE_OBJECT</constant>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>limit</parameter></term>
     <listitem>
      <para>
       Depuis 5.4.0, ce paramètre peut être utilisé pour limiter
       le nombre de trames dans la pile retournée. Par défaut
       (<parameter>limit</parameter>=<literal>0</literal>), la
       fonction retourne toutes les trames de la pile.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1><!-- }}} -->
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne un tableau de tableaux associatifs. Les éléments de retour possibles sont les suivants :
  </para>
  <para>
   <table>
    <title>Éléments possibles de retour de la fonction <function>debug_backtrace</function></title>
    <tgroup cols="3">
     <thead>
      <row>
       <entry>&Name;</entry>
       <entry>&Type;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>function</entry>
       <entry>&string;</entry>
       <entry>
        Le nom de la fonction courante. Voir aussi
        <link linkend="language.constants.predefined">__FUNCTION__</link>.
       </entry>
      </row>
      <row>
       <entry>line</entry>
       <entry>&integer;</entry>
       <entry>
        Le numéro de la ligne courante. Voir aussi
        <link linkend="language.constants.predefined">__LINE__</link>.
       </entry>
      </row>
      <row>
       <entry>file</entry>
       <entry>&string;</entry>
       <entry>
        Le nom du fichier courant. Voir aussi
        <link linkend="language.constants.predefined">__FILE__</link>.
       </entry>
      </row>
      <row>
       <entry>class</entry>
       <entry>&string;</entry>
       <entry>
        Le nom de la <link linkend="language.oop5">classe</link> courante. Voir aussi
        <link linkend="language.constants.predefined">__CLASS__</link>.
       </entry>
      </row>
      <row>
       <entry>object</entry>
       <entry>&object;</entry>
       <entry>
        L'<link linkend="language.oop5">objet</link> courant.
       </entry>
      </row>
      <row>
       <entry>type</entry>
       <entry>&string;</entry>
       <entry>
        Le type de classe courante. Si une méthode est appelée, "->" est retourné.
        Si une méthode statique est appelée, "::" est retourné. Si une fonction est appelée,
        rien ne sera retourné.
       </entry>
      </row>
      <row>
       <entry>args</entry>
       <entry>&array;</entry>
       <entry>
        Si à l'intérieur d'une fonction, ceci liste des arguments. Si
        dans un fichier inclus, ceci liste des fichiers inclus.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </table>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>debug_backtrace</function></title>
    <programlisting role="php">
<![CDATA[
<?php
// filename: /tmp/a.php

function a_test($str)
{
  echo "\nHi: $str";
  var_dump(debug_backtrace());
}

a_test('friend');
?>

<?php
// filename: /tmp/b.php
include_once '/tmp/a.php';
?>
]]>
    </programlisting>
    <para>
     Résultat de l'exécution de
     <filename>/tmp/b.php</filename> :
    </para>
    <screen>
<![CDATA[
Hi: friend
array(2) {
  [0]=>
    array(4) {
      ["file"] => string(10) "/tmp/a.php"
      ["line"] => int(10)
      ["function"] => string(6) "a_test"
      ["args"]=>
        array(1) {
          [0] => &string(6) "friend"
        }
    }
  [1]=>
    array(4) {
      ["file"] => string(10) "/tmp/b.php"
      ["line"] => int(2)
      ["args"] =>
        array(1) {
          [0] => string(10) "/tmp/a.php"
        }
      ["function"] => string(12) "include_once"
    }
}
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>trigger_error</function></member>
    <member><function>debug_print_backtrace</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
-->