Docs For Class Zend_View_Helper_Navigation

Description

Helper for printing sitemaps

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
link: http://www.sitemaps.org/protocol.php
license: New BSD License

Located in /View/Helper/Navigation/Sitemap.php (line 39)

Zend_View_Helper_Abstract
   |
   --Zend_View_Helper_HtmlElement
      |
      --Zend_View_Helper_Navigation_HelperAbstract
         |
         --Zend_View_Helper_Navigation_Sitemap

Class Constant Summary

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

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

Variable Summary

bool $_formatOutput

string $_serverUrl

bool $_useSchemaValidation

bool $_useSitemapValidators

bool $_useXmlDeclaration

Method Summary

DOMDocument getDomSitemap ([ $container = null])

bool getFormatOutput ()

string getServerUrl ()

bool getUseSchemaValidation ()

bool getUseSitemapValidators ()

bool getUseXmlDeclaration ()

string render ([ $container = null])

Zend_View_Helper_Navigation_Sitemap setFormatOutput ([bool $formatOutput = true])

Zend_View_Helper_Navigation_Sitemap setServerUrl (string $serverUrl)

Zend_View_Helper_Navigation_Sitemap setUseSchemaValidation (bool $schemaValidation)

Zend_View_Helper_Navigation_Sitemap setUseSitemapValidators (bool $useSitemapValidators)

Zend_View_Helper_Navigation_Sitemap setUseXmlDeclaration (bool $useXmlDecl)

Zend_View_Helper_Navigation_Sitemap sitemap ([ $container = null])

string url ( $page)

string _xmlEscape (string $string)

Variables

bool $_formatOutput = false (line 61)

Whether XML output should be formatted

access: protected

string $_serverUrl (line 89)

Server url

access: protected

bool $_useSchemaValidation = false (line 82)

Whether sitemap should be schema validated when generated

access: protected

bool $_useSitemapValidators = true (line 75)

Whether sitemap should be validated using Zend_Validate_Sitemap_*

access: protected

bool $_useXmlDeclaration = true (line 68)

Whether the XML declaration should be included in XML output

access: protected

Inherited Variables

Inherited from Zend_View_Helper_Navigation_HelperAbstract

Zend_View_Helper_Navigation_HelperAbstract::$_acl
Zend_View_Helper_Navigation_HelperAbstract::$_container
Zend_View_Helper_Navigation_HelperAbstract::$_defaultAcl
Zend_View_Helper_Navigation_HelperAbstract::$_defaultRole
Zend_View_Helper_Navigation_HelperAbstract::$_indent
Zend_View_Helper_Navigation_HelperAbstract::$_maxDepth
Zend_View_Helper_Navigation_HelperAbstract::$_minDepth
Zend_View_Helper_Navigation_HelperAbstract::$_renderInvisible
Zend_View_Helper_Navigation_HelperAbstract::$_role
Zend_View_Helper_Navigation_HelperAbstract::$_translator
Zend_View_Helper_Navigation_HelperAbstract::$_useAcl
Zend_View_Helper_Navigation_HelperAbstract::$_useTranslator

Inherited from Zend_View_Helper_HtmlElement

Zend_View_Helper_HtmlElement::$_closingBracket

Inherited from Zend_View_Helper_Abstract

Zend_View_Helper_Abstract::$view

Methods

getDomSitemap (line 330)

Returns a DOMDocument containing the Sitemap XML for the given container

return: DOM representation of the container
throws: 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
access: public

DOMDocument getDomSitemap ([ $container = null])

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

getFormatOutput (line 131)

Returns whether XML output should be formatted

return: whether XML output should be formatted
access: public

bool getFormatOutput ()

getServerUrl (line 246)

Returns server URL

return: server URL
access: public

string getServerUrl ()

getUseSchemaValidation (line 203)

Returns true if sitemap should be schema validated when generated

access: public

bool getUseSchemaValidation ()

getUseSitemapValidators (line 179)

Returns whether sitemap should be validated using Zend_Validate_Sitemap_*

return: whether sitemap should be validated using validators
access: public

bool getUseSitemapValidators ()

getUseXmlDeclaration (line 155)

Returns whether the XML declaration should be used in output

return: whether the XML declaration should be used in output
access: public

bool getUseXmlDeclaration ()

render (line 473)

Renders helper

Implements Zend_View_Helper_Navigation_Helper::render().

return: helper output
access: public

string render ([ $container = null])

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

setFormatOutput (line 120)

Sets whether XML output should be formatted

return: fluent interface, returns self
access: public

Zend_View_Helper_Navigation_Sitemap setFormatOutput ([bool $formatOutput = true])

bool $formatOutput: [optional] whether output should be formatted. Default is true.

setServerUrl (line 219)

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

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

return: fluent interface, returns self
throws: Zend_Uri_Exception if invalid server URL
access: public

Zend_View_Helper_Navigation_Sitemap setServerUrl (string $serverUrl)

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

setUseSchemaValidation (line 192)

