mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 18:38:55 +00:00
597c9e6b87
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@171848 c90b9560-bf6c-de11-be94-00142212c4b1
171 lines
4.2 KiB
XML
Executable file
171 lines
4.2 KiB
XML
Executable file
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.13 $ -->
|
|
<refentry id="function.debug-backtrace">
|
|
<refnamediv>
|
|
<refname>debug_backtrace</refname>
|
|
<refpurpose>
|
|
Generates a backtrace
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>debug_backtrace</methodname>
|
|
<void/>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>debug_backtrace</function> generates a PHP backtrace
|
|
and returns this information as an associative <type>array</type>. The
|
|
possible returned elements are listed in the following table:
|
|
</para>
|
|
<para>
|
|
<table>
|
|
<title>Possible returned elements from <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><type>string</type></entry>
|
|
<entry>
|
|
The current function name. See also
|
|
<link linkend="language.constants.predefined">__FUNCTION__</link>.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>line</entry>
|
|
<entry><type>integer</type></entry>
|
|
<entry>
|
|
The current line number. See also
|
|
<link linkend="language.constants.predefined">__LINE__</link>.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>file</entry>
|
|
<entry><type>string</type></entry>
|
|
<entry>
|
|
The current file name. See also
|
|
<link linkend="language.constants.predefined">__FILE__</link>.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>class</entry>
|
|
<entry><type>string</type></entry>
|
|
<entry>
|
|
The current <link linkend="language.oop">class</link> name. See also
|
|
<link linkend="language.constants.predefined">__CLASS__</link>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>type</entry>
|
|
<entry><type>string</type></entry>
|
|
<entry>
|
|
The current call type. If a method call, "->" is returned. If a static
|
|
method call, "::" is returned. If a function call, nothing is returned.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>args</entry>
|
|
<entry><type>array</type></entry>
|
|
<entry>
|
|
If inside a function, this lists the functions arguments. If
|
|
inside an included file, this lists the included file name(s).
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
<para>
|
|
The following is a simple example.
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title>
|
|
<function>debug_backtrace</function> example
|
|
</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// filename: a.php
|
|
|
|
function a_test($str)
|
|
{
|
|
echo "\nHi: $str";
|
|
var_dump(debug_backtrace());
|
|
}
|
|
|
|
a_test('friend');
|
|
?>
|
|
|
|
<?php
|
|
// filename: b.php
|
|
include_once '/tmp/a.php';
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
<para>
|
|
Results when executing <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>
|
|
<para>
|
|
See also <function>trigger_error</function> and
|
|
<function>debug_print_backtrace</function>.
|
|
</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:"../../../../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
|
|
-->
|