<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = 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 => 'ru',
  ),
  'this' => 
  array (
    0 => 'function.ob-get-status.php',
    1 => 'ob_get_status',
    2 => 'Получает статус буфера вывода',
  ),
  'up' => 
  array (
    0 => 'ref.outcontrol.php',
    1 => 'Функции контроля вывода',
  ),
  'prev' => 
  array (
    0 => 'function.ob-get-level.php',
    1 => 'ob_get_level',
  ),
  'next' => 
  array (
    0 => 'function.ob-implicit-flush.php',
    1 => 'ob_implicit_flush',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/outcontrol/functions/ob-get-status.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.ob-get-status" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ob_get_status</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.2.0, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">ob_get_status</span> &mdash; <span class="dc-title">Получает статус буфера вывода</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.ob-get-status-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>ob_get_status</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$full_status</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></span></span>): <span class="type"><a href="language.types.array.php" class="type array">array</a></span></div>

  <p class="para rdfs-comment">
   Функция <span class="function"><strong>ob_get_status()</strong></span> возвращает информацию о состоянии буфера верхнего уровня
   или на всех уровнях активных буферов, если параметр <code class="parameter">full_status</code> установлен в <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.ob-get-status-parameters">
  <h3 class="title">Список параметров</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">full_status</code></dt>
     <dd>
      <p class="para">
       Если <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>, то вернёт все уровни активных буферов. Если <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> или
       не установлен, то вернёт статус только самого верхнего уровня.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.ob-get-status-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="para">
   Если параметр <code class="parameter">full_status</code> опущен или равен <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>,
   возвращает простой массив с информацией о статусе активного уровня вывода.
  </p>
  <p class="para">
   Если параметр <code class="parameter">full_status</code> равен <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>,
   возвращает массив с одним элементом для каждого активного уровня буфера вывода.
   Уровень вывода будет указан как ключ верхнего уровня массива
   и каждый элемент массива сам будет другим массивом
   с информацией о статусе одного активного уровня вывода.
  </p>
  <p class="para">
   Возвращает пустой массив, если буферизация вывода не была включена.
  </p>
  <p class="para">
   <table class="segmentedlist">
    <caption><strong>Элементы массива, которые возвращает функция <span class="function"><strong>ob_get_status()</strong></span></strong></caption>
    <thead><tr><th>Key</th><th>Value</th>
    </tr></thead><tbody><tr class="seglistitem">
     <td class="seg">name</td>
     <td class="seg">
      Имя активного обработчика вывода (подробнее об этом рассказано
      в описании возвращаемых значений функции <span class="function"><a href="function.ob-list-handlers.php" class="function">ob_list_handlers()</a></span>).
     </td>
    </tr>
    <tr class="seglistitem">
     <td class="seg">type</td>
     <td class="seg">
      <code class="literal">0</code> (внутренний обработчик)
      или <code class="literal">1</code> (предоставленный пользователем обработчик)
     </td>
    </tr>
    <tr class="seglistitem">
     <td class="seg">flags</td>
     <td class="seg">
      Битовая маска флагов, заданных в функции <span class="function"><a href="function.ob-start.php" class="function">ob_start()</a></span>,
      тип обработчика вывода (см. выше)
      и статус процесса буферизации
      (константы <a href="outcontrol.constants.php#outcontrol.constants.flags-returned-by-handler" class="link">
       <strong><code><a href="outcontrol.constants.php#constant.php-output-handler-start">PHP_OUTPUT_HANDLER_<span class="replaceable">*</span></a></code></strong>
      </a>).
      Если обработчик успешно обработал буфер и не вернул <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>,
      будут установлены значения констант
      <strong><code><a href="outcontrol.constants.php#constant.php-output-handler-started">PHP_OUTPUT_HANDLER_STARTED</a></code></strong>
      и <strong><code><a href="outcontrol.constants.php#constant.php-output-handler-processed">PHP_OUTPUT_HANDLER_PROCESSED</a></code></strong>.
      Если обработчик не смог обработать буфер или вернул <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>,
      будут установлены значения констант
      <strong><code><a href="outcontrol.constants.php#constant.php-output-handler-started">PHP_OUTPUT_HANDLER_STARTED</a></code></strong>
      и <strong><code><a href="outcontrol.constants.php#constant.php-output-handler-disabled">PHP_OUTPUT_HANDLER_DISABLED</a></code></strong>.
     </td>
    </tr>
    <tr class="seglistitem">
     <td class="seg">level</td>
     <td class="seg">
      Уровень вложенности вывода (начинается с нуля).
      Заметьте, что значение, возвращаемое функцией <span class="function"><a href="function.ob-get-level.php" class="function">ob_get_level()</a></span>
      для того же уровня, больше на единицу.
      Первый уровень для функции <span class="function"><strong>ob_get_status()</strong></span> — это <code class="literal">0</code>,
      а для функции <span class="function"><a href="function.ob-get-level.php" class="function">ob_get_level()</a></span> — это <code class="literal">1</code>.
     </td>
    </tr>
    <tr class="seglistitem">
     <td class="seg">chunk_size</td>
     <td class="seg">
      Размер части в байтах. Значение, устанавленное в функции <span class="function"><a href="function.ob-start.php" class="function">ob_start()</a></span>,
      или значение настройки
      <a href="outcontrol.configuration.php#ini.output-buffering" class="link">output_buffering</a>,
      если она включена и её значение установлено как целое положительное число.
     </td>
    </tr>
    <tr class="seglistitem">
     <td class="seg">buffer_size</td>
     <td class="seg">
      Размер буфера вывода в байтах.
     </td>
    </tr>
    <tr class="seglistitem">
     <td class="seg">buffer_used</td>
     <td class="seg">
      Размер данных буфера вывода в байтах
      (то же, что и возвращаемое функцией <span class="function"><a href="function.ob-get-length.php" class="function">ob_get_length()</a></span> целочисленное значение).
     </td>
    </tr>
   </tbody></table>
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.ob-get-status-examples">
  <h3 class="title">Примеры</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Пример #1 Массив, который будет возвращён, если значение параметра <code class="parameter">full_status</code> равно <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></strong></p>
    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">Array
