-
Notifications
You must be signed in to change notification settings - Fork 72
/
ob-start.xml
283 lines (269 loc) · 10.6 KB
/
ob-start.xml
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: da6be21fef84d61cc4c621b3fe1d5fd2c9046c45 Maintainer: mch Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.ob-start" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ob_start</refname>
<refpurpose>Включает буферизацию вывода</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ob_start</methodname>
<methodparam choice="opt"><type class="union"><type>callable</type><type>null</type></type><parameter>callback</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>chunk_size</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>PHP_OUTPUT_HANDLER_STDFLAGS</constant></initializer></methodparam>
</methodsynopsis>
<para>
Функция включает буферизацию вывода. Пока буферизация вывода активна,
вывод из скрипта не отправляется, вместо этого вывод сохраняется во внутреннем буфере.
Раздел «<xref linkend="outcontrol.what-output-is-buffered"/>»
рассказывает, на какой именно вывод это влияет.
</para>
<para>
Буферы вывода помещаются в стек,
поэтому функцию <function>ob_start</function> разрешается вызывать
при другом активном буфере.
Если активировали несколько буферов вывода,
вывод фильтруется последовательно
через каждый из буферов в порядке вложенности.
Подробнее об этом рассказывает раздел «<xref linkend="outcontrol.nesting-output-buffers"/>».
</para>
<para>
Подробное описание буферов вывода даёт раздел «<xref linkend="outcontrol.user-level-output-buffers"/>».
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>callback</parameter></term>
<listitem>
<para>
Параметр <parameter>callback</parameter> принимает необязательный
аргумент с типом <type>callable</type>.
Когда требуется, чтобы при вызове с аргументами
функция не вызывала callback-функцию, в параметр передают значение &null;.
</para>
<para>
Функция, которую передали в параметр <parameter>callback</parameter>, вызывается
при вызове функций сброса (отправки) или очистки буфера вывода,
или при сбросе буфера вывода в конце скрипта.
</para>
<para>
Сигнатура <parameter>callback</parameter>-функции:
</para>
<para>
<methodsynopsis>
<type>string</type><methodname><replaceable>handler</replaceable></methodname>
<methodparam><type>string</type><parameter>buffer</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>phase</parameter></methodparam>
</methodsynopsis>
<variablelist>
<varlistentry>
<term><parameter>buffer</parameter></term>
<listitem>
<simpara>
Содержимое буфера вывода.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>phase</parameter></term>
<listitem>
<simpara>
Битовая маска из семейства констант
<link linkend="constant.php-output-handler-start">
<constant>PHP_OUTPUT_HANDLER_<replaceable>*</replaceable></constant>
</link>.
Подробнее о флагах рассказывает раздел
«<xref linkend="outcontrol.flags-passed-to-output-handlers"/>».
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
Если параметр <parameter>callback</parameter> вернёт &false;,
возвращается содержимое буфера.
Подробнее об этом рассказывает раздел
«<xref linkend="outcontrol.output-handler-return-values"/>».
</para>
<warning>
<simpara>
Вызов любой из следующих функций из обработчика вывода
выдаст фатальную ошибку:
<function>ob_clean</function>, <function>ob_end_clean</function>,
<function>ob_end_flush</function>, <function>ob_flush</function>,
<function>ob_get_clean</function>, <function>ob_get_flush</function>,
<function>ob_start</function>.
</simpara>
</warning>
<para>
Подробнее о <parameter>callback</parameter>-функциях (обработчиках вывода)
рассказывают разделы «<xref linkend="outcontrol.output-handlers"/>»
и «<xref linkend="outcontrol.working-with-output-handlers"/>».
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>chunk_size</parameter></term>
<listitem>
<para>
Буфер будет сбрасываться после каждого блока кода,
размер буфера которого достиг или превысил
значение параметра <parameter>chunk_size</parameter>,
если передали необязательный параметр <parameter>chunk_size</parameter>.
Значение по умолчанию <literal>0</literal> означает,
что вывод буферизуется до тех пор, пока буфер не выключится.
Подробнее об этом рассказывает раздел «<xref linkend="outcontrol.buffer-size"/>».
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Параметр <parameter>flags</parameter> — битовая маска, которая
управляет операциями с буфером вывода.
По умолчанию разрешаются очистка, сброс и удаление буферов вывода,
что явно устанавливается
<link linkend="outcontrol.constants.buffer-control-flags">
флагами управления буфером
</link>.
Подробнее об этом рассказывает раздел «<xref linkend="outcontrol.operations-on-buffers"/>».
</para>
<para>
Каждый флаг управляет доступом к набору функций, как описывает таблица:
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Константа</entry>
<entry>Функции</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>PHP_OUTPUT_HANDLER_CLEANABLE</constant></entry>
<entry>
<function>ob_clean</function>
</entry>
</row>
<row>
<entry><constant>PHP_OUTPUT_HANDLER_FLUSHABLE</constant></entry>
<entry>
<function>ob_flush</function>
</entry>
</row>
<row>
<entry><constant>PHP_OUTPUT_HANDLER_REMOVABLE</constant></entry>
<entry>
<function>ob_end_clean</function>,
<function>ob_end_flush</function>,
<function>ob_get_clean</function>,
<function>ob_get_flush</function>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример пользовательской callback-функции</title>
<programlisting role="php">
<![CDATA[
<?php
function callback($buffer)
{
// Заменить каждое яблоко апельсином
return (str_replace("яблоки", "апельсины", $buffer));
}
ob_start("callback");
?>
<html>
<body>
<p>Это всё равно, что сравнить яблоки и апельсины.</p>
</body>
</html>
<?php
ob_end_flush();
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
<html>
<body>
<p>Это всё равно, что сравнить апельсины и апельсины.</p>
</body>
</html>
]]>
</screen>
</example>
</para>
<para>
<example xml:id="function.ob-start.flags-bc">
<title>Пример нестираемого буфера вывода</title>
<programlisting role="php">
<![CDATA[
<?php
ob_start(null, 0, PHP_OUTPUT_HANDLER_STDFLAGS ^ PHP_OUTPUT_HANDLER_REMOVABLE);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ob_get_contents</function></member>
<member><function>ob_end_clean</function></member>
<member><function>ob_end_flush</function></member>
<member><function>ob_implicit_flush</function></member>
<member><function>ob_gzhandler</function></member>
<member><function>ob_iconv_handler</function></member>
<member><function>mb_output_handler</function></member>
<member><function>ob_tidyhandler</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
-->