limititerator.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.limititerator" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
 <title>The LimitIterator class</title>
 <titleabbrev>LimitIterator</titleabbrev>
 
 <partintro>
 
<!-- {{{ LimitIterator intro -->
  <section xml:id="limititerator.intro">
   &reftitle.intro;
   <para>
    The <classname>LimitIterator</classname> class allows iteration over 
    a limited subset of items in an <classname>Iterator</classname>.
   </para>
  </section>
<!-- }}} -->
 
  <section xml:id="limititerator.synopsis">
   &reftitle.classsynopsis;
 
<!-- {{{ Synopsis -->
   <classsynopsis class="class">
    <ooclass>
     <classname>LimitIterator</classname>
    </ooclass>

    <ooclass>
     <modifier>extends</modifier>
     <classname>IteratorIterator</classname>
    </ooclass>

    <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:constructorsynopsis[@role='LimitIterator'])">
     <xi:fallback/>
    </xi:include>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.limititerator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='LimitIterator'])">
     <xi:fallback/>
    </xi:include>

    <classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.iteratoriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='IteratorIterator'])">
     <xi:fallback/>
    </xi:include>
   </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><classname>LimitIterator</classname> usage example</title>
     <programlisting role="php">
<![CDATA[
<?php

// Create an iterator to be limited
$fruits = new ArrayIterator(array(
    'apple',
    'banana',
    'cherry',
    'damson',
    'elderberry'
));

// Loop over first three fruits only
foreach (new LimitIterator($fruits, 0, 3) as $fruit) {
    var_dump($fruit);
}

echo "\n";

// Loop from third fruit until the end
// Note: offset starts from zero for apple
foreach (new LimitIterator($fruits, 2) as $fruit) {
    var_dump($fruit);
}

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
string(5) "apple"
string(6) "banana"
string(6) "cherry"

string(6) "cherry"
string(6) "damson"
string(10) "elderberry"
]]>
     </screen>
    </example>
   </para>
  </section>
 <!-- }}} -->
 
 </partintro>
 
 &reference.spl.entities.limititerator;
 
</phpdoc:classref>
<!-- 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
-->