Public Member Functions
	sitemap (Zend_Navigation_Container $container=null)
	View helper entry point: Retrieves helper and optionally sets container to operate on.

	setUseXmlDeclaration ($useXmlDecl)
	Sets whether the XML declaration should be used in output.

	getUseXmlDeclaration ()
	Returns whether the XML declaration should be used in output.

	setUseSitemapValidators ($useSitemapValidators)
	Sets whether sitemap should be validated using Zend_Validate_Sitemap_*.

	getUseSitemapValidators ()
	Returns whether sitemap should be validated using Zend_Validate_Sitemap_*.

	setUseSchemaValidation ($schemaValidation)
	Sets whether sitemap should be schema validated when generated.

	getUseSchemaValidation ()
	Returns true if sitemap should be schema validated when generated.

	setServerUrl ($serverUrl)
	Sets server url (scheme and host-related stuff without request URI)

	getServerUrl ()
	Returns server URL.

	url (Zend_Navigation_Page $page)
	Returns an escaped absolute URL for the given page.

	getDomSitemap (Zend_Navigation_Container $container=null)
	Returns a DOMDocument containing the Sitemap XML for the given container.

	render (Zend_Navigation_Container $container=null)
	Renders helper.

Public Member Functions inherited from Zend_View_Helper_Navigation_HelperAbstract
	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.

Public Member Functions inherited from Zend_View_Helper_HtmlElement
	getClosingBracket ()
	Get the tag closing bracket.

Public Member Functions inherited from Zend_View_Helper_Abstract
	setView (Zend_View_Interface $view)
	Set the View object.

	direct ()
	Strategy pattern: currently unutilized.

Public Attributes
const	SITEMAP_NS = 'http://www.sitemaps.org/schemas/sitemap/0.9'

const	SITEMAP_XSD = 'http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd'

Protected Member Functions
	_xmlEscape ($string)
	Escapes string for XML usage.

Protected Member Functions inherited from Zend_View_Helper_Navigation_HelperAbstract
	_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.

Protected Member Functions inherited from Zend_View_Helper_HtmlElement
	_isXhtml ()
	Is doctype XHTML?

	_isHtml5 ()
	Is doctype HTML5?

	_isStrictDoctype ()
	Is doctype strict?

	_htmlAttribs ($attribs)
	Converts an associative array to a string of tag attributes.

	_normalizeId ($value)
	Normalize an ID.

Protected Attributes
	$_useXmlDeclaration = true

	$_useSitemapValidators = true

	$_useSchemaValidation = false

	$_serverUrl

Protected Attributes inherited from Zend_View_Helper_Navigation_HelperAbstract
	$_container

	$_minDepth

	$_maxDepth

	$_indent = ''

	$_formatOutput = true

	$_prefixForId = null

	$_skipPrefixForId = false

	$_translator

	$_acl

	$_renderInvisible = false

	$_role

	$_useTranslator = true

	$_useAcl = true

Protected Attributes inherited from Zend_View_Helper_HtmlElement
	$_closingBracket = null

Additional Inherited Members
Static Public Member Functions inherited from Zend_View_Helper_Navigation_HelperAbstract
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().

Static Protected Attributes inherited from Zend_View_Helper_Navigation_HelperAbstract
static	$_defaultAcl

static	$_defaultRole

Member Function Documentation

_xmlEscape ( $string )

protected

Escapes string for XML usage.

Parameters

string $string string to escape

Returns: string escaped string

getDomSitemap ( Zend_Navigation_Container $container = null )

Returns a DOMDocument containing the Sitemap XML for the given container.

Parameters

Zend_Navigation_Container $container [optional] container to get breadcrumbs from, defaults to what is registered in the helper

Returns: DOMDocument DOM representation of the container

Exceptions

Zend_View_Exception if schema validation is on and the sitemap is invalid according to the sitemap schema, or if sitemap validators are used and the loc element fails validation

getServerUrl ( )

Returns server URL.

Returns: string server URL

getUseSchemaValidation ( )

Returns true if sitemap should be schema validated when generated.

Returns: bool

getUseSitemapValidators ( )

Returns whether sitemap should be validated using Zend_Validate_Sitemap_*.

Returns: bool whether sitemap should be validated using validators

getUseXmlDeclaration ( )

Returns whether the XML declaration should be used in output.

Returns: bool whether the XML declaration should be used in output

render ( Zend_Navigation_Container $container = null )

Renders helper.

Implements Zend_View_Helper_Navigation_Helper::render().

Parameters

Zend_Navigation_Container $container [optional] container to render. Default is to render the container registered in the helper.

Returns: string helper output

Implements Zend_View_Helper_Navigation_Helper.

setServerUrl ( $serverUrl )

Sets server url (scheme and host-related stuff without request URI)

E.g. http://www.example.com

Parameters

string $serverUrl server URL to set (only scheme and host)

Exceptions

Zend_Uri_Exception if invalid server URL

Returns: Zend_View_Helper_Navigation_Sitemap fluent interface, returns self

setUseSchemaValidation ( $schemaValidation )

Sets whether sitemap should be schema validated when generated.

Parameters

bool $schemaValidation whether sitemap should validated using XSD Schema

Returns: Zend_View_Helper_Navigation_Sitemap fluent interface, returns self

setUseSitemapValidators ( $useSitemapValidators )

Sets whether sitemap should be validated using Zend_Validate_Sitemap_*.

Parameters

bool $useSitemapValidators whether sitemap validators should be used

Returns: Zend_View_Helper_Navigation_Sitemap fluent interface, returns self

setUseXmlDeclaration ( $useXmlDecl )

Sets whether the XML declaration should be used in output.

Parameters

bool $useXmlDecl whether XML delcaration should be rendered

Returns: Zend_View_Helper_Navigation_Sitemap fluent interface, returns self

sitemap ( Zend_Navigation_Container $container = null )

View helper entry point: Retrieves helper and optionally sets container to operate on.

Parameters

Zend_Navigation_Container $container [optional] container to operate on

Returns: Zend_View_Helper_Navigation_Sitemap fluent interface, returns self

url ( Zend_Navigation_Page $page )

Returns an escaped absolute URL for the given page.

Parameters

Zend_Navigation_Page $page page to get URL from

Returns: string

Member Data Documentation

$_serverUrl

protected

$_useSchemaValidation = false

protected

$_useSitemapValidators = true

protected

$_useXmlDeclaration = true

protected

const SITEMAP_NS = 'http://www.sitemaps.org/schemas/sitemap/0.9'

const SITEMAP_XSD = 'http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd'

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

Member Data Documentation