Repository navigation
Expand file tree
/
Copy pathclass.Collection.php
More file actions
345 lines (279 loc) · 8.1 KB
/
Copy pathclass.Collection.php
File metadata and controls
345 lines (279 loc) · 8.1 KB
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
<?php
/**
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; under version 2
* of the License (non-upgradable).
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* Copyright (c) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg
* (under the project TAO & TAO2);
* 2008-2010 (update and modification) Deutsche Institut für Internationale Pädagogische Forschung
* (under the project TAO-TRANSFER);
* 2009-2012 (update and modification) Public Research Centre Henri Tudor
* (under the project TAO-SUSTAIN & TAO-DEV);
*
*/
/**
* Generis Object Oriented API - common\class.Collection.php
*
* Object Collection
*
* This file is part of Generis Object Oriented API.
*
* Automatically generated on 24.03.2010, 14:38:36 with ArgoUML PHP module
* (last revised $Date: 2008-04-19 08:22:08 +0200 (Sat, 19 Apr 2008) $)
*
* @author Lionel Lecaque <lionel.lecaque@tudor.lu>
* @package generis
* @see @license GNU General Public (GPL) Version 2 http://www.opensource.org/licenses/gpl-2.0.php
*/
class common_Collection extends common_Object implements IteratorAggregate, Countable
{
// --- ASSOCIATIONS ---
// --- ATTRIBUTES ---
/**
* Short description of attribute sequence
*
* @access public
* @var array
*/
public $sequence = [];
/**
* Short description of attribute container
*
* @access public
* @var Object
*/
public $container = null;
// --- OPERATIONS ---
/**
* Short description of method __construct
*
* @access public
* @author Lionel Lecaque <lionel.lecaque@tudor.lu>
* @param Object container
* @param string debug
* @return void
*/
public function __construct(common_Object $container, $debug = '')
{
$this->sequence = [];
$this->container = $container;
}
/**
* return the number of node of the collection (only this level)
*
* @author Lionel Lecaque <lionel.lecaque@tudor.lu>
*/
#[ReturnTypeWillChange]
public function count()
{
return count($this->sequence);
}
/**
* return the index of the node array at which the given node resides
*
* @access public
* @author Lionel Lecaque <lionel.lecaque@tudor.lu>
* @param Object object
* @return int
*/
public function indexOf(common_Object $object)
{
$returnValue = (int) 0;
$returnValue = -1;
foreach ($this->sequence as $index => $_object) {
if ($object === $_object) {
return $index;
}
}
return (int) $returnValue;
}
/**
* Retrun the node at the given index
*
* @access public
* @author Lionel Lecaque <lionel.lecaque@tudor.lu>
* @param int index
* @return common_Object
*/
public function get($index)
{
$returnValue = null;
$returnValue = isset($this->sequence[$index]) ? $this->sequence[$index] : null;
if ($returnValue == null) {
throw new common_Exception('index is out of range');
}
return $returnValue;
}
/**
* Short description of method isEmpty
*
* @access public
* @author Lionel Lecaque <lionel.lecaque@tudor.lu>
* @return boolean
*/
public function isEmpty()
{
$returnValue = (bool) false;
$returnValue = (count($this->sequence) == 0);
return (bool) $returnValue;
}
/**
* Implementation of ArrayAccess:offsetSet()
*
* @access public
* @author Lionel Lecaque <lionel.lecaque@tudor.lu>
* @param Object key
* @param Object value
* @return void
*/
public function offsetSet(common_Object $key, common_Object $value)
{
$this->sequence[$key] = $value;
}
/**
* Implementation of ArrayAccess:offsetGet()
*
* @access public
* @author Lionel Lecaque <lionel.lecaque@tudor.lu>
* @param Object key
* @return common_Object
*/
public function offsetGet(common_Object $key)
{
$returnValue = null;
$returnValue = $this->sequence[$key];
return $returnValue;
}
/**
* Implementation of ArrayAccess:offsetUnset()
*
* @access public
* @author Lionel Lecaque <lionel.lecaque@tudor.lu>
* @param Object key
* @return void
*/
public function offsetUnset(common_Object $key)
{
unset($this->sequence[$key]);
}
/**
* Implementation of ArrayAccess:offsetExists()
*
* @access public
* @author Lionel Lecaque <lionel.lecaque@tudor.lu>
* @param Object key
* @return boolean
*/
public function offsetExists(common_Object $key)
{
$returnValue = (bool) false;
$returnValue = isset($this->sequence[$key]);
return (bool) $returnValue;
}
/**
* Implementation of IteratorAggregate::getIterator()
*
* @access public
* @author Lionel Lecaque <lionel.lecaque@tudor.lu>
* @return mixed
*/
#[ReturnTypeWillChange]
public function getIterator()
{
return new ArrayIterator($this->sequence);
}
/**
* Add a node to the collection
*
* @access public
* @author Lionel Lecaque <lionel.lecaque@tudor.lu>
* @param Object node
* @return mixed
*/
public function add(common_Object $node)
{
$this->sequence[] = $node;
$returnValue = $node;
}
/**
* Remove the node from the collection
*
* @access public
* @author Lionel Lecaque <lionel.lecaque@tudor.lu>
* @param Object object
* @return boolean
*/
public function remove(common_Object $object)
{
$returnValue = (bool) false;
foreach ($this->sequence as $index => $_node) {
if ($_node === $object) {
unset($this->sequence[$index]);
$this->sequence = array_values($this->sequence);
return true;
}
}
return false;
return (bool) $returnValue;
}
/**
* Short description of method union
*
* @access public
* @author Lionel Lecaque <lionel.lecaque@tudor.lu>
* @param Collection collection
* @return common_Collection
*/
public function union(common_Collection $collection)
{
$returnValue = null;
$returnValue = new common_Collection($this);
$returnValue->sequence = array_merge($this->sequence, $collection->sequence);
return $returnValue;
}
/**
* Short description of method intersect
*
* @access public
* @author Lionel Lecaque <lionel.lecaque@tudor.lu>
* @param Collection collection
* @return common_Collection
*/
public function intersect(common_Collection $collection)
{
$returnValue = null;
$returnValue = new common_Collection(new common_Object(__METHOD__));
$returnValue->sequence = array_uintersect(
$this->sequence,
$collection->sequence,
'core_kernel_classes_ContainerComparator::compare'
);
return $returnValue;
}
/**
* Short description of method toArray
*
* @access public
* @author Lionel Lecaque <lionel.lecaque@tudor.lu>
* @return array
*/
public function toArray()
{
$returnValue = [];
foreach ($this->getIterator() as $it) {
$returnValue[] = $it;
}
return (array) $returnValue;
}
}