php-doc-en/reference/intl/intliterator.xml

85 lines
2.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.intliterator" 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 IntlIterator class</title>
<titleabbrev>IntlIterator</titleabbrev>
<partintro>
<!-- {{{ IntlIterator intro -->
<section xml:id="intliterator.intro">
&reftitle.intro;
<para>
This class represents iterator objects throughout the intl extension
whenever the iterator cannot be identified with any other object provided
by the extension. The distinct iterator object used internally by the
<link linkend="control-structures.foreach"><literal>foreach</literal>
construct</link> can only be obtained (in the relevant part here) from
objects, so objects of this class serve the purpose of providing the hook
through which this internal object can be obtained. As a convenience, this
class also implements the <classname>Iterator</classname> interface,
allowing the collection of values to be navigated using the methods
defined in that interface. Both these methods and the internal iterator
objects provided to <literal>foreach</literal> are backed by the same
state (e.g. the position of the iterator and its current value).
</para>
<para>
Subclasses may provide richer functionality.
</para>
</section>
<!-- }}} -->
<section xml:id="intliterator.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>IntlIterator</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>IntlIterator</classname>
</ooclass>
<oointerface>
<interfacename>Iterator</interfacename>
</oointerface>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.intliterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
&reference.intl.entities.intliterator;
</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
-->