reference/outcontrol/constants.xml
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>integer</type>)
14
+
(<type>int</type>)
11
15
</term>
12
16
<listitem>
13
17
<para>
...
...
@@ -18,63 +22,51 @@
18
22
<varlistentry xml:id="constant.php-output-handler-write">
19
23
<term>
20
24
<constant>PHP_OUTPUT_HANDLER_WRITE</constant>
21
-
(<type>integer</type>)
25
+
(<type>int</type>)
22
26
</term>
23
27
<listitem>
24
28
<para>
25
29
Indicates that the output buffer is being flushed, and had data to output.
26
30
</para>
27
-
<para>
28
-
Available since PHP 5.4.
29
-
</para>
30
31
</listitem>
31
32
</varlistentry>
32
33
<varlistentry xml:id="constant.php-output-handler-flush">
33
34
<term>
34
35
<constant>PHP_OUTPUT_HANDLER_FLUSH</constant>
35
-
(<type>integer</type>)
36
+
(<type>int</type>)
36
37
</term>
37
38
<listitem>
38
39
<para>
39
40
Indicates that the buffer has been flushed.
40
41
</para>
41
-
<para>
42
-
Available since PHP 5.4.
43
-
</para>
44
42
</listitem>
45
43
</varlistentry>
46
44
<varlistentry xml:id="constant.php-output-handler-clean">
47
45
<term>
48
46
<constant>PHP_OUTPUT_HANDLER_CLEAN</constant>
49
-
(<type>integer</type>)
47
+
(<type>int</type>)
50
48
</term>
51
49
<listitem>
52
50
<para>
53
51
Indicates that the output buffer has been cleaned.
54
52
</para>
55
-
<para>
56
-
Available since PHP 5.4.
57
-
</para>
58
53
</listitem>
59
54
</varlistentry>
60
55
<varlistentry xml:id="constant.php-output-handler-final">
61
56
<term>
62
57
<constant>PHP_OUTPUT_HANDLER_FINAL</constant>
63
-
(<type>integer</type>)
58
+
(<type>int</type>)
64
59
</term>
65
60
<listitem>
66
61
<para>
67
62
Indicates that this is the final output buffering operation.
68
63
</para>
69
-
<para>
70
-
Available since PHP 5.4.
71
-
</para>
72
64
</listitem>
73
65
</varlistentry>
74
66
<varlistentry xml:id="constant.php-output-handler-cont">
75
67
<term>
76
68
<constant>PHP_OUTPUT_HANDLER_CONT</constant>
77
-
(<type>integer</type>)
69
+
(<type>int</type>)
78
70
</term>
79
71
<listitem>
80
72
<para>
...
...
@@ -82,7 +74,7 @@
82
74
continue.
83
75
</para>
84
76
<para>
85
-
As of PHP 5.4, this is an alias for
77
+
This is an alias for
86
78
<constant>PHP_OUTPUT_HANDLER_WRITE</constant>.
87
79
</para>
88
80
</listitem>
...
...
@@ -90,67 +82,72 @@
90
82
<varlistentry xml:id="constant.php-output-handler-end">
91
83
<term>
92
84
<constant>PHP_OUTPUT_HANDLER_END</constant>
93
-
(<type>integer</type>)
85
+
(<type>int</type>)
94
86
</term>
95
87
<listitem>
96
88
<para>
97
89
Indicates that output buffering has ended.
98
90
</para>
99
91
<para>
100
-
As of PHP 5.4, this is an alias for
92
+
This is an alias for
101
93
<constant>PHP_OUTPUT_HANDLER_FINAL</constant>.
102
94
</para>
103
95
</listitem>
104
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>
105
103
<varlistentry xml:id="constant.php-output-handler-cleanable">
106
104
<term>
107
105
<constant>PHP_OUTPUT_HANDLER_CLEANABLE</constant>
108
-
(<type>integer</type>)
106
+
(<type>int</type>)
109
107
</term>
110
108
<listitem>
111
109
<para>
112
110
Controls whether an output buffer created by
113
-
<function>ob_start</function> can be cleaned.
114
-
</para>
115
-
<para>
116
-
Available since PHP 5.4.
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>.
117
115
</para>
118
116
</listitem>
119
117
</varlistentry>
120
118
<varlistentry xml:id="constant.php-output-handler-flushable">
121
119
<term>
122
120
<constant>PHP_OUTPUT_HANDLER_FLUSHABLE</constant>
123
-
(<type>integer</type>)
121
+
(<type>int</type>)
124
122
</term>
125
123
<listitem>
126
124
<para>
127
125
Controls whether an output buffer created by
128
-
<function>ob_start</function> can be flushed.
129
-
</para>
130
-
<para>
131
-
Available since PHP 5.4.
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>.
132
130
</para>
133
131
</listitem>
134
132
</varlistentry>
135
133
<varlistentry xml:id="constant.php-output-handler-removable">
136
134
<term>
137
135
<constant>PHP_OUTPUT_HANDLER_REMOVABLE</constant>
138
-
(<type>integer</type>)
136
+
(<type>int</type>)
139
137
</term>
140
138
<listitem>
141
139
<para>
142
140
Controls whether an output buffer created by
143
-
<function>ob_start</function> can be removed before the end of the script.
144
-
</para>
145
-
<para>
146
-
Available since PHP 5.4.
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>.
147
144
</para>
148
145
</listitem>
149
146
</varlistentry>
150
147
<varlistentry xml:id="constant.php-output-handler-stdflags">
151
148
<term>
152
149
<constant>PHP_OUTPUT_HANDLER_STDFLAGS</constant>
153
-
(<type>integer</type>)
150
+
(<type>int</type>)
154
151
</term>
155
152
<listitem>
156
153
<para>
...
...
@@ -159,14 +156,53 @@
159
156
<constant>PHP_OUTPUT_HANDLER_FLUSHABLE</constant> |
160
157
<constant>PHP_OUTPUT_HANDLER_REMOVABLE</constant>.
161
158
</para>
159
+
</listitem>
160
+
</varlistentry>
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>
162
199
<para>
163
-
Available since PHP 5.4.
200
+
Indicates that the output handler successfully processed the buffer.
164
201
</para>
165
202
</listitem>
166
203
</varlistentry>
167
204
</variablelist>
168
205
</appendix>
169
-

170
206
<!-- Keep this comment at the end of the file
171
207
Local variables:
172
208
mode: sgml
...
...
@@ -187,4 +223,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
187
223
vim: et tw=78 syn=sgml
188
224
vi: ts=1 sw=1
189
225
-->
190
-
191
226