XmlEntryPoint
in package
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 handler.
- addUrlModule() : mixed
- add an url module.
- getDomElement() : DOMElement
- getMapModifier() : mixed
- getName() : mixed
- getType() : mixed
- hasUrlByDedicatedModule() : mixed
- hasUrlByHandler() : mixed
- hasUrlByInclude() : mixed
- hasUrlByModuleAction() : mixed
- hasUrlByModuleController() : mixed
- hasUrlByPathinfo() : mixed
- isDefault() : mixed
- removeUrlModule() : mixed
- setOptions() : mixed
- appendElement() : mixed
- getUrlByDedicatedModule() : null|DOMElement
- getUrlByHandler() : null|DOMElement
- getUrlByInclude() : null|DOMElement
- getUrlByModuleAction() : null|DOMElement
- getUrlByModuleController() : null|DOMElement
- getUrlByPathinfo() : null|DOMElement
- removeElement() : mixed
- setElementOptions() : mixed
- setUrlParametersStatics() : mixed
Properties
$ep
protected
DOMElement
$ep
$map
protected
XmlMapModifier
$map
Methods
__construct()
public
__construct(XmlMapModifier $map, DOMElement $ep) : mixed
Parameters
- $map : XmlMapModifier
- $ep : DOMElement
Return values
mixed —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)
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)
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
Return values
mixed —addUrlInclude()
add an url handler.
public
addUrlInclude(string $pathinfo, string $module, mixed $include[, 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
- $include : mixed
- $options : array<string|int, mixed> = null
-
options are : https => true/(false) noentrypoint => true/(false)
Return values
mixed —addUrlModule()
add an url module.
public
addUrlModule(string $pathinfo, string $module[, array<string|int, mixed> $options = null ]) : 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)
Return values
mixed —getDomElement()
public
getDomElement() : DOMElement
Return values
DOMElement —getMapModifier()
public
getMapModifier() : mixed
Return values
mixed —getName()
public
getName() : mixed
Return values
mixed —getType()
public
getType() : mixed
Return values
mixed —hasUrlByDedicatedModule()
public
hasUrlByDedicatedModule(mixed $module) : mixed
Parameters
- $module : mixed
Return values
mixed —hasUrlByHandler()
public
hasUrlByHandler(mixed $handler, mixed $module) : mixed
Parameters
- $handler : mixed
- $module : mixed
Return values
mixed —hasUrlByInclude()
public
hasUrlByInclude(mixed $include, mixed $module) : mixed
Parameters
- $include : mixed
- $module : mixed
Return values
mixed —hasUrlByModuleAction()
public
hasUrlByModuleAction(mixed $module, mixed $action) : mixed
Parameters
- $module : mixed
- $action : mixed
Return values
mixed —hasUrlByModuleController()
public
hasUrlByModuleController(mixed $module, mixed $controller) : mixed
Parameters
- $module : mixed
- $controller : mixed
Return values
mixed —hasUrlByPathinfo()
public
hasUrlByPathinfo(mixed $pathinfo) : mixed
Parameters
- $pathinfo : mixed
Return values
mixed —isDefault()
public
isDefault() : mixed
Return values
mixed —removeUrlModule()
public
removeUrlModule(mixed $module) : mixed
Parameters
- $module : mixed
Return values
mixed —setOptions()
public
setOptions(mixed $options) : mixed
Parameters
- $options : mixed
Return values
mixed —appendElement()
protected
appendElement(DOMElement $parent, DOMElement $child[, string $indent = ' ' ]) : mixed
Parameters
- $parent : DOMElement
- $child : DOMElement
- $indent : string = ' '
Return values
mixed —getUrlByDedicatedModule()
protected
getUrlByDedicatedModule(string $module) : null|DOMElement
Parameters
- $module : string
Return values
null|DOMElement —getUrlByHandler()
protected
getUrlByHandler(string $handler, string $module) : null|DOMElement
Parameters
- $handler : string
- $module : string
Return values
null|DOMElement —getUrlByInclude()
protected
getUrlByInclude(string $include, string $module) : null|DOMElement
Parameters
- $include : string
- $module : string
Return values
null|DOMElement —getUrlByModuleAction()
protected
getUrlByModuleAction(string $module, string $action) : null|DOMElement
Parameters
- $module : string
- $action : string
Return values
null|DOMElement —getUrlByModuleController()
protected
getUrlByModuleController(string $module, string $controller) : null|DOMElement
Parameters
- $module : string
- $controller : string
Return values
null|DOMElement —getUrlByPathinfo()
protected
getUrlByPathinfo(string $pathinfo) : null|DOMElement
Parameters
- $pathinfo : string
Return values
null|DOMElement —removeElement()
protected
removeElement(DOMElement $child) : mixed
Parameters
- $child : DOMElement
Return values
mixed —setElementOptions()
protected
setElementOptions(mixed $element, mixed $options, mixed $authorizedOptions) : mixed
Parameters
- $element : mixed
- $options : mixed
- $authorizedOptions : mixed
Return values
mixed —setUrlParametersStatics()
protected
setUrlParametersStatics(DOMElement $url[, mixed $parameters = null ][, mixed $statics = null ]) : mixed
Parameters
- $url : DOMElement
- $parameters : mixed = null
- $statics : mixed = null