/
Collection.php
59 lines (51 loc) · 1.62 KB
/
Collection.php
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
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since CakePHP(tm) v 3.0.0
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
namespace Cake\Collection;
use ArrayIterator;
use Cake\Collection\CollectionTrait;
use InvalidArgumentException;
use IteratorIterator;
use JsonSerializable;
/**
* A collection is an immutable list of elements with a handful of functions to
* iterate, group, transform and extract information from it.
*/
class Collection extends IteratorIterator implements JsonSerializable {
use CollectionTrait;
/**
* Constructor. You can provide an array or any traversable object
*
* @param array|\Traversable $items
* @throws InvalidArgumentException if passed incorrect type for items.
*/
public function __construct($items) {
if (is_array($items)) {
$items = new ArrayIterator($items);
}
if (!($items instanceof \Traversable)) {
$msg = 'Only array or \Traversable are allowed for Collection';
throw new InvalidArgumentException($msg);
}
parent::__construct($items);
}
/**
* Returns the iterator with this collection's elements
*
* @return \Traversable
*/
public function getIterator() {
return $this->_iterator;
}
}