Zend_View_Helper_Navigation_Helper Interface Reference

Public Member Functions
	setContainer (Zend_Navigation_Container $container=null)
	Sets navigation container the helper should operate on by default.
	getContainer ()
	Returns the navigation container the helper operates on by default.
	setTranslator ($translator=null)
	Sets translator to use in helper.
	getTranslator ()
	Returns translator used in helper.
	setAcl (Zend_Acl $acl=null)
	Sets ACL to use when iterating pages.
	getAcl ()
	Returns ACL or null if it isn't set using setAcl() or setDefaultAcl().
	setRole ($role=null)
	Sets ACL role to use when iterating pages.
	getRole ()
	Returns ACL role to use when iterating pages, or null if it isn't set.
	setUseAcl ($useAcl=true)
	Sets whether ACL should be used.
	getUseAcl ()
	Returns whether ACL should be used.
	getRenderInvisible ()
	Return renderInvisible flag.
	setRenderInvisible ($renderInvisible=true)
	Render invisible items?
	setUseTranslator ($useTranslator=true)
	Sets whether translator should be used.
	getUseTranslator ()
	Returns whether translator should be used.
	hasContainer ()
	Checks if the helper has a container.
	hasAcl ()
	Checks if the helper has an ACL instance.
	hasRole ()
	Checks if the helper has an ACL role.
	hasTranslator ()
	Checks if the helper has a translator.
	__toString ()
	Magic overload: Should proxy to render().
	render (Zend_Navigation_Container $container=null)
	Renders helper.

Member Function Documentation

__toString

(

)

Magic overload: Should proxy to render().

Returns

string

Implemented in Zend_View_Helper_Navigation_HelperAbstract.

getAcl

(

)

Returns ACL or null if it isn't set using setAcl() or setDefaultAcl().

Returns

Zend_Acl|null ACL object or null

Implemented in Zend_View_Helper_Navigation_HelperAbstract.

getContainer

(

)

Returns the navigation container the helper operates on by default.

Returns

Zend_Navigation_Container navigation container

Implemented in Zend_View_Helper_Navigation_HelperAbstract.

getRenderInvisible

(

)

Return renderInvisible flag.

Returns

bool

Implemented in Zend_View_Helper_Navigation_HelperAbstract.

getRole

(

)

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

Returns

string|Zend_Acl_Role_Interface|null role or null

Implemented in Zend_View_Helper_Navigation_HelperAbstract.

getTranslator

(

)

Returns translator used in helper.

Returns

Zend_Translate_Adapter|null translator or null

Implemented in Zend_View_Helper_Navigation_HelperAbstract.

getUseAcl

(

)

Returns whether ACL should be used.

Returns

bool whether ACL should be used

Implemented in Zend_View_Helper_Navigation_HelperAbstract.

getUseTranslator

(

)

Returns whether translator should be used.

Returns

bool whether translator should be used

Implemented in Zend_View_Helper_Navigation_HelperAbstract.

hasAcl

(

)

Checks if the helper has an ACL instance.

Returns

bool whether the helper has a an ACL instance or not

Implemented in Zend_View_Helper_Navigation_HelperAbstract.

hasContainer

(

)

Checks if the helper has a container.

Returns

bool whether the helper has a container or not

Implemented in Zend_View_Helper_Navigation_HelperAbstract.

hasRole

(

)

Checks if the helper has an ACL role.

Returns

bool whether the helper has a an ACL role or not

Implemented in Zend_View_Helper_Navigation_HelperAbstract.

hasTranslator

(

)

Checks if the helper has a translator.

Returns

bool whether the helper has a translator or not

Implemented in Zend_View_Helper_Navigation_HelperAbstract.

render

(

Zend_Navigation_Container

$container = null

)

Renders helper.

Parameters

Zend_Navigation_Container

$container

[optional] container to render. Default is null, which indicates that the helper should render the container returned by getContainer().

Returns

string helper output

Exceptions

Zend_View_Exception

if unable to render

Implemented in Zend_View_Helper_Navigation_Menu, Zend_View_Helper_Navigation_Links, Zend_View_Helper_Navigation_Sitemap, Zend_View_Helper_Navigation, and Zend_View_Helper_Navigation_Breadcrumbs.

setAcl

(

Zend_Acl

$acl = null

)

Sets ACL to use when iterating pages.

Parameters

Zend_Acl

$acl

[optional] ACL instance

Returns

Zend_View_Helper_Navigation_Helper fluent interface, returns self

Implemented in Zend_View_Helper_Navigation_HelperAbstract.

setContainer

(

Zend_Navigation_Container

$container = null

)

Sets navigation container the helper should operate on by default.

Parameters

Zend_Navigation_Container

$container

[optional] container to operate on. Default is null, which indicates that the container should be reset.

Returns

Zend_View_Helper_Navigation_Helper fluent interface, returns self

Implemented in Zend_View_Helper_Navigation_HelperAbstract.

setRenderInvisible

(

$renderInvisible = true

)

Render invisible items?

Parameters

bool

$renderInvisible

[optional] boolean flag

Returns

Zend_View_Helper_Navigation_HelperAbstract fluent interface returns self

Implemented in Zend_View_Helper_Navigation_HelperAbstract.

setRole

(

$role = null

)

Sets ACL role to use when iterating pages.

Parameters

mixed

$role

[optional] role to set. Expects a string, an instance of type Zend_Acl_Role_Interface, or null. Default is null.

Exceptions

Zend_View_Exception

if $role is invalid

Returns

Zend_View_Helper_Navigation_Helper fluent interface, returns self

Implemented in Zend_View_Helper_Navigation_HelperAbstract.

setTranslator

(

$translator = null

)

Sets translator to use in helper.

Parameters

mixed

$translator

[optional] translator. Expects an object of type Zend_Translate_Adapter or Zend_Translate, or null. Default is null.

Returns

Zend_View_Helper_Navigation_Helper fluent interface, returns self

Implemented in Zend_View_Helper_Navigation_HelperAbstract.

setUseAcl

(

$useAcl = true

)

Sets whether ACL should be used.

Parameters

bool

$useAcl

[optional] whether ACL should be used. Default is true.

Returns

Zend_View_Helper_Navigation_Helper fluent interface, returns self

Implemented in Zend_View_Helper_Navigation_HelperAbstract.

setUseTranslator

(

$useTranslator = true

)

Sets whether translator should be used.

Parameters

bool

$useTranslator

[optional] whether translator should be used. Default is true.

Returns

Zend_View_Helper_Navigation_Helper fluent interface, returns self

Implemented in Zend_View_Helper_Navigation_HelperAbstract.