From 2e743fbe33cc426ae343134ccf61d9e256792a9d Mon Sep 17 00:00:00 2001 From: Sara Golemon Date: Sat, 4 Jun 2005 00:47:35 +0000 Subject: [PATCH] Update runkit docs for rel 0.3 git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@187606 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../runkit-sandbox-output-handler.xml | 130 ++++++++++++++++++ reference/runkit/sandbox.xml | 10 +- 2 files changed, 134 insertions(+), 6 deletions(-) create mode 100644 reference/runkit/functions/runkit-sandbox-output-handler.xml diff --git a/reference/runkit/functions/runkit-sandbox-output-handler.xml b/reference/runkit/functions/runkit-sandbox-output-handler.xml new file mode 100644 index 0000000000..e76947049e --- /dev/null +++ b/reference/runkit/functions/runkit-sandbox-output-handler.xml @@ -0,0 +1,130 @@ + + + + + runkit_sandbox_output_handler + + Specify a function to capture and/or process output from a runkit sandbox + + + + &reftitle.description; + + mixedrunkit_sandbox_output_handler + objectsandbox + mixedcallback + + + Ordinarily, anything output (such as with echo + or print will be output as though it were printed + from the parent's scope. Using runkit_sandbox_output_handler + however, output generated by the sandbox (including errors), can be captured + by a function outside of the sandbox. + + + ¬e.runkit.sandbox; + + + + + &reftitle.parameters; + + + + sandbox + + + Object instance of Runkit_Sandbox class on which to set output handling. + + + + + callback + + + Name of a function which expects one parameter. + Output generated by sandbox will be passed + to this callback. Anything returned by the callback will be displayed + normally. If this parameter is not passed then output handling will not be changed. + If a non-truth value is passed, output handling will be disabled and will revert to + direct display. + + + + + + + + + &reftitle.returnvalues; + + Returns the name of the previously defined output handler callback, or + &false; if no handler was previously defined. + + + + + &reftitle.examples; + + + Feeding output to a variable + +echo("Hello\n"); +$php->eval('var_dump("Excuse me");'); +$php->die("I lost myself."); +unset($php); + +echo "Sandbox complete\n\n"; +echo $sandbox_output; +?> +]]> + + &example.outputs; + + + + + + + + + + + diff --git a/reference/runkit/sandbox.xml b/reference/runkit/sandbox.xml index b47a94666a..6f7ee73a4d 100644 --- a/reference/runkit/sandbox.xml +++ b/reference/runkit/sandbox.xml @@ -1,5 +1,5 @@ - + @@ -168,11 +168,9 @@ bool(false) a method on the sandbox object. This also includes a few psuedo-function language constructs: eval, include, include_once, - require, and require_once. - Most notably abset are the language constructs: echo, - print, die, and exit. - These functions are excluded out of simplicity and to avoid confusion - as they would mostly likely be used incorrectly. + require, require_once, + echo, print, + die, and exit.