1. class
  2. Concrete
  3. \
  4. Job
  5. \
  6. GenerateSitemap

GenerateSitemap

class GenerateSitemap extends Job (View source)

Constants

EOL

The end-of-line terminator.

Methods

string
getJobName()

Returns the job name.

string
getJobDescription()

Returns the job description.

string
run()

Executes the job.

static 
addPage(SimpleXMLElement $xmlDoc, int $cID, array $instances)

Check if the specified page should be included in the sitemap.xml file; if so adds it to the XML document.

static 
canIncludePageInSitemap($page, $instances)

No description

Details

at line 29
string getJobName()

Returns the job name.

Return Value

string

at line 37
string getJobDescription()

Returns the job description.

Return Value

string

at line 47
string run()

Executes the job.

Return Value

string

Returns a string describing the job result in case of success.

Exceptions

Exception

Throws an exception in case of errors.

at line 129
static private addPage(SimpleXMLElement $xmlDoc, int $cID, array $instances)

Check if the specified page should be included in the sitemap.xml file; if so adds it to the XML document.

Parameters

SimpleXMLElement $xmlDoc

The xml document containing the sitemap nodes.
int $cID

The page collection id.
array $instances

An array with some already instantiated helpers, models, ...

Exceptions

Exception

Throws an exception in case of errors.

at line 185
static protected canIncludePageInSitemap($page, $instances)

No description

Parameters

$page
$instances