Documentation

FrameworkExtension extends Extension
in package

Process the configuration and prepare the dependency injection container with parameters and services.

Table of Contents

Properties

$annotatedClasses  : array<string|int, mixed>
$annotationsConfigEnabled  : bool
$formConfigEnabled  : bool
$httpClientConfigEnabled  : bool
$lockConfigEnabled  : bool
$mailerConfigEnabled  : bool
$messengerConfigEnabled  : bool
$notifierConfigEnabled  : bool
$processedConfigs  : array<string|int, mixed>
$propertyAccessConfigEnabled  : bool
$sessionConfigEnabled  : bool
$translationConfigEnabled  : bool
$validatorConfigEnabled  : bool

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
{@inheritdoc}
getNamespace()  : string
getXsdValidationBasePath()  : string|false
{@inheritdoc}
load()  : mixed
Responds to the app.config configuration parameter.
registerRateLimiter()  : mixed
hasConsole()  : bool
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
registerHttpCacheConfiguration()  : mixed
registerHttpClientConfiguration()  : mixed
registerLockConfiguration()  : mixed
registerMailerConfiguration()  : mixed
registerMappingFilesFromConfig()  : mixed
registerMappingFilesFromDir()  : mixed
registerMessengerConfiguration()  : mixed
registerNotifierConfiguration()  : mixed
registerProfilerConfiguration()  : mixed
registerPropertyAccessConfiguration()  : mixed
registerPropertyInfoConfiguration()  : mixed
registerRateLimiterConfiguration()  : mixed
registerRequestConfiguration()  : mixed
registerRetryableHttpClient()  : mixed
registerRouterConfiguration()  : mixed
registerSecretsConfiguration()  : mixed
registerSecurityCsrfConfiguration()  : mixed
registerSerializerConfiguration()  : mixed
registerSessionConfiguration()  : mixed
registerSsiConfiguration()  : mixed
registerTranslatorConfiguration()  : mixed
registerUidConfiguration()  : mixed
registerValidationConfiguration()  : mixed
registerValidatorMapping()  : mixed
registerWorkflowConfiguration()  : mixed
resolveTrustedHeaders()  : int

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
throws
BadMethodCallException

When the extension name does not follow conventions

Return values
string

getAnnotatedClassesToCompile()

Gets the annotated classes to cache.

public getAnnotatedClassesToCompile() : array<string|int, mixed>
Return values
array<string|int, mixed>

getXsdValidationBasePath()

{@inheritdoc}

public getXsdValidationBasePath() : string|false
Return values
string|false

registerRateLimiter()

public static registerRateLimiter(ContainerBuilder $container, string $name, array<string|int, mixed> $limiterConfig) : mixed
Parameters
$container : ContainerBuilder
$name : string
$limiterConfig : array<string|int, mixed>

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, bool $strictMode) : Reference
Parameters
$container : ContainerBuilder
$version : string|null
$format : string|null
$jsonManifestPath : string|null
$name : string
$strictMode : bool
Return values
Reference

registerHttpCacheConfiguration()

private registerHttpCacheConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, bool $httpMethodOverride) : mixed
Parameters
$config : array<string|int, mixed>
$container : ContainerBuilder
$httpMethodOverride : bool

registerMappingFilesFromConfig()

private registerMappingFilesFromConfig(ContainerBuilder $container, array<string|int, mixed> $config, callable $fileRecorder) : mixed
Parameters
$container : ContainerBuilder
$config : array<string|int, mixed>
$fileRecorder : callable

registerMappingFilesFromDir()

private registerMappingFilesFromDir(string $dir, callable $fileRecorder) : mixed
Parameters
$dir : string
$fileRecorder : callable

registerRetryableHttpClient()

private registerRetryableHttpClient(array<string|int, mixed> $options, string $name, ContainerBuilder $container) : mixed
Parameters
$options : array<string|int, mixed>
$name : string
$container : ContainerBuilder

registerTranslatorConfiguration()

private registerTranslatorConfiguration(array<string|int, mixed> $config, ContainerBuilder $container, LoaderInterface $loader, string $defaultLocale, array<string|int, mixed> $enabledLocales) : mixed
Parameters
$config : array<string|int, mixed>
$container : ContainerBuilder
$loader : LoaderInterface
$defaultLocale : string
$enabledLocales : array<string|int, 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>

resolveTrustedHeaders()

private resolveTrustedHeaders(array<string|int, mixed> $headers) : int
Parameters
$headers : array<string|int, mixed>
Return values
int 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results