ConfigHandlersConfigHandler

ConfigHandlersConfigHandler allows you to specify configuration handlers for the application or on a module level.

Migrated to IArrayConfigHandler. Canonical schema is exactly the $handlers map execute() used to build inline: [‘pattern’ => [‘class’ => …, ‘parameters’ => […], ‘transformations’ => […], ‘validations’ => […]]] Note this handler is what config_handlers.xml itself compiles through — it is NOT what the extension-agnostic handler discovery reads (that would be circular); it stays the framework’s own bootstrap-time handler registry regardless of what format future handler configs adopt.

Middleware enable/disable used to be configured inline here via a reserved <middleware_config> block (compiled to a __middleware_config array key); that’s superseded by middleware.xml’s <use enabled="..."> (see MiddlewareConfigHandler), which also covers registration and ordering in the same place.

Synopsis

class ConfigHandlersConfigHandler extends XmlConfigHandler implements IArrayConfigHandler, IPositionAwareConfigHandler, ISchemaAwareConfigHandler


Extends	`XmlConfigHandler`
Implements	`IArrayConfigHandler`, `IPositionAwareConfigHandler`, `ISchemaAwareConfigHandler`
Since	`1.0.0`
Source	`Config/ConfigHandlersConfigHandler.php`

Constants

Constant	Value	Description
`XML_NAMESPACE`	`'http://quiote.dev/quiote/config/parts/config_handlers/1.1'`

Methods

Method	Description
`execute(XmlConfigDomDocument $document): mixed`	Execute this configuration handler.
[`executeArray(array<string, mixed> $config, string	null $sourceRef = null): mixed`](#executearray)
`schema(): Rule`	“transformations”/“validations” are fixed-shape but deeply nested (stage -> step -> validation-type -> file list) internal bootstrap data, not something an app author hand-edits key-by-key — validated only as “present”, not modeled key-by-key here.
`toCanonicalArray(XmlConfigDomDocument $document): array<string, mixed>`
`toCanonicalArrayWithPositions(XmlConfigDomDocument $document, ElementPositionIndex $positions): array{data: array<string, mixed>, positions: array<string, array{file: string, line: int}>}`

execute()

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
`UnreadableException`	If a requested configuration file does not exist or is not readable.
`ParseException`	If a requested configuration file is improperly formatted.

executeArray()

public function executeArray(array<string, mixed> $config, string|null $sourceRef = null): mixed

Origin reference for the compiled cache file’s header comment (a file path for any format; XML’s is $document->documentURI).

Parameter	Type	Description
`$config`	array``<``string``, ``mixed``>	The canonical config array, matching the shape returned by toCanonicalArray().
`$sourceRef`	`string“	“null`

Returns mixed — The declaration to be cached, exactly as IXmlConfigHandler::execute() returns.

schema()

public function schema(): Rule

“transformations”/“validations” are fixed-shape but deeply nested (stage -> step -> validation-type -> file list) internal bootstrap data, not something an app author hand-edits key-by-key — validated only as “present”, not modeled key-by-key here.

Returns Rule

toCanonicalArray()

public function toCanonicalArray(XmlConfigDomDocument $document): array<string, mixed>

Parameter	Type	Description
`$document`	`XmlConfigDomDocument`

Returns array``<``string``, ``mixed``>

toCanonicalArrayWithPositions()

public function toCanonicalArrayWithPositions(XmlConfigDomDocument $document, ElementPositionIndex $positions): array{data: array<string, mixed>, positions: array<string, array{file: string, line: int}>}

Parameter	Type	Description
`$document`	`XmlConfigDomDocument`
`$positions`	`ElementPositionIndex`

Returns array{data: array<string, mixed>, positions: array<string, array{file: string, line: int}>}

Inherited methods

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.
`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.
`initialize()`	`XmlConfigHandler`	Initialize this ConfigHandler.
`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.