ob_get_status

(PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)

ob_get_statusПолучает статус буфера вывода

Описание

ob_get_status(bool$full_status = false): array

Функция ob_get_status() возвращает информацию о состоянии буфера верхнего уровня или на всех уровнях активных буферов, если параметр full_status установлен в true.

Список параметров

full_status

Если true, то вернёт все уровни активных буферов. Если false или не установлен, то вернёт статус только самого верхнего уровня.

Возвращаемые значения

Если параметр full_status опущен или равен false, возвращает простой массив с информацией о статусе активного уровня вывода.

Если параметр full_status равен true, возвращает массив с одним элементом для каждого активного уровня буфера вывода. Уровень вывода будет указан как ключ верхнего уровня массива и каждый элемент массива сам будет другим массивом с информацией о статусе одного активного уровня вывода.

Возвращает пустой массив, если буферизация вывода не была включена.

Элементы массива, которые возвращает функция ob_get_status()
KeyValue
name Имя активного обработчика вывода (подробнее об этом рассказано в описании возвращаемых значений функции ob_list_handlers()).
type0 (внутренний обработчик) или 1 (предоставленный пользователем обработчик)
flags Битовая маска флагов, заданных в функции ob_start(), тип обработчика вывода (см. выше) и статус процесса буферизации (константы PHP_OUTPUT_HANDLER_*). Если обработчик успешно обработал буфер и не вернул false, будут установлены значения констант PHP_OUTPUT_HANDLER_STARTED и PHP_OUTPUT_HANDLER_PROCESSED. Если обработчик не смог обработать буфер или вернул false, будут установлены значения констант PHP_OUTPUT_HANDLER_STARTED и PHP_OUTPUT_HANDLER_DISABLED.
level Уровень вложенности вывода (начинается с нуля). Заметьте, что значение, возвращаемое функцией ob_get_level() для того же уровня, больше на единицу. Первый уровень для функции ob_get_status() — это 0, а для функции ob_get_level() — это 1.
chunk_size Размер части в байтах. Значение, устанавленное в функции ob_start(), или значение настройки output_buffering, если она включена и её значение установлено как целое положительное число.
buffer_size Размер буфера вывода в байтах.
buffer_used Размер данных буфера вывода в байтах (то же, что и возвращаемое функцией ob_get_length() целочисленное значение).

Примеры

Пример #1 Массив, который будет возвращён, если значение параметра full_status равно false

Array ( [name] => URL-Rewriter [type] => 0 [flags] => 112 [level] => 2 [chunk_size] => 0 [buffer_size] => 16384 [buffer_used] => 1024 )

Пример #2 Массив, который будет возвращён, если значение параметра full_status равно true

Array ( [0] => Array ( [name] => default output handler [type] => 0 [flags] => 112 [level] => 1 [chunk_size] => 0 [buffer_size] => 16384 [buffer_used] => 2048 ) [1] => Array ( [name] => URL-Rewriter [type] => 0 [flags] => 112 [level] => 2 [chunk_size] => 0 [buffer_size] => 16384 [buffer_used] => 1024 ) )

Смотрите также

  • ob_get_level() - Возвращает уровень вложенности механизма буферизации вывода
  • ob_list_handlers() - Возвращает список активных обработчиков вывода
  • ob_get_length() - Возвращает размер буфера вывода
  • ob_start() - Включает буферизацию вывода
To Top