diff --git a/reference/outcontrol/functions/ob-get-status.xml b/reference/outcontrol/functions/ob-get-status.xml index cdc9df947d..5acafb7940 100644 --- a/reference/outcontrol/functions/ob-get-status.xml +++ b/reference/outcontrol/functions/ob-get-status.xml @@ -1,5 +1,5 @@ - + ob_get_status @@ -11,16 +11,97 @@ Description arrayob_get_status - bool - full_status + + bool + full_status + FALSE - This will return the current status of output buffers. It returns - array contains buffer status or &false; for error. + ob_get_status returns status information on + either the top level output buffer or all active output buffer levels + if full_status is set to &true;. - See also ob_get_level. + If called without the full_status parameter + or with full_status = &false; a simple array + with the following elements is returned: + + + Simple <function>ob_get_status</function> output + +Array +( + [level] => 2 + [type] => 0 + [status] => 0 + [name] => URL-Rewriter + [del] => 1 +) + + + + + Simple <function>ob_get_status</function> results + KeyValue + levelOutput nesting level + typePHP_OUTPUT_HANDLER_INTERNAL (0) or PHP_OUTPUT_HANDLER_USER (1) + statusOne of PHP_OUTPUT_HANDLER_START (0), PHP_OUTPUT_HANDLER_CONT (1) or PHP_OUTPUT_HANDLER_END (2) + nameName of active output handler or ' default output handler' if none is set + delErase-flag as set by ob_start + + + + If called with full_status = &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. + + + Full <function>ob_get_status</function> output + +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 + ) + +) + + + + The full output contains these additional elements: + + Full <function>ob_get_status</function> results + KeyValue + chunk_sizeChunk size as set by ob_start + size... + blocksize... + + + + See also ob_get_level and + ob_list_handlers.