forked from fuel/docs
-
Notifications
You must be signed in to change notification settings - Fork 118
/
debug.html
338 lines (320 loc) · 7.96 KB
/
debug.html
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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="./../assets/css/combined.css">
<link rel="shortcut icon" href="./../favicon.ico" />
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
var path = './../';
var class_prefix = "Debug::";
</script>
<script src="./../assets/js/combined.js"></script>
<title>Debug - Classes - FuelPHP Documentation</title>
</head>
<body>
<div id="container">
<header id="header">
<div class="table">
<h1>
<a href="http://fuelphp.com"><img height="37px" width="147px" src="./../assets/img/fuel.png" /></a>
<strong>Documentation</strong>
</h1>
<form id="google_search">
<p>
<span id="search_clear"> </span>
<input type="submit" name="search_submit" id="search_submit" value="search" />
<input type="text" value="" id="search_input" name="search_input" />
</p>
</form>
</div>
<nav>
<div class="clear"></div>
</nav>
<a href="#" id="toc_handle">table of contents</a>
<div class="clear"></div>
</header>
<div id="cse">
<div id="cse_point"></div>
<div id="cse_content"></div>
</div>
<div id="main">
<h2>Debug Class</h2>
<p>
The Debug class is a simple utility for debugging variables, objects, arrays, etc by outputting information to the display. This is not
meant as a one-stop-shop to all of your debugging needs, but as a simple way to throw out information quickly to check things as you go.
</p>
<article>
<h4 class="method" id="method_dump">dump(*$args)</h4>
<p>The <strong>dump</strong> method outputs multiple mixed values to the browser in a formatted structured way and includes backtrace information so you know where it is coming from.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>Unlimited mixed arguments</td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Debug::dump($stuff, 'junk', array('whatever'));</code></pre>
</td>
</tr>
</tbody>
</table>
<p class="note">
By default nested structures will be displayed collapsed to minimize the impact of the output on the page layout. You can
alter this behaviour and have it expand by default by setting <strong>Debug::$js_toggle_open</strong> to <strong>true</strong>.
</p>
</article>
<article>
<h4 class="method" id="method_backtrace">backtrace()</h4>
<p>The <strong>backtrace</strong> method shows the file and line the method is called from and a list of all previous.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td><i>None</i></td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Debug::backtrace();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_classes">classes()</h4>
<p>Output a list of all classes currently defined in the PHP runtime.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td><i>None</i></td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Debug::classes();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_interfaces">interfaces()</h4>
<p>Output a list of all <a href="http://uk.php.net/interfaces" target="_blank">interface classes</a> currently defined in the PHP runtime.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td><i>None</i></td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Debug::interfaces();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_includes">includes()</h4>
<p>Output a list of all included files currently loaded in the PHP runtime.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td><i>None</i></td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Debug::includes();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_functions">functions()</h4>
<p>Output a list of all functions currently defined in the PHP runtime.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td><i>None</i></td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Debug::functions();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_constants">constants()</h4>
<p>Output a list of all constants currently defined in the PHP runtime.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td><i>None</i></td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Debug::constants();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_extensions">extensions()</h4>
<p>Output a list of all extensions loaded by PHP.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td><i>None</i></td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Debug::extensions();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_headers">headers()</h4>
<p>Output a list of all HTTP headers the server was requested with.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td><i>None</i></td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Debug::headers();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_phpini">phpini()</h4>
<p>Prints a list of the configuration settings read from <i>php.ini</i></p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td><i>None</i></td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Debug::phpini();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
</div>
<footer>
<p>
© FuelPHP Development Team 2010-2016 - <a href="http://fuelphp.com">FuelPHP</a> is released under the MIT license.
</p>
</footer>
</div>
</body>
</html>