-
Notifications
You must be signed in to change notification settings - Fork 59
Expand file tree
/
Copy pathdebug-backtrace.xml
More file actions
286 lines (278 loc) · 8.01 KB
/
debug-backtrace.xml
File metadata and controls
286 lines (278 loc) · 8.01 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: a124543dd3f6b1e5567b07420d23899e582514dc Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.debug-backtrace" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>debug_backtrace</refname>
<refpurpose>Genera el contexto de depuración</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><constant>DEBUG_BACKTRACE_PROVIDE_OBJECT</constant></initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>limit</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
<function>debug_backtrace</function> genera un contexto de depuración PHP.
</para>
</refsect1>
<refsect1 role="parameters"><!-- {{{ -->
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
Este argumento es una máscara de las siguientes opciones:
<table>
<title>Opciones para la función <function>debug_backtrace</function></title>
<tgroup cols="2">
<tbody>
<row>
<entry>DEBUG_BACKTRACE_PROVIDE_OBJECT</entry>
<entry>
Si se debe o no poblar el índice "object".
</entry>
</row>
<row>
<entry>DEBUG_BACKTRACE_IGNORE_ARGS</entry>
<entry>
Si se debe o no omitir el índice "args" y por lo tanto todos los argumentos
de la función/método para ahorrar memoria.
</entry>
</row>
</tbody>
</tgroup>
</table>
<note>
<para>
Existen cuatro combinaciones posibles:
<table>
<title>Opciones de <function>debug_backtrace</function></title>
<tgroup cols="2">
<tbody>
<row>
<entry><code>debug_backtrace()</code></entry>
<entry morerows="2" valign="middle">
Rellena los dos índices
</entry>
</row>
<row>
<entry><code>debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT)</code></entry>
</row>
<row>
<entry><code>debug_backtrace(1)</code></entry>
</row>
<row>
<entry><code>debug_backtrace(0)</code></entry>
<entry valign="middle">
Omite el índice <literal>"object"</literal> y rellena el índice <literal>"args"</literal>.
</entry>
</row>
<row>
<entry><code>debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS)</code></entry>
<entry morerows="1" valign="middle">
Omite el índice <literal>"object"</literal> <emphasis>y</emphasis> el índice <literal>"args"</literal>.
</entry>
</row>
<row>
<entry><code>debug_backtrace(2)</code></entry>
</row>
<row>
<entry><code>debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT|DEBUG_BACKTRACE_IGNORE_ARGS)</code></entry>
<entry morerows="1" valign="middle">
Rellena el índice <literal>"object"</literal> <emphasis>y</emphasis> omite el índice <literal>"args"</literal>.
</entry>
</row>
<row>
<entry><code>debug_backtrace(3)</code></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</note>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>limit</parameter></term>
<listitem>
<para>
Este argumento puede ser utilizado para limitar
el número de marcos en la pila devuelta. Por omisión
(<parameter>limit</parameter>=<literal>0</literal>), la
función devuelve todos los marcos de la pila.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1><!-- }}} -->
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Devuelve un array de arrays asociativos. Los elementos de retorno posibles son los siguientes:
</para>
<para>
<table>
<title>Elementos posibles de retorno de la función <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>
El nombre de la función actual. Ver también
<link linkend="language.constants.magic">__FUNCTION__</link>.
</entry>
</row>
<row>
<entry>line</entry>
<entry>&integer;</entry>
<entry>
El número de línea actual. Ver también
<link linkend="language.constants.magic">__LINE__</link>.
</entry>
</row>
<row>
<entry>file</entry>
<entry>&string;</entry>
<entry>
El nombre del fichero actual. Ver también
<link linkend="language.constants.magic">__FILE__</link>.
</entry>
</row>
<row>
<entry>class</entry>
<entry>&string;</entry>
<entry>
El nombre de la <link linkend="language.oop5">clase</link> actual. Ver también
<link linkend="language.constants.magic">__CLASS__</link>.
</entry>
</row>
<row>
<entry>object</entry>
<entry>&object;</entry>
<entry>
El <link linkend="language.oop5">objeto</link> actual.
</entry>
</row>
<row>
<entry>type</entry>
<entry>&string;</entry>
<entry>
El tipo de clase actual. Si un método es llamado, "->" es devuelto.
Si un método estático es llamado, "::" es devuelto. Si una función es llamada,
nada será devuelto.
</entry>
</row>
<row>
<entry>args</entry>
<entry>&array;</entry>
<entry>
Si dentro de una función, esto lista los argumentos. Si
en un fichero incluido, esto lista los ficheros incluidos.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Ejemplo con <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>
Resultado de la ejecución 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
-->