Zend\View\Helper\Navigation\HelperInterface
Interface for navigational helpers
Synopsis
interface HelperInterface
extends HelperInterface
{
- // methods
- public string __toString()
- public string render()
- public HelperInterface setAcl()
- public AclInterface|null getAcl()
- public bool hasAcl()
- public HelperInterface setContainer()
- public AbstractContainer getContainer()
- public bool hasContainer()
- public HelperInterface setRenderInvisible()
- public bool getRenderInvisible()
- public HelperInterface setRole()
- public RoleInterface|null getRole()
- public bool hasRole()
- public HelperInterface setUseAcl()
- public bool getUseAcl()
- // Inherited methods from HelperInterface
- public HelperInterface setView()
- public RendererInterface getView()
Hierarchy
Extends
Implemented by
Methods
public
- __toString() — Magic overload: Should proxy to {@link render()}.
- getAcl() — Returns ACL or null if it isn't set using {@link setAcl()} or {@link setDefaultAcl()}
- getContainer() — Returns the navigation container the helper operates on by default
- getRenderInvisible() — Return renderInvisible flag
- getRole() — Returns ACL role to use when iterating pages, or null if it isn't set
- getUseAcl() — Returns whether ACL should be used
- hasAcl() — Checks if the helper has an ACL instance
- hasContainer() — Checks if the helper has a container
- hasRole() — Checks if the helper has an ACL role
- render() — Renders helper
- setAcl() — Sets ACL to use when iterating pages
- setContainer() — Sets navigation container the helper should operate on by default
- setRenderInvisible() — Render invisible items?
- setRole() — Sets ACL role to use when iterating pages
- setUseAcl() — Sets whether ACL should be used