class BaseConfigDefinition implements ConfigurationInterface

ConfigDefinition specifies the bare minimum of what should a config contain.

It's a best practice to extend it and define all parameters required by your code. That way you can be sure that your code has all the data it needs and it can fail fast otherwise. Usually your code requires some parameters, so it's easiest to extend this class and just override getParametersDefinition() method.

Methods

TreeBuilder
getConfigTreeBuilder()

Generates the configuration tree builder. You probably don't need to touch this.

ArrayNodeDefinition
getParametersDefinition()

Definition of parameters section. Override in extending class to validate parameters sent to the component early.

ArrayNodeDefinition
getRootDefinition(TreeBuilder $treeBuilder)

Root definition to be overridden in special cases

Details

at line 25
TreeBuilder getConfigTreeBuilder()

Generates the configuration tree builder. You probably don't need to touch this.

Return Value

TreeBuilder The tree builder

at line 35
protected ArrayNodeDefinition getParametersDefinition()

Definition of parameters section. Override in extending class to validate parameters sent to the component early.

Return Value

ArrayNodeDefinition

at line 46
protected ArrayNodeDefinition getRootDefinition(TreeBuilder $treeBuilder)

Root definition to be overridden in special cases

Parameters

TreeBuilder $treeBuilder

Return Value

ArrayNodeDefinition