1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ob-get-clean" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ob_get_clean</refname>
<refpurpose>Get the contents of the active output buffer and turn it off</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>ob_get_clean</methodname>
<void/>
</methodsynopsis>
<para>
This function calls the output handler
(with the <constant>PHP_OUTPUT_HANDLER_CLEAN</constant> and
<constant>PHP_OUTPUT_HANDLER_FINAL</constant> flags),
discards it's return value,
returns the contents of the active output buffer
and turns off the active output buffer.
</para>
<para>
<function>ob_get_clean</function> will fail
without an active output buffer started with the
<constant>PHP_OUTPUT_HANDLER_REMOVABLE</constant> flag.
</para>
<para>
<function>ob_get_clean</function>
will discard the contents of the active output buffer
even if it was started without the
<constant>PHP_OUTPUT_HANDLER_CLEANABLE</constant> flag.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the contents of the active output buffer on success
or &false; on failure.
</para>
<caution>
<simpara>
<function>ob_get_clean</function> will return false
but will not generate an <constant>E_NOTICE</constant>
if there is no active output buffer.
</simpara>
</caution>
</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>
<example>
<title>A simple <function>ob_get_clean</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
ob_start();
echo "Hello World";
$out = ob_get_clean();
$out = strtolower($out);
var_dump($out);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
string(11) "hello world"
]]>
</screen>
</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_clean</function></member>
<member><function>ob_end_clean</function></member>
<member><function>ob_get_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
-->
|
