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 |
Definition at line 42 of file HelperAbstract.php.
__call | ( | $ | method, |
array $ | arguments = array() |
||
) |
Magic overload: Proxy calls to the navigation container
string | $method | method name in container |
array | $arguments | [optional] arguments to pass |
Zend_Navigation_Exception | if 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().
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:
Zend_Navigation_Page | $page | page to check |
Definition at line 740 of file HelperAbstract.php.
_getWhitespace | ( | $ | indent ) | [protected] |
Retrieve whitespace representation of $indent
int | string | $indent |
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().
array | $attribs | an array where each key-value pair is converted to an attribute name and value |
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().
string | $value |
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:
Zend_Navigation_Page | $page | page 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. |
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
Zend_Navigation_Container | $container | container 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. |
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().
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.
Implements Zend_View_Helper_Navigation_Helper.
Definition at line 168 of file HelperAbstract.php.
getIndent | ( | ) |
getMaxDepth | ( | ) |
Returns maximum depth a page can have to be included when rendering
Definition at line 246 of file HelperAbstract.php.
getMinDepth | ( | ) |
Returns minimum depth a page must have to be included when rendering
Definition at line 213 of file HelperAbstract.php.
getRenderInvisible | ( | ) |
Return renderInvisible flag
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().
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().
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().
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().
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().
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().
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().
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().
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
Zend_Navigation_Page | $page | page to generate HTML for |
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().
Zend_Acl | $acl | [optional] ACL object. Default is null. |
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().
Zend_Navigation_Container | $container | [optional] container to operate on. Default is null, meaning container will be reset. |
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
Zend_Acl | $acl | [optional] ACL object. Default is null, which sets no ACL object. |
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()
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. |
Zend_View_Exception | if role is invalid |
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
string | int | $indent | indentation string or number of spaces |
Definition at line 260 of file HelperAbstract.php.
setMaxDepth | ( | $ | maxDepth = null ) |
Sets the maximum depth a page can have to be included when rendering
int | $maxDepth | [optional] maximum depth. Default is null, which sets no maximum depth. |
Definition at line 231 of file HelperAbstract.php.
setMinDepth | ( | $ | minDepth = null ) |
Sets the minimum depth a page must have to be included when rendering
int | $minDepth | [optional] minimum depth. Default is null, which sets no minimum depth. |
Definition at line 198 of file HelperAbstract.php.
setRenderInvisible | ( | $ | renderInvisible = true ) |
Render invisible items?
bool | $renderInvisible | [optional] boolean flag |
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().
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. |
Zend_View_Exception | if $role is invalid |
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().
mixed | $translator | [optional] translator. Expects an object of type Zend_Translate_Adapter or Zend_Translate, or null. Default is null, which sets no translator. |
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().
bool | $useAcl | [optional] whether ACL should be used. Default is true. |
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().
bool | $useTranslator | [optional] whether translator should be used. Default is true. |
Implements Zend_View_Helper_Navigation_Helper.
Definition at line 468 of file HelperAbstract.php.