mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
Initial commit of this fine function. It may need a little touching up :)
This closes bug #21515 git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@112639 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson
parent
3ac82682c4
commit
8ef688392f
1 changed files with 167 additions and 0 deletions
167
reference/errorfunc/functions/debug-backtrace.xml
Executable file
167
reference/errorfunc/functions/debug-backtrace.xml
Executable file
|
|
@ -0,0 +1,167 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<refentry id="function.debug-backtrace">
|
||||
<refnamediv>
|
||||
<refname>debug_backtrace</refname>
|
||||
<refpurpose>
|
||||
Generates a backtrace
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<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 class type.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>args</entry>
|
||||
<entry><type>array</type></entry>
|
||||
<entry>
|
||||
If inside a function, this lists the functions arguments. If
|
||||
inside a 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[
|
||||
// filename: a.php
|
||||
<?php
|
||||
|
||||
function a_test($str) {
|
||||
|
||||
print "\nHi: $str";
|
||||
|
||||
var_dump(debug_backtrace());
|
||||
}
|
||||
|
||||
a_test('friend');
|
||||
?>
|
||||
|
||||
// filename: b.php
|
||||
<?php
|
||||
include_once '/tmp/a.php';
|
||||
?>
|
||||
|
||||
/* Results when executing /tmp/b.php
|
||||
|
||||
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"
|
||||
}
|
||||
}
|
||||
*/
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
<para>
|
||||
See also <function>trigger_error</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
|
||||
-->
|
||||
Loading…
Reference in a new issue