Version2
in package
Implements
ConfigurationInterface, Upgradable
Interfaces, Classes & Used Traits
- ConfigurationInterface
- Upgradable
Properties
$defaultTemplateName Line 25
private$defaultTemplateName : string
Methods
__construct() Line 27
public__construct(string $defaultTemplateName) : mixed
Parameters
Returns
mixed —
getConfigTreeBuilder() Line 35
publicgetConfigTreeBuilder() : mixed
Returns
mixed —
upgrade() Line 166
Upgrades the version 2 configuration to the version 3 configuration.
publicupgrade(array> $values) : array
phpDocumentor attempts to auto-upgrade the configuration version to the latest version so that the internals of phpDocumentor only need to care about the format of the latest version of the configuration and the rest will be dealt with automatically.
In order to achieve this, the result of this definition is passed into this upgrade function and it should output the same settings in the structure that a newer definition expects (what that structure is depends on the version of the definition.
The 'configVersion' field in the result will inform the ConfigurationFactory what the next Configuration definition should be used to parse this result.