Helper for printing sitemaps

link http://www.sitemaps.org/protocol.php

 Methods

Magic overload: Proxy calls to the navigation container

__call(string $method, array $arguments) : mixed
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::__call()

Parameters

$method

string

method name in container

$arguments

array

[optional] arguments to pass

Exceptions

\Zend\Navigation\Exception\ExceptionInterface if method does not exist in container

Returns

mixedreturns what the container returns

Helper entry point

__invoke(string | \Zend\Navigation\AbstractContainer $container) : \Zend\View\Helper\Navigation\Sitemap

Parameters

$container

string\Zend\Navigation\AbstractContainer

container to operate on

Returns

Magic overload: Proxy to {@link render()}.

__toString() : string
Inherited

This method will trigger an E_USER_ERROR if rendering the helper causes an exception to be thrown.

Implements HelperInterface::__toString().

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::__toString()

Returns

string

Determines whether a page should be accepted when iterating

accept(\Zend\Navigation\Page\AbstractPage $page, bool $recursive) : bool
Inherited

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.

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::accept()

Parameters

$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.

Returns

boolwhether page should be accepted

Finds the deepest active page in the given container

findActive(\Zend\Navigation\AbstractContainer $container, int | null $minDepth, int | null $maxDepth) : array
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::findActive()

Parameters

$container

\Zend\Navigation\AbstractContainer

container to search

$minDepth

intnull

[optional] minimum depth required for page to be valid. Default is to use {@link getMinDepth()}. A null value means no minimum depth required.

$maxDepth

intnull

[optional] maximum depth a page can have to be valid. Default is to use {@link getMaxDepth()}. A null value means no maximum depth required.

Returns

arrayan associative array with the values 'depth' and 'page', or an empty array if not found

Returns ACL or null if it isn't set using {@link setAcl()} or {@link setDefaultAcl()}

getAcl() : \Zend\Permissions\Acl\AclInterface | null
Inherited

Implements HelperInterface::getAcl().

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getAcl()

Returns

\Zend\Permissions\Acl\AclInterfacenullACL object or null

Get the tag closing bracket

getClosingBracket() : string
Inherited

inherited_from \Zend\View\Helper\AbstractHtmlElement::getClosingBracket()
inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getClosingBracket()

Returns

string

Returns the navigation container helper operates on by default

getContainer() : \Zend\Navigation\AbstractContainer
Inherited

Implements HelperInterface::getContainer().

If no container is set, a new container will be instantiated and stored in the helper.

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getContainer()

Returns

Returns a DOMDocument containing the Sitemap XML for the given container

getDomSitemap(\Zend\Navigation\AbstractContainer $container) : \DOMDocument

Parameters

$container

\Zend\Navigation\AbstractContainer

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

Exceptions

\Zend\View\Exception\RuntimeException 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

Returns

\DOMDocumentDOM representation of the container

Returns whether XML output should be formatted

getFormatOutput() : bool

Returns

boolwhether XML output should be formatted

Returns indentation

getIndent() : string
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getIndent()

Returns

string

Returns maximum depth a page can have to be included when rendering

getMaxDepth() : int | null
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getMaxDepth()

Returns

intnullmaximum depth or null

Returns minimum depth a page must have to be included when rendering

getMinDepth() : int | null
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getMinDepth()

Returns

intnullminimum depth or null

Return renderInvisible flag

getRenderInvisible() : bool
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getRenderInvisible()

Returns

bool

Returns ACL role to use when iterating pages, or null if it isn't set using {@link setRole()} or {@link setDefaultRole()}

getRole() : string | \Zend\Permissions\Acl\Role\RoleInterface | null
Inherited

Implements HelperInterface::getRole().

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getRole()

Returns

Returns server URL

getServerUrl() : string

Returns

stringserver URL

Get the service locator.

getServiceLocator() : \Zend\ServiceManager\ServiceLocatorInterface
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getServiceLocator()

Returns

Returns translator used in helper

getTranslator() : \Zend\I18n\Translator\Translator | null
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getTranslator()

Returns

Return the translation text domain

getTranslatorTextDomain() : string
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getTranslatorTextDomain()

Returns

string

Returns whether ACL should be used

getUseAcl() : bool
Inherited

Implements HelperInterface::getUseAcl().

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getUseAcl()

Returns

boolwhether ACL should be used

Returns true if sitemap should be schema validated when generated

getUseSchemaValidation() : bool

Returns

bool

Returns whether sitemap should be validated using Zend\Validate\Sitemap_*

