mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 22:08:55 +00:00
6594e7a19a
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@132016 c90b9560-bf6c-de11-be94-00142212c4b1
80 lines
2.3 KiB
XML
80 lines
2.3 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.7 $ -->
|
|
<!-- splitted from ./en/functions/outcontrol.xml, last change in rev 1.1 -->
|
|
<refentry id="function.ob-end-clean">
|
|
<refnamediv>
|
|
<refname>ob_end_clean</refname>
|
|
<refpurpose>
|
|
Clean (erase) the output buffer and turn off output buffering
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ob_end_clean</methodname>
|
|
<void/>
|
|
</methodsynopsis>
|
|
<para>
|
|
This function discards the contents of the topmost output buffer and
|
|
turns off this output buffering. If you want to further
|
|
process the buffer's contents you have to call
|
|
<function>ob_get_contents</function> before
|
|
<function>ob_end_clean</function> as the buffer contents are
|
|
discarded when <function>ob_end_flush</function> is called.
|
|
The function returns &true; when it successfully
|
|
discarded one buffer and &false; otherwise. Reasons for failure are first
|
|
that you called the function without an active buffer or that for some
|
|
reason a buffer could not be deleted (possible for special buffer).
|
|
</para>
|
|
<para>
|
|
The following example shows an easy way to get rid of all output buffers:
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title><function>ob_end_clean</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
while (@ob_end_clean());
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<note>
|
|
<simpara>
|
|
If the function fails it generates an E_NOTICE.
|
|
</simpara>
|
|
<simpara>
|
|
The boolean return value was added in PHP 4.2.0.
|
|
</simpara>
|
|
</note>
|
|
<para>
|
|
See also <function>ob_start</function>,
|
|
<function>ob_get_contents</function>,
|
|
<function>ob_flush</function> and
|
|
<function>ob_end_clean</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
|
|
-->
|