File: SplObjectStorage.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 (145 lines) | stat: -rw-r--r-- 7,026 bytes parent folder | download | duplicates (3)
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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="SplObjectStorage" namespace="" name="SplObjectStorage">
  <implements name="Countable" full="Countable"/>
  <method name="addAll" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Adds all objects from another storage"/>
      <return type="void"/>
    </docblock>
    <parameter name="storage" optional="false" byreference="false" type="object" class="SplObjectStorage"/>
  </method>
  <method name="attach" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Adds an object in the storage"/>
      <return type="void"/>
    </docblock>
    <parameter name="object" optional="false" byreference="false" type="object" class="object"/>
    <parameter name="data" optional="true" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="contains" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks if the storage contains a specific object"/>
      <return type="bool"/>
    </docblock>
    <parameter name="object" optional="false" byreference="false" type="object" class="object"/>
  </method>
  <method name="count" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the number of objects in the storage"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="current" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the current storage entry"/>
      <return type="object"/>
    </docblock>
  </method>
  <method name="detach" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Removes an object from the storage"/>
      <return type="void"/>
    </docblock>
    <parameter name="object" optional="false" byreference="false" type="object" class="object"/>
  </method>
  <method name="getHash" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Calculate a unique identifier for the contained objects&#10;  ">This method calculates an identifier for the objects added to an SplObjectStorage object.</description>
      <return type="string"/>
    </docblock>
    <parameter name="object" optional="false" byreference="false" type="object" class="object"/>
  </method>
  <method name="getInfo" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the data associated with the current iterator entry"/>
      <return type="mixed"/>
    </docblock>
  </method>
  <method name="key" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the index at which the iterator currently is"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="next" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Move to the next entry"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="offsetExists" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks whether an object exists in the storage">Checks whether an object exists in the storage.</description>
      <return type="bool"/>
    </docblock>
    <parameter name="object" optional="false" byreference="false" type="object" class="object"/>
  </method>
  <method name="offsetGet" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the data associated with an object"/>
      <return type="mixed"/>
    </docblock>
    <parameter name="object" optional="false" byreference="false" type="object" class="object"/>
  </method>
  <method name="offsetSet" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Associates data to an object in the storage">Associate data to an object in the storage.</description>
      <return type="void"/>
    </docblock>
    <parameter name="object" optional="false" byreference="false" type="object" class="object"/>
    <parameter name="data" optional="true" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="offsetUnset" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Removes an object from the storage">Removes an object from the storage.</description>
      <return type="void"/>
    </docblock>
    <parameter name="object" optional="false" byreference="false" type="object" class="object"/>
  </method>
  <method name="removeAll" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Removes objects contained in another storage from the current storage"/>
      <return type="void"/>
    </docblock>
    <parameter name="storage" optional="false" byreference="false" type="object" class="SplObjectStorage"/>
  </method>
  <method name="removeAllExcept" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Removes all objects except for those contained in another storage from the current storage"/>
      <return type="void"/>
    </docblock>
    <parameter name="storage" optional="false" byreference="false" type="object" class="SplObjectStorage"/>
  </method>
  <method name="rewind" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Rewind the iterator to the first storage element"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="serialize" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Serializes the storage"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="setInfo" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the data associated with the current iterator entry"/>
      <return type="void"/>
    </docblock>
    <parameter name="data" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="unserialize" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Unserializes a storage from its string representation"/>
      <return type="void"/>
    </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="Returns if the current iterator entry is valid"/>
      <return type="bool"/>
    </docblock>
  </method>
</class>