Permalink
Browse files

Documented xdebug.halt_level and the XDEBUG_STACK_NO_DESC setting to …

…xdebug_print_function_stack().
  • Loading branch information...
1 parent a2aa6a9 commit 1e267fd17f2270a009e67c6da9fd7ac3e04e2336 @derickr derickr committed Dec 21, 2013
Showing with 37 additions and 2 deletions.
  1. +15 −2 html/docs/include/functions/xdebug_print_function_stack
  2. +22 −0 html/docs/include/settings.php
@@ -1,15 +1,16 @@
= xdebug_print_function_stack
Displays the current function stack.
none
-[ string message ]
+[ string message [, int options ] ]
FUNC_STACK_TRACE
TXT:
Displays the current function stack, in a similar way as what Xdebug would
display in an error situation.
TXT:
-The "message" argument was introduced in Xdebug 2.1.
+The "message" argument allows you to replace
+the message in the header with your own. <i>(Introduced in Xdebug 2.1).</i>
EXAMPLE:
<?php
@@ -30,3 +31,15 @@ RESULT:
<tr><td bgcolor='#eeeeec' align='center'>3</td><td bgcolor='#eeeeec' align='center'>0.0007</td><td bgcolor='#eeeeec' align='right'>654736</td><td bgcolor='#eeeeec'><a href='http://www.php.net/xdebug_print_function_stack' target='_new'>xdebug_print_function_stack</a>
( <span>&apos;Your own message&apos;</span> )</td><td title='/home/httpd/html/test/xdebug/print_function_stack.php' bgcolor='#eeeeec'>../print_function_stack.php<b>:</b>5</td></tr>
</table></font>
+
+TXT:
+The bitmask "options" allows you to configure a few extra options.
+The following options are currently supported:
+<dl>
+<dt><code>XDEBUG_STACK_NO_DESC</code></dt>
+<dd>If this option is set, then the printed stack trace will not have a
+header. This is useful if you want to print a stack trace from your own error
+handler, as otherwise the printed location is where
+<code>xdebug_print_function_stack()</code> was called from. <i>(Introduced in
+Xdebug 2.3).</i></dd>
+</dl>
@@ -28,6 +28,28 @@
ini_set(), but only in php.ini.",
FUNC_REMOTE
),
+ 'halt_level' => array(
+ 'int', 0, "2.3",
+ "<p>This setting allows you to configure a mask that determines
+whether, and which, notices and/or warnings get converted to errors. You can
+configure notices and warnings that are generated by PHP, and notices and
+warnings that you generate yourself (by means of trigger_error()). For example,
+to convert the warning of strlen() (without arguments) to an error, you would
+do:</p>
+<pre>
+ini_set('xdebug.halt_level', E_WARNING);
+echo \"Hi!\\n\";
+</pre>
+<p>Which will then result in the showing of the error message, and the abortion
+of the script. <code>echo \"Hi!\\n\";</code> will not be executed.</p>
+<p>The setting is a bit mask, so to convert all notices and warnings into
+errors for all applications, you can set this in php.ini:</p>
+<pre>
+xdebug.halt_level=E_WARNING|E_NOTICE|E_USER_WARNING|E_USER_NOTICE
+</pre>
+<p>The bitmask only supports the four level that are mentioned above.</p>",
+ FUNC_BASIC
+ ),
'manual_url' => array(
'string', 'http://www.php.net', "< 2.2.1",
"This is the base url for the links from the function traces and error

0 comments on commit 1e267fd

Please sign in to comment.