View/Helper/Navigation/Helper.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_View
subpackage: Helper
version: $Id: Helper.php 20096 2010-01-06 02:05:09Z bkarwin $
Interfaces: Zend_View_Helper_Navigation_Helper

Description

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.

Zend_View_Helper_Navigation_Helper
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_View
subpackage: Helper
Methods: setContainer; getContainer; setTranslator; getTranslator; setAcl; getAcl; setRole; getRole; setUseAcl; getUseAcl; getRenderInvisible; setRenderInvisible; setUseTranslator; getUseTranslator; hasContainer; hasAcl; hasRole; hasTranslator; __toString; render

Description

Interface for navigational helpers

Methods

__toString
jump to class

__toString(
          
          )
        
        :
        string

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

Output

string

Details

visibility: public
final: false
static: false

getAcl
jump to class

getAcl(
          
          )
        
        :
        Zend_Acl|null

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

Output

Zend_Acl|null: ACL object or null

Details

visibility: public
final: false
static: false

getContainer
jump to class

getContainer(
          
          )
        
        :
        Zend_Navigation_Container

Returns the navigation container the helper operates on by default

Output

Zend_Navigation_Container: navigation container

Details

visibility: public
final: false
static: false

getRenderInvisible
jump to class

getRenderInvisible(
          
          )
        
        :
        bool

Return renderInvisible flag

Output

bool

Details

visibility: public
final: false
static: false

getRole
jump to class

getRole(
          
          )
        
        :
        string|Zend_Acl_Role_Interface|null

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

Output

string|Zend_Acl_Role_Interface|null: role or null

Details

visibility: public
final: false
static: false

getTranslator
jump to class

getTranslator(
          
          )
        
        :
        Zend_Translate_Adapter|null

Returns translator used in helper

Output

Zend_Translate_Adapter|null: translator or null

Details

visibility: public
final: false
static: false

getUseAcl
jump to class

getUseAcl(
          
          )
        
        :
        bool

Returns whether ACL should be used

Output

bool: whether ACL should be used

Details

visibility: public
final: false
static: false

getUseTranslator
jump to class

getUseTranslator(
          
          )
        
        :
        bool

Returns whether translator should be used

Output

bool: whether translator should be used

Details

visibility: public
final: false
static: false

hasAcl
jump to class

hasAcl(
          
          )
        
        :
        bool

Checks if the helper has an ACL instance

Output

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

Details

visibility: public
final: false
static: false

hasContainer
jump to class

hasContainer(
          
          )
        
        :
        bool

Checks if the helper has a container

Output

bool: whether the helper has a container or not

Details

visibility: public
final: false
static: false

hasRole
jump to class

hasRole(
          
          )
        
        :
        bool

Checks if the helper has an ACL role

Output

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

Details

visibility: public
final: false
static: false

hasTranslator
jump to class

hasTranslator(
          
          )
        
        :
        bool

Checks if the helper has a translator

Output

bool: whether the helper has a translator or not

Details

visibility: public
final: false
static: false

render
jump to class

render(
          Zend_Navigation_Container $container
              =
              null
          )
        
        :
        string

Renders helper

Arguments

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

Output

string: helper output

Details

visibility: public
final: false
static: false
throws: if unable to render

setAcl
jump to class

setAcl(
          Zend_Acl $acl
              =
              null
          )
        
        :
        Zend_View_Helper_Navigation_Helper

Sets ACL to use when iterating pages

Arguments

$acl: Zend_Acl
[optional] ACL instance

Output

Zend_View_Helper_Navigation_Helper: fluent interface, returns self

Details

visibility: public
final: false
static: false

setContainer
jump to class

setContainer(
          Zend_Navigation_Container $container
              =
              null
          )
        
        :
        Zend_View_Helper_Navigation_Helper

Sets navigation container the helper should operate on by default

Arguments

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

Output

Zend_View_Helper_Navigation_Helper: fluent interface, returns self

Details

visibility: public
final: false
static: false

setRenderInvisible
jump to class

setRenderInvisible(
          bool $renderInvisible
              =
              true
          )
        
        :
        Zend_View_Helper_Navigation_HelperAbstract

Render invisible items?

Arguments

$renderInvisible: bool
[optional] boolean flag

Output

Zend_View_Helper_Navigation_HelperAbstract: fluent interface returns self

Details

visibility: public
final: false
static: false

setRole
jump to class

setRole(
          mixed $role
              =
              null
          )
        
        :
        Zend_View_Helper_Navigation_Helper

Sets ACL role to use when iterating pages

Arguments

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

Output

Zend_View_Helper_Navigation_Helper: fluent interface, returns self

Details

visibility: public
final: false
static: false
throws: if $role is invalid

setTranslator
jump to class

setTranslator(
          mixed $translator
              =
              null
          )
        
        :
        Zend_View_Helper_Navigation_Helper

Sets translator to use in helper

Arguments

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

Output

Zend_View_Helper_Navigation_Helper: fluent interface, returns self

Details

visibility: public
final: false
static: false

setUseAcl
jump to class

setUseAcl(
          bool $useAcl
              =
              true
          )
        
        :
        Zend_View_Helper_Navigation_Helper

Sets whether ACL should be used

Arguments

$useAcl: bool
[optional] whether ACL should be used. Default is true.

Output

Zend_View_Helper_Navigation_Helper: fluent interface, returns self

Details

visibility: public
final: false
static: false

setUseTranslator
jump to class

setUseTranslator(
          bool $useTranslator
              =
              true
          )
        
        :
        Zend_View_Helper_Navigation_Helper

Sets whether translator should be used

Arguments

$useTranslator: bool
[optional] whether translator should be used. Default is true.

Output

Zend_View_Helper_Navigation_Helper: fluent interface, returns self

Details

visibility: public
final: false
static: false

API Documentation

View/Helper/Navigation/Helper.php

Description

Zend_View_Helper_Navigation_Helperjump to top

Description

Methods

__toStringjump to class

Output

Details

getAcljump to class

Output

Details

getContainerjump to class

Output

Details

getRenderInvisiblejump to class

Output

Details

getRolejump to class

Output

Details

getTranslatorjump to class

Output

Details

getUseAcljump to class

Output

Details

getUseTranslatorjump to class

Output

Details

hasAcljump to class

Output

Details

hasContainerjump to class

Output

Details

hasRolejump to class

Output

Details

hasTranslatorjump to class

Output

Details

renderjump to class

Arguments

Output

Details

setAcljump to class

Arguments

Output

Details

setContainerjump to class

Arguments

Output

Details

setRenderInvisiblejump to class

Arguments

Output

Details

setRolejump to class

Arguments

Output

Details

setTranslatorjump to class

Arguments

Output

Details

setUseAcljump to class

Arguments

Output

Details

setUseTranslatorjump to class

Arguments

Output

Details

Zend_View_Helper_Navigation_Helper
jump to top

__toString
jump to class

getAcl
jump to class

getContainer
jump to class

getRenderInvisible
jump to class

getRole
jump to class

getTranslator
jump to class

getUseAcl
jump to class

getUseTranslator
jump to class

hasAcl
jump to class

hasContainer
jump to class

hasRole
jump to class

hasTranslator
jump to class

render
jump to class

setAcl
jump to class

setContainer
jump to class

setRenderInvisible
jump to class

setRole
jump to class

setTranslator
jump to class

setUseAcl
jump to class

setUseTranslator
jump to class