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.
Base class for navigational helpers

\Zend_Acl
$_defaultAcl= ''
Default ACL to use when iterating pages if not explicitly set in the instance by calling {@link setAcl()}

string|\Zend_Acl_Role_Interface
$_defaultRole= ''
Default ACL role to use when iterating pages if not explicitly set in the instance by calling {@link setRole()}

int
$_minDepth= ''
The minimum depth a page must have to be included when rendering

bool
$_renderInvisible= 'false'
Wheter invisible items should be rendered by this helper
false
Details
string|\Zend_Acl_Role_Interface
$_role= ''
ACL role to use when iterating pages

bool
$_useAcl= 'true'
Whether ACL should be used for filtering out pages
true
Details
__call(
string $method, array $arguments
=
array()
)
:
mixed
Magic overload: Proxy calls to the navigation container
Name | Type | Description |
---|---|---|
$method | string | method name in container |
$arguments | array | [optional] arguments to pass |
Type | Description |
---|---|
mixed | returns what the container returns |
Exception | Description |
---|---|
\Zend_Navigation_Exception | if method does not exist in container |

__toString(
)
:
string
Magic overload: Proxy to {@link render()}.
This method will trigger an E_USER_ERROR if rendering the helper causes an exception to be thrown.
Implements {@link Zend_View_Helper_Navigation_Helper::__toString()}.
Type | Description |
---|---|
string |

_acceptAcl(
\Zend_Navigation_Page $page
)
:
bool
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
Name | Type | Description |
---|---|---|
$page | \Zend_Navigation_Page | page to check |
Type | Description |
---|---|
bool | whether page is accepted by ACL |

_getWhitespace(
int|string $indent
)
:
string
Retrieve whitespace representation of $indent
Name | Type | Description |
---|---|---|
$indent | int|string |
Type | Description |
---|---|
string |

_htmlAttribs(
array $attribs
)
:
string
Converts an associative array to a string of tag attributes.
Overloads {@link Zend_View_Helper_HtmlElement::_htmlAttribs()}.
Name | Type | Description |
---|---|---|
$attribs | array | an array where each key-value pair is converted to an attribute name and value |
Type | Description |
---|---|
string | an attribute string |

_normalizeId(
string $value
)
:
string
Normalize an ID
Overrides {@link Zend_View_Helper_HtmlElement::_normalizeId()}.
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
string |

accept(
\Zend_Navigation_Page $page, bool $recursive
=
true
)
:
bool
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.
Name | Type | Description |
---|---|---|
$page | \Zend_Navigation_Page | page to check |
$recursive | bool | [optional] if true, page will not be accepted if it is the descendant of a page that is not accepted. Default is true. |
Type | Description |
---|---|
bool | whether page should be accepted |

findActive(
\Zend_Navigation_Container $container, int|null|int|null $minDepth
=
null, $maxDepth
=
-1
)
:
array
Finds the deepest active page in the given container
Name | Type | Description |
---|---|---|
$container | \Zend_Navigation_Container | container to search |
$minDepth | int|null|int|null | [optional] minimum depth required for page to be valid. Default is to use {@link getMinDepth()}. A null value means no minimum depth required. |
$maxDepth |
Type | Description |
---|---|
array | an associative array with the values 'depth' and 'page', or an empty array if not found |

getAcl(
)
:
\Zend_Acl|null
Returns ACL or null if it isn't set using {@link setAcl()} or {@link setDefaultAcl()}
Implements {@link Zend_View_Helper_Navigation_Helper::getAcl()}.
Type | Description |
---|---|
\Zend_Acl|null | ACL object or null |

