DoctrineMigrationsExtension
extends Extension
in package
DoctrineMigrationsExtension.
Table of Contents
Properties
- $annotatedClasses : array<string|int, mixed>
- $processedConfigs : array<string|int, mixed>
Methods
- addAnnotatedClassesToCompile() : mixed
- Adds annotated classes to the class cache.
- getAlias() : string
- Returns the recommended alias to use in XML.
- getAnnotatedClassesToCompile() : array<string|int, mixed>
- Gets the annotated classes to cache.
- getConfiguration() : ConfigurationInterface|null
- Returns extension configuration.
- getNamespace() : string
- getXsdValidationBasePath() : string
- Returns the base path for the XSD files.
- load() : void
- Responds to the migrations configuration parameter.
- isConfigEnabled() : bool
- processConfiguration() : array<string|int, mixed>
- checkIfBundleRelativePath() : string
- getBundlePath() : string
- registerCollector() : void
Properties
$annotatedClasses
private
array<string|int, mixed>
$annotatedClasses
= []
$processedConfigs
private
array<string|int, mixed>
$processedConfigs
= []
Methods
addAnnotatedClassesToCompile()
Adds annotated classes to the class cache.
public
addAnnotatedClassesToCompile(array<string|int, mixed> $annotatedClasses) : mixed
Parameters
- $annotatedClasses : array<string|int, mixed>
-
An array of class patterns
getAlias()
Returns the recommended alias to use in XML.
public
getAlias() : string
This alias is also the mandatory prefix to use when using YAML.
This convention is to remove the "Extension" postfix from the class name and then lowercase and underscore the result. So:
AcmeHelloExtension
becomes
acme_hello
This can be overridden in a sub-class to specify the alias manually.
Tags
Return values
stringgetAnnotatedClassesToCompile()
Gets the annotated classes to cache.
public
getAnnotatedClassesToCompile() : array<string|int, mixed>
Return values
array<string|int, mixed>getConfiguration()
Returns extension configuration.
public
getConfiguration(array<string|int, mixed> $config, ContainerBuilder $container) : ConfigurationInterface|null
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
Return values
ConfigurationInterface|nullgetNamespace()
public
getNamespace() : string
Return values
stringgetXsdValidationBasePath()
Returns the base path for the XSD files.
public
getXsdValidationBasePath() : string
Return values
string —The XSD base path
load()
Responds to the migrations configuration parameter.
public
load(array<string|int, array<string|int, mixed>> $configs, ContainerBuilder $container) : void
Parameters
- $configs : array<string|int, array<string|int, mixed>>
- $container : ContainerBuilder
Tags
isConfigEnabled()
protected
isConfigEnabled(ContainerBuilder $container, array<string|int, mixed> $config) : bool
Parameters
- $container : ContainerBuilder
- $config : array<string|int, mixed>
Tags
Return values
boolprocessConfiguration()
protected
final processConfiguration(ConfigurationInterface $configuration, array<string|int, mixed> $configs) : array<string|int, mixed>
Parameters
- $configuration : ConfigurationInterface
- $configs : array<string|int, mixed>
Return values
array<string|int, mixed>checkIfBundleRelativePath()
private
checkIfBundleRelativePath(string $path, ContainerBuilder $container) : string
Parameters
- $path : string
- $container : ContainerBuilder
Return values
stringgetBundlePath()
private
getBundlePath(string $bundleName, ContainerBuilder $container) : string
Parameters
- $bundleName : string
- $container : ContainerBuilder
Return values
stringregisterCollector()
private
registerCollector(ContainerBuilder $container) : void
Parameters
- $container : ContainerBuilder