File: SplDoublyLinkedList.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 (159 lines) | stat: -rw-r--r-- 6,890 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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="SplDoublyLinkedList" namespace="" name="SplDoublyLinkedList">
  <implements name="Iterator" full="Iterator"/>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Constructs a new doubly linked list"/>
      <return type="void"/>
    </docblock>
  </constructor>
  <method name="add" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Add/insert a new value at the specified index"/>
      <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="bottom" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Peeks at the node from the beginning of the doubly linked list"/>
      <return type="mixed"/>
    </docblock>
  </method>
  <method name="count" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Counts the number of elements in the doubly linked list"/>
      <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="getIteratorMode" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the mode of iteration"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="isEmpty" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Checks whether the doubly linked list is empty"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="key" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Return current node index"/>
      <return type="mixed"/>
    </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="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="pop" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Pops a node from the end of the doubly linked list"/>
      <return type="mixed"/>
    </docblock>
  </method>
  <method name="prev" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Move to previous entry"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="push" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Pushes an element at the end of the doubly linked list"/>
      <return type="void"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="rewind" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Rewind iterator back to the start"/>
      <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="setIteratorMode" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the mode of iteration"/>
      <return type="void"/>
    </docblock>
    <parameter name="mode" optional="false" byreference="false" type="int"/>
  </method>
  <method name="shift" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Shifts a node from the beginning of the doubly linked list"/>
      <return type="mixed"/>
    </docblock>
  </method>
  <method name="top" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Peeks at the node from the end of the doubly linked list"/>
      <return type="mixed"/>
    </docblock>
  </method>
  <method name="unserialize" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Unserializes the storage"/>
      <return type="void"/>
    </docblock>
    <parameter name="serialized" optional="false" byreference="false" type="string"/>
  </method>
  <method name="unshift" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Prepends the doubly linked list with an element"/>
      <return type="void"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="valid" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Check whether the doubly linked list contains more nodes"/>
      <return type="bool"/>
    </docblock>
  </method>
</class>