<?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 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.ob-get-status.php',
    1 => 'ob_get_status',
    2 => 'Obt&eacute;m status dos buffers de sa&iacute;da',
  ),
  'up' => 
  array (
    0 => 'ref.outcontrol.php',
    1 => 'Fun&ccedil;&otilde;es para Control de Sa&iacute;da',
  ),
  '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' => 'pt_BR',
    '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">Obtém status dos buffers de saída</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.ob-get-status-description">
  <h3 class="title">Descrição</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> retorna informação de status do
   buffer de saída do nível mais alto ou de todos os níveis de buffers de saída ativos se
   <code class="parameter">full_status</code> estiver definido para <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">Parâmetros</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> para retornar todos os níveis de buffers de saída ativos. Se for <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> ou não
       definido, somente o buffer de saída de nível mais alto é retornado.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.ob-get-status-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Se <code class="parameter">full_status</code> for omitido ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> um array simples
   contendo informações de status no nível de saída ativo é retornado.
  </p>
  <p class="para">
   Se <code class="parameter">full_status</code> for <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> um array
   com um elemento para cada nível de buffer de saída ativo é retornado.
   O nível de saída é usado como chave do array de nível superior e cada elemento
   do array em si é outro array que contém informações de status
   sobre um nível de saída ativo.
  </p>
  <p class="para">
   Um array vazio será retornada se o buffer de saída não estiver ativado.
  </p>
  <p class="para">
   <table class="segmentedlist">
    <caption><strong>Elementos do array de retorno de <span class="function"><strong>ob_get_status()</strong></span></strong></caption>
    <thead><tr><th>Chave</th><th>Valor</th>
    </tr></thead><tbody><tr class="seglistitem">
     <td class="seg">name</td>
     <td class="seg">
      Nome do manipulador de saída ativo (veja os valores de retorno de
      <span class="function"><a href="function.ob-list-handlers.php" class="function">ob_list_handlers()</a></span> para detalhes)
     </td>
    </tr>
    <tr class="seglistitem">
     <td class="seg">type</td>
     <td class="seg">
      <code class="literal">0</code> (manipulador interno) ou
      <code class="literal">1</code> (manipulador fornecido pelo usuário)
     </td>
    </tr>
    <tr class="seglistitem">
     <td class="seg">flags</td>
     <td class="seg">
      Máscara de bits das opções definidas por <span class="function"><a href="function.ob-start.php" class="function">ob_start()</a></span>,
      o tipo de manipulador de saída (veja acima)
      e o status do processo de buffer
      (constantes <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>).
      Se o manipulador processou o buffer com sucesso e não retornou <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> e
      <strong><code><a href="outcontrol.constants.php#constant.php-output-handler-processed">PHP_OUTPUT_HANDLER_PROCESSED</a></code></strong> serão definidas.
      Se o manipulador falhou ao processar o buffer ou retornou <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> e
      <strong><code><a href="outcontrol.constants.php#constant.php-output-handler-disabled">PHP_OUTPUT_HANDLER_DISABLED</a></code></strong> serão definidas.
     </td>
    </tr>
    <tr class="seglistitem">
     <td class="seg">level</td>
     <td class="seg">
      Nível de aninhamento de saída (com base em zero). Observe que o valor retornado para o
      mesmo nível por <span class="function"><a href="function.ob-get-level.php" class="function">ob_get_level()</a></span> está deslocado em uma unidade.
      O primeiro nível é <code class="literal">0</code> para <span class="function"><strong>ob_get_status()</strong></span>
      e <code class="literal">1</code> para <span class="function"><a href="function.ob-get-level.php" class="function">ob_get_level()</a></span>.
     </td>
    </tr>
    <tr class="seglistitem">
     <td class="seg">chunk_size</td>
     <td class="seg">
      Tamanho do bloco em bytes. Definido por <span class="function"><a href="function.ob-start.php" class="function">ob_start()</a></span>
      ou se <a href="outcontrol.configuration.php#ini.output-buffering" class="link">output_buffering</a> estiver habilitado
      e seu valor estiver definido como um número inteiro positivo.
     </td>
    </tr>
    <tr class="seglistitem">
     <td class="seg">buffer_size</td>
     <td class="seg">
      Tamanho do buffer de saída em bytes
     </td>
    </tr>
    <tr class="seglistitem">
     <td class="seg">buffer_used</td>
     <td class="seg">
      Tamanho dos dados no buffer de saída em bytes
      (o mesmo que o valor de retorno do tipo inteiro de <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">Exemplos</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Exemplo #1 Array retornado quando <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>Exemplo #2 Array retornado quando <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">Veja Também</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> - Retorna o n&iacute;vel de aninhamento do mecanismo de buffer de sa&iacute;da</span></li>
    <li><span class="function"><a href="function.ob-list-handlers.php" class="function" rel="rdfs-seeAlso">ob_list_handlers()</a> - Lista todos os manipuladores de sa&iacute;da em uso</span></li>
    <li><span class="function"><a href="function.ob-get-length.php" class="function" rel="rdfs-seeAlso">ob_get_length()</a> - Retorna o comprimento do buffer de sa&iacute;da</span></li>
    <li><span class="function"><a href="function.ob-start.php" class="function" rel="rdfs-seeAlso">ob_start()</a> - Ativa o buffer de sa&iacute;da</span></li>
   </ul>
  </p>
 </div>


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