reference/outcontrol/functions/ob-flush.xml
a866f72f5334d05a2cdfe9dd423eedd071192ff8
a866f72f5334d05a2cdfe9dd423eedd071192ff8
...
...
@@ -1,34 +1,50 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ob-flush">
3
+
<refentry xml:id="function.ob-flush" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>ob_flush</refname>
6
-
<refpurpose>Flush (send) the output buffer</refpurpose>
6
+
<refpurpose>Flush (send) the return value of the active output handler</refpurpose>
7
7
</refnamediv>
8
8
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>void</type><methodname>ob_flush</methodname>
12
+
<type>bool</type><methodname>ob_flush</methodname>
13
13
<void/>
14
14
</methodsynopsis>
15
15
<para>
16
-
This function will send the contents of the output buffer (if any). If you
17
-
want to further process the buffer's contents you have to call
18
-
<function>ob_get_contents</function> before <function>ob_flush</function>
19
-
as the buffer contents are discarded after <function>ob_flush</function>
20
-
is called.
16
+
This function calls the output handler
17
+
(with the <constant>PHP_OUTPUT_HANDLER_FLUSH</constant> flag),
18
+
flushes (sends) its return value
19
+
and discards the contents of the active output buffer.
21
20
</para>
22
21
<para>
23
-
This function does not destroy the output buffer like
24
-
<function>ob_end_flush</function> does.
22
+
This function does not turn off the active output buffer like
23
+
<function>ob_end_flush</function> or <function>ob_get_flush</function> does.
25
24
</para>
25
+
<para>
26
+
<function>ob_flush</function> will fail
27
+
without an active output buffer started with the
28
+
<constant>PHP_OUTPUT_HANDLER_FLUSHABLE</constant> flag.
29
+
</para>
30
+
</refsect1>
31
+
32
+
<refsect1 role="parameters">
33
+
&reftitle.parameters;
34
+
&no.function.parameters;
26
35
</refsect1>
27
36
28
37
<refsect1 role="returnvalues">
29
38
&reftitle.returnvalues;
30
39
<para>
31
-
&return.void;
40
+
&return.success;
41
+
</para>
42
+
</refsect1>
43
+
44
+
<refsect1 role="errors">
45
+
&reftitle.errors;
46
+
<para>
47
+
If the function fails it generates an <constant>E_NOTICE</constant>.
32
48
</para>
33
49
</refsect1>
34
50
...
...
@@ -36,16 +52,16 @@
36
52
&reftitle.seealso;
37
53
<para>
38
54
<simplelist>
55
+
<member><function>ob_start</function></member>
39
56
<member><function>ob_get_contents</function></member>
40
-
<member><function>ob_clean</function></member>
41
57
<member><function>ob_end_flush</function></member>
42
-
<member><function>ob_end_clean</function></member>
58
+
<member><function>ob_get_flush</function></member>
59
+
<member><function>ob_clean</function></member>
43
60
</simplelist>
44
61
</para>
45
62
</refsect1>
46
63
47
64
</refentry>
48
-
49
65
<!-- Keep this comment at the end of the file
50
66
Local variables:
51
67
mode: sgml
52
68