Fully Qualified Name: | Zend\View\Helper\Navigation\HelperInterface |
Extends: | HelperInterface |
Interface for navigational helpers
Name | Description | Defined By |
---|---|---|
__toString() | Magic overload: Should proxy to {@link render()}. | HelperInterface |
getAcl() | Returns ACL or null if it isn't set using {@link setAcl()} or {@link setDefaultAcl()} | HelperInterface |
getContainer() | Returns the navigation container the helper operates on by default | HelperInterface |
getRenderInvisible() | Return renderInvisible flag | HelperInterface |
getRole() | Returns ACL role to use when iterating pages, or null if it isn't set | HelperInterface |
getUseAcl() | Returns whether ACL should be used | HelperInterface |
getView() | Get the View object | HelperInterface |
hasAcl() | Checks if the helper has an ACL instance | HelperInterface |
hasContainer() | Checks if the helper has a container | HelperInterface |
hasRole() | Checks if the helper has an ACL role | HelperInterface |
render() | Renders helper | HelperInterface |
setAcl() | Sets ACL to use when iterating pages | HelperInterface |
setContainer() | Sets navigation container the helper should operate on by default | HelperInterface |
setRenderInvisible() | Render invisible items? | HelperInterface |
setRole() | Sets ACL role to use when iterating pages | HelperInterface |
setUseAcl() | Sets whether ACL should be used | HelperInterface |
setView() | Set the View object | HelperInterface |
Magic overload: Should proxy to {@link render()}.
Returns: string
Returns ACL or null if it isn't set using {@link setAcl()} or {@link setDefaultAcl()}
Returns: \Acl\AclInterface|null
Returns the navigation container the helper operates on by default
Returns: \Navigation\AbstractContainer navigation container
Return renderInvisible flag
Returns: bool
Returns ACL role to use when iterating pages, or null if it isn't set
Returns: string|\Acl\Role\RoleInterface|null
Returns whether ACL should be used
Returns: bool
Get the View object
Returns: \Renderer
Checks if the helper has an ACL instance
Returns: bool
Checks if the helper has a container
Returns: bool
Checks if the helper has an ACL role
Returns: bool
Renders helper
Parameter Name | Type | Description |
---|---|---|
$container | string|\Navigation\AbstractContainer | [optional] |
Returns: string helper output
Sets ACL to use when iterating pages
Parameter Name | Type | Description |
---|---|---|
$acl | \Acl\AclInterface | [optional] |
Returns: \HelperInterface
Sets navigation container the helper should operate on by default
Parameter Name | Type | Description |
---|---|---|
$container | string|\Navigation\AbstractContainer | [optional] |
Returns: \HelperInterface
Render invisible items?
Parameter Name | Type | Description |
---|---|---|
$renderInvisible | bool | [optional] |
Returns: \HelperInterface
Sets ACL role to use when iterating pages
Parameter Name | Type | Description |
---|---|---|
$role | mixed | [optional] |
Returns: \HelperInterface
Sets whether ACL should be used
Parameter Name | Type | Description |
---|---|---|
$useAcl | bool | [optional] |
Returns: \HelperInterface
Set the View object
Parameter Name | Type | Description |
---|---|---|
$view | \Renderer |
Returns: \HelperInterface