Update runkit docs for rel 0.3

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@187606 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Sara Golemon 2005-06-04 00:47:35 +00:00
parent 6d0f4bc993
commit 2e743fbe33
2 changed files with 134 additions and 6 deletions

View file

@ -0,0 +1,130 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.runkit-sandbox-output-handler">
<refnamediv>
<refname>runkit_sandbox_output_handler</refname>
<refpurpose>
Specify a function to capture and/or process output from a runkit sandbox
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>runkit_sandbox_output_handler</methodname>
<methodparam><type>object</type><parameter>sandbox</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>callback</parameter></methodparam>
</methodsynopsis>
<para>
Ordinarily, anything output (such as with <function>echo</function>
or <function>print</function> will be output as though it were printed
from the parent's scope. Using <function>runkit_sandbox_output_handler</function>
however, output generated by the sandbox (including errors), can be captured
by a function outside of the sandbox.
</para>
&note.runkit.sandbox;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>sandbox</parameter></term>
<listitem>
<para>
Object instance of Runkit_Sandbox class on which to set output handling.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>callback</parameter></term>
<listitem>
<para>
Name of a function which expects one parameter.
Output generated by <parameter>sandbox</parameter> 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.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the name of the previously defined output handler callback, or
&false; if no handler was previously defined.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Feeding output to a variable</title>
<programlisting role="php">
<![CDATA[
<?php
function capture_output($str) {
$GLOBALS['sandbox_output'] .= $str;
return '';
}
$sandbox_output = '';
$php = new Runkit_Sandbox();
runkit_sandbox_output_handler($php, 'capture_output');
$php->echo("Hello\n");
$php->eval('var_dump("Excuse me");');
$php->die("I lost myself.");
unset($php);
echo "Sandbox complete\n\n";
echo $sandbox_output;
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Sandbox Complete
Hello
string(9) "Excuse me"
I lost myself.
]]>
</screen>
</example>
</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:"../../../../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
-->

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- $Revision: 1.10 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="runkit.sandbox">
<refnamediv>
@ -168,11 +168,9 @@ bool(false)
a method on the sandbox object. This also includes a few
psuedo-function language constructs: <function>eval</function>,
<function>include</function>, <function>include_once</function>,
<function>require</function>, and <function>require_once</function>.
Most notably abset are the language constructs: <function>echo</function>,
<function>print</function>, <function>die</function>, and <function>exit</function>.
These functions are excluded out of simplicity and to avoid confusion
as they would mostly likely be used incorrectly.
<function>require</function>, <function>require_once</function>,
<function>echo</function>, <function>print</function>,
<function>die</function>, and <function>exit</function>.
</para>
<example>