helly Tue May 27 14:56:20 2003 EDT
Modified files:
/phpdoc/en/reference/outcontrol/functions ob-end-clean.xml
ob-end-flush.xml
Log:
Update and Synch.
Index: phpdoc/en/reference/outcontrol/functions/ob-end-clean.xml
diff -u phpdoc/en/reference/outcontrol/functions/ob-end-clean.xml:1.4
phpdoc/en/reference/outcontrol/functions/ob-end-clean.xml:1.5
--- phpdoc/en/reference/outcontrol/functions/ob-end-clean.xml:1.4 Tue May 27
14:48:39 2003
+++ phpdoc/en/reference/outcontrol/functions/ob-end-clean.xml Tue May 27 14:56:20
2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/outcontrol.xml, last change in rev 1.1 -->
<refentry id="function.ob-end-clean">
<refnamediv>
@@ -16,8 +16,13 @@
</methodsynopsis>
<para>
This function discards the contents of the topmost output buffer and
- turns off this output buffering. It returns true when it successfully
- discarded one buffer and false otherwide. Reasons for failure are first
+ turns off this output buffering. If you want to further
+ process the buffer's contents you have to call
+ <function>ob_get_contents</function> before
+ <function>ob_end_clean</function> as the buffer contents are
+ discarded when <function>ob_end_flush</function> is called.
+ The function returns &true; when it successfully
+ discarded one buffer and &false; otherwide. Reasons for failure are first
that you called the function without an active buffer or that for some
reason a buffer could not be deleted (possible for special buffer).
</para>
@@ -44,8 +49,9 @@
</simpara>
<simpara>
See also <function>ob_start</function>,
- <function>ob_clean</function> and
- <function>ob_end_flush</function>.
+ <function>ob_get_contents</function>,
+ <function>ob_flush</function> and
+ <function>ob_end_clean</function>.
</simpara>
</note>
</para>
Index: phpdoc/en/reference/outcontrol/functions/ob-end-flush.xml
diff -u phpdoc/en/reference/outcontrol/functions/ob-end-flush.xml:1.2
phpdoc/en/reference/outcontrol/functions/ob-end-flush.xml:1.3
--- phpdoc/en/reference/outcontrol/functions/ob-end-flush.xml:1.2 Wed Apr 17
02:42:34 2002
+++ phpdoc/en/reference/outcontrol/functions/ob-end-flush.xml Tue May 27 14:56:20
2003
@@ -1,32 +1,60 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/outcontrol.xml, last change in rev 1.1 -->
<refentry id="function.ob-end-flush">
<refnamediv>
<refname>ob_end_flush</refname>
<refpurpose>
- Flush (send) the output buffer and turn off output buffering
+ Flush (send) the output buffer and turn off output buffering
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>void</type><methodname>ob_end_flush</methodname>
+ <type>bool </type><methodname>ob_end_flush</methodname>
<void/>
</methodsynopsis>
<para>
- This function will send the contents of the output buffer (if
- any) and turn output buffering off. If you want to further
+ This function will send the contents of the topmost output buffer (if
+ any) and turn this output buffer off. If you want to further
process the buffer's contents you have to call
<function>ob_get_contents</function> before
<function>ob_end_flush</function> as the buffer contents are
discarded after <function>ob_end_flush</function> is called.
+ The function returns &true; when it successfully
+ discarded one buffer and &false; otherwide. Reasons for failure are first
+ that you called the function without an active buffer or that for some
+ reason a buffer could not be deleted (possible for special buffer).
</para>
<para>
- See also <function>ob_start</function>,
- <function>ob_get_contents</function>,
- <function>ob_flush</function> and
- <function>ob_end_clean</function>.
+ The following example shows an easy way to flush and end all output
+ buffers:
+ <example>
+ <title><function>ob_end_flush</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+while (@ob_end_flush());
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ <para>
+ <note>
+ <simpara>
+ If the function fails it generates an E_NOTICE.
+ </simpara>
+ <simpara>
+ The boolean return value was added in PHP 4.2.0.
+ </simpara>
+ <simpara>
+ See also <function>ob_start</function>,
+ <function>ob_get_contents</function>,
+ <function>ob_flush</function> and
+ <function>ob_end_clean</function>.
+ </simpara>
+ </note>
</para>
</refsect1>
</refentry>
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
