-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
ExtractIterator.php
105 lines (92 loc) · 2.9 KB
/
ExtractIterator.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
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
<?php
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://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. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Collection\Iterator;
use ArrayIterator;
use Cake\Collection\Collection;
use Cake\Collection\CollectionInterface;
use Iterator;
/**
* Creates an iterator from another iterator that extract the requested column
* or property based on a path
*/
class ExtractIterator extends Collection
{
/**
* A callable responsible for extracting a single value for each
* item in the collection.
*
* @var callable
*/
protected $_extractor;
/**
* Creates the iterator that will return the requested property for each value
* in the collection expressed in $path
*
* ### Example:
*
* Extract the user name for all comments in the array:
*
* ```
* $items = [
* ['comment' => ['body' => 'cool', 'user' => ['name' => 'Mark']],
* ['comment' => ['body' => 'very cool', 'user' => ['name' => 'Renan']]
* ];
* $extractor = new ExtractIterator($items, 'comment.user.name'');
* ```
*
* @param iterable $items The list of values to iterate
* @param callable|string $path A dot separated path of column to follow
* so that the final one can be returned or a callable that will take care
* of doing that.
*/
public function __construct(iterable $items, callable|string $path)
{
$this->_extractor = $this->_propertyExtractor($path);
parent::__construct($items);
}
/**
* Returns the column value defined in $path or null if the path could not be
* followed
*
* @return mixed
*/
public function current(): mixed
{
$extractor = $this->_extractor;
return $extractor(parent::current());
}
/**
* @inheritDoc
*/
public function unwrap(): Iterator
{
$iterator = $this->getInnerIterator();
if ($iterator instanceof CollectionInterface) {
$iterator = $iterator->unwrap();
}
if ($iterator::class !== ArrayIterator::class) {
return $this;
}
// ArrayIterator can be traversed strictly.
// Let's do that for performance gains
$callback = $this->_extractor;
$res = [];
foreach ($iterator->getArrayCopy() as $k => $v) {
$res[$k] = $callback($v);
}
return new ArrayIterator($res);
}
}