IXmlConfigHandler
IXmlConfigHandler is the interface that config handlers may implement to indicate that they wish to process a DOMDocument directly.
Synopsis
Section titled “Synopsis”interface IXmlConfigHandler
| Implemented by | XmlConfigHandler |
| Since | 1.0.0 |
| Source | Config/IXmlConfigHandler.php |
Methods
Section titled “Methods”| Method | Description |
|---|---|
execute(XmlConfigDomDocument $document): mixed | Execute this configuration handler. |
initialize(?Context $context = null, array<string, mixed> $parameters = []): void | Initialize this ConfigHandler. |
execute()
Section titled “execute()”abstract public function execute(XmlConfigDomDocument $document): mixed
Execute this configuration handler.
The document to parse.
| Parameter | Type | Description |
|---|---|---|
$document | XmlConfigDomDocument | The document to parse. |
Returns mixed — The declaration to be cached.
| Throws | When |
|---|---|
ParseException | If a requested configuration file is improperly formatted. |
initialize()
Section titled “initialize()”abstract 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 |