getContainer(
)
:
\Zend_Navigation_Container
Returns the navigation container helper operates on by default
Implements {@link Zend_View_Helper_Navigation_Interface::getContainer()}.
If a helper is not explicitly set in this helper instance by calling {@link setContainer()} or by passing it through the helper entry point, this method will look in {@link 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.
Type | Description |
---|---|
\Zend_Navigation_Container | navigation container |

getMaxDepth(
)
:
int|null
Returns maximum depth a page can have to be included when rendering
Type | Description |
---|---|
int|null | maximum depth or null |

getMinDepth(
)
:
int|null
Returns minimum depth a page must have to be included when rendering
Type | Description |
---|---|
int|null | minimum depth or null |

getRole(
)
:
string|\Zend_Acl_Role_Interface|null
Returns ACL role to use when iterating pages, or null if it isn't set using {@link setRole()} or {@link setDefaultRole()}
Implements {@link Zend_View_Helper_Navigation_Helper::getRole()}.
Type | Description |
---|---|
string|\Zend_Acl_Role_Interface|null | role or null |

getTranslator(
)
:
\Zend_Translate_Adapter|null
Returns translator used in helper
Implements {@link Zend_View_Helper_Navigation_Helper::getTranslator()}.
Type | Description |
---|---|
\Zend_Translate_Adapter|null | translator or null |

getUseAcl(
)
:
bool
Returns whether ACL should be used
Implements {@link Zend_View_Helper_Navigation_Helper::getUseAcl()}.
Type | Description |
---|---|
bool | whether ACL should be used |

getUseTranslator(
)
:
bool
Returns whether translator should be used
Implements {@link Zend_View_Helper_Navigation_Helper::getUseTranslator()}.
Type | Description |
---|---|
bool | whether translator should be used |

hasAcl(
)
:
bool
Checks if the helper has an ACL instance
Implements {@link Zend_View_Helper_Navigation_Helper::hasAcl()}.
Type | Description |
---|---|
bool | whether the helper has a an ACL instance or not |

hasContainer(
)
:
bool
Checks if the helper has a container
Implements {@link Zend_View_Helper_Navigation_Helper::hasContainer()}.
Type | Description |
---|---|
bool | whether the helper has a container or not |

hasRole(
)
:
bool
Checks if the helper has an ACL role
Implements {@link Zend_View_Helper_Navigation_Helper::hasRole()}.
Type | Description |
---|---|
bool | whether the helper has a an ACL role or not |

hasTranslator(
)
:
bool
Checks if the helper has a translator
Implements {@link Zend_View_Helper_Navigation_Helper::hasTranslator()}.
Type | Description |
---|---|
bool | whether the helper has a translator or not |

htmlify(
\Zend_Navigation_Page $page
)
:
string
Returns an HTML string containing an 'a' element for the given page
Name | Type | Description |
---|---|---|
$page | \Zend_Navigation_Page | page to generate HTML for |
Type | Description |
---|---|
string | HTML string for the given page |

setAcl(
\Zend_Acl $acl
=
null
)
:
\Zend_View_Helper_Navigation_HelperAbstract
Sets ACL to use when iterating pages
Implements {@link Zend_View_Helper_Navigation_Helper::setAcl()}.
Name | Type | Description |
---|---|---|
$acl | \Zend_Acl | [optional] ACL object. Default is null. |
Type | Description |
---|---|
\Zend_View_Helper_Navigation_HelperAbstract | fluent interface, returns self |

setContainer(
\Zend_Navigation_Container $container
=
null
)
:
\Zend_View_Helper_Navigation_HelperAbstract
Sets navigation container the helper operates on by default
Implements {@link Zend_View_Helper_Navigation_Interface::setContainer()}.
Name | Type | Description |
---|---|---|
$container | \Zend_Navigation_Container | [optional] container to operate on. Default is null, meaning container will be reset. |
Type | Description |
---|---|
\Zend_View_Helper_Navigation_HelperAbstract | fluent interface, returns self |

setDefaultAcl(
\Zend_Acl $acl
=
null
)
:
void
Sets default ACL to use if another ACL is not explicitly set
Name | Type | Description |
---|---|---|
$acl | \Zend_Acl | [optional] ACL object. Default is null, which sets no ACL object. |

setDefaultRole(
\midex $role
=
null
)
:
void
Sets default ACL role(s) to use when iterating pages if not explicitly set later with {@link setRole()}
Name | Type | Description |
---|---|---|
$role | \midex | [optional] role to set. Expects null, string, or an instance of {@link Zend_Acl_Role_Interface}. Default is null, which sets no default role. |
Exception | Description |
---|---|
\Zend_View_Exception | if role is invalid |

setIndent(
string|int $indent
)
:
\Zend_View_Helper_Navigation_HelperAbstract
Set the indentation string for using in {@link render()}, optionally a number of spaces to indent with
Name | Type | Description |
---|---|---|
$indent | string|int | indentation string or number of spaces |
Type | Description |
---|---|
\Zend_View_Helper_Navigation_HelperAbstract | fluent interface, returns self |

setMaxDepth(
int $maxDepth
=
null
)
:
\Zend_View_Helper_Navigation_HelperAbstract
Sets the maximum depth a page can have to be included when rendering
Name | Type | Description |
---|---|---|
$maxDepth | int | [optional] maximum depth. Default is null, which sets no maximum depth. |
Type | Description |
---|---|
\Zend_View_Helper_Navigation_HelperAbstract | fluent interface, returns self |

setMinDepth(
int $minDepth
=
null
)
:
\Zend_View_Helper_Navigation_HelperAbstract
Sets the minimum depth a page must have to be included when rendering
Name | Type | Description |
---|---|---|
$minDepth | int | [optional] minimum depth. Default is null, which sets no minimum depth. |
Type | Description |
---|---|
\Zend_View_Helper_Navigation_HelperAbstract | fluent interface, returns self |

setRenderInvisible(
bool $renderInvisible
=
true
)
:
\Zend_View_Helper_Navigation_HelperAbstract
Render invisible items?
Name | Type | Description |
---|---|---|
$renderInvisible | bool | [optional] boolean flag |
Type | Description |
---|---|
\Zend_View_Helper_Navigation_HelperAbstract | fluent interface returns self |

setRole(
mixed $role
=
null
)
:
\Zend_View_Helper_Navigation_HelperAbstract
Sets ACL role(s) to use when iterating pages
Implements {@link Zend_View_Helper_Navigation_Helper::setRole()}.
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, which will set no role. |
Type | Description |
---|---|
\Zend_View_Helper_Navigation_HelperAbstract | fluent interface, returns self |
Exception | Description |
---|---|
\Zend_View_Exception | if $role is invalid |

setTranslator(
mixed $translator
=
null
)
:
\Zend_View_Helper_Navigation_HelperAbstract
Sets translator to use in helper
Implements {@link Zend_View_Helper_Navigation_Helper::setTranslator()}.
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, which sets no translator. |
Type | Description |
---|---|
\Zend_View_Helper_Navigation_HelperAbstract | fluent interface, returns self |

setUseAcl(
bool $useAcl
=
true
)
:
\Zend_View_Helper_Navigation_HelperAbstract
Sets whether ACL should be used
Implements {@link Zend_View_Helper_Navigation_Helper::setUseAcl()}.
Name | Type | Description |
---|---|---|
$useAcl | bool | [optional] whether ACL should be used. Default is true. |
Type | Description |
---|---|
\Zend_View_Helper_Navigation_HelperAbstract | fluent interface, returns self |

setUseTranslator(
bool $useTranslator
=
true
)
:
\Zend_View_Helper_Navigation_HelperAbstract
Sets whether translator should be used
Implements {@link Zend_View_Helper_Navigation_Helper::setUseTranslator()}.
Name | Type | Description |
---|---|---|
$useTranslator | bool | [optional] whether translator should be used. Default is true. |
Type | Description |
---|---|
\Zend_View_Helper_Navigation_HelperAbstract | fluent interface, returns self |