Documentation

FrameworkConfig
in package
implements ConfigBuilderInterface

This class is automatically generated to help in creating a config.

Table of Contents

Interfaces

ConfigBuilderInterface
A ConfigBuilder provides helper methods to build a large complex array.

Properties

$_usedProperties  : mixed
$annotations  : mixed
$assets  : mixed
$cache  : mixed
$csrfProtection  : mixed
$defaultLocale  : mixed
$disallowSearchEngineIndex  : mixed
$enabledLocales  : mixed
$errorController  : mixed
$esi  : mixed
$exceptions  : mixed
$form  : mixed
$fragments  : mixed
$httpCache  : mixed
$httpClient  : mixed
$httpMethodOverride  : mixed
$ide  : mixed
$lock  : mixed
$mailer  : mixed
$messenger  : mixed
$notifier  : mixed
$phpErrors  : mixed
$profiler  : mixed
$propertyAccess  : mixed
$propertyInfo  : mixed
$rateLimiter  : mixed
$request  : mixed
$router  : mixed
$secret  : mixed
$secrets  : mixed
$serializer  : mixed
$session  : mixed
$setContentLanguageFromLocale  : mixed
$setLocaleFromAcceptLanguage  : mixed
$ssi  : mixed
$test  : mixed
$translator  : mixed
$trustedHeaders  : mixed
$trustedHosts  : mixed
$trustedProxies  : mixed
$uid  : mixed
$validation  : mixed
$webLink  : mixed
$workflows  : mixed

Methods

__construct()  : mixed
annotations()  : AnnotationsConfig
assets()  : AssetsConfig
cache()  : CacheConfig
csrfProtection()  : CsrfProtectionConfig
defaultLocale()  : $this
disallowSearchEngineIndex()  : $this
Enabled by default when debug is enabled.
enabledLocales()  : $this
errorController()  : $this
esi()  : EsiConfig|$this
exception()  : ExceptionConfig|$this
form()  : FormConfig
fragments()  : FragmentsConfig|$this
getExtensionAlias()  : string
Gets the alias for the extension which config we are building.
httpCache()  : HttpCacheConfig|$this
httpClient()  : HttpClientConfig|$this
httpMethodOverride()  : $this
Set true to enable support for the '_method' request parameter to determine the intended HTTP method on POST requests. Note: When using the HttpCache, you need to call the method in your front controller instead
ide()  : $this
lock()  : LockConfig|$this
mailer()  : MailerConfig
messenger()  : MessengerConfig
notifier()  : NotifierConfig
phpErrors()  : PhpErrorsConfig
profiler()  : ProfilerConfig|$this
propertyAccess()  : PropertyAccessConfig
propertyInfo()  : PropertyInfoConfig
rateLimiter()  : RateLimiterConfig|$this
request()  : RequestConfig|$this
router()  : RouterConfig|$this
secret()  : $this
secrets()  : SecretsConfig
serializer()  : SerializerConfig
session()  : SessionConfig|$this
setContentLanguageFromLocale()  : $this
Whether to set the Content-Language HTTP header on the Response using the Request locale.
setLocaleFromAcceptLanguage()  : $this
Whether to use the Accept-Language HTTP header to set the Request locale (only when the "_locale" request attribute is not passed).
ssi()  : SsiConfig|$this
test()  : $this
toArray()  : array<string|int, mixed>
Gets all configuration represented as an array.
translator()  : TranslatorConfig
trustedHeaders()  : $this
trustedHosts()  : $this
trustedProxies()  : $this
uid()  : UidConfig
validation()  : ValidationConfig
webLink()  : WebLinkConfig
workflows()  : WorkflowsConfig|$this

Properties

$setContentLanguageFromLocale

private mixed $setContentLanguageFromLocale

$setLocaleFromAcceptLanguage

private mixed $setLocaleFromAcceptLanguage

Methods

__construct()

public __construct([array<string|int, mixed> $value = [] ]) : mixed
Parameters
$value : array<string|int, mixed> = []

getExtensionAlias()

Gets the alias for the extension which config we are building.

public getExtensionAlias() : string
Return values
string

httpMethodOverride()

Set true to enable support for the '_method' request parameter to determine the intended HTTP method on POST requests. Note: When using the HttpCache, you need to call the method in your front controller instead

public httpMethodOverride(ParamConfigurator|mixed $value) : $this
Parameters
$value : ParamConfigurator|mixed
Tags
default

true

Return values
$this

setContentLanguageFromLocale()

Whether to set the Content-Language HTTP header on the Response using the Request locale.

public setContentLanguageFromLocale(ParamConfigurator|bool $value) : $this
Parameters
$value : ParamConfigurator|bool
Tags
default

false

Return values
$this

setLocaleFromAcceptLanguage()

Whether to use the Accept-Language HTTP header to set the Request locale (only when the "_locale" request attribute is not passed).

public setLocaleFromAcceptLanguage(ParamConfigurator|bool $value) : $this
Parameters
$value : ParamConfigurator|bool
Tags
default

false

Return values
$this

toArray()

Gets all configuration represented as an array.

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

trustedHeaders()

public trustedHeaders(mixed $value) : $this
Parameters
$value : mixed
Return values
$this

trustedHosts()

public trustedHosts(mixed $value) : $this
Parameters
$value : mixed
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results