Jelix 1.8.9

XmlEntryPoint
in package

Tags

Table of Contents

$ep  : DOMElement
$map  : XmlMapModifier
__construct()  : mixed
addUrlAction()  : mixed
add an url action.
addUrlController()  : mixed
add an url controller.
addUrlHandler()  : mixed
add an url handler.
addUrlInclude()  : mixed
add an url include.
addUrlModule()  : mixed
add an url module.
getDomElement()  : DOMElement
getMapModifier()  : mixed
getName()  : mixed
getType()  : mixed
hasUrlByDedicatedModule()  : mixed
hasUrlByHandler()  : bool
hasUrlByInclude()  : mixed
hasUrlByModuleAction()  : mixed
hasUrlByModuleController()  : mixed
hasUrlByPathinfo()  : mixed
isDefault()  : mixed
removeAllUrlsOfModule()  : void
Remove all url targeting a module
removeUrlAction()  : mixed
remove an url action.
removeUrlController()  : mixed
remove an url controller.
removeUrlHandler()  : mixed
remove an url handler.
removeUrlInclude()  : mixed
remove an url include.
removeUrlModule()  : void
Remove an url dedicated to a module
setOptions()  : mixed
appendElement()  : mixed
getUniquePathInfo()  : string
search an unused path info
getUrlByDedicatedModule()  : null|DOMElement
getUrlByHandler()  : null|DOMElement
getUrlByInclude()  : null|DOMElement
getUrlByModuleAction()  : null|DOMElement
getUrlByModuleController()  : null|DOMElement
getUrlByPathinfo()  : null|DOMElement
isUrlByDedicatedModule()  : mixed
removeElement()  : mixed
setElementOptions()  : mixed
setUrlParametersStatics()  : mixed

Properties

Methods

addUrlAction()

add an url action.

public addUrlAction(string $pathinfo, string $module, string $action[, array<string|int, mixed> $parameters = null ][, array<string|int, mixed> $statics = null ][, array<string|int, mixed> $options = null ]) : mixed

It if already exists, and if $parameters or $statics or $options are not null, existing parameters, statics or options will be changed.

Parameters
$pathinfo : string
$module : string
$action : string
$parameters : array<string|int, mixed> = null

key is name, value is array('type'=>'', 'regexp'=>'', 'escape'=>true/false)

$statics : array<string|int, mixed> = null

key is name, value is array('type'=>'', 'value'=>'')

$options : array<string|int, mixed> = null

options are : default => true/(false) https => true/(false) noentrypoint => true/(false) actionoverride => list of method name optionalTrailingSlash => true/(false)

Tags
Return values
mixed

addUrlController()

add an url controller.

public addUrlController(string $pathinfo, string $module, string $controller[, array<string|int, mixed> $options = null ]) : mixed

the url matches any methods of a controller

It if already exists, and if $options is not null, existing options will be changed.

Parameters
$pathinfo : string
$module : string
$controller : string
$options : array<string|int, mixed> = null

options are : default => true/(false) https => true/(false) noentrypoint => true/(false)

Tags
Return values
mixed

addUrlHandler()

add an url handler.

public addUrlHandler(string $pathinfo, string $module, string $handler[, string $action = '' ][, array<string|int, mixed> $options = null ]) : mixed

It if already exists, and if $options is not null, existing options will be changed.

Parameters
$pathinfo : string
$module : string
$handler : string
$action : string = ''
$options : array<string|int, mixed> = null

options are : default => true/(false) https => true/(false) noentrypoint => true/(false) actionoverride => list of method name

Tags
Return values
mixed

addUrlInclude()

add an url include.

public addUrlInclude(string $pathinfo, string $module, string $include[, array<string|int, mixed> $options = null ][, mixed $doReplace = true ]) : mixed

It if already exists, and if $options is not null, existing options will be changed.

Parameters
$pathinfo : string
$module : string
$include : string
$options : array<string|int, mixed> = null

options are : https => true/(false) noentrypoint => true/(false)

$doReplace : mixed = true
Tags
Return values
mixed

addUrlModule()

add an url module.

public addUrlModule(string $pathinfo, string $module[, array<string|int, mixed> $options = null ][, mixed $doReplace = true ]) : mixed

the entrypoint is dedicated to this module and url are automatic

It if already exists, and if $options is not null, existing options will be changed.

Parameters
$pathinfo : string
$module : string
$options : array<string|int, mixed> = null

options are : default => true/(false) https => true/(false) noentrypoint => true/(false)

$doReplace : mixed = true
Tags
Return values
mixed

getDomElement()

public getDomElement() : DOMElement
Tags
Return values
DOMElement

getMapModifier()

public getMapModifier() : mixed
Tags
Return values
mixed

