Docs For Class jResponseSitemap

Description

Sitemap 0.9 response

link: http://www.sitemaps.org/
since: 1.2

Located in /core/response/jResponseSitemap.class.php (line 25)

jResponse
   |
   --jResponseSitemap

Variable Summary

array $allowedChangefreq

jTpl $content

string $contentTpl

int $maxSitemap

int $maxUrl

array() $urlList

array() $urlSitemap

string $_type

Method Summary

void __construct ()

boolean addSitemap (string $loc, [string $lastmod = null])

boolean addUrl (string $loc, [string $lastmod = null], [string $changefreq = null], [string $priority = null])

string getFormatedErrorMsg ()

array getUrlsFromUrlsXml ()

void importFromUrlsXml ()

boolean output ()

void outputErrors ()

boolean ping ( $uri)

array _parseUrlsXml ()

Variables

array $allowedChangefreq = array('always', 'hourly', 'daily', 'weekly',
'monthly', 'yearly', 'never') (line 37)

Frequency change url

access: protected

jTpl $content (line 67)

The template container

access: public

string $contentTpl (line 73)

Selector of the template file

access: public

int $maxSitemap = 1000 (line 43)

Maximum number of URLs for a sitemap index file

access: protected

int $maxUrl = 50000 (line 49)

Maximum number of URLs for a sitemap file

access: protected

array() $urlList = array() (line 61)

List of URLs for a sitemap file

access: protected

array() $urlSitemap = array() (line 55)

List of URLs for a sitemap index file

access: protected

string $_type = 'sitemap' (line 31)

Ident of the response type

access: protected

Redefinition of:

jResponse::$_type

Inherited Variables

Inherited from jResponse

jResponse::$_acceptSeveralErrors
jResponse::$_httpHeaders
jResponse::$_httpHeadersSent
jResponse::$_httpStatusCode
jResponse::$_httpStatusMsg

Methods

Constructor __construct (line 80)

Class constructor

access: public

void __construct ()

Redefinition of:

jResponse::__construct(): constructor

addSitemap (line 194)

add a URL in a sitemap file

return: true if addition is ok, else false
access: public

boolean addSitemap (string $loc, [string $lastmod = null])

string $loc: URL of sitemap file
string $lastmod: The date of last modification of the sitemap file

addUrl (line 163)

add a URL in a sitemap file

return: true if addition is ok, else false
access: public

boolean addUrl (string $loc, [string $lastmod = null], [string $changefreq = null], [string $priority = null])

string $loc: URL of the page
string $lastmod: The date of last modification of the file
string $changefreq: How frequently the page is likely to change
string $priority: The priority of this URL relative to other URLs

getFormatedErrorMsg (line 147)

Format error messages

return: formated errors
access: protected

string getFormatedErrorMsg ()

getUrlsFromUrlsXml (line 227)

Return pathinfo URLs automatically from urls.xml

access: public

array getUrlsFromUrlsXml ()

importFromUrlsXml (line 216)

Add URLs automatically from urls.xml

access: public

void importFromUrlsXml ()

output (line 91)

Generate the content and send it

Errors are managed

return: true if generation is ok, else false
access: public

boolean output ()

Redefinition of:

jResponse::output(): Send the response in the correct format.

outputErrors (line 125)

output errors

access: public

void outputErrors ()

Redefinition of:

jResponse::outputErrors(): Send a response with only error messages which appears during the action

ping (line 235)

Submitting a sitemap by sending an HTTP request

access: public

boolean ping ( $uri)

$uri

_parseUrlsXml (line 252)

Parse urls.xml and return pathinfo URLs

access: protected

array _parseUrlsXml ()

Inherited Methods

Inherited From jResponse

jResponse::__construct()
jResponse::acceptSeveralErrors()
jResponse::addHttpHeader()
jResponse::clearHttpHeaders()
jResponse::getFormatType()
jResponse::getType()
jResponse::hasErrors()
jResponse::output()
jResponse::outputErrors()
jResponse::sendHttpHeaders()
jResponse::setHttpStatus()