[ Index ]

PHP Cross Reference of DokuWiki

title

Body

[close]

/inc/Sitemap/ -> Mapper.php (summary)

Sitemap handling functions

Author: Michael Hamann
License: GPL 2 (http://www.gnu.org/licenses/gpl.html)
File Size: 164 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Mapper:: (5 methods):
  generate()
  getXML()
  getFilePath()
  sitemapIsCompressed()
  pingSearchEngines()


Class: Mapper  - X-Ref

A class for building sitemaps and pinging search engines with the sitemap URL.

generate()   X-Ref
Builds a Google Sitemap of all public pages known to the indexer

The map is placed in the cache directory named sitemap.xml.gz - This
file needs to be writable!

link: https://www.google.com/webmasters/sitemaps/docs/en/about.html
link: http://www.sitemaps.org/
author: Michael Hamann
author: Andreas Gohr
return: bool

getXML($items)   X-Ref
Builds the sitemap XML string from the given array auf SitemapItems.

author: Michael Hamann
param: $items array The SitemapItems that shall be included in the sitemap.
return: string The sitemap XML.

getFilePath()   X-Ref
Helper function for getting the path to the sitemap file.

author: Michael Hamann
return: string The path to the sitemap file.

sitemapIsCompressed()   X-Ref
Helper function for checking if the sitemap is compressed

return: bool If the sitemap file is compressed

pingSearchEngines()   X-Ref
Pings search engines with the sitemap url. Plugins can add or remove
urls to ping using the SITEMAP_PING event.

author: Michael Hamann
return: bool