#46898 [Opn->Csd]: Suggestion to improve docs for unerasable output buffers

ID: 46898 Updated by: vrana@php.net Reported By: robin_fernandes at uk dot ibm dot com -Status: Open +Status: Closed Bug Type: Documentation problem Operating System: * PHP Version: Irrelevant New Comment: This bug has been fixed in the documentation's XML sources. Since the online and downloadable versions of the documentation need some time to get updated, we would like to ask you to be a bit patient. Thank you for the report, and for helping us make our documentation better. Previous Comments: ------------------------------------------------------------------------ [2008-12-18 12:34:13] robin_fernandes at uk dot ibm dot com Description: ------------ It is possible to create an unerasable output buffer by setting the flag $erase=false when calling ob_start(). This flag is documented, but its impact on other output buffering functions is not very clear. I propose adding a sentence to the doc of each of the affected functions as follows: ob_clean(): If the buffer is unerasable, a notice is raised and the function returns false; the buffer is not cleaned. ob_end_clean(): If the buffer is unerasable, a notice is raised and the function returns false; the buffer is not cleaned and is not destroyed. ob_end_flush(): If the buffer is unerasable, a notice is raised and the function returns false; the buffer is not flushed and is not destroyed. ob_get_clean(): PHP5: If the buffer is unerasable, a notice is raised and the function returns false; the buffer is not cleaned. PHP6: If the buffer is unerasable, the contents of the buffer is returned, but a notice is raised and the buffer is not cleaned. ob_get_flush(): PHP5: If the buffer is unerasable, a notice is raised and the function returns false; the buffer is not flushed. PHP6: If the buffer is unerasable, the contents of the buffer is returned, but a notice is raised and the buffer is not flushed. And the following will be true once bug 46897 is fixed (currently, the behaviour is inconsistent): ob_flush(): If the buffer is unerasable, a notice is raised and the function returns false; the buffer is not flushed. Reproduce code: --------------- n/a Expected result: ---------------- n/a Actual result: -------------- n/a ------------------------------------------------------------------------ -- Edit this bug report at http://bugs.php.net/?id=46898&edit=1