[PHP-DOC] cvs: phpdoc /en/functions outcontrol.xml From: Daniel Beckham (danbeck <email protected>)
Date: 08/25/00

danbeck Fri Aug 25 10:50:16 2000 EDT

  Modified files:
    /phpdoc/en/functions outcontrol.xml
  Log:
  first draft of partinfo, still need to add an example of how to use the functions together.
  
Index: phpdoc/en/functions/outcontrol.xml
diff -u phpdoc/en/functions/outcontrol.xml:1.1 phpdoc/en/functions/outcontrol.xml:1.2
--- phpdoc/en/functions/outcontrol.xml:1.1 Fri Aug 25 07:48:24 2000
+++ phpdoc/en/functions/outcontrol.xml Fri Aug 25 10:50:16 2000
@@ -3,15 +3,31 @@
   <titleabbrev>Output Control</titleabbrev>
 
   <partintro>
- <simpara>
- Output Control
- </simpara>
+ <para>
+ The Output Control functions allow you to control when output is
+ sent from the script. This can be useful in several different
+ situations, especially if you need to send headers to the browser
+ after your script has began outputing data. The Output Control
+ functions do not affect headers sent using
+ <function>header</function>, only functions such as
+ <function>echo</function> and data between blocks of PHP code.
+ </para>
+ <para>
+ <example>
+ <title><function>Output Control</function> example</title>
+ <programlisting role="php">
+ </programlisting>
+ </example>
+ </para>
+ <para>
+ See also <function>header</function>.
+ </para>
   </partintro>
 
   <refentry id="function.flush">
    <refnamediv>
- <refname>flush</refname>
- <refpurpose>Flush the output buffer</refpurpose>
+ <refname>flush</refname> <refpurpose>Flush the output
+ buffer</refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
@@ -43,15 +59,16 @@
      </funcprototype>
     </funcsynopsis>
     <para>
- This function will turn output buffering. While output buffering
- is active there will be no rel output from the script, the output
- is appended to an internal buffer instead.
+ This function will turn output buffering on. While output buffering
+ is active no output is sent from the script, instead the output
+ is stored in an internal buffer.
     </para>
     <para>
      The contents of this internal buffer may be copied into a string
- variable using <function>ob_get_contents</function>. Real output
- happens when <function>ob_end_flush</function> is called and
- <function>ob_end_clean</function> will just silently discard the
+ variable using <function>ob_get_contents</function>. To output
+ what is stored in the internal buffer, use
+ <function>ob_end_flush</function>. Alternatively,
+ <function>ob_end_clean</function> will silently discard the
      buffer contents.
     </para>
     <para>
@@ -79,7 +96,7 @@
      </funcprototype>
     </funcsynopsis>
     <para>
- This will return the content of the output buffer or FALSE, if
+ This will return the contents of the output buffer or FALSE, if
      output buffering isn't active.
     </para>
     <para>
@@ -108,10 +125,10 @@
     <para>
      This function will send the contents of the output buffer (if
      any) and turn output buffering off. If you want to further
- process the buffers content you have to call
+ process the buffer's contents you have to call
      <function>ob_get_contents</function> before
- <function>ob_end_flush</function> as the buffer contents get
- discarded after output.
+ <function>ob_end_flush</function> as the buffer contents are
+ discarded after <function>ob_get_contents</function> is called.
     </para>
     <para>
      See also <function>ob_start</function>,
@@ -137,8 +154,8 @@
      </funcprototype>
     </funcsynopsis>
     <para>
- This function discards the content of the output buffer and
- turns off output buffering.
+ This function discards the contents of the output buffer and
+ turns off output buffering.
     </para>
     <para>
      See also <function>ob_start</function> and