<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.appenditerator.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'appenditerator.key.php',
    1 => 'AppendIterator::key',
    2 => 'Obt&eacute;m a chave atual',
  ),
  'up' => 
  array (
    0 => 'class.appenditerator.php',
    1 => 'AppendIterator',
  ),
  'prev' => 
  array (
    0 => 'appenditerator.getiteratorindex.php',
    1 => 'AppendIterator::getIteratorIndex',
  ),
  'next' => 
  array (
    0 => 'appenditerator.next.php',
    1 => 'AppendIterator::next',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/spl/appenditerator/key.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="appenditerator.key" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">AppendIterator::key</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.1.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">AppendIterator::key</span> &mdash; <span class="dc-title">Obtém a chave atual</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-appenditerator.key-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>AppendIterator::key</strong></span>(): <span class="type">scalar</span></div>

  <p class="para rdfs-comment">
   Obtém a chave atual.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-appenditerator.key-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">Esta função não possui parâmetros.</p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-appenditerator.key-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   A chave atual se for válida ou <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> caso contrário.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-appenditerator.key-examples">
  <h3 class="title">Exemplos</h3>
  <p class="para">
   <div class="example" id="appenditerator.key.examples.basic">
    <p><strong>Exemplo #1 Exemplo básico de <span class="methodname"><strong>AppendIterator::key()</strong></span></strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$array_a </span><span style="color: #007700">= new </span><span style="color: #0000BB">ArrayIterator</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'a' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'aardwolf'</span><span style="color: #007700">, </span><span style="color: #DD0000">'b' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'bear'</span><span style="color: #007700">, </span><span style="color: #DD0000">'c' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'capybara'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$array_b </span><span style="color: #007700">= new </span><span style="color: #0000BB">ArrayIterator</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'apple'</span><span style="color: #007700">, </span><span style="color: #DD0000">'orange'</span><span style="color: #007700">, </span><span style="color: #DD0000">'lemon'</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">$iterator </span><span style="color: #007700">= new </span><span style="color: #0000BB">AppendIterator</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$iterator</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">append</span><span style="color: #007700">(</span><span style="color: #0000BB">$array_a</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$iterator</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">append</span><span style="color: #007700">(</span><span style="color: #0000BB">$array_b</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Iteração manual<br /></span><span style="color: #0000BB">$iterator</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">rewind</span><span style="color: #007700">();<br />while (</span><span style="color: #0000BB">$iterator</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">valid</span><span style="color: #007700">()) {<br />    echo </span><span style="color: #0000BB">$iterator</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">key</span><span style="color: #007700">() . </span><span style="color: #DD0000">' ' </span><span style="color: #007700">. </span><span style="color: #0000BB">$iterator</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">current</span><span style="color: #007700">() . </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br />    </span><span style="color: #0000BB">$iterator</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">next</span><span style="color: #007700">();<br />}<br /><br />echo </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// Com foreach<br /></span><span style="color: #007700">foreach (</span><span style="color: #0000BB">$iterator </span><span style="color: #007700">as </span><span style="color: #0000BB">$key </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">$current</span><span style="color: #007700">) {<br />    echo </span><span style="color: #0000BB">$key </span><span style="color: #007700">. </span><span style="color: #DD0000">' ' </span><span style="color: #007700">. </span><span style="color: #0000BB">$current </span><span style="color: #007700">. </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    <div class="example-contents"><p>O exemplo acima produzirá:</p></div>
    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">a aardwolf
b bear
c capybara
0 apple
1 orange
2 lemon

a aardwolf
b bear
c capybara
0 apple
1 orange
2 lemon</pre>
</div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-appenditerator.key-seealso">
  <h3 class="title">Veja Também</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="methodname"><a href="iterator.key.php" class="methodname" rel="rdfs-seeAlso">Iterator::key()</a> - Retorna a chave do elemento atual</span></li>
    <li><span class="methodname"><a href="appenditerator.current.php" class="methodname" rel="rdfs-seeAlso">AppendIterator::current()</a> - Obt&eacute;m o valor atual</span></li>
    <li><span class="methodname"><a href="appenditerator.valid.php" class="methodname" rel="rdfs-seeAlso">AppendIterator::valid()</a> - Verifica a validade do elemento atual</span></li>
    <li><span class="methodname"><a href="appenditerator.next.php" class="methodname" rel="rdfs-seeAlso">AppendIterator::next()</a> - Move para o pr&oacute;ximo elemento</span></li>
    <li><span class="methodname"><a href="appenditerator.rewind.php" class="methodname" rel="rdfs-seeAlso">AppendIterator::rewind()</a> - Rebobina o Iterador</span></li>
   </ul>
  </p>
 </div>


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