Source of: /manual/en/function.ob-get-status.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.outcontrol.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.ob-get-status.php',
1 => 'ob_get_status',
),
'up' =>
array (
0 => 'ref.outcontrol.php',
1 => 'Output Control Functions',
),
'prev' =>
array (
0 => 'function.ob-get-level.php',
1 => 'ob_get_level',
),
'next' =>
array (
0 => 'function.ob-gzhandler.php',
1 => 'ob_gzhandler',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.ob-get-status" class="refentry">
<div class="refnamediv">
<h1 class="refname">ob_get_status</h1>
<p class="verinfo">(PHP 4 >= 4.2.0, PHP 5)</p><p class="refpurpose"><span class="refname">ob_get_status</span> — <span class="dc-title">Get status of output buffers</span></p>
</div>
<a name="function.ob-get-status.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><b>ob_get_status</b></span>
([ <span class="methodparam"><span class="type">bool</span> <tt class="parameter">$full_status</tt> <span class="initializer"> = FALSE</span></span>
] )</div>
<p class="para rdfs-comment">
<b>ob_get_status()</b> returns status information on either
the top level output buffer or all active output buffer levels if
<i><tt class="parameter">full_status</tt></i>
is set to <b><tt class="constant">TRUE</tt></b>.
</p>
</div>
<a name="function.ob-get-status.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">full_status</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
<b><tt class="constant">TRUE</tt></b> to return all active output buffer levels. If <b><tt class="constant">FALSE</tt></b> or not
set, only the top level output buffer is returned.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.ob-get-status.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
If called without the <i><tt class="parameter">full_status</tt></i>
parameter
or with <i><tt class="parameter">full_status</tt></i>
= <b><tt class="constant">FALSE</tt></b> a simple array
with the following elements is returned:
</p><div class="informalexample">
<div class="example-contents screen">
<div class="returnvaluescode"><pre class="returnvaluescode">Array
(
[level] => 2
[type] => 0
[status] => 0
[name] => URL-Rewriter
[del] => 1
)</pre>
</div>
</div>
</div><p>
<div class="segmentedlist">
<strong class="title">Simple <b>ob_get_status()</b> results</strong>
<div class="seglistitem"><div class="seg"><strong><span class="segtitle">Key:</span></strong>level</div><div class="seg"><strong><span class="segtitle">Value:</span></strong>Output nesting level</div></div>
<div class="seglistitem"><div class="seg"><strong><span class="segtitle">Key:</span></strong>type</div><div class="seg"><strong><span class="segtitle">Value:</span></strong><i>PHP_OUTPUT_HANDLER_INTERNAL (0)</i> or <i>PHP_OUTPUT_HANDLER_USER (1)</i></div></div>
<div class="seglistitem"><div class="seg"><strong><span class="segtitle">Key:</span></strong>status</div><div class="seg"><strong><span class="segtitle">Value:</span></strong>One of <i>PHP_OUTPUT_HANDLER_START</i> (0), <i>PHP_OUTPUT_HANDLER_CONT</i> (1) or <i>PHP_OUTPUT_HANDLER_END</i> (2)</div></div>
<div class="seglistitem"><div class="seg"><strong><span class="segtitle">Key:</span></strong>name</div><div class="seg"><strong><span class="segtitle">Value:</span></strong>Name of active output handler or ' default output handler' if none is set</div></div>
<div class="seglistitem"><div class="seg"><strong><span class="segtitle">Key:</span></strong>del</div><div class="seg"><strong><span class="segtitle">Value:</span></strong>Erase-flag as set by <a href="function.ob-start.php" class="function">ob_start()</a></div></div>
</div>
</p>
<p class="para">
If called with <i><tt class="parameter">full_status</tt></i>
= <b><tt class="constant">TRUE</tt></b> 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.
</p><div class="informalexample">
<div class="example-contents screen">
<div class="cdata"><pre>
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
)
)
</pre></div>
</div>
</div><p>
</p>
<p class="para">
The full output contains these additional elements:
<div class="segmentedlist">
<strong class="title">Full <b>ob_get_status()</b> results</strong>
<div class="seglistitem"><div class="seg"><strong><span class="segtitle">Key:</span></strong>chunk_size</div><div class="seg"><strong><span class="segtitle">Value:</span></strong>Chunk size as set by <a href="function.ob-start.php" class="function">ob_start()</a></div></div>
<div class="seglistitem"><div class="seg"><strong><span class="segtitle">Key:</span></strong>size</div><div class="seg"><strong><span class="segtitle">Value:</span></strong>...</div></div>
<div class="seglistitem"><div class="seg"><strong><span class="segtitle">Key:</span></strong>blocksize</div><div class="seg"><strong><span class="segtitle">Value:</span></strong>...</div></div>
</div>
</p>
</div>
<a name="function.ob-get-status.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.ob-get-level.php" class="function" rel="rdfs-seeAlso">ob_get_level()</a> - Return the nesting level of the output buffering mechanism</li>
<li class="member"><a href="function.ob-list-handlers.php" class="function" rel="rdfs-seeAlso">ob_list_handlers()</a> - List all output handlers in use</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
