ConfigurationFactory
in package
FinalYes
Tags
Table of Contents
Properties
- $compiledFactory : CompiledConfigurationFactory
- $componentProviders : iterable<string|int, mixed>
- $envReader : EnvReader
- $rootComponent : ComponentProvider
Methods
- __construct() : mixed
- parseFile() : ComponentPlugin
- process() : ComponentPlugin<string|int, T>
- compileFactory() : CompiledConfigurationFactory
Properties
$compiledFactory read-only
private
CompiledConfigurationFactory
$compiledFactory
$componentProviders read-only
private
iterable<string|int, mixed>
$componentProviders
$envReader read-only
private
EnvReader
$envReader
$rootComponent read-only
private
ComponentProvider
$rootComponent
Methods
__construct()
public
__construct(iterable<string|int, ComponentProvider> $componentProviders, ComponentProvider<string|int, T> $rootComponent, EnvReader $envReader) : mixed
Parameters
- $componentProviders : iterable<string|int, ComponentProvider>
- $rootComponent : ComponentProvider<string|int, T>
- $envReader : EnvReader
parseFile()
public
parseFile(string|array<int, string> $file[, string|null $cacheFile = null ][, bool $debug = true ]) : ComponentPlugin
Parameters
- $file : string|array<int, string>
-
path(s) to parse
- $cacheFile : string|null = null
-
path to cache parsed configuration to
- $debug : bool = true
-
will check for cache freshness if debug mode enabled
Tags
Return values
ComponentPlugin —parsed component plugin
process()
public
process(array<string|int, mixed> $configs[, ResourceCollection|null $resources = null ]) : ComponentPlugin<string|int, T>
Parameters
- $configs : array<string|int, mixed>
-
configs to process
- $resources : ResourceCollection|null = null
-
resources that can be used for cache invalidation
Tags
Return values
ComponentPlugin<string|int, T> —processed component plugin
compileFactory()
private
compileFactory() : CompiledConfigurationFactory