stream-flush.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="streamwrapper.stream-flush" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>streamWrapper::stream_flush</refname>
  <refpurpose>Flushes the output</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>bool</type><methodname>streamWrapper::stream_flush</methodname>
   <void />
  </methodsynopsis>
  <para>
   This method is called in response to <function>fflush</function> and when the stream is being closed while any unflushed data has been written to it before.
  </para>
  <para>
   If you have cached data in your stream but not yet stored it into the
   underlying storage, you should do so now.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Should return &true; if the cached data was successfully stored (or
   if there was no data to store), or &false; if the data could
   not be stored.
  </para>
 </refsect1>

<!--
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>streamWrapper::stream_flush</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
/* ... */
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
...
]]>
    </screen>
   </example>
  </para>
 </refsect1>
-->

 <refsect1 role="notes"><!-- {{{ -->
  &reftitle.notes;
  <note>
   <para>
    If not implemented, &false; is assumed as the return value.
   </para>
  </note>
 </refsect1><!-- }}} -->
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>fflush</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
-->