(
    [name] =&gt; URL-Rewriter
    [type] =&gt; 0
    [flags] =&gt; 112
    [level] =&gt; 2
    [chunk_size] =&gt; 0
    [buffer_size] =&gt; 16384
    [buffer_used] =&gt; 1024
)</pre>
</div>
    </div>
   </div>
  </p>
  <p class="para">
   <div class="example" id="example-2">
    <p><strong>Пример #2 Массив, который будет возвращён, если значение параметра <code class="parameter">full_status</code> равно <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong></strong></p>
    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">Array
(
    [0] =&gt; Array
        (
            [name] =&gt; default output handler
            [type] =&gt; 0
            [flags] =&gt; 112
            [level] =&gt; 1
            [chunk_size] =&gt; 0
            [buffer_size] =&gt; 16384
            [buffer_used] =&gt; 2048
        )

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

)</pre>
</div>
    </div>
    </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.ob-get-status-seealso">
  <h3 class="title">Смотрите также</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.ob-get-level.php" class="function" rel="rdfs-seeAlso">ob_get_level()</a> - Возвращает уровень вложенности механизма буферизации вывода</span></li>
    <li><span class="function"><a href="function.ob-list-handlers.php" class="function" rel="rdfs-seeAlso">ob_list_handlers()</a> - Возвращает список активных обработчиков вывода</span></li>
    <li><span class="function"><a href="function.ob-get-length.php" class="function" rel="rdfs-seeAlso">ob_get_length()</a> - Возвращает размер буфера вывода</span></li>
    <li><span class="function"><a href="function.ob-start.php" class="function" rel="rdfs-seeAlso">ob_start()</a> - Включает буферизацию вывода</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>