derick Fri Nov 30 05:55:30 2001 EDT
Modified files:
/phpdoc/en/functions outcontrol.xml
Log:
- Added documentation for ob_flush and ob_clean.
Index: phpdoc/en/functions/outcontrol.xml
diff -u phpdoc/en/functions/outcontrol.xml:1.19 phpdoc/en/functions/outcontrol.xml:1.20
--- phpdoc/en/functions/outcontrol.xml:1.19 Wed Nov 21 18:05:18 2001
+++ phpdoc/en/functions/outcontrol.xml Fri Nov 30 05:55:30 2001
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.19 $ -->
+<!-- $Revision: 1.20 $ -->
<reference id="ref.outcontrol">
<title>Output Control Functions</title>
<titleabbrev>Output Control</titleabbrev>
@@ -312,6 +312,72 @@
</refsect1>
</refentry>
+ <refentry id="function.ob-flush">
+ <refnamediv>
+ <refname>ob_flush</refname>
+ <refpurpose>
+ Flush (send) the output buffer
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>ob_flush</function></funcdef>
+ <void/>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ This function will send the contents of the output buffer (if
+ any). If you want to further
+ process the buffer's contents you have to call
+ <function>ob_get_contents</function> before
+ <function>ob_flush</function> as the buffer contents are
+ discarded after <function>ob_end_flush</function> is called.
+ </para>
+ <para>
+ This function does not destroy the output buffer like
+ <function>ob_end_flush</function> does.
+ </para>
+ <para>
+ See also <function>ob_get_contents</function>,
+ <function>ob_clean</function>,
+ <function>ob_end_flush</function> and
+ <function>ob_end_clean</function>.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.ob-clean">
+ <refnamediv>
+ <refname>ob_clean</refname>
+ <refpurpose>
+ Clean (erase) the output buffer
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>ob_clean</function></funcdef>
+ <void/>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ This function discards the contents of the output buffer.
+ </para>
+ <para>
+ This function does not destroy the output buffer like
+ <function>ob_end_clean</function> does.
+ </para>
+ <para>
+ See also <function>ob_flush</function>,
+ <function>ob_end_flush</function> and
+ <function>ob_end_clean</function>.
+ </para>
+ </refsect1>
+ </refentry>
+
<refentry id="function.ob-end-flush">
<refnamediv>
<refname>ob_end_flush</refname>
@@ -337,7 +403,8 @@
</para>
<para>
See also <function>ob_start</function>,
- <function>ob_get_contents</function>, and
+ <function>ob_get_contents</function>,
+ <function>ob_flush</function> and
<function>ob_end_clean</function>.
</para>
</refsect1>
@@ -363,7 +430,8 @@
turns off output buffering.
</para>
<para>
- See also <function>ob_start</function> and
+ See also <function>ob_start</function>,
+ <function>ob_clean</function> and
<function>ob_end_flush</function>.
</para>
</refsect1>
