Jelix 1.8.9

XmlMapModifier
in package

allow to modify the urls.xml file.

Tags

Table of Contents

$currentEntryPoint  : XmlEntryPoint
$document  : DOMDocument
$file  : string
$modified  : bool
__construct()  : mixed
addEntryPoint()  : XmlEntryPoint
getDefaultEntryPoint()  : XmlEntryPoint
getEntryPoint()  : XmlEntryPoint
getEntryPointsOfType()  : array<string|int, XmlEntryPoint>
Return the list of entrypoints having the given type
removeAllUrlOfModule()  : mixed
removeEntryPoint()  : mixed
removeUrlModuleInOtherEntryPoint()  : mixed
save()  : mixed
setAsModified()  : mixed
setCurrentEntryPoint()  : mixed
setNewDefaultEntryPoint()  : mixed
getXMLEntryPointsOfType()  : array<string|int, DomElement>

Properties

$document

protected DOMDocument $document

the DOM document representing the file

Tags

$modified

protected bool $modified = false

indicate if the content is modified, to save or not the file.

Tags

Methods

__construct()

public __construct(string $file[, bool $createIfNotExists = false ]) : mixed
Parameters
$file : string
$createIfNotExists : bool = false
Tags
throws
Exception
Return values
mixed

addEntryPoint()

public addEntryPoint(string $name[, string $type = 'classic' ][, array<string|int, mixed> $options = array() ]) : XmlEntryPoint
Parameters
$name : string
$type : string = 'classic'
$options : array<string|int, mixed> = array()

options are default=true/(false) https=true/(false) noentrypoint=true/(false) optionalTrailingSlash=true/(false)

Tags
Return values
XmlEntryPoint

getEntryPointsOfType()

Return the list of entrypoints having the given type

public getEntryPointsOfType([string $type = 'classic' ]) : array<string|int, XmlEntryPoint>
Parameters
$type : string = 'classic'
Tags
Return values
array<string|int, XmlEntryPoint>

removeAllUrlOfModule()

public removeAllUrlOfModule(mixed $module) : mixed
Parameters
$module : mixed
Tags
Return values
mixed

removeEntryPoint()

public removeEntryPoint(string $name) : mixed
Parameters
$name : string
Tags
since
1.7.11
Return values
mixed

removeUrlModuleInOtherEntryPoint()

public removeUrlModuleInOtherEntryPoint(mixed $module, XmlEntryPoint $except) : mixed
Parameters
$module : mixed
$except : XmlEntryPoint
Tags
Return values
mixed

setAsModified()

public setAsModified() : mixed
Tags
Return values
mixed

setCurrentEntryPoint()

public setCurrentEntryPoint(mixed $name[, mixed $type = 'classic' ]) : mixed
Parameters
$name : mixed
$type : mixed = 'classic'
Tags
Return values
mixed

setNewDefaultEntryPoint()

public setNewDefaultEntryPoint(mixed $name, mixed $type) : mixed
Parameters
$name : mixed
$type : mixed
Tags
Return values
mixed

getXMLEntryPointsOfType()

protected getXMLEntryPointsOfType([string $type = 'classic' ]) : array<string|int, DomElement>
Parameters
$type : string = 'classic'
Tags
Return values
array<string|int, DomElement>

Search results