vrana Thu Aug 12 14:56:24 2004 EDT
Modified files:
/phpdoc/en/reference/outcontrol/functions ob-start.xml
Log:
New parameters, additional parameter to callback function
http://cvs.php.net/diff.php/phpdoc/en/reference/outcontrol/functions/ob-start.xml?r1=1.10&r2=1.11&ty=u
Index: phpdoc/en/reference/outcontrol/functions/ob-start.xml
diff -u phpdoc/en/reference/outcontrol/functions/ob-start.xml:1.10
phpdoc/en/reference/outcontrol/functions/ob-start.xml:1.11
--- phpdoc/en/reference/outcontrol/functions/ob-start.xml:1.10 Wed May 19 12:09:22
2004
+++ phpdoc/en/reference/outcontrol/functions/ob-start.xml Thu Aug 12 14:56:23
2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.10 $ -->
+<!-- $Revision: 1.11 $ -->
<!-- splitted from ./en/functions/outcontrol.xml, last change in rev 1.1 -->
<refentry id="function.ob-start">
<refnamediv>
@@ -10,9 +10,9 @@
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ob_start</methodname>
- <methodparam choice="opt"><type>callback</type><parameter>
- output_callback
- </parameter></methodparam>
+ <methodparam
choice="opt"><type>callback</type><parameter>output_callback</parameter></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>chunk_size</parameter></methodparam>
+ <methodparam
choice="opt"><type>bool</type><parameter>erase</parameter></methodparam>
</methodsynopsis>
<para>
This function will turn output buffering on. While output
@@ -38,6 +38,11 @@
expected to return a new output buffer as a result, which will be
sent to the browser. If the <parameter>output_callback</parameter> is not
a callable function, this function will return &false;.
+ If the callback function has two parameters, the second parameter is filled
+ with the bit-field consisting of
+ <constant>PHP_OUTPUT_HANDLER_START</constant>,
+ <constant>PHP_OUTPUT_HANDLER_CONT</constant> and
+ <constant>PHP_OUTPUT_HANDLER_END</constant>.
</para>
<note>
<para>
@@ -54,6 +59,16 @@
<parameter>output_callback</parameter> can not be executed.
</para>
</note>
+ <para>
+ If an optional parameter <parameter>chunk_size</parameter> is passed, the
+ callback function is called on every first newline after
+ <parameter>chunk_size</parameter> bytes of output.
+ </para>
+ <para>
+ If an optional parameter <parameter>erase</parameter> is set to &false;
+ buffer may not be deleted until script finishes. It is available since
+ PHP 4.3.0.
+ </para>
<para>
Output buffers are stackable, that is, you may call
<function>ob_start</function> while another
