Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
SitemapHandler Class Reference
Inheritance diagram for SitemapHandler:
Handler PKPHandler

Public Member Functions

 _createJournalSitemap ()
 
 _createSitemapIndex ()
 
 _createUrlTree (&$doc, $loc, $lastmod=null, $changefreq=null, $priority=null)
 
 index ()
 
- Public Member Functions inherited from PKPHandler
 addCheck (&$handlerValidator)
 
 addPolicy (&$authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 authorize (&$request, &$args, $roleAssignments)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getLoginExemptions ()
 
getRangeInfo ($rangeName, $contextData=null)
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 hashPageContext ($contextData=array())
 
 index ()
 
 initialize (&$request, $args=null)
 
 PKPHandler ()
 
 setDispatcher (&$dispatcher)
 
 setId ($id)
 
 validate ($requiredContexts=null, $request=null)
 

Detailed Description

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

Definition at line 21 of file SitemapHandler.inc.php.

Member Function Documentation

SitemapHandler::_createJournalSitemap ( )

Construct the sitemap

Returns
XMLNode

Definition at line 70 of file SitemapHandler.inc.php.

References _createUrlTree(), XMLCustomWriter\createDocument(), DAORegistry\getDAO(), Request\getJournal(), and Request\url().

Referenced by index().

SitemapHandler::_createSitemapIndex ( )

Construct a sitemap index listing each journal's individual sitemap

Returns
XMLNode

Definition at line 46 of file SitemapHandler.inc.php.

References XMLCustomWriter\createDocument(), DAORegistry\getDAO(), and Request\url().

Referenced by index().

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

Create a url entry with children

Parameters
$docXMLNode Reference to the XML document object
$locstring URL of page (required)
$lastmodstring Last modification date of page (optional)
$changefreqFrequency of page modifications (optional)
$prioritystring Subjective priority assesment of page (optional)
Returns
XMLNode

Definition at line 128 of file SitemapHandler.inc.php.

Referenced by _createJournalSitemap().

SitemapHandler::index ( )

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

Definition at line 26 of file SitemapHandler.inc.php.

References _createJournalSitemap(), _createSitemapIndex(), and Request\getRequestedJournalPath().


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