1238. Function

1238.1. Zend\View\Helper\Navigation\setContainer

ZendViewHelperNavigationsetContainer()

Sets navigation container the helper should operate on by default

Parameters:string|NavigationAbstractContainer – [optional] container to operate on. Default is null, which indicates that the container should be reset.
Return type:HelperInterface fluent interface, returns self

1239. Function

1239.1. Zend\View\Helper\Navigation\getContainer

ZendViewHelperNavigationgetContainer()

Returns the navigation container the helper operates on by default

Return type:NavigationAbstractContainer navigation container

1240. Function

1240.1. Zend\View\Helper\Navigation\setAcl

ZendViewHelperNavigationsetAcl()

Sets ACL to use when iterating pages

Parameters:AclAclInterface – [optional] ACL instance
Return type:HelperInterface fluent interface, returns self

1241. Function

1241.1. Zend\View\Helper\Navigation\getAcl

ZendViewHelperNavigationgetAcl()

Returns ACL or null if it isn’t set using {@link setAcl()} or {@link setDefaultAcl()}

Return type:AclAclInterface|null ACL object or null

1242. Function

1242.1. Zend\View\Helper\Navigation\setRole

ZendViewHelperNavigationsetRole()

Sets ACL role to use when iterating pages

Parameters:mixed – [optional] role to set. Expects a string, an instance of type {@link AclRole}, or null. Default is null.
Throws ZendViewExceptionExceptionInterface:
 if $role is invalid
Return type:HelperInterface fluent interface, returns self

1243. Function

1243.1. Zend\View\Helper\Navigation\getRole

ZendViewHelperNavigationgetRole()

Returns ACL role to use when iterating pages, or null if it isn’t set

Return type:string|AclRoleRoleInterface|null role or null

1244. Function

1244.1. Zend\View\Helper\Navigation\setUseAcl

ZendViewHelperNavigationsetUseAcl()

Sets whether ACL should be used

Parameters:bool – [optional] whether ACL should be used. Default is true.
Return type:HelperInterface fluent interface, returns self

1245. Function

1245.1. Zend\View\Helper\Navigation\getUseAcl

ZendViewHelperNavigationgetUseAcl()

Returns whether ACL should be used

Return type:bool whether ACL should be used

1246. Function

1246.1. Zend\View\Helper\Navigation\getRenderInvisible

ZendViewHelperNavigationgetRenderInvisible()

Return renderInvisible flag

Return type:bool

1247. Function

1247.1. Zend\View\Helper\Navigation\setRenderInvisible

ZendViewHelperNavigationsetRenderInvisible()

Render invisible items?

Parameters:bool – [optional] boolean flag
Return type:HelperInterface fluent interface returns self

1248. Function

1248.1. Zend\View\Helper\Navigation\hasContainer

ZendViewHelperNavigationhasContainer()

Checks if the helper has a container

Return type:bool whether the helper has a container or not

1249. Function

1249.1. Zend\View\Helper\Navigation\hasAcl

ZendViewHelperNavigationhasAcl()

Checks if the helper has an ACL instance

Return type:bool whether the helper has a an ACL instance or not

1250. Function

1250.1. Zend\View\Helper\Navigation\hasRole

ZendViewHelperNavigationhasRole()

Checks if the helper has an ACL role

Return type:bool whether the helper has a an ACL role or not

1251. Function

1251.1. Zend\View\Helper\Navigation\__toString

ZendViewHelperNavigation__toString()

Magic overload: Should proxy to {@link render()}.

Return type:string

1252. Function

1252.1. Zend\View\Helper\Navigation\render

ZendViewHelperNavigationrender()

Renders helper

Parameters:string|NavigationAbstractContainer – [optional] container to render. Default is null, which indicates that the helper should render the container returned by {@link getContainer()}.
Return type:string helper output
Throws :ZendViewExceptionExceptionInterface if unable to render