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.
Proxy helper for retrieving navigational helpers and forwarding calls

string
$_defaultProxy= ''menu''
Default proxy to use in {@link render()}
'menu'
Details
array
$_helpers= 'array()'
Contains references to proxied helpers
array()
Details
bool
$_injectAcl= 'true'
Whether ACL should be injected when proxying
true
Details
bool
$_injectContainer= 'true'
Whether container should be injected when proxying
true
Details
__call(
string $method, array $arguments
=
array()
)
:
mixed
Magic overload: Proxy to other navigation helpers or the container
Examples of usage from a view script or layout:
// 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');
Name | Type | Description |
---|---|---|
$method | string | helper name or method name in container |
$arguments | array | [optional] arguments to pass |
Type | Description |
---|---|
mixed | returns what the proxied call returns |
Exception | Description |
---|---|
\Zend_View_Exception | if proxying to a helper, and the helper is not an instance of the interface specified in {@link findHelper()} |
\Zend_Navigation_Exception | if method does not exist in container |

_inject(
\Zend_View_Helper_Navigation_Helper $helper
)
:
void
Injects container, ACL, and translator to the given $helper if this helper is configured to do so
Name | Type | Description |
---|---|---|
$helper | \Zend_View_Helper_Navigation_Helper | helper instance |

findHelper(
string $proxy, bool $strict
=
true
)
:
\Zend_View_Helper_Navigation_Helper
Returns the helper matching $proxy
The helper must implement the interface {@link Zend_View_Helper_Navigation_Helper}.
Name | Type | Description |
---|---|---|
$proxy | string | helper name |
$strict | bool | [optional] whether exceptions should be thrown if something goes wrong. Default is true. |
Type | Description |
---|---|
\Zend_View_Helper_Navigation_Helper | helper instance |
Exception | Description |
---|---|
\Zend_Loader_PluginLoader_Exception | if $strict is true and helper cannot be found |
\Zend_View_Exception | if $strict is true and helper does not implement the specified interface |

getDefaultProxy(
)
:
string
Returns the default proxy to use in {@link render()}
Type | Description |
---|---|
string | the default proxy to use in {@link render()} |

getInjectAcl(
)
:
bool
Returns whether ACL should be injected when proxying
Type | Description |
---|---|
bool | whether ACL should be injected when proxying |

getInjectContainer(
)
:
bool
Returns whether container should be injected when proxying
Type | Description |
---|---|
bool | whether container should be injected when proxying |

getInjectTranslator(
)
:
bool
Returns whether translator should be injected when proxying
Type | Description |
---|---|
bool | whether translator should be injected when proxying |

navigation(
\Zend_Navigation_Container $container
=
null
)
:
\Zend_View_Helper_Navigation
Helper entry point
Name | Type | Description |
---|---|---|
$container | \Zend_Navigation_Container | [optional] container to operate on |
Type | Description |
---|---|
\Zend_View_Helper_Navigation | fluent interface, returns self |

render(
\Zend_Navigation_Container $container
=
null
)
:
string
Renders helper
Name | Type | Description |
---|---|---|
$container | \Zend_Navigation_Container | [optional] container to render. Default is to render the container registered in the helper. |
Type | Description |
---|---|
string | helper output |
Exception | Description |
---|---|
\Zend_Loader_PluginLoader_Exception | if helper cannot be found |
\Zend_View_Exception | if helper doesn't implement the interface specified in {@link findHelper()} |

setDefaultProxy(
string $proxy
)
:
\Zend_View_Helper_Navigation
Sets the default proxy to use in {@link render()}
Name | Type | Description |
---|---|---|
$proxy | string | default proxy |
Type | Description |
---|---|
\Zend_View_Helper_Navigation | fluent interface, returns self |

setInjectAcl(
bool $injectAcl
=
true
)
:
\Zend_View_Helper_Navigation
Sets whether ACL should be injected when proxying
Name | Type | Description |
---|---|---|
$injectAcl | bool | [optional] whether ACL should be injected when proxying. Default is true. |
Type | Description |
---|---|
\Zend_View_Helper_Navigation | fluent interface, returns self |

setInjectContainer(
bool $injectContainer
=
true
)
:
\Zend_View_Helper_Navigation
Sets whether container should be injected when proxying
Name | Type | Description |
---|---|---|
$injectContainer | bool | [optional] whether container should be injected when proxying. Default is true. |
Type | Description |
---|---|
\Zend_View_Helper_Navigation | fluent interface, returns self |

setInjectTranslator(
bool $injectTranslator
=
true
)
:
\Zend_View_Helper_Navigation
Sets whether translator should be injected when proxying
Name | Type | Description |
---|---|---|
$injectTranslator | bool | [optional] whether translator should be injected when proxying. Default is true. |
Type | Description |
---|---|
\Zend_View_Helper_Navigation | fluent interface, returns self |