new function

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@147773 c90b9560-bf6c-de11-be94-00142212c4b1

reference/outcontrol/functions/ob-get-flush.xml

@@ -0,0 +1,90 @@
+<?xml version='1.0' encoding='iso-8859-1'?>
+<!-- $Revision: 1.1 $ -->
+  <refentry id="function.ob-get-flush">
+   <refnamediv>
+    <refname>ob_get_flush</refname>
+    <refpurpose>
+     Flush the output buffer, return it as a string and turn off output buffering
+    </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>string</type><methodname>ob_get_flush</methodname>
+     <void/>
+    </methodsynopsis>
+    <para><function>ob_get_flush</function> flushs the output buffer, return
+     it as a string and turns off output buffering.
+     <function>ob_get_flush</function> returns &false; if no buffering is
+     active.
+    </para>
+    <note>
+     <simpara>
+      This function is similar to <function>ob_end_flush</function>, except
+      that this function returns the buffer as a string.
+     </simpara>
+    </note>
+    <para>
+     <example>
+      <title><function>ob_get_flush</function> example</title>
+      <programlisting role="php">
+<![CDATA[
+<?php
+//using output_buffering=On
+print_r(ob_list_handlers());
+
+//this will output everything in buffer
+echo ob_get_flush();
+
+print_r(ob_list_handlers());
+?>
+]]>
+      </programlisting>
+      <para>
+       The above example will output:
+      </para>
+      <screen>
+<![CDATA[
+Array
+(
+    [0] => default output handler
+)
+Array
+(
+    [0] => default output handler
+)
+Array
+(
+)
+]]>
+      </screen>
+     </example>
+    </para>
+    <para>
+     See also <function>ob_end_clean</function>,
+     <function>ob_end_flush</function> and
+     <function>ob_list_handlers</function>.
+    </para>
+   </refsect1>
+  </refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->