/
TreePrinter.php
136 lines (121 loc) · 3.46 KB
/
TreePrinter.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
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
<?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 Cake\Collection\CollectionInterface;
use Cake\Collection\CollectionTrait;
use RecursiveIterator;
use RecursiveIteratorIterator;
/**
* Iterator for flattening elements in a tree structure while adding some
* visual markers for their relative position in the tree
*/
class TreePrinter extends RecursiveIteratorIterator implements CollectionInterface
{
use CollectionTrait;
/**
* A callable to generate the iteration key
*
* @var callable
*/
protected $_key;
/**
* A callable to extract the display value
*
* @var callable
*/
protected $_value;
/**
* Cached value for the current iteration element
*
* @var mixed
*/
protected $_current;
/**
* The string to use for prefixing the values according to their depth in the tree.
*
* @var string
*/
protected $_spacer;
/**
* Constructor
*
* @param \RecursiveIterator $items The iterator to flatten.
* @param callable|string $valuePath The property to extract or a callable to return
* the display value.
* @param callable|string $keyPath The property to use as iteration key or a
* callable returning the key value.
* @param string $spacer The string to use for prefixing the values according to
* their depth in the tree.
* @param int $mode Iterator mode.
*/
public function __construct(
RecursiveIterator $items,
$valuePath,
$keyPath,
string $spacer,
int $mode = RecursiveIteratorIterator::SELF_FIRST
) {
parent::__construct($items, $mode);
$this->_value = $this->_propertyExtractor($valuePath);
$this->_key = $this->_propertyExtractor($keyPath);
$this->_spacer = $spacer;
}
/**
* Returns the current iteration key
*
* @return mixed
*/
#[\ReturnTypeWillChange]
public function key()
{
$extractor = $this->_key;
return $extractor($this->_fetchCurrent(), parent::key(), $this);
}
/**
* Returns the current iteration value
*
* @return string
*/
public function current(): string
{
$extractor = $this->_value;
$current = $this->_fetchCurrent();
$spacer = str_repeat($this->_spacer, $this->getDepth());
return $spacer . $extractor($current, parent::key(), $this);
}
/**
* Advances the cursor one position
*
* @return void
*/
public function next(): void
{
parent::next();
$this->_current = null;
}
/**
* Returns the current iteration element and caches its value
*
* @return mixed
*/
protected function _fetchCurrent()
{
if ($this->_current !== null) {
return $this->_current;
}
return $this->_current = parent::current();
}
}