ob-implicit-flush.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ob-implicit-flush" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ob_implicit_flush</refname>
  <refpurpose>Turn implicit flush on/off</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>ob_implicit_flush</methodname>
   <methodparam choice="opt"><type>bool</type><parameter>enable</parameter><initializer>&true;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>ob_implicit_flush</function> will turn implicit flushing on or
   off. Implicit flushing will result in a flush operation after every block of
   code resulting in output, so that explicit calls to <function>flush</function>
   will no longer be needed.
  </para>
  <note>
   <simpara>
    Printing empty strings or sending headers is not considered output
    and will not result in a flush operation.
   </simpara>
  </note>
  <note>
   <simpara>
    This function does not have any effect on user level output handlers
    such as those started by <function>ob_start</function>
    or <function>output_add_rewrite_var</function>.
   </simpara>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>enable</parameter></term>
     <listitem>
      <para>
       &true; to turn implicit flushing on, &false; otherwise.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       The <parameter>enable</parameter> expects a <type>bool</type> value now;
       previously, an <type>int</type> was expected.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>flush</function></member>
    <member><function>ob_start</function></member>
    <member><function>ob_end_flush</function></member>
   </simplelist>
  </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:"~/.phpdoc/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
-->