Sets whether sitemap should be schema validated when generated

return: fluent interface, returns self
access: public

Zend_View_Helper_Navigation_Sitemap setUseSchemaValidation (bool $schemaValidation)

bool $schemaValidation: whether sitemap should validated using XSD Schema

setUseSitemapValidators (line 168)

Sets whether sitemap should be validated using Zend_Validate_Sitemap_*

return: fluent interface, returns self
access: public

Zend_View_Helper_Navigation_Sitemap setUseSitemapValidators (bool $useSitemapValidators)

bool $useSitemapValidators: whether sitemap validators should be used

setUseXmlDeclaration (line 144)

Sets whether the XML declaration should be used in output

return: fluent interface, returns self
access: public

Zend_View_Helper_Navigation_Sitemap setUseXmlDeclaration (bool $useXmlDecl)

bool $useXmlDecl: whether XML delcaration should be rendered

sitemap (line 100)

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

return: fluent interface, returns self
access: public

Zend_View_Helper_Navigation_Sitemap sitemap ([ $container = null])

Zend_Navigation_Container $container: [optional] container to operate on

url (line 291)

Returns an escaped absolute URL for the given page

access: public

string url ( $page)

Zend_Navigation_Page $page: page to get URL from

_xmlEscape (line 263)

Escapes string for XML usage

return: escaped string
access: protected

string _xmlEscape (string $string)

string $string: string to escape

Inherited Methods

Inherited From Zend_View_Helper_Navigation_HelperAbstract

Zend_View_Helper_Navigation_HelperAbstract::accept()
Zend_View_Helper_Navigation_HelperAbstract::findActive()
Zend_View_Helper_Navigation_HelperAbstract::getAcl()
Zend_View_Helper_Navigation_HelperAbstract::getContainer()
Zend_View_Helper_Navigation_HelperAbstract::getIndent()
Zend_View_Helper_Navigation_HelperAbstract::getMaxDepth()
Zend_View_Helper_Navigation_HelperAbstract::getMinDepth()
Zend_View_Helper_Navigation_HelperAbstract::getRenderInvisible()
Zend_View_Helper_Navigation_HelperAbstract::getRole()
Zend_View_Helper_Navigation_HelperAbstract::getTranslator()
Zend_View_Helper_Navigation_HelperAbstract::getUseAcl()
Zend_View_Helper_Navigation_HelperAbstract::getUseTranslator()
Zend_View_Helper_Navigation_HelperAbstract::hasAcl()
Zend_View_Helper_Navigation_HelperAbstract::hasContainer()
Zend_View_Helper_Navigation_HelperAbstract::hasRole()
Zend_View_Helper_Navigation_HelperAbstract::hasTranslator()
Zend_View_Helper_Navigation_HelperAbstract::htmlify()
Zend_View_Helper_Navigation_HelperAbstract::setAcl()
Zend_View_Helper_Navigation_HelperAbstract::setContainer()
Zend_View_Helper_Navigation_HelperAbstract::setDefaultAcl()
Zend_View_Helper_Navigation_HelperAbstract::setDefaultRole()
Zend_View_Helper_Navigation_HelperAbstract::setIndent()
Zend_View_Helper_Navigation_HelperAbstract::setMaxDepth()
Zend_View_Helper_Navigation_HelperAbstract::setMinDepth()
Zend_View_Helper_Navigation_HelperAbstract::setRenderInvisible()
Zend_View_Helper_Navigation_HelperAbstract::setRole()
Zend_View_Helper_Navigation_HelperAbstract::setTranslator()
Zend_View_Helper_Navigation_HelperAbstract::setUseAcl()
Zend_View_Helper_Navigation_HelperAbstract::setUseTranslator()
Zend_View_Helper_Navigation_HelperAbstract::_acceptAcl()
Zend_View_Helper_Navigation_HelperAbstract::_getWhitespace()
Zend_View_Helper_Navigation_HelperAbstract::_htmlAttribs()
Zend_View_Helper_Navigation_HelperAbstract::_normalizeId()
Zend_View_Helper_Navigation_HelperAbstract::__call()
Zend_View_Helper_Navigation_HelperAbstract::__toString()

Inherited From Zend_View_Helper_HtmlElement

Zend_View_Helper_HtmlElement::getClosingBracket()
Zend_View_Helper_HtmlElement::_htmlAttribs()
Zend_View_Helper_HtmlElement::_isXhtml()
Zend_View_Helper_HtmlElement::_normalizeId()

Inherited From Zend_View_Helper_Abstract

Zend_View_Helper_Abstract::direct()
Zend_View_Helper_Abstract::setView()

Class Constants

SITEMAP_NS = 'http://www.sitemaps.org/schemas/sitemap/0.9' (line 47)

Namespace for the <urlset> tag

SITEMAP_XSD = 'http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd' (line 54)

Schema URL

Inherited Constants

Inherited from Zend_View_Helper_HtmlElement

Zend_View_Helper_HtmlElement::EOL