Source for file Collection.php

Documentation is available at Collection.php

1: <?php
2:
3: /**
4: * Nette Framework
5: *
6: * Copyright (c) 2004, 2009 David Grudl (http://davidgrudl.com)
7: *
8: * This source file is subject to the "Nette license" that is bundled
9: * with this package in the file license.txt.
10: *
11: * For more information please see https://nette.org
12: *
13: * @copyright Copyright (c) 2004, 2009 David Grudl
14: * @license https://nette.org/license Nette license
15: * @link https://nette.org
16: * @category Nette
17: * @package Nette\Collections
18: * @version $Id$
19: */
20:
21:
22:
23: require_once dirname(__FILE__) . '/../Collections/ICollection.php';
24:
25:
26:
27: /**
28: * SPL ArrayObject customization.
29: *
30: * @author David Grudl
31: * @copyright Copyright (c) 2004, 2009 David Grudl
32: * @package Nette\Collections
33: */
34: abstract class Collection extends ArrayObject implements ICollection
35: {
36: /** @var string type (class, interface, PHP type) */
37: protected $itemType;
38:
39: /** @var string function to verify type */
40: protected $checkFunc;
41:
42: /** @var bool */
43: protected $readOnly = FALSE;
44:
45:
46:
47: /**
48: * @param array to wrap
49: * @param string class/interface name or ':type'
50: * @throws InvalidArgumentException
51: */
52: public function __construct($arr = NULL, $type = NULL)
53: {
54: if (substr($type, 0, 1) === ':') {
55: $this->itemType = substr($type, 1);
56: $this->checkFunc = 'is_' . $this->itemType;
57: } else {
58: $this->itemType = $type;
59: }
60:
61: if ($arr !== NULL) {
62: $this->import($arr);
63: }
64: }
65:
66:
67:
68: /**
69: * Prevent any more modifications.
70: * @return void
71: */
72: public function setReadOnly()
73: {
74: $this->readOnly = TRUE;
75: }
76:
77:
78:
79: /**
80: * Appends the specified element to the end of this collection.
81: * @param mixed
82: * @return void
83: * @throws InvalidArgumentException
84: */
85: public function append($item)
86: {
87: $this->beforeAdd($item);
88: parent::append($item);
89: }
90:
91:
92:
93: /**
94: * Removes the first occurrence of the specified element.
95: * @param mixed
96: * @return bool true if this collection changed as a result of the call
97: * @throws NotSupportedException
98: */
99: public function remove($item)
100: {
101: $this->beforeRemove();
102: $index = $this->search($item);
103: if ($index === FALSE) {
104: return FALSE;
105: } else {
106: parent::offsetUnset($index);
107: return TRUE;
108: }
109: }
110:
111:
112:
113: /**
114: * Returns the index of the first occurrence of the specified element,.
115: * or FALSE if this collection does not contain this element.
116: * @param mixed
117: * @return int|FALSE
118: */
119: protected function search($item)
120: {
121: return array_search($item, $this->getArrayCopy(), TRUE);
122: }
123:
124:
125:
126: /**
127: * Removes all of the elements from this collection.
128: * @return void
129: * @throws NotSupportedException
130: */
131: public function clear()
132: {
133: $this->beforeRemove();
134: parent::exchangeArray(array());
135: }
136:
137:
138:
139: /**
140: * Returns true if this collection contains the specified item.
141: * @param mixed
142: * @return bool
143: */
144: public function contains($item)
145: {
146: return $this->search($item) !== FALSE;
147: }
148:
149:
150:
151: /**
152: * Import from array or any traversable object.
153: * @param array|\Traversable
154: * @return void
155: * @throws InvalidArgumentException
156: */
157: public function import($arr)
158: {
159: if (!(is_array($arr) || $arr instanceof Traversable)) {
160: throw new InvalidArgumentException("Argument must be traversable.");
161: }
162:
163: $this->clear();
164: foreach ($arr as $item) {
165: $this->offsetSet(NULL, $item);
166: }
167: }
168:
169:
170:
171: /**
172: * Returns a value indicating whether collection is read-only.
173: * @return bool
174: */
175: public function isReadOnly()
176: {
177: return $this->readOnly;
178: }
179:
180:
181:
182: /********************* internal notifications ****************d*g**/
183:
184:
185:
186: /**
187: * Responds when the item is about to be added to the collection.
188: * @param mixed
189: * @return void
190: * @throws InvalidArgumentException, \NotSupportedException
191: */
192: protected function beforeAdd($item)
193: {
194: if ($this->readOnly) {
195: throw new NotSupportedException('Collection is read-only.');
196: }
197:
198: if ($this->itemType !== NULL) {
199: if ($this->checkFunc === NULL) {
200: if (!($item instanceof $this->itemType)) {
201: throw new InvalidArgumentException("Item must be '$this->itemType' object.");
202: }
203: } else {
204: $fnc = $this->checkFunc;
205: if (!$fnc($item)) {
206: throw new InvalidArgumentException("Item must be $this->itemType type.");
207: }
208: }
209: }
210: }
211:
212:
213:
214: /**
215: * Responds when an item is about to be removed from the collection.
216: * @return void
217: * @throws NotSupportedException
218: */
219: protected function beforeRemove()
220: {
221: if ($this->readOnly) {
222: throw new NotSupportedException('Collection is read-only.');
223: }
224: }
225:
226:
227:
228: /********************* ArrayObject cooperation ****************d*g**/
229:
230:
231:
232: /**
233: * Returns the iterator.
234: * @return ArrayIterator
235: */
236: public function getIterator()
237: {
238: return new ArrayIterator($this->getArrayCopy());
239: }
240:
241:
242:
243: /**
244: * Not supported. Use import().
245: */
246: public function exchangeArray($array)
247: {
248: throw new NotSupportedException('Use ' . __CLASS__ . '::import()');
249: }
250:
251:
252:
253: /**
254: * Protected exchangeArray().
255: * @param array new array
256: * @return void
257: */
258: protected function setArray($array)
259: {
260: parent::exchangeArray($array);
261: }
262:
263:
264:
265: /********************* Nette\Object behaviour ****************d*g**/
266:
267:
268:
269: /**
270: * Returns the name of the class of this object.
271: *
272: * @return string
273: */
274: final public function getClass()
275: {
276: return get_class($this);
277: }
278:
279:
280:
281: /**
282: * Call to undefined method.
283: *
284: * @throws MemberAccessException
285: */
286: public function __call($name, $args)
287: {
288: return ObjectMixin::call($this, $name, $args);
289: }
290:
291:
292:
293: /**
294: * Call to undefined static method.
295: *
296: * @throws MemberAccessException
297: */
298: public static function __callStatic($name, $args)
299: {
300: $class = get_called_class();
301: throw new MemberAccessException("Call to undefined static method $class::$name().");
302: }
303:
304:
305:
306: /**
307: * Returns property value. Do not call directly.
308: *
309: * @throws MemberAccessException if the property is not defined.
310: */
311: public function &__get($name)
312: {
313: return ObjectMixin::get($this, $name);
314: }
315:
316:
317:
318: /**
319: * Sets value of a property. Do not call directly.
320: *
321: * @throws MemberAccessException if the property is not defined or is read-only
322: */
323: public function __set($name, $value)
324: {
325: return ObjectMixin::set($this, $name, $value);
326: }
327:
328:
329:
330: /**
331: * Is property defined?
332: *
333: * @param string property name
334: * @return bool
335: */
336: public function __isset($name)
337: {
338: return ObjectMixin::has($this, $name);
339: }
340:
341:
342:
343: /**
344: * Access to undeclared property.
345: *
346: * @throws MemberAccessException
347: */
348: public function __unset($name)
349: {
350: throw new MemberAccessException("Cannot unset the property $this->class::\$$name.");
351: }
352:
353: }

Source for file Collection.php

Namespaces