File: ArrayIterator.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (171 lines) | stat: -rw-r--r-- 7,188 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
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="ArrayIterator" namespace="" name="ArrayIterator">
  <implements name="ArrayAccess" full="ArrayAccess"/>
  <constant name="" value="1">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="" value="2">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <method name="append" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Append an element"/>
      <return type="void"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="asort" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sort array by values"/>
      <return type="void"/>
    </docblock>
  </method>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Construct an ArrayIterator"/>
      <return type="void"/>
    </docblock>
    <parameter name="array" optional="true" byreference="false" type="object" class="mixed"/>
    <parameter name="flags" optional="true" byreference="false" type="int"/>
  </constructor>
  <method name="count" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Count elements"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="current" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Return current array entry"/>
      <return type="mixed"/>
    </docblock>
  </method>
  <method name="getArrayCopy" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get array copy"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getFlags" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get behavior flags"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="key" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Return current array key"/>
      <return type="mixed"/>
    </docblock>
  </method>
  <method name="ksort" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sort array by keys"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="natcasesort" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sort an array naturally, case insensitive"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="natsort" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sort an array naturally"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="next" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Move to next entry"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="offsetExists" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Check if offset exists"/>
      <return type="bool"/>
    </docblock>
    <parameter name="index" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="offsetGet" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get value for an offset"/>
      <return type="mixed"/>
    </docblock>
    <parameter name="index" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="offsetSet" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set value for an offset"/>
      <return type="void"/>
    </docblock>
    <parameter name="index" optional="false" byreference="false" type="object" class="mixed"/>
    <parameter name="newval" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="offsetUnset" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Unset value for an offset"/>
      <return type="void"/>
    </docblock>
    <parameter name="index" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="rewind" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Rewind array back to the start"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="seek" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Seek to position"/>
      <return type="void"/>
    </docblock>
    <parameter name="position" optional="false" byreference="false" type="int"/>
  </method>
  <method name="serialize" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Serialize"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="setFlags" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set behaviour flags"/>
      <return type="void"/>
    </docblock>
    <parameter name="flags" optional="false" byreference="false" type="string"/>
  </method>
  <method name="uasort" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sort with a user-defined comparison function and maintain index association">This method sorts the elements such that indices maintain their correlation with the values they are associated with, using a user-defined comparison function.</description>
      <return type="void"/>
    </docblock>
    <parameter name="cmp_function" optional="false" byreference="false" type="object" class="callable"/>
  </method>
  <method name="uksort" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sort by keys using a user-defined comparison function">This method sorts the elements by keys using a user-supplied comparison function.</description>
      <return type="void"/>
    </docblock>
    <parameter name="cmp_function" optional="false" byreference="false" type="object" class="callable"/>
  </method>
  <method name="unserialize" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Unserialize"/>
      <return type="string"/>
    </docblock>
    <parameter name="serialized" optional="false" byreference="false" type="string"/>
  </method>
  <method name="valid" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Check whether array contains more entries"/>
      <return type="bool"/>
    </docblock>
  </method>
</class>