Documentation

Domain
in package

FinalYes
Tags
author

Daniel Schulz

Table of Contents

Constants

ATTR_CURRENT_PAGE  = 'current'
ATTR_NAME  = 'name'
ATTR_REDIRECT  = 'redirect'
ATTR_REFERENCE  = 'ref'
ATTR_URI  = 'uri'
CURRENT_SITEMAP  = 'farah://slothsoft@farah/current-sitemap'
TAG_DOMAIN  = 'domain'
TAG_FILE  = 'file'
TAG_INCLUDE_PAGES  = 'include-pages'
TAG_PAGE  = 'page'
TAG_SITEMAP  = 'sitemap'

Methods

__construct()  : mixed
clearCurrentPageNode()  : void
createWithDefaultSitemap()  : Domain
getCurrentPageNode()  : DOMElement|null
getDocument()  : DOMDocument
getDomainNode()  : DOMElement
getXPath()  : DOMXPath
lookupAssetUrl()  : FarahUrl
lookupPageNode()  : DOMElement
setCurrentPageNode()  : void

Constants

ATTR_CURRENT_PAGE

public mixed ATTR_CURRENT_PAGE = 'current'

ATTR_NAME

public mixed ATTR_NAME = 'name'

ATTR_REDIRECT

public mixed ATTR_REDIRECT = 'redirect'

ATTR_REFERENCE

public mixed ATTR_REFERENCE = 'ref'

ATTR_URI

public mixed ATTR_URI = 'uri'

CURRENT_SITEMAP

public mixed CURRENT_SITEMAP = 'farah://slothsoft@farah/current-sitemap'

TAG_DOMAIN

public mixed TAG_DOMAIN = 'domain'

TAG_FILE

public mixed TAG_FILE = 'file'

TAG_INCLUDE_PAGES

public mixed TAG_INCLUDE_PAGES = 'include-pages'

TAG_PAGE

public mixed TAG_PAGE = 'page'

TAG_SITEMAP

public mixed TAG_SITEMAP = 'sitemap'

Methods

__construct()

public __construct(DOMDocument $document) : mixed
Parameters
$document : DOMDocument

clearCurrentPageNode()

public clearCurrentPageNode() : void

createWithDefaultSitemap()

public static createWithDefaultSitemap() : Domain
Return values
Domain

getCurrentPageNode()

public getCurrentPageNode() : DOMElement|null
Return values
DOMElement|null

getDocument()

public getDocument() : DOMDocument
Return values
DOMDocument

getDomainNode()

public getDomainNode() : DOMElement
Return values
DOMElement

getXPath()

public getXPath() : DOMXPath
Return values
DOMXPath

lookupAssetUrl()

public lookupAssetUrl(DOMElement $dataNode[, array<string|int, mixed> $args = [] ]) : FarahUrl
Parameters
$dataNode : DOMElement
$args : array<string|int, mixed> = []
Return values
FarahUrl

lookupPageNode()

public lookupPageNode(string $path[, DOMElement $contextNode = null ]) : DOMElement
Parameters
$path : string
$contextNode : DOMElement = null
Return values
DOMElement

setCurrentPageNode()

public setCurrentPageNode(DOMElement $pageNode) : void
Parameters
$pageNode : DOMElement

        
On this page

Search results