CachingConfigHandler

CachingConfigHandler compiles the per-action configuration files placed in the “cache” subfolder of a module directory.

Canonical schema: request method (or ’*’) => [‘lifetime’ => …, ‘groups’ => […], ‘views’ => …, ‘action_attributes’ => […], ‘output_types’ => […]].

Synopsis

class CachingConfigHandler extends XmlConfigHandler implements IArrayConfigHandler, IPositionAwareConfigHandler, ISchemaAwareConfigHandler


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

Constants

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

Methods

Method	Description
`execute(XmlConfigDomDocument $document): mixed`	Execute this configuration handler.
`executeArray(array<string, mixed> $config, ?string $sourceRef = null): mixed`	The declaration is the canonical map itself: the caching entries keyed by request method (or ’*’), for a caller to pick the matching one from.
`schema(): Rule`	“layers” is a polymorphic per-layer-name map (true, or a list of slot names) not modeled key-by-key here — structural parity stops at the known, fixed keys of a caching entry and an output-type entry; the dynamic method/output-type/layer-name keys themselves are, correctly, unconstrained (Dict), same as SettingConfigHandler’s open shape.
`toCanonicalArray(XmlConfigDomDocument $document): array<string, array<string, mixed>>`
`toCanonicalArrayWithPositions(XmlConfigDomDocument $document, ElementPositionIndex $positions): array{data: array<string, array<string, mixed>>, positions: array<string, array{file: string, line: int}>}`	Positions are only tracked for each caching entry’s own “lifetime” key, at the element’s line — a reasonable top-level anchor without mirroring the full recursive output_types/layers/slots walk above, which polymorphic “layers” values (true\|list) don’t cleanly reduce to a single leaf position anyway.

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 $sourceRef = null): mixed

The declaration is the canonical map itself: the caching entries keyed by request method (or ’*’), for a caller to pick the matching one from.

Parameter	Type	Description
`$config`	array``<``string``, ``mixed``>
`$sourceRef`	?``string

Returns mixed

schema()

public function schema(): Rule

“layers” is a polymorphic per-layer-name map (true, or a list of slot names) not modeled key-by-key here — structural parity stops at the known, fixed keys of a caching entry and an output-type entry; the dynamic method/output-type/layer-name keys themselves are, correctly, unconstrained (Dict), same as SettingConfigHandler’s open shape.

Returns Rule

toCanonicalArray()

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

Parameter	Type	Description
`$document`	`XmlConfigDomDocument`

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

toCanonicalArrayWithPositions()

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

Positions are only tracked for each caching entry’s own “lifetime” key, at the element’s line — a reasonable top-level anchor without mirroring the full recursive output_types/layers/slots walk above, which polymorphic “layers” values (true|list) don’t cleanly reduce to a single leaf position anyway.

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

Returns array{data: array<string, 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.