Proxy helper for retrieving navigational helpers and forwarding calls
Helper entry point
Parameters: | string|AbstractContainer – container to operate on |
---|---|
Return type: | Navigation |
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>
Parameters: |
|
---|---|
Return type: | mixed returns what the proxied call returns |
Throws : | ZendViewExceptionExceptionInterface if proxying to a helper, and the helper is not an instance of the interface specified in {@link findHelper()} |
Throws : | ZendNavigationExceptionExceptionInterface if method does not exist in container |
Set manager for retrieving navigation helpers
Parameters: | NavigationPluginManager – |
---|---|
Return type: | Navigation |
Retrieve plugin loader for navigation helpers
Lazy-loads an instance of NavigationHelperLoader if none currently registered.
Return type: | NavigationPluginManager |
---|
Returns the helper matching $proxy
The helper must implement the interface {@link ZendViewHelperNavigationHelper}.
Parameters: |
|
---|---|
Return type: | ZendViewHelperNavigationHelperInterface helper instance |
Throws : | ExceptionRuntimeException if $strict is true and helper cannot be found |
Injects container, ACL, and translator to the given $helper if this helper is configured to do so
Parameters: | NavigationHelper – helper instance |
---|---|
Return type: | void |
Sets whether container should be injected when proxying
Parameters: | bool – [optional] whether container should be injected when proxying. Default is true. |
---|---|
Return type: | ZendViewHelperNavigation fluent interface, returns self |
Returns whether container should be injected when proxying
Return type: | bool whether container should be injected when proxying |
---|
Sets whether ACL should be injected when proxying
Parameters: | bool – [optional] whether ACL should be injected when proxying. Default is true. |
---|---|
Return type: | ZendViewHelperNavigation fluent interface, returns self |
Returns whether ACL should be injected when proxying
Return type: | bool whether ACL should be injected when proxying |
---|
Sets whether translator should be injected when proxying
Parameters: | bool – [optional] whether translator should be injected when proxying. Default is true. |
---|---|
Return type: | Navigation fluent interface, returns self |
Returns whether translator should be injected when proxying
Return type: | bool whether translator should be injected when proxying |
---|
Renders helper
Parameters: | ZendNavigationAbstractContainer – [optional] container to render. Default is to render the container registered in the helper. |
---|---|
Return type: | string helper output |
Throws : | ExceptionRuntimeException if helper cannot be found |
Full-text doc search.
Enter search terms or a module, class or function name.