PKPSitemapHandler Class Reference

Inheritance diagram for PKPSitemapHandler:

Public Member Functions
	_createContextSitemap ($request)
	_createSitemapIndex ($request)
	index ($args, $request)
Public Member Functions inherited from PKPHandler
	__construct ()
	addPolicy ($authorizationPolicy, $addToTop=false)
	addRoleAssignment ($roleIds, $operations)
	authorize ($request, &$args, $roleAssignments)
	getApiToken ()
&	getAuthorizedContext ()
&	getAuthorizedContextObject ($assocType)
&	getDispatcher ()
	getFirstUserContext ($user, $contexts)
	getId ()
	getLastAuthorizationMessage ()
	getRoleAssignment ($roleId)
	getRoleAssignments ()
	getSiteRedirectContext ($request)
	getTargetContext ($request, &$contextsCount=null)
	initialize ($request)
	markRoleAssignmentsChecked ()
	requireSSL ()
	setApiToken ($apiToken)
	setDispatcher ($dispatcher)
	setEnforceRestrictedSite ($enforceRestrictedSite)
	setId ($id)
	setupTemplate ($request)
	validate ($requiredContexts=null, $request=null)

Protected Member Functions
	_createUrlTree ($doc, $loc, $lastmod=null, $changefreq=null, $priority=null)

Additional Inherited Members
Static Public Member Functions inherited from PKPHandler
static	getPageParamName ($rangeName)
static	getRangeInfo ($request, $rangeName, $contextData=null)
static	hashPageContext ($request, $contextData=array())
Data Fields inherited from PKPHandler
	$_authorizationDecisionManager
	$_checks = array()
	$_dispatcher
	$_enforceRestrictedSite = true
	$_id
	$_isBackendPage = false
	$_roleAssignments = array()
	$_roleAssignmentsChecked = false
Protected Attributes inherited from PKPHandler
	$_apiToken = null

Detailed Description

Produce a sitemap in XML format for submitting to search engines.

Definition at line 20 of file PKPSitemapHandler.inc.php.

Member Function Documentation

_createContextSitemap()

PKPSitemapHandler::_createContextSitemap

(

$request

)

Construct the sitemap

Parameters

$request

Request

Returns

DOMDocument

Reimplemented in SitemapHandler.

Definition at line 73 of file PKPSitemapHandler.inc.php.

References _createUrlTree(), Application\getContextAssocType(), and DAORegistry\getDAO().

Referenced by index().

_createSitemapIndex()

PKPSitemapHandler::_createSitemapIndex

(

$request

)

Construct a sitemap index listing each context's individual sitemap

Parameters

$request

Request

Returns

DOMDocument

Definition at line 49 of file PKPSitemapHandler.inc.php.

References Application\getContextDAO().

Referenced by index().

_createUrlTree()

PKPSitemapHandler::_createUrlTree (   $doc,   $loc,   $lastmod = null,   $changefreq = null,   $priority = null  )

protected

Create a url entry with children

Parameters

$doc	DOMDocument Reference to the XML document object
$loc	string URL of page (required)
$lastmod	string Last modification date of page (optional)
$changefreq	Frequency of page modifications (optional)
$priority	string Subjective priority assessment of page (optional)

Returns

DOMNode

Definition at line 135 of file PKPSitemapHandler.inc.php.

Referenced by SitemapHandler\_createContextSitemap(), and _createContextSitemap().

index()

PKPSitemapHandler::index	(		$args,
			$request
	)

Generate an XML sitemap for webcrawlers Creates a sitemap index if in site context, else creates a sitemap

Parameters

$args	array
$request	Request

Reimplemented from PKPHandler.

Definition at line 27 of file PKPSitemapHandler.inc.php.

References _createContextSitemap(), and _createSitemapIndex().

---

The documentation for this class was generated from the following file:

• PKPSitemapHandler.inc.php