Soong
Soong provides a general-purpose ETL library for data migration.
OptionsResolverComponent Class Reference
Inheritance diagram for OptionsResolverComponent:
ConfigurableComponent ExtractorBase Select KeyMapBase LoaderBase SimpleTask PropertyTransformerBase Copy PropertyMapper

Public Member Functions

 getConfigurationValue (string $optionName)
 Retrieve a configuration value for a named option.
Parameters
string$optionNameName of the option to retrieve.
Returns
mixed|null Retrieved value, or NULL if unset.
More...
 
 getAllConfigurationValues ()
 Retrieve a list of all available configuration values.
Returns
iterable Option values keyed by names.
More...
 

Protected Member Functions

 optionDefinitions ()
 List of definition arrays for each option supported by the component. More...
 

Protected Attributes

 $configuration = []
 Resolved configuration for the component. More...
 
 $resolver
 Use Symfony OptionsResolver as our default configuration manager. More...
 

Member Function Documentation

◆ optionDefinitions()

optionDefinitions ( )
protected

List of definition arrays for each option supported by the component.

Returns
array Keyed by option name, each element is an array with these contents: default_value - default value, if any required - true if the option is required, false if optional. allowed_types - types of values allowed for the option. allowed_values - specific values allowed for the option. normalizer - callable which will modify the option values.

◆ getConfigurationValue()

◆ getAllConfigurationValues()

getAllConfigurationValues ( )

Retrieve a list of all available configuration values.

Returns
iterable Option values keyed by names.

Implements ConfigurableComponent.

Member Data Documentation

◆ $configuration

array $configuration = []
protected

Resolved configuration for the component.

Configuration values keyed by configuration name.

Referenced by OptionsResolverComponent\getAllConfigurationValues().

◆ $resolver

OptionsResolver $resolver
protected

Use Symfony OptionsResolver as our default configuration manager.