File: ArrayObject.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (161 lines) | stat: -rw-r--r-- 7,380 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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="ArrayObject" namespace="" name="ArrayObject">
  <implements name="IteratorAggregate" full="IteratorAggregate"/>
  <constant name="" value="1">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="" value="2">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Construct a new array object"/>
      <return type="void"/>
    </docblock>
    <parameter name="input" optional="true" byreference="false" type="object" class="mixed"/>
    <parameter name="flags" optional="true" byreference="false" type="int"/>
    <parameter name="iterator_class" optional="true" byreference="false" type="string"/>
  </constructor>
  <method name="append" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Appends the value">Appends a new value as the last element.</description>
      <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 the entries by value"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="count" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the number of public properties in the ArrayObject"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="exchangeArray" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Exchange the array for another one"/>
      <return type="array"/>
    </docblock>
    <parameter name="input" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="getArrayCopy" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Creates a copy of the ArrayObject"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getFlags" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the behavior flags"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getIterator" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Create a new iterator from an ArrayObject instance"/>
      <return type="ArrayIterator"/>
    </docblock>
  </method>
  <method name="getIteratorClass" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the iterator classname for the ArrayObject"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="ksort" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sort the entries by key"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="natcasesort" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sort an array using a case insensitive &quot;natural order&quot; algorithm">This method is a case insensitive version of ArrayObject::natsort.</description>
      <return type="void"/>
    </docblock>
  </method>
  <method name="natsort" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sort entries using a &quot;natural order&quot; algorithm"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="offsetExists" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns whether the requested index 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="Returns the value at the specified index"/>
      <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="Sets the value at the specified index to newval"/>
      <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="Unsets the value at the specified index"/>
      <return type="void"/>
    </docblock>
    <parameter name="index" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="serialize" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Serialize an ArrayObject"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="setFlags" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the behavior flags"/>
      <return type="void"/>
    </docblock>
    <parameter name="flags" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setIteratorClass" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the iterator classname for the ArrayObject"/>
      <return type="void"/>
    </docblock>
    <parameter name="iterator_class" optional="false" byreference="false" type="string"/>
  </method>
  <method name="uasort" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sort the entries with a user-defined comparison function and maintain key association">This function sorts the entries such that keys maintain their correlation with the entry that 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 the entries by keys using a user-defined comparison function"/>
      <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 an ArrayObject"/>
      <return type="void"/>
    </docblock>
    <parameter name="serialized" optional="false" byreference="false" type="string"/>
  </method>
</class>