getUseSitemapValidators() : bool

Returns

boolwhether sitemap should be validated using validators

Returns whether the XML declaration should be used in output

getUseXmlDeclaration() : bool

Returns

boolwhether the XML declaration should be used in output

Get the view object

getView() : null | \Zend\View\Renderer\RendererInterface
Inherited

inherited_from \Zend\View\Helper\AbstractHelper::getView()
inherited_from \Zend\View\Helper\AbstractHtmlElement::getView()
inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getView()

Returns

Checks if the helper has an ACL instance

hasAcl() : bool
Inherited

Implements HelperInterface::hasAcl().

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::hasAcl()

Returns

boolwhether the helper has a an ACL instance or not

Checks if the helper has a container

hasContainer() : bool
Inherited

Implements HelperInterface::hasContainer().

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::hasContainer()

Returns

boolwhether the helper has a container or not

Checks if the helper has an ACL role

hasRole() : bool
Inherited

Implements HelperInterface::hasRole().

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::hasRole()

Returns

boolwhether the helper has a an ACL role or not

Checks if the helper has a translator

hasTranslator() : bool
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::hasTranslator()

Returns

bool

Returns an HTML string containing an 'a' element for the given page

htmlify(\Zend\Navigation\Page\AbstractPage $page) : string
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::htmlify()

Parameters

$page

\Zend\Navigation\Page\AbstractPage

page to generate HTML for

Returns

stringHTML string for the given page

Returns whether translator is enabled and should be used

isTranslatorEnabled() : bool
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::isTranslatorEnabled()

Returns

bool

Renders helper

render(\Zend\Navigation\AbstractContainer $container) : string

Implements HelperInterface::render().

Parameters

$container

\Zend\Navigation\AbstractContainer

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

Exceptions

\Zend\View\Exception\ExceptionInterface if unable to render

Returns

stringhelper output

Sets ACL to use when iterating pages

setAcl(\Zend\Permissions\Acl\AclInterface $acl) : \Zend\View\Helper\Navigation\AbstractHelper
Inherited

Implements HelperInterface::setAcl().

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setAcl()

Parameters

$acl

\Zend\Permissions\Acl\AclInterface

[optional] ACL object. Default is null.

Returns

\Zend\View\Helper\Navigation\AbstractHelperfluent interface, returns self

Sets navigation container the helper operates on by default

setContainer(string | \Zend\Navigation\AbstractContainer $container) : \Zend\View\Helper\Navigation\AbstractHelper
Inherited

Implements HelperInterface::setContainer().

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setContainer()

Parameters

$container

string\Zend\Navigation\AbstractContainer

[optional] container to operate on. Default is null, meaning container will be reset.

Returns

\Zend\View\Helper\Navigation\AbstractHelperfluent interface, returns self

Sets default ACL to use if another ACL is not explicitly set

setDefaultAcl(\Zend\Permissions\Acl\AclInterface $acl) : void
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setDefaultAcl()

Parameters

$acl

\Zend\Permissions\Acl\AclInterface

[optional] ACL object. Default is null, which sets no ACL object.

Sets default ACL role(s) to use when iterating pages if not explicitly set later with {@link setRole()}

setDefaultRole(mixed $role) : void
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setDefaultRole()

Parameters

$role

mixed

[optional] role to set. Expects null, string, or an instance of {@link Acl\Role\RoleInterface}. Default is null, which sets no default role.

Exceptions

\Zend\View\Exception\InvalidArgumentException if role is invalid

Sets whether XML output should be formatted

setFormatOutput(bool $formatOutput) : \Zend\View\Helper\Navigation\Sitemap

Parameters

$formatOutput

bool

[optional] whether output should be formatted. Default is true.

Returns

\Zend\View\Helper\Navigation\Sitemapfluent interface, returns self

Set the indentation string for using in {@link render()}, optionally a number of spaces to indent with

setIndent(string | int $indent) : \Zend\View\Helper\Navigation\AbstractHelper
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setIndent()

Parameters

$indent

stringint

indentation string or number of spaces

Returns

\Zend\View\Helper\Navigation\AbstractHelperfluent interface, returns self

Sets the maximum depth a page can have to be included when rendering

setMaxDepth(int $maxDepth) : \Zend\View\Helper\Navigation\AbstractHelper
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setMaxDepth()

Parameters

$maxDepth

int

[optional] maximum depth. Default is null, which sets no maximum depth.

Returns

\Zend\View\Helper\Navigation\AbstractHelperfluent interface, returns self

