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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.arrayiterator" 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 ArrayIterator class</title>
<titleabbrev>ArrayIterator</titleabbrev>
<partintro>
<!-- {{{ ArrayIterator intro -->
<section xml:id="arrayiterator.intro">
&reftitle.intro;
<para>
Allows the removal of elements, and the modification of
keys or values while iterating over <type>array</type>s or <type>object</type>s.
</para>
<para>
To iterate the same array more than once, it is recommended to
instantiate <classname>ArrayObject</classname> and use the
<classname>ArrayIterator</classname> instance either implicitly created when
using &foreach; to iterate over the array stored internally, or create one by
calling the <methodname>ArrayObject::getIterator</methodname> method manually.
</para>
</section>
<!-- }}} -->
<section xml:id="arrayiterator.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis class="class">
<ooclass>
<classname>ArrayIterator</classname>
</ooclass>
<oointerface>
<modifier>implements</modifier>
<interfacename>SeekableIterator</interfacename>
</oointerface>
<oointerface>
<interfacename>ArrayAccess</interfacename>
</oointerface>
<oointerface>
<interfacename>Serializable</interfacename>
</oointerface>
<oointerface>
<interfacename>Countable</interfacename>
</oointerface>
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>const</modifier>
<type>int</type>
<varname linkend="arrayiterator.constants.std-prop-list">ArrayIterator::STD_PROP_LIST</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>const</modifier>
<type>int</type>
<varname linkend="arrayiterator.constants.array-as-props">ArrayIterator::ARRAY_AS_PROPS</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.arrayiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='ArrayIterator'])">
<xi:fallback/>
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.arrayiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='ArrayIterator'])">
<xi:fallback/>
</xi:include>
</classsynopsis>
</section>
<section xml:id="arrayiterator.constants">
&reftitle.constants;
<section xml:id="arrayiterator.constants.flags">
<title>ArrayIterator Flags</title>
<variablelist>
<varlistentry xml:id="arrayiterator.constants.std-prop-list">
<term><constant>ArrayIterator::STD_PROP_LIST</constant></term>
<listitem>
<para>
Properties of the object have their normal functionality
when accessed as list (<function>var_dump</function>, &foreach;, etc.).
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="arrayiterator.constants.array-as-props">
<term><constant>ArrayIterator::ARRAY_AS_PROPS</constant></term>
<listitem>
<para>Entries can be accessed as properties (read and write).</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>
<!-- {{{ ArrayIterator properties
<section xml:id="arrayiterator.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="arrayiterator.props.name">
<term><varname>name</varname></term>
<listitem>
<para>Prop description</para>
</listitem>
</varlistentry>
</variablelist>
</section>
}}} -->
</partintro>
&reference.spl.entities.arrayiterator;
</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
-->
|
