Zend Framework
1.12
|
Public Member Functions | |
breadcrumbs (Zend_Navigation_Container $container=null) | |
View helper entry point: Retrieves helper and optionally sets container to operate on. | |
setSeparator ($separator) | |
Sets breadcrumb separator. | |
getSeparator () | |
Returns breadcrumb separator. | |
setLinkLast ($linkLast) | |
Sets whether last page in breadcrumbs should be hyperlinked. | |
getLinkLast () | |
Returns whether last page in breadcrumbs should be hyperlinked. | |
setPartial ($partial) | |
Sets which partial view script to use for rendering menu. | |
getPartial () | |
Returns partial view script to use for rendering menu. | |
renderStraight (Zend_Navigation_Container $container=null) | |
Renders breadcrumbs by chaining 'a' elements with the separator registered in the helper. | |
renderPartial (Zend_Navigation_Container $container=null, $partial=null) | |
Renders the given $container by invoking the partial view helper. | |
render (Zend_Navigation_Container $container=null) | |
Renders helper. | |
![]() | |
setContainer (Zend_Navigation_Container $container=null) | |
Sets navigation container the helper operates on by default. | |
getContainer () | |
Returns the navigation container helper operates on by default. | |
setMinDepth ($minDepth=null) | |
Sets the minimum depth a page must have to be included when rendering. | |
getMinDepth () | |
Returns minimum depth a page must have to be included when rendering. | |
setMaxDepth ($maxDepth=null) | |
Sets the maximum depth a page can have to be included when rendering. | |
getMaxDepth () | |
Returns maximum depth a page can have to be included when rendering. | |
setIndent ($indent) | |
Set the indentation string for using in render(), optionally a number of spaces to indent with. | |
getIndent () | |
Returns indentation (format output is respected) | |
getEOL () | |
Returns the EOL character (format output is respected) | |
setFormatOutput ($formatOutput=true) | |
Sets whether HTML/XML output should be formatted. | |
getFormatOutput () | |
Returns whether HTML/XML output should be formatted. | |
setPrefixForId ($prefix) | |
Sets prefix for IDs when they are normalized. | |
getPrefixForId () | |
Returns prefix for IDs when they are normalized. | |
skipPrefixForId ($flag=true) | |
Skip the current prefix for IDs when they are normalized. | |
setTranslator ($translator=null) | |
Sets translator to use in helper. | |
getTranslator () | |
Returns translator used in helper. | |
setAcl (Zend_Acl $acl=null) | |
Sets ACL to use when iterating pages. | |
getAcl () | |
Returns ACL or null if it isn't set using setAcl() or setDefaultAcl(). | |
setRole ($role=null) | |
Sets ACL role(s) to use when iterating pages. | |
getRole () | |
Returns ACL role to use when iterating pages, or null if it isn't set using setRole() or setDefaultRole(). | |
setUseAcl ($useAcl=true) | |
Sets whether ACL should be used. | |
getUseAcl () | |
Returns whether ACL should be used. | |
getRenderInvisible () | |
Return renderInvisible flag. | |
setRenderInvisible ($renderInvisible=true) | |
Render invisible items? | |
setUseTranslator ($useTranslator=true) | |
Sets whether translator should be used. | |
getUseTranslator () | |
Returns whether translator should be used. | |
__call ($method, array $arguments=array()) | |
Magic overload: Proxy calls to the navigation container. | |
__toString () | |
Magic overload: Proxy to render(). | |
findActive (Zend_Navigation_Container $container, $minDepth=null, $maxDepth=-1) | |
Finds the deepest active page in the given container. | |
hasContainer () | |
Checks if the helper has a container. | |
hasAcl () | |
Checks if the helper has an ACL instance. | |
hasRole () | |
Checks if the helper has an ACL role. | |
hasTranslator () | |
Checks if the helper has a translator. | |
htmlify (Zend_Navigation_Page $page) | |
Returns an HTML string containing an 'a' element for the given page. | |
accept (Zend_Navigation_Page $page, $recursive=true) | |
Determines whether a page should be accepted when iterating. | |
![]() | |
getClosingBracket () | |
Get the tag closing bracket. | |
![]() | |
setView (Zend_View_Interface $view) | |
Set the View object. | |
direct () | |
Strategy pattern: currently unutilized. | |
Protected Attributes | |
$_separator = ' > ' | |
$_minDepth = 1 | |
$_linkLast = false | |
$_partial | |
![]() | |
$_container | |
$_minDepth | |
$_maxDepth | |
$_indent = '' | |
$_formatOutput = true | |
$_prefixForId = null | |
$_skipPrefixForId = false | |
$_translator | |
$_acl | |
$_renderInvisible = false | |
$_role | |
$_useTranslator = true | |
$_useAcl = true | |
![]() | |
$_closingBracket = null | |
Additional Inherited Members | |
![]() | |
static | setDefaultAcl (Zend_Acl $acl=null) |
Sets default ACL to use if another ACL is not explicitly set. | |
static | setDefaultRole ($role=null) |
Sets default ACL role(s) to use when iterating pages if not explicitly set later with setRole(). | |
![]() | |
const | EOL = "\n" |
EOL character. | |
![]() | |
_acceptAcl (Zend_Navigation_Page $page) | |
Determines whether a page should be accepted by ACL when iterating. | |
_getWhitespace ($indent) | |
Retrieve whitespace representation of $indent. | |
_htmlAttribs ($attribs) | |
Converts an associative array to a string of tag attributes. | |
_normalizeId ($value) | |
Normalize an ID. | |
![]() | |
static | $_defaultAcl |
static | $_defaultRole |
breadcrumbs | ( | Zend_Navigation_Container | $container = null | ) |
View helper entry point: Retrieves helper and optionally sets container to operate on.
Zend_Navigation_Container | $container | [optional] container to operate on |
getLinkLast | ( | ) |
Returns whether last page in breadcrumbs should be hyperlinked.
getPartial | ( | ) |
Returns partial view script to use for rendering menu.
getSeparator | ( | ) |
Returns breadcrumb separator.
render | ( | Zend_Navigation_Container | $container = null | ) |
Renders helper.
Implements Zend_View_Helper_Navigation_Helper::render().
Zend_Navigation_Container | $container | [optional] container to render. Default is to render the container registered in the helper. |
Implements Zend_View_Helper_Navigation_Helper.
renderPartial | ( | Zend_Navigation_Container | $container = null , |
$partial = null |
|||
) |
Renders the given $container by invoking the partial view helper.
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 | $container | [optional] container to pass to view script. Default is to use the container registered in the helper. |
string | array | $partial | [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. |
renderStraight | ( | Zend_Navigation_Container | $container = null | ) |
Renders breadcrumbs by chaining 'a' elements with the separator registered in the helper.
Zend_Navigation_Container | $container | [optional] container to render. Default is to render the container registered in the helper. |
setLinkLast | ( | $linkLast | ) |
Sets whether last page in breadcrumbs should be hyperlinked.
bool | $linkLast | whether last page should be hyperlinked |
setPartial | ( | $partial | ) |
Sets which partial view script to use for rendering menu.
string | array | $partial | 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. |
setSeparator | ( | $separator | ) |
Sets breadcrumb separator.
string | $separator | separator string |
|
protected |
|
protected |
|
protected |
|
protected |