getName()

public getName() : mixed
Tags
Return values
mixed

getType()

public getType() : mixed
Tags
Return values
mixed

hasUrlByDedicatedModule()

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

hasUrlByHandler()

public hasUrlByHandler(mixed $handler, string $module[, string $action = '' ]) : bool
Parameters
$handler : mixed
$module : string
$action : string = ''
Tags
Return values
bool

hasUrlByInclude()

public hasUrlByInclude(mixed $include, mixed $module) : mixed
Parameters
$include : mixed
$module : mixed
Tags
Return values
mixed

hasUrlByModuleAction()

public hasUrlByModuleAction(mixed $module, mixed $action) : mixed
Parameters
$module : mixed
$action : mixed
Tags
Return values
mixed

hasUrlByModuleController()

public hasUrlByModuleController(mixed $module, mixed $controller) : mixed
Parameters
$module : mixed
$controller : mixed
Tags
Return values
mixed

hasUrlByPathinfo()

public hasUrlByPathinfo(mixed $pathinfo) : mixed
Parameters
$pathinfo : mixed
Tags
Return values
mixed

isDefault()

public isDefault() : mixed
Tags
Return values
mixed

removeAllUrlsOfModule()

Remove all url targeting a module

public removeAllUrlsOfModule(string $module) : void
Parameters
$module : string
Tags
Return values
void

removeUrlAction()

remove an url action.

public removeUrlAction(string $module, string $action) : mixed
Parameters
$module : string
$action : string
Tags
Return values
mixed

removeUrlController()

remove an url controller.

public removeUrlController(string $module, string $controller) : mixed
Parameters
$module : string
$controller : string
Tags
Return values
mixed

removeUrlHandler()

remove an url handler.

public removeUrlHandler(string $module, string $handler[, string $action = '' ]) : mixed
Parameters
$module : string
$handler : string
$action : string = ''
Tags
Return values
mixed

removeUrlInclude()

remove an url include.

public removeUrlInclude(string $module, mixed $include) : mixed
Parameters
$module : string
$include : mixed
Tags
Return values
mixed

removeUrlModule()

Remove an url dedicated to a module

public removeUrlModule(string $module) : void
Parameters
$module : string
Tags
Return values
void

setOptions()

public setOptions(mixed $options) : mixed
Parameters
$options : mixed
Tags
Return values
mixed

appendElement()

protected appendElement(DOMElement $parent, DOMElement $child[, string $indent = ' ' ]) : mixed
Parameters
$parent : DOMElement
$child : DOMElement
$indent : string = ' '
Tags
Return values
mixed

getUniquePathInfo()

search an unused path info

protected getUniquePathInfo(string $pathInfo) : string
Parameters
$pathInfo : string

the original path info

Tags
Return values
string

the unique path info

getUrlByDedicatedModule()

protected getUrlByDedicatedModule(string $module) : null|DOMElement
Parameters
$module : string
Tags
Return values
null|DOMElement

getUrlByHandler()

protected getUrlByHandler(string $handler, string $module[, string $action = '' ]) : null|DOMElement
Parameters
$handler : string
$module : string
$action : string = ''
Tags
Return values
null|DOMElement

getUrlByInclude()

protected getUrlByInclude(string $include, string $module) : null|DOMElement
Parameters
$include : string
$module : string
Tags
Return values
null|DOMElement

getUrlByModuleAction()

protected getUrlByModuleAction(string $module, string $action) : null|DOMElement
Parameters
$module : string
$action : string
Tags
Return values
null|DOMElement

getUrlByModuleController()

protected getUrlByModuleController(string $module, string $controller) : null|DOMElement
Parameters
$module : string
$controller : string
Tags
Return values
null|DOMElement

getUrlByPathinfo()

protected getUrlByPathinfo(string $pathinfo) : null|DOMElement
Parameters
$pathinfo : string
Tags
Return values
null|DOMElement

isUrlByDedicatedModule()

protected isUrlByDedicatedModule(mixed $url) : mixed
Parameters
$url : mixed
Tags
Return values
mixed

removeElement()

protected removeElement(DOMElement $child) : mixed
Parameters
$child : DOMElement
Tags
Return values
mixed

setElementOptions()

protected setElementOptions(mixed $element, mixed $options, mixed $authorizedOptions) : mixed
Parameters
$element : mixed
$options : mixed
$authorizedOptions : mixed
Tags
Return values
mixed

setUrlParametersStatics()

protected setUrlParametersStatics(DOMElement $url[, mixed $parameters = null ][, mixed $statics = null ]) : mixed
Parameters
$url : DOMElement
$parameters : mixed = null
$statics : mixed = null
Tags
Return values
mixed

Search results