mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
8b5940cade
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334605 c90b9560-bf6c-de11-be94-00142212c4b1
101 lines
2.7 KiB
XML
101 lines
2.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml: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 role="description">
|
|
&reftitle.description;
|
|
<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_clean</function> is called.
|
|
</para>
|
|
<para>
|
|
The output buffer must be started by
|
|
<function>ob_start</function> with <link
|
|
linkend="constant.php-output-handler-cleanable">PHP_OUTPUT_HANDLER_CLEANABLE</link>
|
|
and <link
|
|
linkend="constant.php-output-handler-removable">PHP_OUTPUT_HANDLER_REMOVABLE</link>
|
|
flags. Otherwise <function>ob_end_clean</function> will not work.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success; 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>
|
|
</refsect1>
|
|
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<para>
|
|
If the function fails it generates an <constant>E_NOTICE</constant>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<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
|
|
ob_start();
|
|
echo 'Text that won\'t get displayed.';
|
|
ob_end_clean();
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>ob_start</function></member>
|
|
<member><function>ob_get_contents</function></member>
|
|
<member><function>ob_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
|
|
-->
|