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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
|
<?php
/**
* Zend Framework
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://framework.zend.com/license/new-bsd
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@zend.com so we can send you a copy immediately.
*
* @category Zend
* @package Zend_Controller
* @subpackage Zend_Controller_Action
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @version $Id$
*/
/**
* @category Zend
* @package Zend_Controller
* @subpackage Zend_Controller_Action
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
class Zend_Controller_Action_HelperBroker_PriorityStack implements IteratorAggregate, ArrayAccess, Countable
{
protected $_helpersByPriority = array();
protected $_helpersByNameRef = array();
protected $_nextDefaultPriority = 1;
/**
* Magic property overloading for returning helper by name
*
* @param string $helperName The helper name
* @return Zend_Controller_Action_Helper_Abstract
*/
public function __get($helperName)
{
if (!array_key_exists($helperName, $this->_helpersByNameRef)) {
return false;
}
return $this->_helpersByNameRef[$helperName];
}
/**
* Magic property overloading for returning if helper is set by name
*
* @param string $helperName The helper name
* @return Zend_Controller_Action_Helper_Abstract
*/
public function __isset($helperName)
{
return array_key_exists($helperName, $this->_helpersByNameRef);
}
/**
* Magic property overloading for unsetting if helper is exists by name
*
* @param string $helperName The helper name
*/
public function __unset($helperName)
{
$this->offsetUnset($helperName);
}
/**
* push helper onto the stack
*
* @param Zend_Controller_Action_Helper_Abstract $helper
* @return Zend_Controller_Action_HelperBroker_PriorityStack
*/
public function push(Zend_Controller_Action_Helper_Abstract $helper)
{
$this->offsetSet($this->getNextFreeHigherPriority(), $helper);
return $this;
}
/**
* Return something iterable
*
* @return Traversable
*/
public function getIterator(): Traversable
{
return new ArrayObject($this->_helpersByPriority);
}
/**
* offsetExists()
*
* @param int|string $priorityOrHelperName
* @return bool
*/
public function offsetExists($priorityOrHelperName): bool
{
if (is_string($priorityOrHelperName)) {
return array_key_exists($priorityOrHelperName, $this->_helpersByNameRef);
} else {
return array_key_exists($priorityOrHelperName, $this->_helpersByPriority);
}
}
/**
* offsetGet()
*
* @param int|string $priorityOrHelperName
* @return Zend_Controller_Action_Helper_Abstract
*/
public function offsetGet($priorityOrHelperName): Zend_Controller_Action_Helper_Abstract
{
if (!$this->offsetExists($priorityOrHelperName)) {
throw new Zend_Controller_Action_Exception('A helper with priority ' . $priorityOrHelperName . ' does not exist.');
}
if (is_string($priorityOrHelperName)) {
return $this->_helpersByNameRef[$priorityOrHelperName];
} else {
return $this->_helpersByPriority[$priorityOrHelperName];
}
}
/**
* offsetSet()
*
* @param int $priority
* @param Zend_Controller_Action_Helper_Abstract $helper
*/
public function offsetSet($priority, $helper): void
{
$priority = (int) $priority;
if (!$helper instanceof Zend_Controller_Action_Helper_Abstract) {
throw new Zend_Controller_Action_Exception('$helper must extend Zend_Controller_Action_Helper_Abstract.');
}
if (array_key_exists($helper->getName(), $this->_helpersByNameRef)) {
// remove any object with the same name to retain BC compailitbility
// @todo At ZF 2.0 time throw an exception here.
$this->offsetUnset($helper->getName());
}
if (array_key_exists($priority, $this->_helpersByPriority)) {
$priority = $this->getNextFreeHigherPriority($priority); // ensures LIFO
trigger_error("A helper with the same priority already exists, reassigning to $priority", E_USER_WARNING);
}
$this->_helpersByPriority[$priority] = $helper;
$this->_helpersByNameRef[$helper->getName()] = $helper;
if ($priority == ($nextFreeDefault = $this->getNextFreeHigherPriority($this->_nextDefaultPriority))) {
$this->_nextDefaultPriority = $nextFreeDefault;
}
krsort($this->_helpersByPriority); // always make sure priority and LIFO are both enforced
}
/**
* offsetUnset()
*
* @param int|string $priorityOrHelperName Priority integer or the helper name
*/
public function offsetUnset($priorityOrHelperName): void
{
if (!$this->offsetExists($priorityOrHelperName)) {
throw new Zend_Controller_Action_Exception('A helper with priority or name ' . $priorityOrHelperName . ' does not exist.');
}
if (is_string($priorityOrHelperName)) {
$helperName = $priorityOrHelperName;
$helper = $this->_helpersByNameRef[$helperName];
$priority = array_search($helper, $this->_helpersByPriority, true);
} else {
$priority = $priorityOrHelperName;
$helperName = $this->_helpersByPriority[$priorityOrHelperName]->getName();
}
unset($this->_helpersByNameRef[$helperName]);
unset($this->_helpersByPriority[$priority]);
}
/**
* return the count of helpers
*
* @return int
*/
public function count(): int
{
return count($this->_helpersByPriority);
}
/**
* Find the next free higher priority. If an index is given, it will
* find the next free highest priority after it.
*
* @param int $indexPriority OPTIONAL
* @return int
*/
public function getNextFreeHigherPriority($indexPriority = null)
{
if ($indexPriority == null) {
$indexPriority = $this->_nextDefaultPriority;
}
$priorities = array_keys($this->_helpersByPriority);
while (in_array($indexPriority, $priorities)) {
$indexPriority++;
}
return $indexPriority;
}
/**
* Find the next free lower priority. If an index is given, it will
* find the next free lower priority before it.
*
* @param int $indexPriority
* @return int
*/
public function getNextFreeLowerPriority($indexPriority = null)
{
if ($indexPriority == null) {
$indexPriority = $this->_nextDefaultPriority;
}
$priorities = array_keys($this->_helpersByPriority);
while (in_array($indexPriority, $priorities)) {
$indexPriority--;
}
return $indexPriority;
}
/**
* return the highest priority
*
* @return int
*/
public function getHighestPriority()
{
return max(array_keys($this->_helpersByPriority));
}
/**
* return the lowest priority
*
* @return int
*/
public function getLowestPriority()
{
return min(array_keys($this->_helpersByPriority));
}
/**
* return the helpers referenced by name
*
* @return array
*/
public function getHelpersByName()
{
return $this->_helpersByNameRef;
}
}
|
