#46898 [NEW]: Suggestion to improve docs for unerasable output buffers

From: robin_fernandes at uk dot ibm dot com Operating system: * PHP version: Irrelevant PHP Bug Type: Documentation problem Bug description: Suggestion to improve docs for unerasable output buffers 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 bug report at http://bugs.php.net/?id=46898&edit=1 -- Try a CVS snapshot (PHP 5.2): http://bugs.php.net/fix.php?id=46898&r=trysnapshot52 Try a CVS snapshot (PHP 5.3): http://bugs.php.net/fix.php?id=46898&r=trysnapshot53 Try a CVS snapshot (PHP 6.0): http://bugs.php.net/fix.php?id=46898&r=trysnapshot60 Fixed in CVS: http://bugs.php.net/fix.php?id=46898&r=fixedcvs Fixed in CVS and need be documented: http://bugs.php.net/fix.php?id=46898&r=needdocs Fixed in release: http://bugs.php.net/fix.php?id=46898&r=alreadyfixed Need backtrace: http://bugs.php.net/fix.php?id=46898&r=needtrace Need Reproduce Script: http://bugs.php.net/fix.php?id=46898&r=needscript Try newer version: http://bugs.php.net/fix.php?id=46898&r=oldversion Not developer issue: http://bugs.php.net/fix.php?id=46898&r=support Expected behavior: http://bugs.php.net/fix.php?id=46898&r=notwrong Not enough info: http://bugs.php.net/fix.php?id=46898&r=notenoughinfo Submitted twice: http://bugs.php.net/fix.php?id=46898&r=submittedtwice register_globals: http://bugs.php.net/fix.php?id=46898&r=globals PHP 4 support discontinued: http://bugs.php.net/fix.php?id=46898&r=php4 Daylight Savings: http://bugs.php.net/fix.php?id=46898&r=dst IIS Stability: http://bugs.php.net/fix.php?id=46898&r=isapi Install GNU Sed: http://bugs.php.net/fix.php?id=46898&r=gnused Floating point limitations: http://bugs.php.net/fix.php?id=46898&r=float No Zend Extensions: http://bugs.php.net/fix.php?id=46898&r=nozend MySQL Configuration Error: http://bugs.php.net/fix.php?id=46898&r=mysqlcfg