Helper for printing breadcrumbs
category | Zend |
---|---|
package | Zend_View |
subpackage | Helper |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
inherited_from | \Zend_View_Helper_Navigation_HelperAbstract |
__call(string $method, array $arguments = array()
) : mixed
string
method name in container
array
[optional] arguments to pass
\Zend_Navigation_Exception |
if method does not exist in container |
---|
mixed
returns what the container returns__toString() : string
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().
inherited_from | \Zend_View_Helper_Navigation_Helper::__toString() |
---|
string
accept(\Zend_Navigation_Page $page, boolean $recursive = true
) : boolean
Rules:
\Zend_Navigation_Page
page to check
boolean
[optional] if true, page will not be accepted if it is the descendant of a page that is not accepted. Default is true.
boolean
whether page should be accepteddirect() : void
inherited_from | \Zend_View_Helper_Interface::direct() |
---|
findActive(\Zend_Navigation_Container $container, integer|null $minDepth= null
, $maxDepth= -1
) : array
\Zend_Navigation_Container
container to search
integer
null
integer
null
[optional] minimum depth required for page to be valid. Default is to use {@link getMinDepth()}. A null value means no minimum depth required.
array
an associative array with
the values 'depth' and
'page', or an empty array
if not foundgetAcl() : \Zend_Acl | null
Implements Zend_View_Helper_Navigation_Helper::getAcl().
inherited_from | \Zend_View_Helper_Navigation_Helper::getAcl() |
---|
\Zend_Acl
null
ACL object or nullgetClosingBracket() : string
string
getContainer() : \Zend_Navigation_Container
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.
inherited_from | \Zend_View_Helper_Navigation_Helper::getContainer() |
---|
\Zend_Navigation_Container
navigation containergetEOL() : string
getFormatOutput() : boolean
boolean
whether HTML/XML output should be formattedgetIndent() : string
string
indentation string or an empty stringgetLinkLast() : boolean
boolean
whether last page in breadcrumbs should be hyperlinkedgetMaxDepth() : integer | null
integer
null
maximum depth or nullgetMinDepth() : integer | null
integer
null
minimum depth or nullgetPartial() : string | array | null
string
array
null
getPrefixForId() : string
string
Prefix forgetRenderInvisible() : boolean
inherited_from | \Zend_View_Helper_Navigation_Helper::getRenderInvisible() |
---|
boolean
getRole() : string | \Zend_Acl_Role_Interface | null
Implements Zend_View_Helper_Navigation_Helper::getRole().
inherited_from | \Zend_View_Helper_Navigation_Helper::getRole() |
---|
string
\Zend_Acl_Role_Interface
null
role or nullgetSeparator() : string
string
breadcrumb separatorgetTranslator() : \Zend_Translate_Adapter | null
inherited_from | \Zend_View_Helper_Navigation_Helper::getTranslator() |
---|
\Zend_Translate_Adapter
null
translator or nullgetUseAcl() : boolean
Implements Zend_View_Helper_Navigation_Helper::getUseAcl().
inherited_from | \Zend_View_Helper_Navigation_Helper::getUseAcl() |
---|
boolean
whether ACL should be usedgetUseTranslator() : boolean
inherited_from | \Zend_View_Helper_Navigation_Helper::getUseTranslator() |
---|
boolean
whether translator should be usedhasAcl() : boolean
Implements Zend_View_Helper_Navigation_Helper::hasAcl().
inherited_from | \Zend_View_Helper_Navigation_Helper::hasAcl() |
---|
boolean
whether the helper has a an ACL instance or nothasContainer() : boolean
inherited_from | \Zend_View_Helper_Navigation_Helper::hasContainer() |
---|
boolean
whether the helper has a container or nothasRole() : boolean
Implements Zend_View_Helper_Navigation_Helper::hasRole().
inherited_from | \Zend_View_Helper_Navigation_Helper::hasRole() |
---|
boolean
whether the helper has a an ACL role or nothasTranslator() : boolean
inherited_from | \Zend_View_Helper_Navigation_Helper::hasTranslator() |
---|
boolean
whether the helper has a translator or nothtmlify(\Zend_Navigation_Page $page) : string
\Zend_Navigation_Page
page to generate HTML for
string
HTML string for the given pagerender(\Zend_Navigation_Container $container = null
) : string
Implements Zend_View_Helper_Navigation_Helper::render().
\Zend_Navigation_Container
[optional] container to render. Default is to render the container registered in the helper.
string
helper outputrenderPartial(\Zend_Navigation_Container $container= null
, string|array $partial= null
) : string
The container will simply be passed on as a model to the view script,
so in the script it will be available in $this->container
.
\Zend_Navigation_Container
[optional] container to pass to view script. Default is to use the container registered in the helper.
string
array
[optional] partial view script to use. Default is to use the partial registered in the helper. If an array is given, it is expected to contain two values; the partial view script to use, and the module where the script can be found.
string
helper outputrenderStraight(\Zend_Navigation_Container $container = null
) : string
\Zend_Navigation_Container
[optional] container to render. Default is to render the container registered in the helper.
string
helper outputsetAcl(\Zend_Acl $acl = null
) : \Zend_View_Helper_Navigation_HelperAbstract
Implements Zend_View_Helper_Navigation_Helper::setAcl().
inherited_from | \Zend_View_Helper_Navigation_Helper::setAcl() |
---|
\Zend_Acl
[optional] ACL object. Default is null.
\Zend_View_Helper_Navigation_HelperAbstract
fluent interface,
returns selfsetContainer(\Zend_Navigation_Container $container = null
) : \Zend_View_Helper_Navigation_HelperAbstract
Implements \Zend_View_Helper_Navigation_Interface::setContainer().
inherited_from | \Zend_View_Helper_Navigation_Helper::setContainer() |
---|
\Zend_Navigation_Container
[optional] container to operate on. Default is null, meaning container will be reset.
\Zend_View_Helper_Navigation_HelperAbstract
fluent interface,
returns selfsetDefaultAcl(\Zend_Acl $acl = null
) : void
\Zend_Acl
[optional] ACL object. Default is null, which sets no ACL object.
setDefaultRole(mixed $role = null
) : void
mixed
[optional] role to set. Expects null, string, or an instance of {@link Zend_Acl_Role_Interface}. Default is null, which sets no default role.
\Zend_View_Exception |
if role is invalid |
---|
setFormatOutput(boolean $formatOutput = true
) : \Zend_View_Helper_Navigation_Sitemap
boolean
[optional] whether output should be formatted. Default is true.
\Zend_View_Helper_Navigation_Sitemap
fluent interface, returns
selfsetIndent(string|integer $indent) : \Zend_View_Helper_Navigation_HelperAbstract
string
integer
indentation string or number of spaces
\Zend_View_Helper_Navigation_HelperAbstract
fluent interface,
returns selfsetLinkLast(boolean $linkLast) : \Zend_View_Helper_Navigation_Breadcrumbs
boolean
whether last page should be hyperlinked
\Zend_View_Helper_Navigation_Breadcrumbs
fluent interface,
returns selfsetMaxDepth(integer $maxDepth = null
) : \Zend_View_Helper_Navigation_HelperAbstract
integer
[optional] maximum depth. Default is null, which sets no maximum depth.
\Zend_View_Helper_Navigation_HelperAbstract
fluent interface,
returns selfsetMinDepth(integer $minDepth = null
) : \Zend_View_Helper_Navigation_HelperAbstract
integer
[optional] minimum depth. Default is null, which sets no minimum depth.
\Zend_View_Helper_Navigation_HelperAbstract
fluent interface,
returns selfsetPartial(string|array $partial) : \Zend_View_Helper_Navigation_Breadcrumbs
string
array
partial view script or null. If an array is given, it is expected to contain two values; the partial view script to use, and the module where the script can be found.
\Zend_View_Helper_Navigation_Breadcrumbs
fluent interface,
returns selfsetPrefixForId(string $prefix) : \Zend_View_Helper_Navigation_HelperAbstract
string
Prefix for IDs
\Zend_View_Helper_Navigation_HelperAbstract
fluent interface, returns selfsetRenderInvisible(boolean $renderInvisible = true
) : \Zend_View_Helper_Navigation_HelperAbstract
inherited_from | \Zend_View_Helper_Navigation_Helper::setRenderInvisible() |
---|
boolean
[optional] boolean flag
\Zend_View_Helper_Navigation_HelperAbstract
fluent interface
returns selfsetRole(mixed $role = null
) : \Zend_View_Helper_Navigation_HelperAbstract
Implements Zend_View_Helper_Navigation_Helper::setRole().
inherited_from | \Zend_View_Helper_Navigation_Helper::setRole() |
---|
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.
\Zend_View_Exception |
if $role is invalid |
---|
\Zend_View_Helper_Navigation_HelperAbstract
fluent interface,
returns selfsetSeparator(string $separator) : \Zend_View_Helper_Navigation_Breadcrumbs
string
separator string
\Zend_View_Helper_Navigation_Breadcrumbs
fluent interface,
returns selfsetTranslator(mixed $translator = null
) : \Zend_View_Helper_Navigation_HelperAbstract
inherited_from | \Zend_View_Helper_Navigation_Helper::setTranslator() |
---|
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.
\Zend_View_Helper_Navigation_HelperAbstract
fluent interface,
returns selfsetUseAcl(boolean $useAcl = true
) : \Zend_View_Helper_Navigation_HelperAbstract
Implements Zend_View_Helper_Navigation_Helper::setUseAcl().
inherited_from | \Zend_View_Helper_Navigation_Helper::setUseAcl() |
---|
boolean
[optional] whether ACL should be used. Default is true.
\Zend_View_Helper_Navigation_HelperAbstract
fluent interface,
returns selfsetUseTranslator(boolean $useTranslator = true
) : \Zend_View_Helper_Navigation_HelperAbstract
inherited_from | \Zend_View_Helper_Navigation_Helper::setUseTranslator() |
---|
boolean
[optional] whether translator should be used. Default is true.
\Zend_View_Helper_Navigation_HelperAbstract
fluent interface,
returns selfsetView(\Zend_View_Interface $view) : \Zend_View_Helper_Abstract
inherited_from | \Zend_View_Helper_Interface::setView() |
---|
\Zend_View_Interface
\Zend_View_Helper_Abstract
skipPrefixForId(boolean $flag = true
) : \Zend_View_Helper_Navigation_HelperAbstract
boolean
\Zend_View_Helper_Navigation_HelperAbstract
fluent interface, returns self_acceptAcl(\Zend_Navigation_Page $page) : boolean
Rules:
\Zend_Navigation_Page
page to check
boolean
whether page is accepted by ACL_getWhitespace(integer|string $indent) : string
integer
string
string
_htmlAttribs(array $attribs) : string
access | public |
---|
array
From this array, each key-value pair is converted to an attribute name and value.
string
The XHTML for the attributes._isHtml5() : boolean
boolean
_isStrictDoctype() : boolean
boolean
_isXhtml() : boolean
boolean
_normalizeId(string $value) : string
string
string
$view : \Zend_View_Interface
null
$_acl : \Zend_Acl
$_closingBracket : string
null
$_container : \Zend_Navigation_Container
$_defaultAcl : \Zend_Acl
$_defaultRole : string | \Zend_Acl_Role_Interface
$_formatOutput : boolean
true
$_indent : string
''
$_linkLast : boolean
false
$_maxDepth : integer
$_minDepth : integer
1
inherited_from | \Zend_View_Helper_Navigation_HelperAbstract::_minDepth |
---|
$_minDepth : integer
$_partial : string | array
$_prefixForId : string | null
null
$_renderInvisible : boolean
false
$_role : string | \Zend_Acl_Role_Interface
$_separator : string
' > '
$_skipPrefixForId : boolean
false
$_translator : \Zend_Translate_Adapter
$_useAcl : boolean
true
$_useTranslator : boolean
true
EOL = "\n"