reference/outcontrol/functions/ob-implicit-flush.xml
1cdb6d04aa0d5c15c73337d0dca75d67e0f2e48e
1cdb6d04aa0d5c15c73337d0dca75d67e0f2e48e
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ob-implicit-flush">
3
+
<refentry xml:id="function.ob-implicit-flush" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>ob_implicit_flush</refname>
6
6
<refpurpose>Turn implicit flush on/off</refpurpose>
...
...
@@ -10,14 +10,27 @@
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>void</type><methodname>ob_implicit_flush</methodname>
13
-
<methodparam choice="opt"><type>int</type><parameter>flag</parameter><initializer>true</initializer></methodparam>
13
+
<methodparam choice="opt"><type>bool</type><parameter>enable</parameter><initializer>&true;</initializer></methodparam>
14
14
</methodsynopsis>
15
15
<para>
16
16
<function>ob_implicit_flush</function> will turn implicit flushing on or
17
-
off. Implicit flushing will result in a flush operation after every output
18
-
call, so that explicit calls to <function>flush</function> will no longer
19
-
be needed.
17
+
off. Implicit flushing will result in a flush operation after every block of
18
+
code resulting in output, so that explicit calls to <function>flush</function>
19
+
will no longer be needed.
20
20
</para>
21
+
<note>
22
+
<simpara>
23
+
Printing empty strings or sending headers is not considered output
24
+
and will not result in a flush operation.
25
+
</simpara>
26
+
</note>
27
+
<note>
28
+
<simpara>
29
+
This function does not have any effect on user level output handlers
30
+
such as those started by <function>ob_start</function>
31
+
or <function>output_add_rewrite_var</function>.
32
+
</simpara>
33
+
</note>
21
34
</refsect1>
22
35
23
36
<refsect1 role="parameters">
...
...
@@ -25,7 +38,7 @@
25
38
<para>
26
39
<variablelist>
27
40
<varlistentry>
28
-
<term><parameter>flag</parameter></term>
41
+
<term><parameter>enable</parameter></term>
29
42
<listitem>
30
43
<para>
31
44
&true; to turn implicit flushing on, &false; otherwise.
...
...
@@ -43,6 +56,29 @@
43
56
</para>
44
57
</refsect1>
45
58
59
+
<refsect1 role="changelog">
60
+
&reftitle.changelog;
61
+
<informaltable>
62
+
<tgroup cols="2">
63
+
<thead>
64
+
<row>
65
+
<entry>&Version;</entry>
66
+
<entry>&Description;</entry>
67
+
</row>
68
+
</thead>
69
+
<tbody>
70
+
<row>
71
+
<entry>8.0.0</entry>
72
+
<entry>
73
+
The <parameter>enable</parameter> expects a <type>bool</type> value now;
74
+
previously, an <type>int</type> was expected.
75
+
</entry>
76
+
</row>
77
+
</tbody>
78
+
</tgroup>
79
+
</informaltable>
80
+
</refsect1>
81
+
46
82
<refsect1 role="seealso">
47
83
&reftitle.seealso;
48
84
<para>
...
...
@@ -55,7 +91,6 @@
55
91
</refsect1>
56
92
57
93
</refentry>
58
-
59
94
<!-- Keep this comment at the end of the file
60
95
Local variables:
61
96
mode: sgml
62
97