PHP Trait Bolt\Extension\ConfigTrait

Author: Carson Full ([email protected])

Public Methods

Method	Description
getName ( ) : string
getVendor ( ) : string

Method	Description
extendConfigService ( )	Call this in register method.
getBaseDirectory ( ) : Bolt\Filesystem\Handler\DirectoryInterface
getConfig ( ) : array	Returns the config for the extension.
getContainer ( ) : Pimple
getDefaultConfig ( ) : array	Override this to provide a default configuration, which will be used in the absence of a config file.
registerFields ( ) : Bolt\Storage\Field\FieldInterface[]	Register a list of Bolt fields.

Method	Description
addConfig ( Bolt\Filesystem\Handler\YamlFile $file )	Merge in a yaml file to the config.
copyDistFile ( Bolt\Filesystem\Handler\YamlFile $file )	Copy config.yml.dist to config/extensions.

Call this in register method.

protected extendConfigService ( )

abstract protected getBaseDirectory ( ) : Bolt\Filesystem\Handler\DirectoryInterface
return	Bolt\Filesystem\Handler\DirectoryInterface

Returns the config for the extension.

protected getConfig ( ) : array
return	array

abstract protected getContainer ( ) : Pimple
return	Pimple

Override this to provide a default configuration, which will be used in the absence of a config file.

protected getDefaultConfig ( ) : array
return	array

abstract public getName ( ) : string
return	string

abstract public getVendor ( ) : string
return	string

Example:

 return [
     new ColourPickField(),
 ];

protected registerFields ( ) : Bolt\Storage\Field\FieldInterface[]
return	Bolt\Storage\Field\FieldInterface[]