File: intliterator.xml

package info (click to toggle)
php-doc 20241205~git.dfcbb86%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 70,956 kB
  • sloc: xml: 968,269; php: 23,883; javascript: 671; sh: 177; makefile: 37
file content (80 lines) | stat: -rw-r--r-- 2,630 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.intliterator" role="class" 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 class="class">
    <ooclass>
     <classname>IntlIterator</classname>
    </ooclass>

    <oointerface>
     <modifier>implements</modifier>
     <interfacename>Iterator</interfacename>
    </oointerface>

    <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[@role='IntlIterator'])">
     <xi:fallback/>
    </xi:include>
   </classsynopsis>
<!-- }}} -->

  </section>

 </partintro>

 &reference.intl.entities.intliterator;

</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
-->