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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\View\Helper;
use Zend\Navigation\AbstractContainer;
use Zend\View\Exception;
use Zend\View\Helper\Navigation\AbstractHelper as AbstractNavigationHelper;
use Zend\View\Helper\Navigation\HelperInterface as NavigationHelper;
use Zend\View\Renderer\RendererInterface as Renderer;
/**
* Proxy helper for retrieving navigational helpers and forwarding calls
*
* @method \Zend\View\Helper\Navigation\Breadcrumbs breadcrumbs($container = null)
* @method \Zend\View\Helper\Navigation\Links links($container = null)
* @method \Zend\View\Helper\Navigation\Menu menu($container = null)
* @method \Zend\View\Helper\Navigation\Sitemap sitemap($container = null)
*/
class Navigation extends AbstractNavigationHelper
{
/**
* View helper namespace
*
* @var string
*/
const NS = 'Zend\View\Helper\Navigation';
/**
* Default proxy to use in {@link render()}
*
* @var string
*/
protected $defaultProxy = 'menu';
/**
* Indicates whether or not a given helper has been injected
*
* @var array
*/
protected $injected = [];
/**
* Whether ACL should be injected when proxying
*
* @var bool
*/
protected $injectAcl = true;
/**
* Whether container should be injected when proxying
*
* @var bool
*/
protected $injectContainer = true;
/**
* Whether translator should be injected when proxying
*
* @var bool
*/
protected $injectTranslator = true;
/**
* @var Navigation\PluginManager
*/
protected $plugins;
/**
* Helper entry point
*
* @param string|AbstractContainer $container container to operate on
* @return Navigation
*/
public function __invoke($container = null)
{
if (null !== $container) {
$this->setContainer($container);
}
return $this;
}
/**
* Magic overload: Proxy to other navigation helpers or the container
*
* Examples of usage from a view script or layout:
* <code>
* // proxy to Menu helper and render container:
* echo $this->navigation()->menu();
*
* // proxy to Breadcrumbs helper and set indentation:
* $this->navigation()->breadcrumbs()->setIndent(8);
*
* // proxy to container and find all pages with 'blog' route:
* $blogPages = $this->navigation()->findAllByRoute('blog');
* </code>
*
* @param string $method helper name or method name in container
* @param array $arguments [optional] arguments to pass
* @throws \Zend\View\Exception\ExceptionInterface if proxying to a helper, and the
* helper is not an instance of the
* interface specified in
* {@link findHelper()}
* @throws \Zend\Navigation\Exception\ExceptionInterface if method does not exist in container
* @return mixed returns what the proxied call returns
*/
public function __call($method, array $arguments = [])
{
// check if call should proxy to another helper
$helper = $this->findHelper($method, false);
if ($helper) {
if (method_exists($helper, 'setServiceLocator') && $this->getServiceLocator()) {
$helper->setServiceLocator($this->getServiceLocator());
}
return call_user_func_array($helper, $arguments);
}
// default behaviour: proxy call to container
return parent::__call($method, $arguments);
}
/**
* Renders helper
*
* @param AbstractContainer $container
* @return string
* @throws Exception\RuntimeException
*/
public function render($container = null)
{
return $this->findHelper($this->getDefaultProxy())->render($container);
}
/**
* Returns the helper matching $proxy
*
* The helper must implement the interface
* {@link Zend\View\Helper\Navigation\Helper}.
*
* @param string $proxy helper name
* @param bool $strict [optional] whether exceptions should be
* thrown if something goes
* wrong. Default is true.
* @throws Exception\RuntimeException if $strict is true and helper cannot be found
* @return \Zend\View\Helper\Navigation\HelperInterface helper instance
*/
public function findHelper($proxy, $strict = true)
{
$plugins = $this->getPluginManager();
if (! $plugins->has($proxy)) {
if ($strict) {
throw new Exception\RuntimeException(sprintf(
'Failed to find plugin for %s',
$proxy
));
}
return false;
}
$helper = $plugins->get($proxy);
$container = $this->getContainer();
$hash = spl_object_hash($container) . spl_object_hash($helper);
if (! isset($this->injected[$hash])) {
$helper->setContainer();
$this->inject($helper);
$this->injected[$hash] = true;
} else {
if ($this->getInjectContainer()) {
$helper->setContainer($container);
}
}
return $helper;
}
/**
* Injects container, ACL, and translator to the given $helper if this
* helper is configured to do so
*
* @param NavigationHelper $helper helper instance
* @return void
*/
protected function inject(NavigationHelper $helper)
{
if ($this->getInjectContainer() && ! $helper->hasContainer()) {
$helper->setContainer($this->getContainer());
}
if ($this->getInjectAcl()) {
if (! $helper->hasAcl()) {
$helper->setAcl($this->getAcl());
}
if (! $helper->hasRole()) {
$helper->setRole($this->getRole());
}
}
if ($this->getInjectTranslator() && ! $helper->hasTranslator()) {
$helper->setTranslator(
$this->getTranslator(),
$this->getTranslatorTextDomain()
);
}
}
/**
* Sets the default proxy to use in {@link render()}
*
* @param string $proxy default proxy
* @return Navigation
*/
public function setDefaultProxy($proxy)
{
$this->defaultProxy = (string) $proxy;
return $this;
}
/**
* Returns the default proxy to use in {@link render()}
*
* @return string
*/
public function getDefaultProxy()
{
return $this->defaultProxy;
}
/**
* Sets whether container should be injected when proxying
*
* @param bool $injectContainer
* @return Navigation
*/
public function setInjectContainer($injectContainer = true)
{
$this->injectContainer = (bool) $injectContainer;
return $this;
}
/**
* Returns whether container should be injected when proxying
*
* @return bool
*/
public function getInjectContainer()
{
return $this->injectContainer;
}
/**
* Sets whether ACL should be injected when proxying
*
* @param bool $injectAcl
* @return Navigation
*/
public function setInjectAcl($injectAcl = true)
{
$this->injectAcl = (bool) $injectAcl;
return $this;
}
/**
* Returns whether ACL should be injected when proxying
*
* @return bool
*/
public function getInjectAcl()
{
return $this->injectAcl;
}
/**
* Sets whether translator should be injected when proxying
*
* @param bool $injectTranslator
* @return Navigation
*/
public function setInjectTranslator($injectTranslator = true)
{
$this->injectTranslator = (bool) $injectTranslator;
return $this;
}
/**
* Returns whether translator should be injected when proxying
*
* @return bool
*/
public function getInjectTranslator()
{
return $this->injectTranslator;
}
/**
* Set manager for retrieving navigation helpers
*
* @param Navigation\PluginManager $plugins
* @return Navigation
*/
public function setPluginManager(Navigation\PluginManager $plugins)
{
$renderer = $this->getView();
if ($renderer) {
$plugins->setRenderer($renderer);
}
$this->plugins = $plugins;
return $this;
}
/**
* Retrieve plugin loader for navigation helpers
*
* Lazy-loads an instance of Navigation\HelperLoader if none currently
* registered.
*
* @return Navigation\PluginManager
*/
public function getPluginManager()
{
if (null === $this->plugins) {
$this->setPluginManager(new Navigation\PluginManager($this->getServiceLocator()));
}
return $this->plugins;
}
/**
* Set the View object
*
* @param Renderer $view
* @return self
*/
public function setView(Renderer $view)
{
parent::setView($view);
if ($view && $this->plugins) {
$this->plugins->setRenderer($view);
}
return $this;
}
}