limititerator.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b77ea449e7387667c8c8386ea4f736748abf2787 Maintainer: yago Status: ready -->
<!-- Reviewed: yes Maintainer: seros -->
<reference role="class" xml:id="class.limititerator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
 <title>La clase LimitIterator</title>
 <titleabbrev>LimitIterator</titleabbrev>
 
 <partintro>
  
  <!-- {{{ LimitIterator intro -->
  <section xml:id="limititerator.intro">
   &reftitle.intro;
   <para>
    La clase <classname>LimitIterator</classname> permite recorrer un
    limitado subconjunto de elemento de un <classname>Iterator</classname>.
   </para>
  </section>
  <!-- }}} -->
  
  <section xml:id="limititerator.synopsis">
   &reftitle.classsynopsis;
   
   <!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>LimitIterator</classname></ooclass>
    
    <!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>LimitIterator</classname>
     </ooclass>
     
     <ooclass>
      <modifier>extends</modifier>
      <classname>IteratorIterator</classname>
     </ooclass>
     
     <oointerface>
      <interfacename>OuterIterator</interfacename>
     </oointerface>
     
    </classsynopsisinfo>
    <!-- }}} -->
    
    <!-- {{{ If the property is documented below (xml:id=limititerator.props) use this
    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>string</type>
     <varname linkend="limititerator.props.name">name</varname>
    </fieldsynopsis>
    }}} -->
    
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.limititerator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
   </classsynopsis>
   
  </section>
  
  <!-- {{{ LimitIterator properties
  <section xml:id="limititerator.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="limititerator.props.name">
     <term><varname>name</varname></term>
     <listitem>
      <para>Prop description</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
}}} -->
  
  <!-- {{{ examples -->
  <section xml:id="limititerator.examples">
   &reftitle.examples;
   <para>
    <example>
     <title>Ejemplo de uso de <classname>LimitIterator</classname></title>
     <programlisting role="php">
<![CDATA[
<?php

// Crea un iterador a limitar
$frutas = new ArrayIterator(array(
    'manzana',
    'banana',
    'cereza',
    'ciruela',
    'baya'
));

// Recorre el bucle sólo para las tres primeras frutas
foreach (new LimitIterator($frutas, 0, 3) as $fruta) {
    var_dump($fruta);
}

echo "\n";

// Recorre el bucle desde la tercera fruta hasta el final
// Nota: empieza por 0, por manzana
foreach (new LimitIterator($frutas, 2) as $fruta) {
    var_dump($fruta);
}

?>
]]>
     </programlisting>
     &example.outputs;
     <screen>
<![CDATA[
string(7) "manzana"
string(6) "banana"
string(6) "cereza"

string(6) "cereza"
string(7) "ciruela"
string(4) "baya"
]]>
     </screen>
    </example>
   </para>
  </section>
  <!-- }}} -->
  
 </partintro>
 
 &reference.spl.entities.limititerator;
 
</reference>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->