abstract class CompilerExtension

Configurator compiling extension.

Traits

Strict class for better experience.

Properties

protected Compiler $compiler
protected string $name
protected array|object $config

Methods

setCompiler(Compiler $compiler, string $name)

No description

setConfig(array|object $config)

No description

array|object
getConfig()

Returns extension configuration.

getConfigSchema()

Returns configuration schema.

array
validateConfig(array $expected, array $config = null, string $name = null) deprecated

Checks whether $config contains only $expected items and returns combined array.

array
loadFromFile(string $file)

Reads configuration from file.

void
loadDefinitionsFromConfig(array $configList)

Loads list of service definitions from configuration.

createLoader()

No description

string
prefix(string $id)

Prepend extension name to identifier or service name.

void
loadConfiguration()

Processes configuration data. Intended to be overridden by descendant.

void
beforeCompile()

Adjusts DI container before is compiled to PHP class. Intended to be overridden by descendant.

void
afterCompile(ClassType $class)

Adjusts DI container compiled to PHP class. Intended to be overridden by descendant.

Details

at line 35
CompilerExtension setCompiler(Compiler $compiler, string $name)

Parameters

Compiler $compiler
string $name

Return Value

CompilerExtension

at line 47
CompilerExtension setConfig(array|object $config)

Parameters

array|object $config

Return Value

CompilerExtension

at line 61
array|object getConfig()

Returns extension configuration.

Return Value

array|object

at line 70
Schema getConfigSchema()

Returns configuration schema.

Return Value

Schema

at line 83
array validateConfig(array $expected, array $config = null, string $name = null) deprecated

deprecated use getConfigSchema()

Checks whether $config contains only $expected items and returns combined array.

Parameters

array $expected
array $config
string $name

Return Value

array

Exceptions

InvalidStateException

at line 98
ContainerBuilder getContainerBuilder()

Return Value

ContainerBuilder

at line 107
array loadFromFile(string $file)

Reads configuration from file.

Parameters

string $file

Return Value

array

at line 120
void loadDefinitionsFromConfig(array $configList)

Loads list of service definitions from configuration.

Prefixes its names and replaces @extension with name in definition.

Parameters

array $configList

Return Value

void

at line 131
protected Loader createLoader()

Return Value

Loader

at line 140
string prefix(string $id)

Prepend extension name to identifier or service name.

Parameters

string $id

Return Value

string

at line 150
void loadConfiguration()

Processes configuration data. Intended to be overridden by descendant.

Return Value

void

at line 159
void beforeCompile()

Adjusts DI container before is compiled to PHP class. Intended to be overridden by descendant.

Return Value

void

at line 168
void afterCompile(ClassType $class)

Adjusts DI container compiled to PHP class. Intended to be overridden by descendant.

Parameters

ClassType $class

Return Value

void