Sets the minimum depth a page must have to be included when rendering

setMinDepth(int $minDepth) : \Zend\View\Helper\Navigation\AbstractHelper
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setMinDepth()

Parameters

$minDepth

int

[optional] minimum depth. Default is null, which sets no minimum depth.

Returns

\Zend\View\Helper\Navigation\AbstractHelperfluent interface, returns self

Render invisible items?

setRenderInvisible(bool $renderInvisible) : \Zend\View\Helper\Navigation\AbstractHelper
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setRenderInvisible()

Parameters

$renderInvisible

bool

[optional] boolean flag

Returns

\Zend\View\Helper\Navigation\AbstractHelperfluent interface returns self

Sets ACL role(s) to use when iterating pages

setRole(mixed $role) : \Zend\View\Helper\Navigation\AbstractHelper
Inherited

Implements HelperInterface::setRole().

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setRole()

Parameters

$role

mixed

[optional] role to set. Expects a string, an instance of type {@link Acl\Role\RoleInterface}, or null. Default is null, which will set no role.

Exceptions

\Zend\View\Exception\InvalidArgumentException if $role is invalid

Returns

\Zend\View\Helper\Navigation\AbstractHelperfluent interface, returns self

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

setServerUrl(string $serverUrl) : \Zend\View\Helper\Navigation\Sitemap

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

Parameters

$serverUrl

string

server URL to set (only scheme and host)

Exceptions

\Zend\View\Exception\InvalidArgumentException if invalid server URL

Returns

\Zend\View\Helper\Navigation\Sitemapfluent interface, returns self

Set the service locator.

setServiceLocator(\Zend\ServiceManager\ServiceLocatorInterface $serviceLocator) : \Zend\View\Helper\Navigation\AbstractHelper
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setServiceLocator()

Parameters

Returns

Sets translator to use in helper

setTranslator(\Zend\I18n\Translator\Translator $translator, string $textDomain) : \Zend\View\Helper\Navigation\AbstractHelper
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setTranslator()

Parameters

$translator

\Zend\I18n\Translator\Translator

[optional] translator. Default is null, which sets no translator.

$textDomain

string

[optional] text domain Default is null, which skips setTranslatorTextDomain

Returns

Sets whether translator is enabled and should be used

setTranslatorEnabled(bool $enabled) : \Zend\View\Helper\Navigation\AbstractHelper
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setTranslatorEnabled()

Parameters

$enabled

bool

[optional] whether translator should be used. Default is true.

Returns

Set translation text domain

setTranslatorTextDomain(string $textDomain) : \Zend\View\Helper\Navigation\AbstractHelper
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setTranslatorTextDomain()

Parameters

$textDomain

string

Returns

Sets whether ACL should be used

setUseAcl(bool $useAcl) : \Zend\View\Helper\Navigation\AbstractHelper
Inherited

Implements HelperInterface::setUseAcl().

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setUseAcl()

Parameters

$useAcl

bool

[optional] whether ACL should be used. Default is true.

Returns

\Zend\View\Helper\Navigation\AbstractHelperfluent interface, returns self

Sets whether sitemap should be schema validated when generated

setUseSchemaValidation(bool $schemaValidation) : \Zend\View\Helper\Navigation\Sitemap

Parameters

$schemaValidation

bool

whether sitemap should validated using XSD Schema

Returns

Sets whether sitemap should be validated using Zend\Validate\Sitemap_*

setUseSitemapValidators(bool $useSitemapValidators) : \Zend\View\Helper\Navigation\Sitemap

Parameters

$useSitemapValidators

bool

whether sitemap validators should be used

Returns

\Zend\View\Helper\Navigation\Sitemapfluent interface, returns self

Sets whether the XML declaration should be used in output

setUseXmlDeclaration(bool $useXmlDecl) : \Zend\View\Helper\Navigation\Sitemap

Parameters

$useXmlDecl

bool

whether XML declaration should be rendered

Returns

\Zend\View\Helper\Navigation\Sitemapfluent interface, returns self

Set the View object

setView(\Zend\View\Renderer\RendererInterface $view) : \Zend\View\Helper\AbstractHelper
Inherited

inherited_from \Zend\View\Helper\AbstractHelper::setView()
inherited_from \Zend\View\Helper\AbstractHtmlElement::setView()
inherited_from \Zend\View\Helper\Navigation\AbstractHelper::setView()

Parameters

Returns

Returns an escaped absolute URL for the given page

url(\Zend\Navigation\Page\AbstractPage $page) : string

