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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
<?php
declare(strict_types=1);
namespace Laminas\View\Helper;
use Laminas\Stdlib\ArrayUtils;
use Laminas\View\Exception;
use Traversable;
use function func_num_args;
use function get_class;
use function gettype;
use function is_array;
use function is_object;
use function method_exists;
use function sprintf;
/**
* Helper for rendering a template fragment in its own variable scope; iterates
* over data provided and renders for each iteration.
*/
class PartialLoop extends Partial
{
/**
* Marker to where the pointer is at in the loop
*
* @var int
*/
protected $partialCounter = 0;
/**
* The current nesting level
*/
private int $nestingLevel = 0;
/**
* Stack with object keys for each nested level
*
* @var array indexed by nesting level
*/
private array $objectKeyStack = [
0 => null,
];
/**
* Renders a template fragment within a variable scope distinct from the
* calling View object.
*
* If no arguments are provided, returns object instance.
*
* @param string $name Name of view script
* @param array $values Variables to populate in the view
* @return static|string
* @throws Exception\InvalidArgumentException
*/
public function __invoke($name = null, $values = null)
{
if (0 === func_num_args()) {
return $this;
}
return $this->loop($name, $values);
}
/**
* Renders a template fragment within a variable scope distinct from the
* calling View object.
*
* @param string $name Name of view script
* @param array $values Variables to populate in the view
* @throws Exception\InvalidArgumentException
* @return string
*/
public function loop($name = null, $values = null)
{
// reset the counter if it's called again
$this->partialCounter = 0;
$content = '';
foreach ($this->extractViewVariables($values) as $item) {
$this->nestObjectKey();
$this->partialCounter++;
$content .= parent::__invoke($name, $item);
$this->unNestObjectKey();
}
return $content;
}
/**
* Get the partial counter
*
* @return int
*/
public function getPartialCounter()
{
return $this->partialCounter;
}
/**
* Set object key in this loop and any child loop
*
* {@inheritDoc}
*
* @param string|null $key
* @return self
*/
public function setObjectKey($key)
{
if (null === $key) {
unset($this->objectKeyStack[$this->nestingLevel]);
} else {
$this->objectKeyStack[$this->nestingLevel] = (string) $key;
}
return parent::setObjectKey($key);
}
/**
* Increment nestedLevel and default objectKey to parent's value
*
* @return self
*/
private function nestObjectKey()
{
$this->nestingLevel += 1;
$this->setObjectKey($this->getObjectKey());
return $this;
}
/**
* Decrement nestedLevel and restore objectKey to parent's value
*
* @return self
*/
private function unNestObjectKey()
{
$this->setObjectKey(null);
$this->nestingLevel -= 1;
if (isset($this->objectKeyStack[$this->nestingLevel])) {
$this->objectKey = $this->objectKeyStack[$this->nestingLevel];
}
return $this;
}
/**
* @param mixed $values
* @return array Variables to populate in the view
*/
private function extractViewVariables($values)
{
if ($values instanceof Traversable) {
return ArrayUtils::iteratorToArray($values, false);
}
if (is_array($values)) {
return $values;
}
if (is_object($values) && method_exists($values, 'toArray')) {
return $values->toArray();
}
throw new Exception\InvalidArgumentException(sprintf(
'PartialLoop helper requires iterable data, %s given',
is_object($values) ? get_class($values) : gettype($values)
));
}
}