/
FilterIterator.php
45 lines (41 loc) · 1.49 KB
/
FilterIterator.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
<?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\Iterator;
use Cake\Collection\Collection;
use CallbackFilterIterator;
use Iterator;
/**
* Creates a filtered iterator from another iterator. The filtering is done by
* passing a callback function to each of the elements and taking them out if
* it does not return true.
*/
class FilterIterator extends Collection {
/**
* Creates a filtered iterator using the callback to determine which items are
* accepted or rejected.
*
* Each time the callback is executed it will receive the value of the element
* in the current iteration, the key of the element and the passed $items iterator
* as arguments, in that order.
*
* @param Iterator $items the items to be filtered
* @param callable $callback
* @return void
*/
public function __construct(Iterator $items, callable $callback) {
$wrapper = new CallbackFilterIterator($items, $callback);
parent::__construct($wrapper);
}
}