DatabaseConfigHandler

DatabaseConfigHandler allows you to setup database connections in a configuration file that will be created for you automatically upon first request.

Migrated to IArrayConfigHandler (phase 2). Canonical schema: [‘default’ => ‘connection_name’|null, ‘databases’ => [‘connection_name’ => [‘class’ => ‘Some\Class’, ‘parameters’ => […]]]] The “a default must be declared by the time a block is * seen” check is inherently about the order configuration blocks are processed in, not just the final data shape, so it still runs during toCanonicalArray()‘s walk (throwing ParseException exactly as before); the “no databases at all” / “undefined default” checks only depend on the final canonical array and have moved to executeArray().

Synopsis

class DatabaseConfigHandler extends XmlConfigHandler implements IArrayConfigHandler, IPositionAwareConfigHandler, ISchemaAwareConfigHandler


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

Constants

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

Methods

Method	Description
`execute(XmlConfigDomDocument $document): mixed`	Execute this configuration handler.
[`executeArray(array{default?: (string	null), databases?: array<string, array{class: string, parameters: array<(int
`schema(): Rule`	“default must exist as a key in databases” and “databases must be * non-empty” stay in executeArray() — cross-field/non-empty checks, not structural shape.
[`toCanonicalArray(XmlConfigDomDocument $document): array{default: (string	null), databases: array<string, array{class: string, parameters: array<(int
[`toCanonicalArrayWithPositions(XmlConfigDomDocument $document, ElementPositionIndex $positions): array{data: array{default: (string	null), databases: array<string, array{class: string, parameters: array<(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
`ParseException`	If a requested configuration file is improperly formatted.

executeArray()

public function executeArray(array{default?: (string | null), databases?: array<string, array{class: string, parameters: array<(int | 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{default?: (string	null), databases?: array<string, array{class: string, parameters: array<(int
`$sourceRef`	`string“	“null`

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

schema()

public function schema(): Rule

“default must exist as a key in databases” and “databases must be * non-empty” stay in executeArray() — cross-field/non-empty checks, not structural shape.

Returns Rule

toCanonicalArray()

public function toCanonicalArray(XmlConfigDomDocument $document): array{default: (string | null), databases: array<string, array{class: string, parameters: array<(int | string), mixed>}>}

Parameter	Type	Description
`$document`	`XmlConfigDomDocument`

Returns array{default: (string | null), databases: array<string, array{class: string, parameters: array<(int | string), mixed>}>}

toCanonicalArrayWithPositions()

public function toCanonicalArrayWithPositions(XmlConfigDomDocument $document, ElementPositionIndex $positions): array{data: array{default: (string | null), databases: array<string, array{class: string, parameters: array<(int | string), mixed>}>}, positions: array<string, array{file: string, line: int}>}

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

Returns array{data: array{default: (string | null), databases: array<string, array{class: string, parameters: array<(int | 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.