API Documentation

View/Helper/Navigation/Helper.php

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_View  
subpackage
Helper  
version
$Id: Helper.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_View_Helper_Navigation_Helper

Interface for navigational helpers

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_View  
subpackage
Helper  

Methods

methodpublic__toString( ) : string

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

Returns
Type Description
string
methodpublicgetAcl( ) : \Zend_Acl|null

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

Returns
Type Description
\Zend_Aclnull ACL object or null
methodpublicgetContainer( ) : \Zend_Navigation_Container

Returns the navigation container the helper operates on by default

Returns
Type Description
\Zend_Navigation_Container navigation container
methodpublicgetRenderInvisible( ) : bool

Return renderInvisible flag

Returns
Type Description
bool
methodpublicgetRole( ) : string|\Zend_Acl_Role_Interface|null

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

Returns
Type Description
string\Zend_Acl_Role_Interfacenull role or null
methodpublicgetTranslator( ) : \Zend_Translate_Adapter|null

Returns translator used in helper

Returns
Type Description
\Zend_Translate_Adapternull translator or null
methodpublicgetUseAcl( ) : bool

Returns whether ACL should be used

Returns
Type Description
bool whether ACL should be used
methodpublicgetUseTranslator( ) : bool

Returns whether translator should be used

Returns
Type Description
bool whether translator should be used
methodpublichasAcl( ) : bool

Checks if the helper has an ACL instance

Returns
Type Description
bool whether the helper has a an ACL instance or not
methodpublichasContainer( ) : bool

Checks if the helper has a container

Returns
Type Description
bool whether the helper has a container or not
methodpublichasRole( ) : bool

Checks if the helper has an ACL role

Returns
Type Description
bool whether the helper has a an ACL role or not
methodpublichasTranslator( ) : bool

Checks if the helper has a translator

Returns
Type Description
bool whether the helper has a translator or not
methodpublicrender( \Zend_Navigation_Container $container = null ) : string

Renders helper

Parameters
Name Type Description
$container \Zend_Navigation_Container

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

Returns
Type Description
string helper output
Throws
Exception Description
\Zend_View_Exception if unable to render
methodpublicsetAcl( \Zend_Acl $acl = null ) : \Zend_View_Helper_Navigation_Helper

Sets ACL to use when iterating pages

Parameters
Name Type Description
$acl \Zend_Acl

[optional] ACL instance

Returns
Type Description
\Zend_View_Helper_Navigation_Helper fluent interface, returns self
methodpublicsetContainer( \Zend_Navigation_Container $container = null ) : \Zend_View_Helper_Navigation_Helper

Sets navigation container the helper should operate on by default

Parameters
Name Type Description
$container \Zend_Navigation_Container

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

Returns
Type Description
\Zend_View_Helper_Navigation_Helper fluent interface, returns self
methodpublicsetRenderInvisible( bool $renderInvisible = true ) : \Zend_View_Helper_Navigation_HelperAbstract

Render invisible items?

Parameters
Name Type Description
$renderInvisible bool

[optional] boolean flag

Returns
Type Description
\Zend_View_Helper_Navigation_HelperAbstract fluent interface returns self
methodpublicsetRole( mixed $role = null ) : \Zend_View_Helper_Navigation_Helper

Sets ACL role to use when iterating pages

Parameters
Name Type Description
$role mixed

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

Returns
Type Description
\Zend_View_Helper_Navigation_Helper fluent interface, returns self
Throws
Exception Description
\Zend_View_Exception if $role is invalid
methodpublicsetTranslator( mixed $translator = null ) : \Zend_View_Helper_Navigation_Helper

Sets translator to use in helper

Parameters
Name Type Description
$translator mixed

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

Returns
Type Description
\Zend_View_Helper_Navigation_Helper fluent interface, returns self
methodpublicsetUseAcl( bool $useAcl = true ) : \Zend_View_Helper_Navigation_Helper

Sets whether ACL should be used

Parameters
Name Type Description
$useAcl bool

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

Returns
Type Description
\Zend_View_Helper_Navigation_Helper fluent interface, returns self
methodpublicsetUseTranslator( bool $useTranslator = true ) : \Zend_View_Helper_Navigation_Helper

Sets whether translator should be used

Parameters
Name Type Description
$useTranslator bool

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

Returns
Type Description
\Zend_View_Helper_Navigation_Helper fluent interface, returns self
Documentation was generated by DocBlox 0.13.3.