FrameworkExtension
extends Extension
in package
FrameworkExtension.
Tags
Table of Contents
- $annotatedClasses : mixed
- $annotationsConfigEnabled : mixed
- $formConfigEnabled : mixed
- $httpClientConfigEnabled : mixed
- $mailerConfigEnabled : mixed
- $messengerConfigEnabled : mixed
- $processedConfigs : mixed
- $sessionConfigEnabled : mixed
- $translationConfigEnabled : mixed
- $validatorConfigEnabled : mixed
- 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() : mixed
- {@inheritdoc}
- getNamespace() : mixed
- getXsdValidationBasePath() : mixed
- {@inheritdoc}
- load() : mixed
- Responds to the app.config configuration parameter.
- isConfigEnabled() : bool
- processConfiguration() : array<string|int, mixed>
- createPackageDefinition() : Definition
- Returns a definition for an asset package.
- createVersion() : Reference
- registerAnnotationsConfiguration() : mixed
- registerAssetsConfiguration() : mixed
- registerCacheConfiguration() : mixed
- registerDebugConfiguration() : mixed
- registerEsiConfiguration() : mixed
- registerFormConfiguration() : mixed
- registerFragmentsConfiguration() : mixed
- registerHttpClientConfiguration() : mixed
- registerLockConfiguration() : mixed
- registerMailerConfiguration() : mixed
- registerMappingFilesFromConfig() : mixed
- registerMappingFilesFromDir() : mixed
- registerMessengerConfiguration() : mixed
- registerProfilerConfiguration() : mixed
- registerPropertyAccessConfiguration() : mixed
- registerPropertyInfoConfiguration() : mixed
- registerRequestConfiguration() : mixed
- registerRouterConfiguration() : mixed
- registerSecretsConfiguration() : mixed
- registerSecurityCsrfConfiguration() : mixed
- registerSerializerConfiguration() : mixed
- registerSessionConfiguration() : mixed
- registerSsiConfiguration() : mixed
- registerTemplatingConfiguration() : mixed
- registerTranslatorConfiguration() : mixed
- registerValidationConfiguration() : mixed
- registerValidatorMapping() : mixed
- registerWorkflowConfiguration() : mixed
Properties
$annotatedClasses
private
mixed
$annotatedClasses
= []
$annotationsConfigEnabled
private
mixed
$annotationsConfigEnabled
= false
$formConfigEnabled
private
mixed
$formConfigEnabled
= false
$httpClientConfigEnabled
private
mixed
$httpClientConfigEnabled
= false
$mailerConfigEnabled
private
mixed
$mailerConfigEnabled
= false
$messengerConfigEnabled
private
mixed
$messengerConfigEnabled
= false
$processedConfigs
private
mixed
$processedConfigs
= []
$sessionConfigEnabled
private
mixed
$sessionConfigEnabled
= false
$translationConfigEnabled
private
mixed
$translationConfigEnabled
= false
$validatorConfigEnabled
private
mixed
$validatorConfigEnabled
= false
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
Return values
mixed —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
string —The alias
getAnnotatedClassesToCompile()
Gets the annotated classes to cache.
public
getAnnotatedClassesToCompile() : array<string|int, mixed>
Return values
array<string|int, mixed> —An array of classes
getConfiguration()
{@inheritdoc}
public
getConfiguration(array<string|int, mixed> $config, ContainerBuilder $container) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
Return values
mixed —getNamespace()
public
getNamespace() : mixed
Return values
mixed —getXsdValidationBasePath()
{@inheritdoc}
public
getXsdValidationBasePath() : mixed
Return values
mixed —load()
Responds to the app.config configuration parameter.
public
load(array<string|int, mixed> $configs, ContainerBuilder $container) : mixed
Parameters
- $configs : array<string|int, mixed>
- $container : ContainerBuilder
Tags
Return values
mixed —isConfigEnabled()
protected
isConfigEnabled(ContainerBuilder $container, array<string|int, mixed> $config) : bool
Parameters
- $container : ContainerBuilder
- $config : array<string|int, mixed>
Tags
Return values
bool —Whether the configuration is enabled
processConfiguration()
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> —createPackageDefinition()
Returns a definition for an asset package.
private
createPackageDefinition(string|null $basePath, array<string|int, mixed> $baseUrls, Reference $version) : Definition
Parameters
- $basePath : string|null
- $baseUrls : array<string|int, mixed>
- $version : Reference
Return values
Definition —createVersion()
private
createVersion(ContainerBuilder $container, string|null $version, string|null $format, string|null $jsonManifestPath, string $name) : Reference
Parameters
- $container : ContainerBuilder
- $version : string|null
- $format : string|null
- $jsonManifestPath : string|null
- $name : string
Return values
Reference —registerAnnotationsConfiguration()
private
registerAnnotationsConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, LoaderInterface $loader) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
- $loader : LoaderInterface
Return values
mixed —registerAssetsConfiguration()
private
registerAssetsConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, XmlFileLoader $loader) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
- $loader : XmlFileLoader
Return values
mixed —registerCacheConfiguration()
private
registerCacheConfiguration(array<string|int, mixed> $config, ContainerBuilder $container) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
Return values
mixed —registerDebugConfiguration()
private
registerDebugConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, XmlFileLoader $loader) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
- $loader : XmlFileLoader
Return values
mixed —registerEsiConfiguration()
private
registerEsiConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, XmlFileLoader $loader) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
- $loader : XmlFileLoader
Return values
mixed —registerFormConfiguration()
private
registerFormConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, XmlFileLoader $loader) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
- $loader : XmlFileLoader
Return values
mixed —registerFragmentsConfiguration()
private
registerFragmentsConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, XmlFileLoader $loader) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
- $loader : XmlFileLoader
Return values
mixed —registerHttpClientConfiguration()
private
registerHttpClientConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, XmlFileLoader $loader, array<string|int, mixed> $profilerConfig) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
- $loader : XmlFileLoader
- $profilerConfig : array<string|int, mixed>
Return values
mixed —registerLockConfiguration()
private
registerLockConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, XmlFileLoader $loader) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
- $loader : XmlFileLoader
Return values
mixed —registerMailerConfiguration()
private
registerMailerConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, XmlFileLoader $loader) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
- $loader : XmlFileLoader
Return values
mixed —registerMappingFilesFromConfig()
private
registerMappingFilesFromConfig(ContainerBuilder $container, array<string|int, mixed> $config, callable $fileRecorder) : mixed
Parameters
- $container : ContainerBuilder
- $config : array<string|int, mixed>
- $fileRecorder : callable
Return values
mixed —registerMappingFilesFromDir()
private
registerMappingFilesFromDir(string $dir, callable $fileRecorder) : mixed
Parameters
- $dir : string
- $fileRecorder : callable
Return values
mixed —registerMessengerConfiguration()
private
registerMessengerConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, XmlFileLoader $loader, array<string|int, mixed> $validationConfig) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
- $loader : XmlFileLoader
- $validationConfig : array<string|int, mixed>
Return values
mixed —registerProfilerConfiguration()
private
registerProfilerConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, XmlFileLoader $loader) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
- $loader : XmlFileLoader
Return values
mixed —registerPropertyAccessConfiguration()
private
registerPropertyAccessConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, XmlFileLoader $loader) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
- $loader : XmlFileLoader
Return values
mixed —registerPropertyInfoConfiguration()
private
registerPropertyInfoConfiguration(ContainerBuilder $container, XmlFileLoader $loader) : mixed
Parameters
- $container : ContainerBuilder
- $loader : XmlFileLoader
Return values
mixed —registerRequestConfiguration()
private
registerRequestConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, XmlFileLoader $loader) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
- $loader : XmlFileLoader
Return values
mixed —registerRouterConfiguration()
private
registerRouterConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, XmlFileLoader $loader) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
- $loader : XmlFileLoader
Return values
mixed —registerSecretsConfiguration()
private
registerSecretsConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, XmlFileLoader $loader) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
- $loader : XmlFileLoader
Return values
mixed —registerSecurityCsrfConfiguration()
private
registerSecurityCsrfConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, XmlFileLoader $loader) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
- $loader : XmlFileLoader
Return values
mixed —registerSerializerConfiguration()
private
registerSerializerConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, XmlFileLoader $loader) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
- $loader : XmlFileLoader
Return values
mixed —registerSessionConfiguration()
private
registerSessionConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, XmlFileLoader $loader) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
- $loader : XmlFileLoader
Return values
mixed —registerSsiConfiguration()
private
registerSsiConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, XmlFileLoader $loader) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
- $loader : XmlFileLoader
Return values
mixed —registerTemplatingConfiguration()
private
registerTemplatingConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, XmlFileLoader $loader) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
- $loader : XmlFileLoader
Return values
mixed —registerTranslatorConfiguration()
private
registerTranslatorConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, LoaderInterface $loader, string $defaultLocale) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
- $loader : LoaderInterface
- $defaultLocale : string
Return values
mixed —registerValidationConfiguration()
private
registerValidationConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, XmlFileLoader $loader, bool $propertyInfoEnabled) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
- $loader : XmlFileLoader
- $propertyInfoEnabled : bool
Return values
mixed —registerValidatorMapping()
private
registerValidatorMapping(ContainerBuilder $container, array<string|int, mixed> $config, array<string|int, mixed> &$files) : mixed
Parameters
- $container : ContainerBuilder
- $config : array<string|int, mixed>
- $files : array<string|int, mixed>
Return values
mixed —registerWorkflowConfiguration()
private
registerWorkflowConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, XmlFileLoader $loader) : mixed
Parameters
- $config : array<string|int, mixed>
- $container : ContainerBuilder
- $loader : XmlFileLoader