mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
b77ea449e7
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@330310 c90b9560-bf6c-de11-be94-00142212c4b1
151 lines
3.6 KiB
XML
151 lines
3.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" 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>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>
|
|
<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><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
|
|
-->
|
|
|