vendor/zendframework/zend-navigation/doc/book/helpers/navigation.md

   1 # Navigation Proxy
   2
   3 The `navigation()` helper is a proxy helper that relays calls to other
   4 navigational helpers. It can be considered an entry point to all
   5 navigation-related view tasks.
   6
   7 The `Navigation` helper finds other helpers that implement
   8 `Zend\View\Helper\Navigation\HelperInterface`, which means custom view helpers
   9 can also be proxied.  This would, however, require that the custom helper path
  10 is added to the view.
  11
  12 When proxying to other helpers, the `Navigation` helper can inject its
  13 container, ACL and optionally role, and a translator. This means that you won't
  14 have to explicitly set all three in all navigational helpers, nor resort to
  15 injecting by means of static methods.
  16
  17 ## Methods
  18
  19 Method signature                                                               | Description
  20 ------------------------------------------------------------------------------ | -----------
  21 `findHelper(string $helper, bool $strict = true) : Navigation\HelperInterface` | Finds the given helper, verifies that it is a navigational helper, and injects the current container, ACL and role instances,  and translator, if present. If `$strict` is `true`, the method will raise an exception when unable to find a valid helper.
  22 `getInjectContainer() : bool`                                                  | Retrieve the flag indicating whether or not to inject the current container into proxied helpers; default is `true`.
  23 `setInjectContainer(bool $flag) : self`                                        | Set the flag indicating whether or not to inject the current container into proxied helpers.
  24 `getInjectAcl() : bool`                                                        | Retrieve the flag indicating whether or not to inject ACL and role instances into proxied helpers; default is `true`.
  25 `setInjectAcl(bool $flag) : self`                                              | Set the flag indicating whether or not to inject ACL and role instances into proxied helpers.
  26 `getInjectTranslator() : bool`                                                 | Retrieve the flag indicating whether or not to inject the current translator instance into proxied helpers; default is `true`.
  27 `setInjectTranslator(bool $flag) : self`                                       | Set the flag indicating whether or not to inject the current translator instance into proxied helpers.
  28 `getDefaultProxy() : string`                                                   | Retrieve the default proxy helper to delegate to when rendering; defaults to `menu`.
  29 `setDefaultProxy(string $helper) : self`                                       | Set the default proxy helper to delegate to when rendering.
  30 `render(AbstractContainer = null)`                                             | Proxies to the render method of the default proxy.