cvs: phpdoc /en/reference/outcontrol/functions ob-start.xml

derick Sat Jun 28 03:24:36 2003 EDT Modified files: /phpdoc/en/reference/outcontrol/functions ob-start.xml Log: - Document return value and the linked version note. (Bug #24346) #- The callback stuff should still be documented, so I'm not closing the bug # yet Index: phpdoc/en/reference/outcontrol/functions/ob-start.xml diff -u phpdoc/en/reference/outcontrol/functions/ob-start.xml:1.3 phpdoc/en/reference/outcontrol/functions/ob-start.xml:1.4 --- phpdoc/en/reference/outcontrol/functions/ob-start.xml:1.3 Fri Mar 21 04:49:19 2003 +++ phpdoc/en/reference/outcontrol/functions/ob-start.xml Sat Jun 28 03:24:36 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/outcontrol.xml, last change in rev 1.1 --> <refentry id="function.ob-start"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>ob_start</methodname> + <type>bool</type><methodname>ob_start</methodname> <methodparam choice="opt"><type>callback</type><parameter> output_callback </parameter></methodparam> @@ -36,7 +36,8 @@ <parameter>output_callback</parameter> is called, it will receive the contents of the output buffer as its parameter and is expected to return a new output buffer as a result, which will be - sent to the browser. + sent to the browser. If the <parameter>output_callback</parameter> is not + a callable function, thos function will return &false;. </para> <note> <para> @@ -45,6 +46,12 @@ support compressed web pages. <function>ob_gzhandler</function> determines what type of content encoding the browser will accept and will return it's output accordingly. + </para> + </note> + <note> + <para> + Before PHP 4.3.2 this function did not return &false; in case the passed + <parameter>output_callback</parameter> can not be executed. </para> </note> <para>