sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

added description of output fields

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@203793 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hartmut Holzgraefe 2005-12-27 21:08:51 +00:00
parent 611975374e
commit f953a0f164
1 changed files with 87 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

93
reference/outcontrol/functions/ob-get-status.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.ob-get-status">
<refnamediv>
<refname>ob_get_status</refname>
@ -11,16 +11,97 @@
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>ob_get_status</methodname>
<methodparam choice="opt"><type>bool</type><parameter>
full_status</parameter>
<methodparam choice="opt">
<type>bool</type>
<parameter>full_status</parameter>
<initializer>FALSE</initializer>
</methodparam>
</methodsynopsis>
<para>
This will return the current status of output buffers. It returns
array contains buffer status or &false; for error.
<function>ob_get_status</function> returns status information on
either the top level output buffer or all active output buffer levels
if <parameter>full_status</parameter> is set to &true;.
</para>
<para>
See also <function>ob_get_level</function>.
If called without the <parameter>full_status</parameter> parameter
or with <parameter>full_status</parameter> = &false; a simple array
with the following elements is returned:
</para>
<example>
<title>Simple <function>ob_get_status</function> output</title>
<screen>
Array
(
[level] => 2
[type] => 0
[status] => 0
[name] => URL-Rewriter
[del] => 1
)
</screen>
</example>
<para>
<segmentedlist>
<title>Simple <function>ob_get_status</function> results</title>
<segtitle>Key</segtitle><segtitle>Value</segtitle>
<seglistitem><seg>level</seg><seg>Output nesting level</seg></seglistitem>
<seglistitem><seg>type</seg><seg><literal>PHP_OUTPUT_HANDLER_INTERNAL (0)</literal> or <literal>PHP_OUTPUT_HANDLER_USER (1)</literal></seg></seglistitem>
<seglistitem><seg>status</seg><seg>One of <literal>PHP_OUTPUT_HANDLER_START</literal> (0), <literal>PHP_OUTPUT_HANDLER_CONT</literal> (1) or <literal>PHP_OUTPUT_HANDLER_END</literal> (2)</seg></seglistitem>
<seglistitem><seg>name</seg><seg>Name of active output handler or ' default output handler' if none is set</seg></seglistitem>
<seglistitem><seg>del</seg><seg>Erase-flag as set by <function>ob_start</function></seg></seglistitem>
</segmentedlist>
</para>
<para>
If called with <parameter>full_status</parameter> = &true; an array
with one element for each active output buffer level is returned.
The output level is used as key of the top level array and each array
element itself is another array holding status information
on one active output level.
</para>
<example>
<title>Full <function>ob_get_status</function> output</title>
<screen>
Array
(
[0] => Array
(
[chunk_size] => 0
[size] => 40960
[block_size] => 10240
[type] => 1
[status] => 0
[name] => default output handler
[del] => 1
)
[1] => Array
(
[chunk_size] => 0
[size] => 40960
[block_size] => 10240
[type] => 0
[buffer_size] => 0
[status] => 0
[name] => URL-Rewriter
[del] => 1
)
)
</screen>
</example>
<para>
The full output contains these additional elements:
<segmentedlist>
<title>Full <function>ob_get_status</function> results</title>
<segtitle>Key</segtitle><segtitle>Value</segtitle>
<seglistitem><seg>chunk_size</seg><seg>Chunk size as set by <function>ob_start</function></seg></seglistitem>
<seglistitem><seg>size</seg><seg>...</seg></seglistitem>
<seglistitem><seg>blocksize</seg><seg>...</seg></seglistitem>
</segmentedlist>
</para>
<para>
See also <function>ob_get_level</function> and
<function>ob_list_handlers</function>.
</para>
</refsect1>
</refentry>