Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes

Zend_View_Helper_Navigation_HelperAbstract Class Reference

Inheritance diagram for Zend_View_Helper_Navigation_HelperAbstract:
Zend_View_Helper_HtmlElement Zend_View_Helper_Navigation_Helper Zend_View_Helper_Abstract Zend_View_Helper_Interface Zend_View_Helper_Navigation Zend_View_Helper_Navigation_Breadcrumbs Zend_View_Helper_Navigation_Links Zend_View_Helper_Navigation_Menu Zend_View_Helper_Navigation_Sitemap

Public Member Functions

 setContainer (Zend_Navigation_Container $container=null)
 getContainer ()
 setMinDepth ($minDepth=null)
 getMinDepth ()
 setMaxDepth ($maxDepth=null)
 getMaxDepth ()
 setIndent ($indent)
 getIndent ()
 setTranslator ($translator=null)
 getTranslator ()
 setAcl (Zend_Acl $acl=null)
 getAcl ()
 setRole ($role=null)
 getRole ()
 setUseAcl ($useAcl=true)
 getUseAcl ()
 getRenderInvisible ()
 setRenderInvisible ($renderInvisible=true)
 setUseTranslator ($useTranslator=true)
 getUseTranslator ()
 __call ($method, array $arguments=array())
 __toString ()
 findActive (Zend_Navigation_Container $container, $minDepth=null, $maxDepth=-1)
 hasContainer ()
 hasAcl ()
 hasRole ()
 hasTranslator ()
 htmlify (Zend_Navigation_Page $page)
 accept (Zend_Navigation_Page $page, $recursive=true)

Static Public Member Functions

static setDefaultAcl (Zend_Acl $acl=null)
static setDefaultRole ($role=null)

Protected Member Functions

 _acceptAcl (Zend_Navigation_Page $page)
 _getWhitespace ($indent)
 _htmlAttribs ($attribs)
 _normalizeId ($value)

Protected Attributes

 $_container
 $_minDepth
 $_maxDepth
 $_indent = ''
 $_translator
 $_acl
 $_renderInvisible = false
 $_role
 $_useTranslator = true
 $_useAcl = true

Static Protected Attributes

static $_defaultAcl
static $_defaultRole

Detailed Description

Definition at line 42 of file HelperAbstract.php.


Member Function Documentation

__call ( method,
array $  arguments = array() 
)

Magic overload: Proxy calls to the navigation container

Parameters:
string$methodmethod name in container
array$arguments[optional] arguments to pass
Returns:
mixed returns what the container returns
Exceptions:
Zend_Navigation_Exceptionif method does not exist in container

Reimplemented in Zend_View_Helper_Navigation_Links, and Zend_View_Helper_Navigation.

Definition at line 496 of file HelperAbstract.php.

__toString (  )

Magic overload: Proxy to render().

This method will trigger an E_USER_ERROR if rendering the helper causes an exception to be thrown.

Implements Zend_View_Helper_Navigation_Helper::__toString().

Returns:
string

Implements Zend_View_Helper_Navigation_Helper.

Definition at line 513 of file HelperAbstract.php.

_acceptAcl ( Zend_Navigation_Page $  page ) [protected]

Determines whether a page should be accepted by ACL when iterating

Rules:

  • If helper has no ACL, page is accepted
  • If page has a resource or privilege defined, page is accepted if the ACL allows access to it using the helper's role
  • If page has no resource or privilege, page is accepted
Parameters:
Zend_Navigation_Page$pagepage to check
Returns:
bool whether page is accepted by ACL

Definition at line 740 of file HelperAbstract.php.

_getWhitespace ( indent ) [protected]

Retrieve whitespace representation of $indent

Parameters:
int | string$indent
Returns:
string

Definition at line 767 of file HelperAbstract.php.

_htmlAttribs ( attribs ) [protected]

Converts an associative array to a string of tag attributes.

Overloads Zend_View_Helper_HtmlElement::_htmlAttribs().

Parameters:
array$attribsan array where each key-value pair is converted to an attribute name and value
Returns:
string an attribute string

Reimplemented from Zend_View_Helper_HtmlElement.

Definition at line 785 of file HelperAbstract.php.

_normalizeId ( value ) [protected]

Normalize an ID

Overrides Zend_View_Helper_HtmlElement::_normalizeId().

Parameters:
string$value
Returns:
string

Reimplemented from Zend_View_Helper_HtmlElement.

Definition at line 805 of file HelperAbstract.php.

accept ( Zend_Navigation_Page $  page,
recursive = true 
)

Determines whether a page should be accepted when iterating

Rules:

  • If a page is not visible it is not accepted, unless RenderInvisible has been set to true.
  • If helper has no ACL, page is accepted
  • If helper has ACL, but no role, page is not accepted
  • If helper has ACL and role:
    • Page is accepted if it has no resource or privilege
    • Page is accepted if ACL allows page's resource or privilege
  • If page is accepted by the rules above and $recursive is true, the page will not be accepted if it is the descendant of a non-accepted page.