Parameters

$page

\Zend\Navigation\Page\AbstractPage

page to get URL from

Returns

string

Determines whether a page should be accepted by ACL when iterating

acceptAcl(\Zend\Navigation\Page\AbstractPage $page) : bool
Inherited

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

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::acceptAcl()

Parameters

Returns

boolwhether page is accepted by ACL

Retrieve whitespace representation of $indent

getWhitespace(int | string $indent) : string
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::getWhitespace()

Parameters

$indent

intstring

Returns

string

Converts an associative array to a string of tag attributes.

htmlAttribs(array $attribs) : string
Inherited

Overloads View\Helper\AbstractHtmlElement::htmlAttribs().

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::htmlAttribs()

Parameters

$attribs

array

an array where each key-value pair is converted to an attribute name and value

Returns

stringan attribute string

Is doctype XHTML?

isXhtml() : bool
Inherited

inherited_from \Zend\View\Helper\AbstractHtmlElement::isXhtml()
inherited_from \Zend\View\Helper\Navigation\AbstractHelper::isXhtml()

Returns

bool

Normalize an ID

normalizeId(string $value) : string
Inherited

Overrides View\Helper\AbstractHtmlElement::normalizeId().

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::normalizeId()

Parameters

$value

string

Returns

string

Verifies container and eventually fetches it from service locator if it is a string

parseContainer(\Zend\Navigation\AbstractContainer | string | null $container) 
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::parseContainer()

Parameters

$container

\Zend\Navigation\AbstractContainerstringnull

Exceptions

\Zend\View\Exception\InvalidArgumentException

Escapes string for XML usage

xmlEscape(string $string) : string

Parameters

$string

string

string to escape

Returns

stringescaped string

 Properties

 

ACL to use when iterating pages

$acl : \Zend\Permissions\Acl\AclInterface
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$acl
 

The tag closing bracket

$closingBracket : string
Inherited

inherited_from \Zend\View\Helper\AbstractHtmlElement::$$closingBracket
inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$closingBracket
 

AbstractContainer to operate on by default

$container : \Zend\Navigation\AbstractContainer
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$container
 

Default ACL to use when iterating pages if not explicitly set in the instance by calling {@link setAcl()}

$defaultAcl : \Zend\Permissions\Acl\AclInterface
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$defaultAcl
 

Default ACL role to use when iterating pages if not explicitly set in the instance by calling {@link setRole()}

$defaultRole : string | \Zend\Permissions\Acl\Role\RoleInterface
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$defaultRole
 

Whether XML output should be formatted

$formatOutput : bool

 

Indentation string

$indent : string
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$indent
 

The maximum depth a page can have to be included when rendering

$maxDepth : int
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$maxDepth
 

The minimum depth a page must have to be included when rendering

$minDepth : int
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$minDepth
 

Whether invisible items should be rendered by this helper

$renderInvisible : bool
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$renderInvisible
 

ACL role to use when iterating pages

$role : string | \Zend\Permissions\Acl\Role\RoleInterface
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$role
 

Server url

$serverUrl : string

 

$serviceLocator

$serviceLocator : \Zend\ServiceManager\ServiceLocatorInterface
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$serviceLocator
 

Translator (optional)

$translator : \Zend\I18n\Translator\Translator
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$translator
 

Whether translator should be used

$translatorEnabled : bool
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$translatorEnabled
 

Translator text domain (optional)

$translatorTextDomain : string
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$translatorTextDomain
 

List of urls in the sitemap

$urls : array

 

Whether ACL should be used for filtering out pages

$useAcl : bool
Inherited

inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$useAcl
 

Whether sitemap should be schema validated when generated

$useSchemaValidation : bool

 

Whether sitemap should be validated using Zend\Validate\Sitemap\*

$useSitemapValidators : bool

 

Whether the XML declaration should be included in XML output

$useXmlDeclaration : bool

 

View object

$view : \Zend\View\Renderer\RendererInterface
Inherited

inherited_from \Zend\View\Helper\AbstractHelper::$$view
inherited_from \Zend\View\Helper\AbstractHtmlElement::$$view
inherited_from \Zend\View\Helper\Navigation\AbstractHelper::$$view

 Constants

 

EOL character

EOL 
Inherited

inherited_from \Zend\View\Helper\AbstractHtmlElement::EOL
inherited_from \Zend\View\Helper\Navigation\AbstractHelper::EOL
 

Namespace for the <urlset> tag

SITEMAP_NS : string

 

Schema URL

SITEMAP_XSD : string