<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.yaconf.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'yaconf.debug-info.php',
    1 => 'Yaconf::__debug_info',
    2 => 'Inspect how a configuration value is stored',
  ),
  'up' => 
  array (
    0 => 'class.yaconf.php',
    1 => 'Yaconf',
  ),
  'prev' => 
  array (
    0 => 'class.yaconf.php',
    1 => 'Yaconf',
  ),
  'next' => 
  array (
    0 => 'yaconf.get.php',
    1 => 'Yaconf::get',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/yaconf/yaconf/debuginfo.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="yaconf.debug-info" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Yaconf::__debug_info</h1>
  <p class="verinfo">(PECL yaconf &gt;= 1.1.0)</p><p class="refpurpose"><span class="refname">Yaconf::__debug_info</span> &mdash; <span class="dc-title">Inspect how a configuration value is stored</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-yaconf.debug-info-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="modifier">static</span> <span class="modifier">function</span> <span class="methodname"><strong>Yaconf::__debug_info</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$name</code></span>): <span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.array.php" class="type array">array</a></span></span></div>

  <p class="simpara">
   Returns debugging information about the value stored under
   <code class="parameter">name</code>: the memory address of the stored value
   and whether the value still lives inside Yaconf&#039;s compacted storage
   block.
  </p>
  <div class="warning"><strong class="warning">Aviso</strong>
   <p class="simpara">
    This method exists solely for Yaconf&#039;s own test suite, which
    uses it to verify that the extension is working correctly.
    Do not use it in production code, and do not rely on the
    format of its output: the returned array may change at any
    time.
   </p>
  </div>
 </div>


 <div class="refsect1 parameters" id="refsect1-yaconf.debug-info-parameters">
  <h3 class="title">Parâmetros</h3>
  <dl>
   
    <dt><code class="parameter">name</code></dt>
    <dd>
     <p class="simpara">
      The configuration name to inspect, using the same dot notation as
      <span class="methodname"><a href="yaconf.get.php" class="methodname">Yaconf::get()</a></span>.
     </p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-yaconf.debug-info-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="simpara">
   An <span class="type"><a href="language.types.array.php" class="type array">array</a></span> with four entries when the configuration
   exists, <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> otherwise:
  </p>
  <ul class="itemizedlist">
   <li class="listitem">
    <p class="simpara">
     <code class="literal">key</code> — the name that was looked up.
    </p>
   </li>
   <li class="listitem">
    <p class="simpara">
     <code class="literal">address</code> — the memory address of the stored
     value. Values are stored as interned strings or immutable arrays,
     so this address stays constant until the configuration is
     reloaded.
    </p>
   </li>
   <li class="listitem">
    <p class="simpara">
     <code class="literal">val</code> — the stored value itself.
    </p>
   </li>
   <li class="listitem">
    <p class="simpara">
     <code class="literal">changed</code> — <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> while the value&#039;s data still
     lives inside the compacted storage block, meaning the operating
     system has not had to copy the page (copy-on-write still applies);
     <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> when the value has been re-allocated outside the block.
    </p>
   </li>
  </ul>
 </div>


 <div class="refsect1 examples" id="refsect1-yaconf.debug-info-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="example-1">
   <p><strong>Exemplo #1 <span class="methodname"><strong>Yaconf::__debug_info()</strong></span> example</strong></p>
   <div class="example-contents">
<div class="phpcode"><pre><code style="color: #000000"><span style="color: #0000BB">&lt;?php
</span><span style="color: #FF8000">// assuming app.ini contains name="shop"
</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">Yaconf</span><span style="color: #007700">::</span><span style="color: #0000BB">__debug_info</span><span style="color: #007700">(</span><span style="color: #DD0000">"app.name"</span><span style="color: #007700">));
</span><span style="color: #FF8000">/*
array(4) {
  ["key"]=&gt;
  string(8) "app.name"
  ["address"]=&gt;
  string(14) "0x7f8b1c0a3d20"
  ["val"]=&gt;
  string(4) "shop"
  ["changed"]=&gt;
  bool(false)
}
*/

</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">Yaconf</span><span style="color: #007700">::</span><span style="color: #0000BB">__debug_info</span><span style="color: #007700">(</span><span style="color: #DD0000">"app.missing"</span><span style="color: #007700">)); </span><span style="color: #FF8000">// NULL
</span><span style="color: #0000BB">?&gt;</span></code></pre></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-yaconf.debug-info-seealso">
  <h3 class="title">Veja também</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="methodname"><a href="yaconf.get.php" class="methodname" rel="rdfs-seeAlso">Yaconf::get()</a> - Recupera um item</span></li>
    <li><span class="methodname"><a href="yaconf.has.php" class="methodname" rel="rdfs-seeAlso">Yaconf::has()</a> - Determina se um item existe</span></li>
   </ul>
  </p>
 </div>


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