reference/errorfunc/functions/debug-backtrace.xml
e203b12d7964aa7c729e1f7c26fcbf357fc9fb63
...
...
@@ -10,7 +10,7 @@
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>array</type><methodname>debug_backtrace</methodname>
13
-
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>DEBUG_BACKTRACE_PROVIDE_OBJECT</initializer></methodparam>
13
+
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer><constant>DEBUG_BACKTRACE_PROVIDE_OBJECT</constant></initializer></methodparam>
14
14
<methodparam choice="opt"><type>int</type><parameter>limit</parameter><initializer>0</initializer></methodparam>
15
15
</methodsynopsis>
16
16
<para>
...
...
@@ -26,7 +26,7 @@
26
26
<term><parameter>options</parameter></term>
27
27
<listitem>
28
28
<para>
29
-
As of 5.3.6, this parameter is a bitmask for the following options:
29
+
This parameter is a bitmask for the following options:
30
30
<table>
31
31
<title><function>debug_backtrace</function> options</title>
32
32
<tgroup cols="2">
...
...
@@ -47,8 +47,54 @@
47
47
</tbody>
48
48
</tgroup>
49
49
</table>
50
-
Before 5.3.6, the only values recognized are &true; or &false;, which are the same as
51
-
setting or not setting the <constant>DEBUG_BACKTRACE_PROVIDE_OBJECT</constant> option respectively.
50
+
<note>
51
+
<para>
52
+
There are four possible combinations:
53
+
<table>
54
+
<title><function>debug_backtrace</function> options</title>
55
+
<tgroup cols="2">
56
+
<tbody>
57
+
<row>
58
+
<entry><code>debug_backtrace()</code></entry>
59
+
<entry morerows="2" valign="middle">
60
+
Populates both indexes
61
+
</entry>
62
+
</row>
63
+
<row>
64
+
<entry><code>debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT)</code></entry>
65
+
</row>
66
+
<row>
67
+
<entry><code>debug_backtrace(1)</code></entry>
68
+
</row>
69
+
<row>
70
+
<entry><code>debug_backtrace(0)</code></entry>
71
+
<entry valign="middle">
72
+
Omits index <literal>"object"</literal> and populates index <literal>"args"</literal>.
73
+
</entry>
74
+
</row>
75
+
<row>
76
+
<entry><code>debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS)</code></entry>
77
+
<entry morerows="1" valign="middle">
78
+
Omits index <literal>"object"</literal> <emphasis>and</emphasis> index <literal>"args"</literal>.
79
+
</entry>
80
+
</row>
81
+
<row>
82
+
<entry><code>debug_backtrace(2)</code></entry>
83
+
</row>
84
+
<row>
85
+
<entry><code>debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT|DEBUG_BACKTRACE_IGNORE_ARGS)</code></entry>
86
+
<entry morerows="1" valign="middle">
87
+
Populate index <literal>"object"</literal> <emphasis>and</emphasis> omit index <literal>"args"</literal>.
88
+
</entry>
89
+
</row>
90
+
<row>
91
+
<entry><code>debug_backtrace(3)</code></entry>
92
+
</row>
93
+
</tbody>
94
+
</tgroup>
95
+
</table>
96
+
</para>
97
+
</note>
52
98
</para>
53
99
</listitem>
54
100
</varlistentry>
...
...
@@ -56,7 +102,7 @@
56
102
<term><parameter>limit</parameter></term>
57
103
<listitem>
58
104
<para>
59
-
As of 5.4.0, this parameter can be used to limit the number of stack frames returned.
105
+
This parameter can be used to limit the number of stack frames returned.
60
106
By default (<parameter>limit</parameter>=<literal>0</literal>) it returns all stack frames.
61
107
</para>
62
108
</listitem>
...
...
@@ -93,7 +139,7 @@
93
139
</row>
94
140
<row>
95
141
<entry>line</entry>
96
-
<entry><type>integer</type></entry>
142
+
<entry><type>int</type></entry>
97
143
<entry>
98
144
The current line number. See also
99
145
<link linkend="language.constants.predefined">__LINE__</link>.
...
...
@@ -126,7 +172,7 @@
126
172
<entry>type</entry>
127
173
<entry><type>string</type></entry>
128
174
<entry>
129
-
The current call type. If a method call, "->" is returned. If a static
175
+
The current call type. If a method call, "-&gt;" is returned. If a static
130
176
method call, "::" is returned. If a function call, nothing is returned.
131
177
</entry>
132
178
</row>
...
...
@@ -144,49 +190,6 @@
144
190
</para>
145
191
</refsect1>
146
192

147
-
<refsect1 role="changelog">
148
-
&reftitle.changelog;
149
-
<para>
150
-
<informaltable>
151
-
<tgroup cols="2">
152
-
<thead>
153
-
<row>
154
-
<entry>&Version;</entry>
155
-
<entry>&Description;</entry>
156
-
</row>
157
-
</thead>
158
-
<tbody>
159
-
<row>
160
-
<entry>5.4.0</entry>
161
-
<entry>
162
-
Added the optional parameter <parameter>limit</parameter>.
163
-
</entry>
164
-
</row>
165
-
<row>
166
-
<entry>5.3.6</entry>
167
-
<entry>
168
-
The parameter <parameter>provide_object</parameter> changed to <parameter>options</parameter> and additional option
169
-
<constant>DEBUG_BACKTRACE_IGNORE_ARGS</constant> is added.
170
-
</entry>
171
-
</row>
172
-
<row>
173
-
<entry>5.2.5</entry>
174
-
<entry>
175
-
Added the optional parameter <parameter>provide_object</parameter>.
176
-
</entry>
177
-
</row>
178
-
<row>
179
-
<entry>5.1.1</entry>
180
-
<entry>
181
-
Added the current <type>object</type> as a possible return element.
182
-
</entry>
183
-
</row>
184
-
</tbody>
185
-
</tgroup>
186
-
</informaltable>
187
-
</para>
188
-
</refsect1>
189
-
190
193
<refsect1 role="examples">
191
194
&reftitle.examples;
192
195
<para>
...
...
@@ -257,7 +260,6 @@ array(4) {
257
260
</para>
258
261
</refsect1>
259
262
</refentry>
260
-

261
263
<!-- Keep this comment at the end of the file
262
264
Local variables:
263
265
mode: sgml
264
266