reference/outcontrol/constants.xml
af7044e82ac0abe745ce3dfe2169e69a7e8e342f
af7044e82ac0abe745ce3dfe2169e69a7e8e342f
...
...
@@ -3,11 +3,15 @@
3
3
<appendix xml:id="outcontrol.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
4
4
&reftitle.constants;
5
5
&extension.constants.core;
6
-
<variablelist>
6
+
<variablelist xml:id="outcontrol.constants.flags-passed-to-handler">
7
+
<title>Status flags passed to output handler</title>
8
+
<para>
9
+
The following flags are passed to the second (<parameter>phase</parameter>) parameter of the output handler set by <function>ob_start</function> as part of a bitmask:
10
+
</para>
7
11
<varlistentry xml:id="constant.php-output-handler-start">
8
12
<term>
9
13
<constant>PHP_OUTPUT_HANDLER_START</constant>
10
-
(<type>int</type>)
14
+
(<type>int</type>)
11
15
</term>
12
16
<listitem>
13
17
<para>
...
...
@@ -18,7 +22,7 @@
18
22
<varlistentry xml:id="constant.php-output-handler-write">
19
23
<term>
20
24
<constant>PHP_OUTPUT_HANDLER_WRITE</constant>
21
-
(<type>int</type>)
25
+
(<type>int</type>)
22
26
</term>
23
27
<listitem>
24
28
<para>
...
...
@@ -29,7 +33,7 @@
29
33
<varlistentry xml:id="constant.php-output-handler-flush">
30
34
<term>
31
35
<constant>PHP_OUTPUT_HANDLER_FLUSH</constant>
32
-
(<type>int</type>)
36
+
(<type>int</type>)
33
37
</term>
34
38
<listitem>
35
39
<para>
...
...
@@ -40,7 +44,7 @@
40
44
<varlistentry xml:id="constant.php-output-handler-clean">
41
45
<term>
42
46
<constant>PHP_OUTPUT_HANDLER_CLEAN</constant>
43
-
(<type>int</type>)
47
+
(<type>int</type>)
44
48
</term>
45
49
<listitem>
46
50
<para>
...
...
@@ -51,7 +55,7 @@
51
55
<varlistentry xml:id="constant.php-output-handler-final">
52
56
<term>
53
57
<constant>PHP_OUTPUT_HANDLER_FINAL</constant>
54
-
(<type>int</type>)
58
+
(<type>int</type>)
55
59
</term>
56
60
<listitem>
57
61
<para>
...
...
@@ -62,7 +66,7 @@
62
66
<varlistentry xml:id="constant.php-output-handler-cont">
63
67
<term>
64
68
<constant>PHP_OUTPUT_HANDLER_CONT</constant>
65
-
(<type>int</type>)
69
+
(<type>int</type>)
66
70
</term>
67
71
<listitem>
68
72
<para>
...
...
@@ -78,7 +82,7 @@
78
82
<varlistentry xml:id="constant.php-output-handler-end">
79
83
<term>
80
84
<constant>PHP_OUTPUT_HANDLER_END</constant>
81
-
(<type>int</type>)
85
+
(<type>int</type>)
82
86
</term>
83
87
<listitem>
84
88
<para>
...
...
@@ -90,46 +94,60 @@
90
94
</para>
91
95
</listitem>
92
96
</varlistentry>
97
+
</variablelist>
98
+
<variablelist xml:id="outcontrol.constants.buffer-control-flags">
99
+
<title>Output buffer control flags</title>
100
+
<para>
101
+
The following flags can be passed to the third (<parameter>flags</parameter>) parameter of the output handler set by <function>ob_start</function> as a bitmask:
102
+
</para>
93
103
<varlistentry xml:id="constant.php-output-handler-cleanable">
94
104
<term>
95
105
<constant>PHP_OUTPUT_HANDLER_CLEANABLE</constant>
96
-
(<type>int</type>)
106
+
(<type>int</type>)
97
107
</term>
98
108
<listitem>
99
109
<para>
100
110
Controls whether an output buffer created by
101
-
<function>ob_start</function> can be cleaned.
111
+
<function>ob_start</function> can be cleaned
112
+
by <function>ob_clean</function>.
113
+
This flag does not control the behaviour of
114
+
<function>ob_end_clean</function> or <function>ob_get_clean</function>.
102
115
</para>
103
116
</listitem>
104
117
</varlistentry>
105
118
<varlistentry xml:id="constant.php-output-handler-flushable">
106
119
<term>
107
120
<constant>PHP_OUTPUT_HANDLER_FLUSHABLE</constant>
108
-
(<type>int</type>)
121
+
(<type>int</type>)
109
122
</term>
110
123
<listitem>
111
124
<para>
112
125
Controls whether an output buffer created by
113
-
<function>ob_start</function> can be flushed.
126
+
<function>ob_start</function> can be flushed
127
+
by <function>ob_flush</function>.
128
+
This flag does not control the behaviour of
129
+
<function>ob_end_flush</function> or <function>ob_get_flush</function>.
114
130
</para>
115
131
</listitem>
116
132
</varlistentry>
117
133
<varlistentry xml:id="constant.php-output-handler-removable">
118
134
<term>
119
135
<constant>PHP_OUTPUT_HANDLER_REMOVABLE</constant>
120
-
(<type>int</type>)
136
+
(<type>int</type>)
121
137
</term>
122
138
<listitem>
123
139
<para>
124
140
Controls whether an output buffer created by
125
-
<function>ob_start</function> can be removed before the end of the script.
141
+
<function>ob_start</function> can be removed before the end of the script
142
+
or when calling <function>ob_end_clean</function>, <function>ob_end_flush</function>,
143
+
<function>ob_get_clean</function> or <function>ob_get_flush</function>.
126
144
</para>
127
145
</listitem>
128
146
</varlistentry>
129
147
<varlistentry xml:id="constant.php-output-handler-stdflags">
130
148
<term>
131
149
<constant>PHP_OUTPUT_HANDLER_STDFLAGS</constant>
132
-
(<type>int</type>)
150
+
(<type>int</type>)
133
151
</term>
134
152
<listitem>
135
153
<para>
...
...
@@ -141,8 +159,50 @@
141
159
</listitem>
142
160
</varlistentry>
143
161
</variablelist>
162
+
<variablelist xml:id="outcontrol.constants.flags-returned-by-handler">
163
+
<title>Output handler status flags</title>
164
+
<para>
165
+
The following flags are part of the <literal>flags</literal> bitmask
166
+
returned by <function>ob_get_status</function>:
167
+
</para>
168
+
<varlistentry xml:id="constant.php-output-handler-started">
169
+
<term>
170
+
<constant>PHP_OUTPUT_HANDLER_STARTED</constant>
171
+
(<type>int</type>)
172
+
</term>
173
+
<listitem>
174
+
<para>
175
+
Indicates that the output handler was called.
176
+
</para>
177
+
</listitem>
178
+
</varlistentry>
179
+
<varlistentry xml:id="constant.php-output-handler-disabled">
180
+
<term>
181
+
<constant>PHP_OUTPUT_HANDLER_DISABLED</constant>
182
+
(<type>int</type>)
183
+
</term>
184
+
<listitem>
185
+
<para>
186
+
Indicates that the output handler is disabled.
187
+
This flag is set when the output handler returns &false;
188
+
or fails while processing the buffer,
189
+
or it was set prior to calling the output handler.
190
+
</para>
191
+
</listitem>
192
+
</varlistentry>
193
+
<varlistentry xml:id="constant.php-output-handler-processed">
194
+
<term>
195
+
<constant>PHP_OUTPUT_HANDLER_PROCESSED</constant>
196
+
(<type>int</type>)
197
+
</term>
198
+
<listitem>
199
+
<para>
200
+
Indicates that the output handler successfully processed the buffer.
201
+
</para>
202
+
</listitem>
203
+
</varlistentry>
204
+
</variablelist>
144
205
</appendix>
145
-
146
206
<!-- Keep this comment at the end of the file
147
207
Local variables:
148
208
mode: sgml
...
...
@@ -163,4 +223,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
163
223
vim: et tw=78 syn=sgml
164
224
vi: ts=1 sw=1
165
225
-->
166
-
167
226