Parameters:
Zend_Navigation_Page$pagepage to check
bool$recursive[optional] if true, page will not be accepted if it is the descendant of a page that is not accepted. Default is true.
Returns:
bool whether page should be accepted

Definition at line 705 of file HelperAbstract.php.

findActive ( Zend_Navigation_Container $  container,
minDepth = null,
maxDepth = -1 
)

Finds the deepest active page in the given container

Parameters:
Zend_Navigation_Container$containercontainer to search
int | null$minDepth[optional] minimum depth required for page to be valid. Default is to use getMinDepth(). A null value means no minimum depth required.
int | null$minDepth[optional] maximum depth a page can have to be valid. Default is to use getMaxDepth(). A null value means no maximum depth required.
Returns:
array an associative array with the values 'depth' and 'page', or an empty array if not found

Definition at line 547 of file HelperAbstract.php.

getAcl (  )

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

Implements Zend_View_Helper_Navigation_Helper::getAcl().

Returns:
Zend_Acl|null ACL object or null

Implements Zend_View_Helper_Navigation_Helper.

Definition at line 347 of file HelperAbstract.php.

getContainer (  )

Returns the navigation container helper operates on by default

Implements Zend_View_Helper_Navigation_Interface::getContainer().

If a helper is not explicitly set in this helper instance by calling setContainer() or by passing it through the helper entry point, this method will look in Zend_Registry for a container by using the key 'Zend_Navigation'.

If no container is set, and nothing is found in Zend_Registry, a new container will be instantiated and stored in the helper.

Returns:
Zend_Navigation_Container navigation container

Implements Zend_View_Helper_Navigation_Helper.

Definition at line 168 of file HelperAbstract.php.

getIndent (  )

Returns indentation

Returns:
string

Definition at line 271 of file HelperAbstract.php.

getMaxDepth (  )

Returns maximum depth a page can have to be included when rendering

Returns:
int|null maximum depth or null

Definition at line 246 of file HelperAbstract.php.

getMinDepth (  )

Returns minimum depth a page must have to be included when rendering

Returns:
int|null minimum depth or null

Definition at line 213 of file HelperAbstract.php.

getRenderInvisible (  )

Return renderInvisible flag

Returns:
bool

Implements Zend_View_Helper_Navigation_Helper.

Definition at line 439 of file HelperAbstract.php.

getRole (  )

Returns ACL role to use when iterating pages, or null if it isn't set using setRole() or setDefaultRole()

Implements Zend_View_Helper_Navigation_Helper::getRole().

Returns:
string|Zend_Acl_Role_Interface|null role or null

Implements Zend_View_Helper_Navigation_Helper.

Definition at line 396 of file HelperAbstract.php.

getTranslator (  )

Returns translator used in helper

Implements Zend_View_Helper_Navigation_Helper::getTranslator().

Returns:
Zend_Translate_Adapter|null translator or null

Implements Zend_View_Helper_Navigation_Helper.

Definition at line 311 of file HelperAbstract.php.

getUseAcl (  )

Returns whether ACL should be used

Implements Zend_View_Helper_Navigation_Helper::getUseAcl().

Returns:
bool whether ACL should be used

Implements Zend_View_Helper_Navigation_Helper.

Definition at line 429 of file HelperAbstract.php.

getUseTranslator (  )

Returns whether translator should be used

Implements Zend_View_Helper_Navigation_Helper::getUseTranslator().

Returns:
bool whether translator should be used

Implements Zend_View_Helper_Navigation_Helper.

Definition at line 481 of file HelperAbstract.php.

hasAcl (  )

Checks if the helper has an ACL instance

Implements Zend_View_Helper_Navigation_Helper::hasAcl().

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

Implements Zend_View_Helper_Navigation_Helper.

Definition at line 618 of file HelperAbstract.php.

hasContainer (  )

Checks if the helper has a container

Implements Zend_View_Helper_Navigation_Helper::hasContainer().

Returns:
bool whether the helper has a container or not

Implements Zend_View_Helper_Navigation_Helper.

Definition at line 606 of file HelperAbstract.php.

hasRole (  )

Checks if the helper has an ACL role

Implements Zend_View_Helper_Navigation_Helper::hasRole().

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

Implements Zend_View_Helper_Navigation_Helper.

Definition at line 630 of file HelperAbstract.php.

hasTranslator (  )

Checks if the helper has a translator

Implements Zend_View_Helper_Navigation_Helper::hasTranslator().

Returns:
bool whether the helper has a translator or not

Implements Zend_View_Helper_Navigation_Helper.

Definition at line 642 of file HelperAbstract.php.

htmlify ( Zend_Navigation_Page $  page )

Returns an HTML string containing an 'a' element for the given page

Parameters:
Zend_Navigation_Page$pagepage to generate HTML for
Returns:
string HTML string for the given page

Reimplemented in Zend_View_Helper_Navigation_Menu.

