API Documentation

SitemapGenerator extends BaseXmlGenerator
in package
uses TracksExecutionTime

Defines the public API for XML generators and provides a shared codebase for common helpers.

Tags
see
https://www.sitemaps.org/protocol.html

Table of Contents

Properties

$timeStart  : float
$xmlElement  : SimpleXMLElement

Methods

__construct()  : mixed
Create a new XML generator instance.
generate()  : $this
Generate the XML document.
getXml()  : string
Get the XML document as a string.
getXmlElement()  : SimpleXMLElement
Get the XML document as a SimpleXMLElement object.
make()  : string
Generate a new XML document and get the contents as a string.
addChild()  : SimpleXMLElement
addRoute()  : void
constructBaseElement()  : void
escape()  : string
getExecutionTimeInMs()  : int|float
getExecutionTimeString()  : string
getFormattedProcessingTime()  : numeric-string
getLastModDate()  : string
getPriority()  : string
resolveRouteLink()  : string
startClock()  : void
stopClock()  : float

Properties

Methods

__construct()

Create a new XML generator instance.

public __construct() : mixed

generate()

Generate the XML document.

public generate() : $this
Return values
$this

getXml()

Get the XML document as a string.

public getXml() : string
Return values
string

getXmlElement()

Get the XML document as a SimpleXMLElement object.

public getXmlElement() : SimpleXMLElement
Return values
SimpleXMLElement

make()

Generate a new XML document and get the contents as a string.

public static make() : string
Return values
string

addChild()

protected addChild(SimpleXMLElement $element, string $name, string $value) : SimpleXMLElement
Parameters
$element : SimpleXMLElement
$name : string
$value : string
Return values
SimpleXMLElement

escape()

protected escape(string $string) : string
Parameters
$string : string
Return values
string

getExecutionTimeInMs()

protected getExecutionTimeInMs() : int|float
Return values
int|float

getExecutionTimeString()

protected getExecutionTimeString() : string
Return values
string

getFormattedProcessingTime()

protected getFormattedProcessingTime() : numeric-string
Return values
numeric-string

getLastModDate()

protected getLastModDate(string $file) : string
Parameters
$file : string
Return values
string

getPriority()

protected getPriority(string $pageClass, string $slug) : string
Parameters
$pageClass : string
$slug : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results