<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/spl.iterators.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'class.limititerator.php',
    1 => 'LimitIterator',
    2 => 'A classe LimitIterator',
  ),
  'up' => 
  array (
    0 => 'spl.iterators.php',
    1 => 'Iteradores',
  ),
  'prev' => 
  array (
    0 => 'iteratoriterator.valid.php',
    1 => 'IteratorIterator::valid',
  ),
  'next' => 
  array (
    0 => 'limititerator.construct.php',
    1 => 'LimitIterator::__construct',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/spl/limititerator.xml',
  ),
  'history' => 
  array (
  ),
  'extra_header_links' => 
  array (
    'rel' => 'alternate',
    'href' => '/manual/en/feeds/class.limititerator.atom',
    'type' => 'application/atom+xml',
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="class.limititerator" class="reference">
 <h1 class="title">A classe LimitIterator</h1>
 

 <div class="partintro"><p class="verinfo">(PHP 5 &gt;= 5.1.0, PHP 7, PHP 8)</p>


  <div class="section" id="limititerator.intro">
   <h2 class="title">Introdução</h2>
   <p class="para">
    A classe <span class="classname"><strong class="classname">LimitIterator</strong></span> permite a iteração sobre
    um subconjunto limitado de itens em um <span class="classname"><a href="class.iterator.php" class="classname">Iterator</a></span>.
   </p>
  </div>


  <div class="section" id="limititerator.synopsis">
   <h2 class="title">Resumo da classe</h2>


   <div class="classsynopsis"><div class="classsynopsisinfo">
    
     <span class="modifier">class</span> <strong class="classname"><strong class="classname">LimitIterator</strong></strong>
    

    
     <span class="modifier">extends</span>
      <a href="class.iteratoriterator.php" class="classname">IteratorIterator</a>
     {</div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Métodos */</div>
    <div class="constructorsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><a href="limititerator.construct.php" class="methodname">__construct</a></span>(<span class="methodparam"><span class="type"><a href="class.iterator.php" class="type Iterator">Iterator</a></span> <code class="parameter">$iterator</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$offset</code><span class="initializer"> = 0</span></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$limit</code><span class="initializer"> = -1</span></span>)</div>

    <div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="limititerator.current.php" class="methodname">current</a></span>(): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="limititerator.getposition.php" class="methodname">getPosition</a></span>(): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="limititerator.key.php" class="methodname">key</a></span>(): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="limititerator.next.php" class="methodname">next</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="limititerator.rewind.php" class="methodname">rewind</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="limititerator.seek.php" class="methodname">seek</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$offset</code></span>): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="limititerator.valid.php" class="methodname">valid</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>


    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Métodos herdados */</div>
    <div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="iteratoriterator.current.php" class="methodname">IteratorIterator::current</a></span>(): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="iteratoriterator.getinneriterator.php" class="methodname">IteratorIterator::getInnerIterator</a></span>(): <span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="class.iterator.php" class="type Iterator">Iterator</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="iteratoriterator.key.php" class="methodname">IteratorIterator::key</a></span>(): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="iteratoriterator.next.php" class="methodname">IteratorIterator::next</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="iteratoriterator.rewind.php" class="methodname">IteratorIterator::rewind</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="iteratoriterator.valid.php" class="methodname">IteratorIterator::valid</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

   }</div>

  </div>



 
  <div class="section" id="limititerator.examples">
   <h2 class="title">Exemplos</h2>
   <p class="para">
    <div class="example" id="example-1">
     <p><strong>Exemplo #1 Exemplo de uso de <span class="classname"><strong class="classname">LimitIterator</strong></span></strong></p>
     <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #FF8000">// Cria um iterador para ser limitado<br /></span><span style="color: #0000BB">$fruits </span><span style="color: #007700">= new </span><span style="color: #0000BB">ArrayIterator</span><span style="color: #007700">(array(<br />    </span><span style="color: #DD0000">'apple'</span><span style="color: #007700">,<br />    </span><span style="color: #DD0000">'banana'</span><span style="color: #007700">,<br />    </span><span style="color: #DD0000">'cherry'</span><span style="color: #007700">,<br />    </span><span style="color: #DD0000">'damson'</span><span style="color: #007700">,<br />    </span><span style="color: #DD0000">'elderberry'<br /></span><span style="color: #007700">));<br /><br /></span><span style="color: #FF8000">// Percorre pelas três primeiras frutas somente<br /></span><span style="color: #007700">foreach (new </span><span style="color: #0000BB">LimitIterator</span><span style="color: #007700">(</span><span style="color: #0000BB">$fruits</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">) as </span><span style="color: #0000BB">$fruit</span><span style="color: #007700">) {<br />    </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$fruit</span><span style="color: #007700">);<br />}<br /><br />echo </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// Percorre a partir da terceira fruta até o final<br />// Observação: a posição inicia a partir de zero para "apple"<br /></span><span style="color: #007700">foreach (new </span><span style="color: #0000BB">LimitIterator</span><span style="color: #007700">(</span><span style="color: #0000BB">$fruits</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">) as </span><span style="color: #0000BB">$fruit</span><span style="color: #007700">) {<br />    </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$fruit</span><span style="color: #007700">);<br />}<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="cdata"><pre>
string(5) &quot;apple&quot;
string(6) &quot;banana&quot;
string(6) &quot;cherry&quot;

string(6) &quot;cherry&quot;
string(6) &quot;damson&quot;
string(10) &quot;elderberry&quot;
</pre></div>
     </div>
    </div>
   </p>
  </div>
 

 </div>

 












































<h2>Índice</h2><ul class="chunklist chunklist_reference"><li><a href="limititerator.construct.php">LimitIterator::__construct</a> — Constr&oacute;i um LimitIterator</li><li><a href="limititerator.current.php">LimitIterator::current</a> — Obt&eacute;m o elemento atual</li><li><a href="limititerator.getposition.php">LimitIterator::getPosition</a> — Retorna a posi&ccedil;&atilde;o atual</li><li><a href="limititerator.key.php">LimitIterator::key</a> — Obt&eacute;m a chave atual</li><li><a href="limititerator.next.php">LimitIterator::next</a> — Avan&ccedil;a o iterador</li><li><a href="limititerator.rewind.php">LimitIterator::rewind</a> — Retorna o iterador para o come&ccedil;o especificado no construtor</li><li><a href="limititerator.seek.php">LimitIterator::seek</a> — Aponta para a posi&ccedil;&atilde;o especificada</li><li><a href="limititerator.valid.php">LimitIterator::valid</a> — Verifica se o elemento atual &eacute; v&aacute;lido ou n&atilde;o</li></ul>
</div>
<?php manual_footer($setup); ?>