XmlConfigHandler

XmlConfigHandler is the base config handler that deals with DOMDocuments

Synopsis

abstract class XmlConfigHandler extends BaseConfigHandler implements IXmlConfigHandler


Extends	`BaseConfigHandler`
Implements	`IXmlConfigHandler`
Since	`1.0.0`
Source	`Config/XmlConfigHandler.php`

Property	Type	Description
`$context`	`mixed`	protected.

Method	Description
`initialize(?Context $context = null, array<string, mixed> $parameters = []): void`	Initialize this ConfigHandler.

public function initialize(?Context $context = null, array<string, mixed> $parameters = []): void

Initialize this ConfigHandler.

An associative array of initialization parameters.

Parameter	Type	Description
`$context`	`?Context`	The context to work with (if available).
`$parameters`	array``<``string``, ``mixed``>	An associative array of initialization parameters.

Throws	When
`InitializationException`	If an error occurs while initializing the ConfigHandler

These come from an ancestor and are documented where they are declared.

Method	Declared in	Description
`appendParameter()`	`ParameterHolder`	Append a parameter.
`appendParameterByRef()`	`ParameterHolder`	Append a parameter by reference.
`clearParameters()`	`ParameterHolder`	Clear all parameters associated with this request.
`execute()`	`IXmlConfigHandler`	Execute this configuration handler.
`getFlatParameterNames()`	`ParameterHolder`	Retrieve an array of flattened parameter names.
`getParameter()`	`ParameterHolder`	Retrieve a parameter.
`getParameterNames()`	`ParameterHolder`	Retrieve an array of parameter names.
`getParameters()`	`ParameterHolder`	Retrieve an array of parameters.
`hasParameter()`	`ParameterHolder`	Indicates whether or not a parameter exists.
`literalize()`	`BaseConfigHandler`	Literalize a string value.
`removeParameter()`	`ParameterHolder`	Remove a parameter.
`replaceConstants()`	`BaseConfigHandler`	Replace configuration directive identifiers in a string.
`replacePath()`	`BaseConfigHandler`	Replace a relative filesystem path with an absolute one.
`reset()`	`ParameterHolder`	Removes every parameter held, leaving the holder empty for reuse.
`setParameter()`	`ParameterHolder`	Set a parameter.
`setParameterByRef()`	`ParameterHolder`	Set a parameter by reference.
`setParameters()`	`ParameterHolder`	Set an array of parameters.
`setParametersByRef()`	`ParameterHolder`	Set an array of parameters by reference.