Class jResponseSitemap

Description

Sitemap 0.9 response

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

jResponse
   |
   --jResponseSitemap
Variable Summary
Method Summary
void __construct ()
boolean addSitemap (string $loc, [string $lastmod = null])
boolean addUrl (string $loc, [string $lastmod = null], [string $changefreq = null], [string $priority = null])
boolean output ()
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::$forcedHttpVersion
jResponse::$httpVersion
jResponse::$_httpHeaders
jResponse::$_httpHeadersSent
jResponse::$_httpStatusCode
jResponse::$_httpStatusMsg
jResponse::$_outputOnlyHeaders
Methods
Constructor __construct (line 80)

Class constructor

  • access: public
void __construct ()

Redefinition of:
jResponse::__construct()
constructor
addSitemap (line 158)

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 127)

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
getUrlsFromUrlsXml (line 190)

Return pathinfo URLs automatically from urls.xml

  • access: public
array getUrlsFromUrlsXml ()
importFromUrlsXml (line 179)

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. If errors or exceptions appears during this method, outputErrors will be called. So the the content should be generated using the output buffer if errors can be appeared during this generation. Be care of http headers.
ping (line 198)

Submitting a sitemap by sending an HTTP request

  • access: public
boolean ping ( $uri)
  • $uri
_parseUrlsXml (line 215)

Parse urls.xml and return pathinfo URLs

  • access: protected
array _parseUrlsXml ()

Inherited Methods

Inherited From jResponse

jResponse::__construct()
jResponse::addHttpHeader()
jResponse::cleanCacheHeaders()
jResponse::clearHttpHeaders()
jResponse::getFormatType()
jResponse::getType()
jResponse::isValidCache()
jResponse::output()
jResponse::outputErrors()
jResponse::sendHttpHeaders()
jResponse::setExpires()
jResponse::setHttpStatus()
jResponse::setLifetime()
jResponse::_checkRequestType()
jResponse::_normalizeDate()

Documentation generated on Mon, 26 Oct 2015 21:55:46 +0100 by phpDocumentor 1.4.3