SymfonyConfigFactory
in package
Table of Contents
- FIELD_CONFIG_VERSION = 'configVersion'
- DEFAULT_CONFIG_VERSION = '2'
- $configurationDefinitions : array<string|int, ConfigurationInterface>
- __construct() : mixed
- createDefault() : array<string|int, mixed>
- createFromFile() : array<string|int, mixed>
- findDefinition() : ConfigurationInterface
- generateConfiguration() : array<string|int, mixed>
- processConfiguration() : array<string|int, mixed>
- Normalizes and validates the given values.
- upgradeConfiguration() : array<string|int, mixed>
Constants
FIELD_CONFIG_VERSION
public
mixed
FIELD_CONFIG_VERSION
= 'configVersion'
DEFAULT_CONFIG_VERSION
private
mixed
DEFAULT_CONFIG_VERSION
= '2'
Properties
$configurationDefinitions
private
array<string|int, ConfigurationInterface>
$configurationDefinitions
Methods
__construct()
public
__construct(array<string|int, ConfigurationInterface> $definitions) : mixed
Parameters
- $definitions : array<string|int, ConfigurationInterface>
Return values
mixed —createDefault()
public
createDefault() : array<string|int, mixed>
Return values
array<string|int, mixed> —createFromFile()
public
createFromFile(string $filename) : array<string|int, mixed>
Parameters
- $filename : string
Return values
array<string|int, mixed> —findDefinition()
private
findDefinition(string $configurationVersion) : ConfigurationInterface
Parameters
- $configurationVersion : string
Return values
ConfigurationInterface —generateConfiguration()
private
generateConfiguration(array<string|int, mixed> $values) : array<string|int, mixed>
Parameters
- $values : array<string|int, mixed>
Return values
array<string|int, mixed> —processConfiguration()
Normalizes and validates the given values.
private
processConfiguration(array<string|int, mixed> $values) : array<string|int, mixed>
When this version of the configuration can be upgraded (which is detected by the Upgradable interface on the Configuration definition) then it will do so and re-run this method with the upgraded values. The 'configVersion' field will tell which definition should be used; when none is provided then a version 2 configuration is assumed.
Parameters
- $values : array<string|int, mixed>
Return values
array<string|int, mixed> —upgradeConfiguration()
private
upgradeConfiguration(Upgradable $definition, array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
- $definition : Upgradable
- $configuration : array<string|int, mixed>