Skip to content

Update ob_get_status and ob_start documentation #5260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lacatoire wants to merge 1 commit into
base: master
Choose a base branch
from
+17 −3
Open

Update ob_get_status and ob_start documentation #5260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion reference/outcontrol/functions/ob-get-status.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,14 @@
<seglistitem>
<seg>buffer_size</seg>
<seg>
Output buffer size in bytes
Currently allocated size of the output buffer in bytes.
It starts at <literal>16384</literal> bytes with the default
<parameter>chunk_size</parameter>, or at
<parameter>chunk_size</parameter> rounded up to the next multiple of
<literal>4096</literal> when one is given, and grows in multiples of
<literal>4096</literal> as more output is buffered.
This is not the amount of data in the buffer (see
<literal>buffer_used</literal>).
</seg>
</seglistitem>
<seglistitem>
Expand Down
11 changes: 9 additions & 2 deletions reference/outcontrol/functions/ob-start.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,15 +111,22 @@
<varlistentry>
<term><parameter>chunk_size</parameter></term>
<listitem>
<para>
<simpara>
If the optional parameter <parameter>chunk_size</parameter> is passed,
the buffer will be flushed after any block of code resulting in output
that causes the buffer's length to equal
or exceed <parameter>chunk_size</parameter>.
The default value <literal>0</literal> means
that all output is buffered until the buffer is turned off.
A value of <literal>1</literal> means the buffer will be flushed
after every output operation, effectively disabling buffering.
<parameter>chunk_size</parameter> also determines the initial size of
the buffer reported by <function>ob_get_status</function>:
<literal>16384</literal> bytes when it is <literal>0</literal>, and
<parameter>chunk_size</parameter> rounded up to the next multiple of
<literal>4096</literal> otherwise.
See <xref linkend="outcontrol.buffer-size"/> for more details.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
Expand Down