API Documentation

Zend/View/Helper/Navigation/Sitemap.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_View  
Subpackage
Helper  
Version
$Id: Sitemap.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_View_Helper_Navigation_Sitemap

Package: Zend\View\Helper

Helper for printing sitemaps

Parent(s)
\Zend_View_Helper_Navigation_HelperAbstract < \Zend_View_Helper_HtmlElement < \Zend_View_Helper_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Link
http://www.sitemaps.org/protocol.php  

Constants

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

Namespace for the <urlset> tag

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

Schema URL

string

Properties

Propertyprotectedbool  $_formatOutput= 'false'

Whether XML output should be formatted

Default valuefalseDetails
Type
bool
Propertyprotectedstring  $_serverUrl= ''

Server url

Details
Type
string
Propertyprotectedbool  $_useSchemaValidation= 'false'

Whether sitemap should be schema validated when generated

Default valuefalseDetails
Type
bool
Propertyprotectedbool  $_useSitemapValidators= 'true'

Whether sitemap should be validated using Zend_Validate_Sitemap_*

Default valuetrueDetails
Type
bool
Propertyprotectedbool  $_useXmlDeclaration= 'true'

Whether the XML declaration should be included in XML output

Default valuetrueDetails
Type
bool

Methods

methodprotected_xmlEscape( string $string ) : string

Escapes string for XML usage

Parameters
Name Type Description
$string string

string to escape

Returns
Type Description
string escaped string
methodpublicgetDomSitemap( \Zend_Navigation_Container $container = null ) : \DOMDocument

Returns a DOMDocument containing the Sitemap XML for the given container

Parameters
Name Type Description
$container \Zend_Navigation_Container

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

Returns
Type Description
\DOMDocument DOM representation of the container
Throws
Exception Description
\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
methodpublicgetFormatOutput( ) : bool

Returns whether XML output should be formatted

Returns
Type Description
bool whether XML output should be formatted
methodpublicgetServerUrl( ) : string

Returns server URL

Returns
Type Description
string server URL
methodpublicgetUseSchemaValidation( ) : bool

Returns true if sitemap should be schema validated when generated

Returns
Type Description
bool
methodpublicgetUseSitemapValidators( ) : bool

Returns whether sitemap should be validated using Zend_Validate_Sitemap_*

Returns
Type Description
bool whether sitemap should be validated using validators
methodpublicgetUseXmlDeclaration( ) : bool

Returns whether the XML declaration should be used in output

Returns
Type Description
bool whether the XML declaration should be used in output
methodpublicrender( \Zend_Navigation_Container $container = null ) : string

Renders helper

Implements {@link Zend_View_Helper_Navigation_Helper::render()}.

Parameters
Name Type Description
$container \Zend_Navigation_Container

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

Returns
Type Description
string helper output
methodpublicsetFormatOutput( bool $formatOutput = true ) : \Zend_View_Helper_Navigation_Sitemap

Sets whether XML output should be formatted

Parameters
Name Type Description
$formatOutput bool

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

Returns
Type Description
\Zend_View_Helper_Navigation_Sitemap fluent interface, returns self
methodpublicsetServerUrl( string $serverUrl ) : \Zend_View_Helper_Navigation_Sitemap

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

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

Parameters
Name Type Description
$serverUrl string

server URL to set (only scheme and host)

Returns
Type Description
\Zend_View_Helper_Navigation_Sitemap fluent interface, returns self
Throws
Exception Description
\Zend_Uri_Exception if invalid server URL
methodpublicsetUseSchemaValidation( bool $schemaValidation ) : \Zend_View_Helper_Navigation_Sitemap

Sets whether sitemap should be schema validated when generated

Parameters
Name Type Description
$schemaValidation bool

whether sitemap should validated using XSD Schema

Returns
Type Description
\Zend_View_Helper_Navigation_Sitemap fluent interface, returns self
methodpublicsetUseSitemapValidators( bool $useSitemapValidators ) : \Zend_View_Helper_Navigation_Sitemap

Sets whether sitemap should be validated using Zend_Validate_Sitemap_*

Parameters
Name Type Description
$useSitemapValidators bool

whether sitemap validators should be used

Returns
Type Description
\Zend_View_Helper_Navigation_Sitemap fluent interface, returns self
methodpublicsetUseXmlDeclaration( bool $useXmlDecl ) : \Zend_View_Helper_Navigation_Sitemap

Sets whether the XML declaration should be used in output

Parameters
Name Type Description
$useXmlDecl bool

whether XML delcaration should be rendered

Returns
Type Description
\Zend_View_Helper_Navigation_Sitemap fluent interface, returns self
methodpublicsitemap( \Zend_Navigation_Container $container = null ) : \Zend_View_Helper_Navigation_Sitemap

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

Parameters
Name Type Description
$container \Zend_Navigation_Container

[optional] container to operate on

Returns
Type Description
\Zend_View_Helper_Navigation_Sitemap fluent interface, returns self
methodpublicurl( \Zend_Navigation_Page $page ) : string

Returns an escaped absolute URL for the given page

Parameters
Name Type Description
$page \Zend_Navigation_Page

page to get URL from

Returns
Type Description
string
Documentation was generated by DocBlox 0.15.1.