Definition at line 653 of file HelperAbstract.php.

setAcl ( Zend_Acl acl = null )

Sets ACL to use when iterating pages

Implements Zend_View_Helper_Navigation_Helper::setAcl().

Parameters:
Zend_Acl$acl[optional] ACL object. Default is null.
Returns:
Zend_View_Helper_Navigation_HelperAbstract fluent interface, returns self

Implements Zend_View_Helper_Navigation_Helper.

Definition at line 333 of file HelperAbstract.php.

setContainer ( Zend_Navigation_Container $  container = null )

Sets navigation container the helper operates on by default

Implements Zend_View_Helper_Navigation_Interface::setContainer().

Parameters:
Zend_Navigation_Container$container[optional] container to operate on. Default is null, meaning container will be reset.
Returns:
Zend_View_Helper_Navigation_HelperAbstract fluent interface, returns self

Implements Zend_View_Helper_Navigation_Helper.

Definition at line 147 of file HelperAbstract.php.

static setDefaultAcl ( Zend_Acl acl = null ) [static]

Sets default ACL to use if another ACL is not explicitly set

Parameters:
Zend_Acl$acl[optional] ACL object. Default is null, which sets no ACL object.
Returns:
void

Definition at line 822 of file HelperAbstract.php.

static setDefaultRole ( role = null ) [static]

Sets default ACL role(s) to use when iterating pages if not explicitly set later with setRole()

Parameters:
midex$role[optional] role to set. Expects null, string, or an instance of Zend_Acl_Role_Interface. Default is null, which sets no default role.
Exceptions:
Zend_View_Exceptionif role is invalid
Returns:
void

Definition at line 839 of file HelperAbstract.php.

setIndent ( indent )

Set the indentation string for using in render(), optionally a number of spaces to indent with

Parameters:
string | int$indentindentation string or number of spaces
Returns:
Zend_View_Helper_Navigation_HelperAbstract fluent interface, returns self

Definition at line 260 of file HelperAbstract.php.

setMaxDepth ( maxDepth = null )

Sets the maximum depth a page can have to be included when rendering

Parameters:
int$maxDepth[optional] maximum depth. Default is null, which sets no maximum depth.
Returns:
Zend_View_Helper_Navigation_HelperAbstract fluent interface, returns self

Definition at line 231 of file HelperAbstract.php.

setMinDepth ( minDepth = null )

Sets the minimum depth a page must have to be included when rendering

Parameters:
int$minDepth[optional] minimum depth. Default is null, which sets no minimum depth.
Returns:
Zend_View_Helper_Navigation_HelperAbstract fluent interface, returns self

Definition at line 198 of file HelperAbstract.php.

setRenderInvisible ( renderInvisible = true )

Render invisible items?

Parameters:
bool$renderInvisible[optional] boolean flag
Returns:
Zend_View_Helper_Navigation_HelperAbstract fluent interface returns self

Implements Zend_View_Helper_Navigation_Helper.

Definition at line 451 of file HelperAbstract.php.

setRole ( role = null )

Sets ACL role(s) to use when iterating pages

Implements Zend_View_Helper_Navigation_Helper::setRole().

Parameters:
mixed$role[optional] role to set. Expects a string, an instance of type Zend_Acl_Role_Interface, or null. Default is null, which will set no role.
Exceptions:
Zend_View_Exceptionif $role is invalid
Returns:
Zend_View_Helper_Navigation_HelperAbstract fluent interface, returns self

Implements Zend_View_Helper_Navigation_Helper.

Definition at line 372 of file HelperAbstract.php.

setTranslator ( translator = null )

Sets translator to use in helper

Implements Zend_View_Helper_Navigation_Helper::setTranslator().

Parameters:
mixed$translator[optional] translator. Expects an object of type Zend_Translate_Adapter or Zend_Translate, or null. Default is null, which sets no translator.
Returns:
Zend_View_Helper_Navigation_HelperAbstract fluent interface, returns self

Implements Zend_View_Helper_Navigation_Helper.

Definition at line 292 of file HelperAbstract.php.

setUseAcl ( useAcl = true )

Sets whether ACL should be used

Implements Zend_View_Helper_Navigation_Helper::setUseAcl().

Parameters:
bool$useAcl[optional] whether ACL should be used. Default is true.
Returns:
Zend_View_Helper_Navigation_HelperAbstract fluent interface, returns self

Implements Zend_View_Helper_Navigation_Helper.

Definition at line 416 of file HelperAbstract.php.

setUseTranslator ( useTranslator = true )

Sets whether translator should be used

Implements Zend_View_Helper_Navigation_Helper::setUseTranslator().

Parameters:
bool$useTranslator[optional] whether translator should be used. Default is true.
Returns:
Zend_View_Helper_Navigation_HelperAbstract fluent interface, returns self

Implements Zend_View_Helper_Navigation_Helper.

Definition at line 468 of file HelperAbstract.php.


The documentation for this class was generated from the following file: