pollita Thu Sep 22 21:11:02 2005 EDT
Modified files:
/phpdoc/en/reference/runkit/functions
runkit-sandbox-output-handler.xml
/phpdoc/en/reference/runkit sandbox.xml
Log:
These need examples, but it's late...
http://cvs.php.net/diff.php/phpdoc/en/reference/runkit/functions/runkit-sandbox-output-handler.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/runkit/functions/runkit-sandbox-output-handler.xml
diff -u
phpdoc/en/reference/runkit/functions/runkit-sandbox-output-handler.xml:1.2
phpdoc/en/reference/runkit/functions/runkit-sandbox-output-handler.xml:1.3
--- phpdoc/en/reference/runkit/functions/runkit-sandbox-output-handler.xml:1.2
Mon Jun 6 20:44:45 2005
+++ phpdoc/en/reference/runkit/functions/runkit-sandbox-output-handler.xml
Thu Sep 22 21:11:01 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.runkit-sandbox-output-handler">
<refnamediv>
<refname>runkit_sandbox_output_handler</refname>
@@ -24,6 +24,16 @@
¬e.runkit.sandbox;
+ <note>
+ <title>Deprecated</title>
+ <para>
+ As of runkit version 0.5, this function is deprecated and is scheduled to
+ be removed from the package prior to a 1.0 release. The output handler
for
+ a given Runkit_Sandbox instance may be read/set using the array offset
syntax
+ shown on the <link linkend="runkit.sandbox">Runkit_Sandbox</link> class
definition page.
+ </para>
+ </note>
+
</refsect1>
<refsect1 role="parameters">
@@ -63,6 +73,7 @@
</para>
</refsect1>
+ <!-- TODO: Move this example to runkit.sandbox -->
<refsect1 role="examples">
&reftitle.examples;
<para>
http://cvs.php.net/diff.php/phpdoc/en/reference/runkit/sandbox.xml?r1=1.12&r2=1.13&ty=u
Index: phpdoc/en/reference/runkit/sandbox.xml
diff -u phpdoc/en/reference/runkit/sandbox.xml:1.12
phpdoc/en/reference/runkit/sandbox.xml:1.13
--- phpdoc/en/reference/runkit/sandbox.xml:1.12 Fri Jul 22 15:35:26 2005
+++ phpdoc/en/reference/runkit/sandbox.xml Thu Sep 22 21:11:02 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.12 $ -->
+<!-- $Revision: 1.13 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc.
-->
<refentry id="runkit.sandbox">
<refnamediv>
@@ -190,7 +190,7 @@
</screen>
</refsect1>
- <refsect1 role="variables">
+ <refsect1 role="functions">
<title>Calling PHP Functions</title>
<para>
Any function defined within the sandbox may be called as
@@ -252,6 +252,58 @@
</screen>
</refsect1>
+ <refsect1 role="settings">
+ <title>Changing Sandbox Settings</title>
+ <para>
+ As of runkit version 0.5, certain Sandbox settings may
+ be modified on the fly using ArrayAccess syntax.
+ Some settings, such as <parameter>active</parameter>
+ are read-only and meant to provide status information.
+ Other settings, such as <parameter>output_handler</parameter>
+ may be set and read much like a normal array offset.
+ Future settings may be write-only, however no such
+ settings currently exist.
+ </para>
+
+ <para>
+ <table>
+ <title>Sandbox Settings / Status Indicators</title>
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>Setting</entry>
+ <entry>Visibility</entry>
+ <entry>Purpose</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><literal>active</literal></entry>
+ <entry><constant>Read Only</constant></entry>
+ <entry>
+ &true; if the Sandbox is still in a usable state,
+ &false; if the request is in bailout due to a
+ call to die(), exit(), or because of a fatal
+ error condition.
+ </entry>
+ </row>
+ <row>
+ <entry><literal>output_handler</literal></entry>
+ <entry><constant>Read/Write</constant></entry>
+ <entry>
+ When set to a valid callback, all output generated
+ by the Sandbox instance will be processed through
+ the named function.
+ Sandbox output handlers follow the same calling
+ conventions as the system-wide output handler.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
