Framework Configuration Reference (FrameworkBundle) ¶

enabled ¶

type: boolean default: false

debug ¶

type: boolean default: %kernel.debug%

If true, exceptions are thrown when things go wrong. Otherwise, the cache will try to carry on and deliver a meaningful response.

trace_level ¶

type: string possible values: 'none', 'short' or 'full'

For 'short', a concise trace of the main request will be added as an HTTP header. 'full' will add traces for all requests (including ESI subrequests). (default: 'full' if in debug; 'none' otherwise)

trace_header ¶

type: string

Header name to use for traces. (default: X-Symfony-Cache)

default_ttl ¶

type: integer

The number of seconds that a cache entry should be considered fresh when no explicit freshness information is provided in a response. Explicit Cache-Control or Expires headers override this value. (default: 0)

private_headers ¶

type: array

Set of request headers that trigger "private" cache-control behavior on responses that don't explicitly state whether the response is public or private via a Cache-Control directive. (default: Authorization and Cookie)

allow_reload ¶

type: string

Specifies whether the client can force a cache reload by including a Cache-Control "no-cache" directive in the request. Set it to true for compliance with RFC 2616. (default: false)

allow_revalidate ¶

type: string

Specifies whether the client can force a cache revalidate by including a Cache-Control "max-age=0" directive in the request. Set it to true for compliance with RFC 2616. (default: false)

stale_while_revalidate ¶

type: integer

Specifies the default number of seconds (the granularity is the second as the Response TTL precision is a second) during which the cache can immediately return a stale response while it revalidates it in the background (default: 2). This setting is overridden by the stale-while-revalidate HTTP Cache-Control extension (see RFC 5861).

stale_if_error ¶

type: integer

Specifies the default number of seconds (the granularity is the second) during which the cache can serve a stale response when an error is encountered (default: 60). This setting is overridden by the stale-if-error HTTP Cache-Control extension (see RFC 5861).

terminate_on_cache_hit ¶

type: boolean default: true

If true, the kernel.terminate event is dispatched even when the cache is hit.

Unless your application needs to process events on cache hits, it's recommended to set this to false to improve performance, because it avoids having to bootstrap the Symfony framework on a cache hit.

enabled_locales ¶

type: array default: [] (empty array = enable all locales)

Symfony applications generate by default the translation files for validation and security messages in all locales. If your application only uses some locales, use this option to restrict the files generated by Symfony and improve performance a bit:

1
2
3

# config/packages/translation.yaml
framework:
    enabled_locales: ['en', 'es']

1
2
3
4
5
6
7
8
9
10
11
12
13
14

<!-- config/packages/translation.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <enabled-locale>en</enabled-locale>
        <enabled-locale>es</enabled-locale>
    </framework:config>
</container>

1
2
3
4
5
6

// config/packages/translation.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework) {
    $framework->enabledLocales(['en', 'es']);
};

If some user makes requests with a locale not included in this option, the application won't display any error because Symfony will display contents using the fallback locale.

set_content_language_from_locale ¶

type: boolean default: false

If this option is set to true, the response will have a Content-Language HTTP header set with the Request locale.

set_locale_from_accept_language ¶

type: boolean default: false

If this option is set to true, the Request locale will automatically be set to the value of the Accept-Language HTTP header.

When the _locale request attribute is passed, the Accept-Language header is ignored.

enabled ¶

type: boolean default: true or false depending on your installation

Whether to enable the form services or not in the service container. If you don't use forms, setting this to false may increase your application's performance because less services will be loaded into the container.

This option will automatically be set to true when one of the child settings is configured.

field_name ¶

type: string default: _token

This is the field name that you should give to the CSRF token field of your forms.

enabled ¶

type: boolean default: true or false depending on your installation

This option can be used to disable CSRF protection on all forms. But you can also disable CSRF protection on individual forms.

1
2
3
4

# config/packages/framework.yaml
framework:
    # ...
    csrf_protection: true

1
2
3
4
5
6
7
8
9
10
11
12
13

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony
        https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
    <framework:config>
        <framework:csrf-protection enabled="true"/>
    </framework:config>
</container>

1
2
3
4
5
6
7

// config/packages/framework.php
use Symfony\Config\FrameworkConfig;
return static function (FrameworkConfig $framework) {
    $framework->csrfProtection()
        ->enabled(true)
    ;
};

If you're using forms, but want to avoid starting your session (e.g. using forms in an API-only website), csrf_protection will need to be set to false.

enabled ¶

type: boolean default: false

Whether to enable the edge side includes support in the framework.

You can also set esi to true to enable it:

1
2
3

# config/packages/framework.yaml
framework:
    esi: true

1
2
3
4
5
6
7
8
9
10
11
12
13

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:esi/>
    </framework:config>
</container>

1
2
3
4
5
6

// config/packages/framework.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework) {
    $framework->esi()->enabled(true);
};

enabled ¶

type: boolean default: false

Whether to enable the fragment listener or not. The fragment listener is used to render ESI fragments independently of the rest of the page.

This setting is automatically set to true when one of the child settings is configured.

hinclude_default_template ¶

type: string default: null

Sets the content shown during the loading of the fragment or when JavaScript is disabled. This can be either a template name or the content itself.

path ¶

type: string default: '/_fragment'

The path prefix for fragments. The fragment listener will only be executed when the request starts with this path.

auth_basic ¶

type: string

The username and password used to create the Authorization HTTP header used in HTTP Basic authentication. The value of this option must follow the format username:password.

auth_bearer ¶

type: string

The token used to create the Authorization HTTP header used in HTTP Bearer authentication (also called token authentication).

auth_ntlm ¶

type: string

The username and password used to create the Authorization HTTP header used in the Microsoft NTLM authentication protocol. The value of this option must follow the format username:password. This authentication mechanism requires using the cURL-based transport.

base_uri ¶

type: string

URI that is merged into relative URIs, following the rules explained in the RFC 3986 standard. This is useful when all the requests you make share a common prefix (e.g. https://api.github.com/) so you can avoid adding it to every request.

Here are some common examples of how base_uri merging works in practice:

bindto ¶

type: string

A network interface name, IP address, a host name or a UNIX socket to use as the outgoing network interface.

buffer ¶

type: boolean | Closure

Buffering the response means that you can access its content multiple times without performing the request again. Buffering is enabled by default when the content type of the response is text/*, application/json or application/xml.

If this option is a boolean value, the response is buffered when the value is true. If this option is a closure, the response is buffered when the returned value is true (the closure receives as argument an array with the response headers).

cafile ¶

type: string

The path of the certificate authority file that contains one or more certificates used to verify the other servers' certificates.

capath ¶

type: string

The path to a directory that contains one or more certificate authority files.

ciphers ¶

type: string

A list of the names of the ciphers allowed for the SSL/TLS connections. They can be separated by colons, commas or spaces (e.g. 'RC4-SHA:TLS13-AES-128-GCM-SHA256').

delay ¶

type: integer default: 1000

The initial delay in milliseconds used to compute the waiting time between retries.

enabled ¶

type: boolean default: false

Whether to enable the support for retry failed HTTP request or not. This setting is automatically set to true when one of the child settings is configured.

headers ¶

type: array

An associative array of the HTTP headers added before making the request. This value must use the format ['header-name' => 'value0, value1, ...'].

http_codes ¶

type: array default: DEFAULT_RETRY_STATUS_CODES()

The list of HTTP status codes that triggers a retry of the request.

http_version ¶

type: string | null default: null

The HTTP version to use, typically '1.1' or '2.0'. Leave it to null to let Symfony select the best version automatically.

jitter ¶

type: float default: 0.1 (must be between 0.0 and 1.0)

This option adds some randomness to the delay. It's useful to avoid sending multiple requests to the server at the exact same time. The randomness is calculated as delay * jitter. For example: if delay is 1000ms and jitter is 0.2, the actual delay will be a number between 800 and 1200 (1000 +/- 20%).

local_cert ¶

type: string

The path to a file that contains the PEM formatted certificate used by the HTTP client. This is often combined with the local_pk and passphrase options.

local_pk ¶

type: string

The path of a file that contains the PEM formatted private key of the certificate defined in the local_cert option.

max_delay ¶

type: integer default: 0

The maximum amount of milliseconds initial to wait between retries. Use 0 to not limit the duration.

max_duration ¶

type: float default: 0

The maximum execution time, in seconds, that the request and the response are allowed to take. A value lower than or equal to 0 means it is unlimited.

max_host_connections ¶

type: integer default: 6

Defines the maximum amount of simultaneously open connections to a single host (considering a "host" the same as a "host name + port number" pair). This limit also applies for proxy connections, where the proxy is considered to be the host for which this limit is applied.

max_redirects ¶

type: integer default: 20

The maximum number of redirects to follow. Use 0 to not follow any redirection.

max_retries ¶

type: integer default: 3

The maximum number of retries for failing requests. When the maximum is reached, the client returns the last received response.

multiplier ¶

type: float default: 2

This value is multiplied to the delay each time a retry occurs, to distribute retries in time instead of making all of them sequentially.

no_proxy ¶

type: string | null default: null

A comma separated list of hosts that do not require a proxy to be reached, even if one is configured. Use the '*' wildcard to match all hosts and an empty string to match none (disables the proxy).

passphrase ¶

type: string

The passphrase used to encrypt the certificate stored in the file defined in the local_cert option.

peer_fingerprint ¶

type: array

When negotiating a TLS or SSL connection, the server sends a certificate indicating its identity. A public key is extracted from this certificate and if it does not exactly match any of the public keys provided in this option, the connection is aborted before sending or receiving any data.

The value of this option is an associative array of algorithm => hash (e.g ['pin-sha256' => '...']).

proxy ¶

type: string | null

The HTTP proxy to use to make the requests. Leave it to null to detect the proxy automatically based on your system configuration.

query ¶

type: array

An associative array of the query string values added to the URL before making the request. This value must use the format ['parameter-name' => parameter-value, ...].

resolve ¶

type: array

A list of hostnames and their IP addresses to pre-populate the DNS cache used by the HTTP client in order to avoid a DNS lookup for those hosts. This option is useful to improve security when IPs are checked before the URL is passed to the client and to make your tests easier.

The value of this option is an associative array of domain => IP address (e.g ['symfony.com' => '46.137.106.254', ...]).

retry_strategy ¶

type: string

The service is used to decide if a request should be retried and to compute the time to wait between retries. By default, it uses an instance of GenericRetryStrategy configured with http_codes, delay, max_delay, multiplier and jitter options. This class has to implement RetryStrategyInterface.

scope ¶

type: string

For scoped clients only: the regular expression that the URL must match before applying all other non-default options. By default, the scope is derived from base_uri.

timeout ¶

type: float default: depends on your PHP config

Time, in seconds, to wait for a response. If the response takes longer, a TransportException is thrown. Its default value is the same as the value of PHP's default_socket_timeout config option.

verify_host ¶

type: boolean default: true

If true, the certificate sent by other servers is verified to ensure that their common name matches the host included in the URL. This is usually combined with verify_peer to also verify the certificate authenticity.

verify_peer ¶

type: boolean default: true

If true, the certificate sent by other servers when negotiating a TLS or SSL connection is verified for authenticity. Authenticating the certificate is not enough to be sure about the server, so you should combine this with the verify_host option.

enabled ¶

type: boolean default: false

The profiler can be enabled by setting this option to true. When you install it using Symfony Flex, the profiler is enabled in the dev and test environments.

collect ¶

type: boolean default: true

This option configures the way the profiler behaves when it is enabled. If set to true, the profiler collects data for all requests. If you want to only collect information on-demand, you can set the collect flag to false and activate the data collectors manually:

1

$profiler->enable();

collect_parameter ¶

type: string default: null

This specifies name of a query parameter, a body parameter or a request attribute used to enable or disable collection of data by the profiler for each request. Combine it with the collect option to enable/disable the profiler on demand:

• If the collect option is set to true but this parameter exists in a request and has any value other than true, yes, on or 1, the request data will not be collected;
  collect オプションが true に設定されているが、このパラメーターが request に存在し、true、yes、on、または 1 以外の値を持つ場合、要求データは収集されません。
• If the collect option is set to false, but this parameter exists in a request and has value of true, yes, on or 1, the request data will be collected.
  収集オプションが false に設定されているが、このパラメーターが要求に存在し、値が true、yes、on、または 1 の場合、要求データが収集されます。

only_exceptions ¶

type: boolean default: false

When this is set to true, the profiler will only be enabled when an exception is thrown during the handling of the request.

only_main_requests ¶

type: boolean default: false

When this is set to true, the profiler will only be enabled on the main requests (and not on the subrequests).

dsn ¶

type: string default: 'file:%kernel.cache_dir%/profiler'

The DSN where to store the profiling information.

collect_serializer_data ¶

type: boolean default: false

Set this option to true to enable the serializer data collector and its profiler panel. When this option is true, all normalizers and encoders are decorated by traceable implementations that collect profiling information about them.

name ¶

type: prototype

Name of the rate limiter you want to create.

formats ¶

type: array default: []

This setting is used to associate additional request formats (e.g. html) to one or more mime types (e.g. text/html), which will allow you to use the format & mime types to call Request::getFormat($mimeType) or Request::getMimeType($format).

In practice, this is important because Symfony uses it to automatically set the Content-Type header on the Response (if you don't explicitly set one). If you pass an array of mime types, the first will be used for the header.

To configure a jsonp format:

1
2
3
4
5

# config/packages/framework.yaml
framework:
    request:
        formats:
            jsonp: 'application/javascript'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>

<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony
        https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:request>
            <framework:format name="jsonp">
                <framework:mime-type>application/javascript</framework:mime-type>
            </framework:format>
        </framework:request>
    </framework:config>
</container>

1
2
3
4
5
6
7

// config/packages/framework.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework) {
    $framework->request()
        ->format('jsonp', 'application/javascript');
};

resource ¶

type: string required

The path the main routing resource (e.g. a YAML file) that contains the routes and imports the router should load.

type ¶

type: string

The type of the resource to hint the loaders about the format. This isn't needed when you use the default routers with the expected file extensions (.xml, .yaml, .php).

default_uri ¶

type: string

The default URI used to generate URLs in a non-HTTP context (see Generating URLs in Commands).

http_port ¶

type: integer default: 80

The port for normal http requests (this is used when matching the scheme).

https_port ¶

type: integer default: 443

The port for https requests (this is used when matching the scheme).

strict_requirements ¶

type: mixed default: true

Determines the routing generator behavior. When generating a route that has specific parameter requirements, the generator can behave differently in case the used parameters do not meet these requirements.

The value can be one of:

true

Throw an exception when the requirements are not met;

要件が満たされていない場合に例外をスローします。

false

Disable exceptions when the requirements are not met and return '' instead;

要件が満たされていない場合は例外を無効にし、代わりに '' を返します。

null

Disable checking the requirements (thus, match the route even when the requirements don't match).

要件のチェックを無効にします (したがって、要件が一致しない場合でもルートを一致させます)。

true is recommended in the development environment, while false or null might be preferred in production.

utf8 ¶

type: boolean default: true

When this option is set to true, the regular expressions used in the requirements of route parameters will be run using the utf-8 modifier. This will for example match any UTF-8 character when using ., instead of matching only a single byte.

If the charset of your application is UTF-8 (as defined in the getCharset() method of your kernel) it's recommended setting it to true. This will make non-UTF8 URLs to generate 404 errors.

cache_dir ¶

type: string default: %kernel.cache_dir%

The directory where routing information will be cached. Can be set to ~ (null) to disable route caching.

storage_factory_id ¶

type: string default: 'session.storage.factory.native'

The service ID used for creating the SessionStorageInterface that stores the session. This service is available in the Symfony application via the session.storage.factory service alias. The class has to implement SessionStorageFactoryInterface. To see a list of all available storages, run:

1

$ php bin/console debug:container session.storage.factory.

handler_id ¶

type: string default: 'session.handler.native_file'

The service id used for session storage. The default value 'session.handler.native_file' will let Symfony manage the sessions itself using files to store the session metadata. Set it to null to use the native PHP session mechanism. You can also store sessions in a database.

name ¶

type: string default: null

This specifies the name of the session cookie. By default, it will use the cookie name which is defined in the php.ini with the session.name directive.

cookie_lifetime ¶

type: integer default: null

This determines the lifetime of the session - in seconds. The default value - null - means that the session.cookie_lifetime value from php.ini will be used. Setting this value to 0 means the cookie is valid for the length of the browser session.

cookie_path ¶

type: string default: /

This determines the path to set in the session cookie. By default, it will use /.

cache_limiter ¶

type: string or int default: ''

If set to 0, Symfony won't set any particular header related to the cache and it will rely on the cache control method configured in the session.cache-limiter PHP.ini option.

Unlike the other session options, cache_limiter is set as a regular container parameter:

1
2
3
4

# config/services.yaml
parameters:
    session.storage.options:
        cache_limiter: 0

1
2
3
4
5
6
7
8
9
10
11
12
13

<!-- config/services.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd">

    <parameters>
        <parameter key="session.storage.options" type="collection">
            <parameter key="cache_limiter">0</parameter>
        </parameter>
    </parameters>
</container>

1
2
3
4

// config/services.php
$container->setParameter('session.storage.options', [
    'cache_limiter' => 0,
]);

cookie_domain ¶

type: string default: ''

This determines the domain to set in the session cookie. By default, it's blank, meaning the host name of the server which generated the cookie according to the cookie specification.

cookie_samesite ¶

type: string or null default: 'lax'

It controls the way cookies are sent when the HTTP request did not originate from the same domain that is associated with the cookies. Setting this option is recommended to mitigate CSRF security attacks.

By default, browsers send all cookies related to the domain of the HTTP request. This may be a problem for example when you visit a forum and some malicious comment includes a link like https://some-bank.com/?send_money_to=attacker&amount=1000. If you were previously logged into your bank website, the browser will send all those cookies when making that HTTP request.

The possible values for this option are:

• null, use it to disable this protection. Same behavior as in older Symfony versions.
  null、この保護を無効にするために使用します。古い Symfony バージョンと同じ動作。
• 'none' (or the Symfony\Component\HttpFoundation\Cookie::SAMESITE_NONE constant), use it to allow sending of cookies when the HTTP request originated from a different domain (previously this was the default behavior of null, but in newer browsers 'lax' would be applied when the header has not been set)
  'none' (または Symfony\Component\HttpFoundation\Cookie::SAMESITE_NONE 定数)、HTTP リクエストが別のドメインから発信された場合に Cookie の送信を許可するために使用します (以前は、これは null のデフォルトの動作でしたが、新しいブラウザーでは 'lax 'ヘッダーが設定されていない場合に適用されます)
• 'strict' (or the Cookie::SAMESITE_STRICT constant), use it to never send any cookie when the HTTP request did not originate from the same domain.
  'strict' (または Cookie::SAMESITE_STRICT 定数) を使用すると、HTTP 要求が同じドメインから発信されていない場合に、Cookie を送信しないようにできます。
• 'lax' (or the Cookie::SAMESITE_LAX constant), use it to allow sending cookies when the request originated from a different domain, but only when the user consciously made the request (by clicking a link or submitting a form with the GET method).
  'lax' (または Cookie::SAMESITE_LAX 定数) を使用すると、リクエストが別のドメインから発信された場合に Cookie の送信が許可されますが、ユーザーが意識的にリクエストを行った場合 (リンクをクリックするか、GET メソッドでフォームを送信することにより) に限られます。

cookie_secure ¶

type: boolean or 'auto' default: 'auto'

This determines whether cookies should only be sent over secure connections. In addition to true and false, there's a special 'auto' value that means true for HTTPS requests and false for HTTP requests.

cookie_httponly ¶

type: boolean default: true

This determines whether cookies should only be accessible through the HTTP protocol. This means that the cookie won't be accessible by scripting languages, such as JavaScript. This setting can effectively help to reduce identity theft through XSS attacks.

gc_divisor ¶

type: integer default: 100

See gc_probability.

gc_probability ¶

type: integer default: 1

This defines the probability that the garbage collector (GC) process is started on every session initialization. The probability is calculated by using gc_probability / gc_divisor, e.g. 1/100 means there is a 1% chance that the GC process will start on each request.

gc_maxlifetime ¶

type: integer default: 1440

This determines the number of seconds after which data will be seen as "garbage" and potentially cleaned up. Garbage collection may occur during session start and depends on gc_divisor and gc_probability.

sid_length ¶

type: integer default: 32

This determines the length of session ID string, which can be an integer between 22 and 256 (both inclusive), being 32 the recommended value. Longer session IDs are harder to guess.

This option is related to the session.sid_length PHP option.

sid_bits_per_character ¶

type: integer default: 4

This determines the number of bits in the encoded session ID character. The possible values are 4 (0-9, a-f), 5 (0-9, a-v), and 6 (0-9, a-z, A-Z, "-", ","). The more bits results in stronger session ID. 5 is recommended value for most environments.

This option is related to the session.sid_bits_per_character PHP option.

save_path ¶

type: string default: %kernel.cache_dir%/sessions

This determines the argument to be passed to the save handler. If you choose the default file handler, this is the path where the session files are created.

You can also set this value to the save_path of your php.ini by setting the value to null:

1
2
3
4

# config/packages/framework.yaml
framework:
    session:
        save_path: ~

1
2
3
4
5
6
7
8
9
10
11
12
13

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:session save-path="null"/>
    </framework:config>
</container>

1
2
3
4
5
6
7

// config/packages/framework.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework) {
    $framework->session()
        ->savePath(null);
};

metadata_update_threshold ¶

type: integer default: 0

This is how many seconds to wait between updating/writing the session metadata. This can be useful if, for some reason, you want to limit the frequency at which the session persists, instead of doing that on every request.

enabled ¶

type: boolean default: true

Whether to enable the session support in the framework.

1
2
3
4

# config/packages/framework.yaml
framework:
    session:
        enabled: true

1
2
3
4
5
6
7
8
9
10
11
12
13

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:session enabled="true"/>
    </framework:config>
</container>

1
2
3
4
5
6
7

// config/packages/framework.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework) {
    $framework->session()
        ->enabled(true);
};

use_cookies ¶

type: boolean default: null

This specifies if the session ID is stored on the client side using cookies or not. By default, it will use the value defined in the php.ini with the session.use_cookies directive.

base_path ¶

type: string

This option allows you to define a base path to be used for assets:

1
2
3
4
5

# config/packages/framework.yaml
framework:
    # ...
    assets:
        base_path: '/images'

1
2
3
4
5
6
7
8
9
10
11
12
13

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:assets base-path="/images"/>
    </framework:config>
</container>

1
2
3
4
5
6
7
8

// config/packages/framework.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework) {
    // ...
    $framework->assets()
        ->basePath('/images');
};

base_urls ¶

type: array

This option allows you to define base URLs to be used for assets. If multiple base URLs are provided, Symfony will select one from the collection each time it generates an asset's path:

1
2
3
4
5
6

# config/packages/framework.yaml
framework:
    # ...
    assets:
        base_urls:
            - 'http://cdn.example.com/'

1
2
3
4
5
6
7
8
9
10
11
12
13

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:assets base-url="http://cdn.example.com/"/>
    </framework:config>
</container>

1
2
3
4
5
6
7
8

// config/packages/framework.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework) {
    // ...
    $framework->assets()
        ->baseUrls(['http://cdn.example.com/']);
};

packages ¶

You can group assets into packages, to specify different base URLs for them:

1
2
3
4
5
6
7

# config/packages/framework.yaml
framework:
    # ...
    assets:
        packages:
            avatars:
                base_urls: 'http://static_cdn.example.com/avatars'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:assets>
            <framework:package
                name="avatars"
                base-url="http://static_cdn.example.com/avatars"/>
        </framework:assets>
    </framework:config>
</container>

1
2
3
4
5
6
7
8
9

// config/packages/framework.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework) {
    // ...
    $framework->assets()
        ->package('avatars')
            ->baseUrls(['http://static_cdn.example.com/avatars']);
};

Now you can use the avatars package in your templates:

1

<img src="{{ asset('...', 'avatars') }}">

Each package can configure the following options:

• base_path
  base_path
• base_urls
  base_urls
• version_strategy
  version_strategy
• version
  バージョン
• version_format
  version_format
• json_manifest_path
  json_manifest_path
• strict_mode
  strict_mode

version ¶

type: string

This option is used to bust the cache on assets by globally adding a query parameter to all rendered asset paths (e.g. /images/logo.png?v2). This applies only to assets rendered via the Twig asset() function (or PHP equivalent).

For example, suppose you have the following:

1

<img src="{{ asset('images/logo.png') }}" alt="Symfony!"/>

By default, this will render a path to your image such as /images/logo.png. Now, activate the version option:

1
2
3
4
5

# config/packages/framework.yaml
framework:
    # ...
    assets:
        version: 'v2'

1
2
3
4
5
6
7
8
9
10
11
12
13

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:assets version="v2"/>
    </framework:config>
</container>

1
2
3
4
5
6
7
8

// config/packages/framework.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework) {
    // ...
    $framework->assets()
        ->version('v2');
};

Now, the same asset will be rendered as /images/logo.png?v2 If you use this feature, you must manually increment the version value before each deployment so that the query parameters change.

You can also control how the query string works via the version_format option.

version_format ¶

type: string default: %%s?%%s

This specifies a sprintf pattern that will be used with the version option to construct an asset's path. By default, the pattern adds the asset's version as a query string. For example, if version_format is set to %%s?version=%%s and version is set to 5, the asset's path would be /images/logo.png?version=5.

version_strategy ¶

type: string default: null

The service id of the asset version strategy applied to the assets. This option can be set globally for all assets and individually for each asset package:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# config/packages/framework.yaml
framework:
    assets:
        # this strategy is applied to every asset (including packages)
        version_strategy: 'app.asset.my_versioning_strategy'
        packages:
            foo_package:
                # this package removes any versioning (its assets won't be versioned)
                version: ~
            bar_package:
                # this package uses its own strategy (the default strategy is ignored)
                version_strategy: 'app.asset.another_version_strategy'
            baz_package:
                # this package inherits the default strategy
                base_path: '/images'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:assets version-strategy="app.asset.my_versioning_strategy">
            <!-- this package removes any versioning (its assets won't be versioned) -->
            <framework:package
                name="foo_package"
                version="null"/>
            <!-- this package uses its own strategy (the default strategy is ignored) -->
            <framework:package
                name="bar_package"
                version-strategy="app.asset.another_version_strategy"/>
            <!-- this package inherits the default strategy -->
            <framework:package
                name="baz_package"
                base_path="/images"/>
        </framework:assets>
    </framework:config>
</container>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

// config/packages/framework.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework) {
    // ...
    $framework->assets()
        ->versionStrategy('app.asset.my_versioning_strategy');

    $framework->assets()->package('foo_package')
        // this package removes any versioning (its assets won't be versioned)
        ->version(null);

    $framework->assets()->package('bar_package')
        // this package uses its own strategy (the default strategy is ignored)
        ->versionStrategy('app.asset.another_version_strategy');

    $framework->assets()->package('baz_package')
        // this package inherits the default strategy
        ->basePath('/images');
};

json_manifest_path ¶

type: string default: null

The file path or absolute URL to a manifest.json file containing an associative array of asset names and their respective compiled names. A common cache-busting technique using a "manifest" file works by writing out assets with a "hash" appended to their file names (e.g. main.ae433f1cb.css) during a front-end compilation routine.

This option can be set globally for all assets and individually for each asset package:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# config/packages/framework.yaml
framework:
    assets:
        # this manifest is applied to every asset (including packages)
        json_manifest_path: "%kernel.project_dir%/public/build/manifest.json"
        # you can use absolute URLs too and Symfony will download them automatically
        # json_manifest_path: 'https://cdn.example.com/manifest.json'
        packages:
            foo_package:
                # this package uses its own manifest (the default file is ignored)
                json_manifest_path: "%kernel.project_dir%/public/build/a_different_manifest.json"
                # Throws an exception when an asset is not found in the manifest
                strict_mode: %kernel.debug%
            bar_package:
                # this package uses the global manifest (the default file is used)
                base_path: '/images'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <!-- this manifest is applied to every asset (including packages) -->
        <framework:assets json-manifest-path="%kernel.project_dir%/public/build/manifest.json">
        <!-- you can use absolute URLs too and Symfony will download them automatically -->
        <!-- <framework:assets json-manifest-path="https://cdn.example.com/manifest.json"> -->
            <!-- this package uses its own manifest (the default file is ignored) -->
            <!-- Throws an exception when an asset is not found in the manifest -->
            <framework:package
                name="foo_package"
                json-manifest-path="%kernel.project_dir%/public/build/a_different_manifest.json" strict-mode="%kernel.debug%"/>
            <!-- this package uses the global manifest (the default file is used) -->
            <framework:package
                name="bar_package"
                base-path="/images"/>
        </framework:assets>
    </framework:config>
</container>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

// config/packages/framework.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework) {
    // ...
    $framework->assets()
        // this manifest is applied to every asset (including packages)
        ->jsonManifestPath('%kernel.project_dir%/public/build/manifest.json');

    // you can use absolute URLs too and Symfony will download them automatically
    // 'json_manifest_path' => 'https://cdn.example.com/manifest.json',
    $framework->assets()->package('foo_package')
        // this package uses its own manifest (the default file is ignored)
        ->jsonManifestPath('%kernel.project_dir%/public/build/a_different_manifest.json')
        // Throws an exception when an asset is not found in the manifest
        ->setStrictMode('%kernel.debug%');

    $framework->assets()->package('bar_package')
        // this package uses the global manifest (the default file is used)
        ->basePath('/images');
};

strict_mode ¶

type: boolean default: false

When enabled, the strict mode asserts that all requested assets are in the manifest file. This option is useful to detect typos or missing assets, the recommended value is %kernel.debug%.

cache_dir ¶

type: string | null default: %kernel.cache_dir%/translations/

Defines the directory where the translation cache is stored. Use null to disable this cache.

enabled ¶

type: boolean default: true or false depending on your installation

Whether or not to enable the translator service in the service container.

fallbacks ¶

type: string|array default: value of default_locale

This option is used when the translation key for the current locale wasn't found.

logging ¶

default: true when the debug mode is enabled, false otherwise.

When true, a log entry is made whenever the translator cannot find a translation for a given key. The logs are made to the translation channel at the debug level for keys where there is a translation in the fallback locale, and the warning level if there is no translation to use at all.

formatter ¶

type: string default: translator.formatter.default

The ID of the service used to format translation messages. The service class must implement the MessageFormatterInterface.

paths ¶

type: array default: []

This option allows to define an array of paths where the component will look for translation files. The later a path is added, the more priority it has (translations from later paths overwrite earlier ones). Translations from the default_path have more priority than translations from all these paths.

default_path ¶

type: string default: %kernel.project_dir%/translations

This option allows to define the path where the application translations files are stored.

providers ¶

type: array default: []

This option enables and configures translation providers to push and pull your translations to/from third party translation services.

magic_call ¶

type: boolean default: false

When enabled, the property_accessor service uses PHP's magic __call() method when its getValue() method is called.

magic_get ¶

type: boolean default: true

When enabled, the property_accessor service uses PHP's magic __get() method when its getValue() method is called.

magic_set ¶

type: boolean default: true

When enabled, the property_accessor service uses PHP's magic __set() method when its setValue() method is called.

throw_exception_on_invalid_index ¶

type: boolean default: false

When enabled, the property_accessor service throws an exception when you try to access an invalid index of an array.

throw_exception_on_invalid_property_path ¶

type: boolean default: true

When enabled, the property_accessor service throws an exception when you try to access an invalid property path of an object.

enabled ¶

type: boolean default: true or false depending on your installation

enabled ¶

type: boolean default: true or false depending on your installation

Whether or not to enable validation support.

This option will automatically be set to true when one of the child settings is configured.

enable_annotations ¶

type: boolean default: false

If this option is enabled, validation constraints can be defined using annotations or attributes.

translation_domain ¶

type: string | false default: validators

The translation domain that is used when translating validation constraint error messages. Use false to disable translations.

not_compromised_password ¶

The NotCompromisedPassword constraint makes HTTP requests to a public API to check if the given password has been compromised in a data breach.

static_method ¶

type: string | array default: ['loadValidatorMetadata']

Defines the name of the static method which is called to load the validation metadata of the class. You can define an array of strings with the names of several methods. In that case, all of them will be called in that order to load the metadata.

email_validation_mode ¶

type: string default: loose

Sets the default value for the "mode" option of the Email validator.

mapping ¶

1
2
3
4
5
6

# config/packages/framework.yaml
framework:
    validation:
        mapping:
            paths:
                - "%kernel.project_dir%/config/validation/"

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:validation>
            <framework:mapping>
                <framework:path>%kernel.project_dir%/config/validation/</framework:path>
            </framework:mapping>
        </framework:validation>
    </framework:config>
</container>

1
2
3
4
5
6
7
8

// config/packages/framework.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework) {
    $framework->validation()
        ->mapping()
            ->paths(['%kernel.project_dir%/config/validation/']);
};

cache ¶

type: string default: 'php_array'

This option can be one of the following values:

php_array

Use a PHP array to cache annotations in memory

PHP 配列を使用して注釈をメモリにキャッシュする

file

Use the filesystem to cache annotations

ファイルシステムを使用して注釈をキャッシュする

none

Disable the caching of annotations

注釈のキャッシュを無効にする

file_cache_dir ¶

type: string default: '%kernel.cache_dir%/annotations'

The directory to store cache files for annotations, in case annotations.cache is set to 'file'.

debug ¶

type: boolean default: %kernel.debug%

Whether to enable debug mode for caching. If enabled, the cache will automatically update when the original file is changed (both with code and annotation changes). For performance reasons, it is recommended to disable debug mode in production, which will happen automatically if you use the default value.

decryption_env_var ¶

type: string default: base64:default::SYMFONY_DECRYPTION_SECRET

The environment variable that contains the decryption key.

local_dotenv_file ¶

type: string default: %kernel.project_dir%/.env.%kernel.environment%.local

Path to an dotenv file that holds secrets. This is primarily used for testing.

vault_directory ¶

type: string default: %kernel.project_dir%/config/secrets/%kernel.environment%

The directory where the vault of secrets is stored.

enabled ¶

type: boolean default: true or false depending on your installation

Whether to enable the serializer service or not in the service container.

enable_annotations ¶

type: boolean default: false

If this option is enabled, serialization groups can be defined using annotations or attributes.

name_converter ¶

type: string

The name converter to use. The CamelCaseToSnakeCaseNameConverter name converter can enabled by using the serializer.name_converter.camel_case_to_snake_case value.

circular_reference_handler ¶

type string

The service id that is used as the circular reference handler of the default serializer. The service has to implement the magic __invoke($object) method.

mapping ¶

default_context ¶

type: array default: []

A map with default context options that will be used with each serialize and deserialize call. This can be used for example to set the json encoding behavior by setting json_encode_options to a json_encode flags bitmask.

You can inspect the serializer context builders to discover the available settings.

log ¶

type: boolean|int default: %kernel.debug%

Use the application logger instead of the PHP logger for logging PHP errors. When an integer value is used, it also sets the log level. Those integer values must be the same used in the error_reporting PHP option.

This option also accepts a map of PHP errors to log levels:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# config/packages/framework.yaml
framework:
    php_errors:
        log:
            '!php/const \E_DEPRECATED': !php/const Psr\Log\LogLevel::ERROR
            '!php/const \E_USER_DEPRECATED': !php/const Psr\Log\LogLevel::ERROR
            '!php/const \E_NOTICE': !php/const Psr\Log\LogLevel::ERROR
            '!php/const \E_USER_NOTICE': !php/const Psr\Log\LogLevel::ERROR
            '!php/const \E_STRICT': !php/const Psr\Log\LogLevel::ERROR
            '!php/const \E_WARNING': !php/const Psr\Log\LogLevel::ERROR
            '!php/const \E_USER_WARNING': !php/const Psr\Log\LogLevel::ERROR
            '!php/const \E_COMPILE_WARNING': !php/const Psr\Log\LogLevel::ERROR
            '!php/const \E_CORE_WARNING': !php/const Psr\Log\LogLevel::ERROR
            '!php/const \E_USER_ERROR': !php/const Psr\Log\LogLevel::CRITICAL
            '!php/const \E_RECOVERABLE_ERROR': !php/const Psr\Log\LogLevel::CRITICAL
            '!php/const \E_COMPILE_ERROR': !php/const Psr\Log\LogLevel::CRITICAL
            '!php/const \E_PARSE': !php/const Psr\Log\LogLevel::CRITICAL
            '!php/const \E_ERROR': !php/const Psr\Log\LogLevel::CRITICAL
            '!php/const \E_CORE_ERROR': !php/const Psr\Log\LogLevel::CRITICAL

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <!-- in XML configuration you cannot use PHP constants as the value of
             the 'type' attribute, which makes this format way less readable.
             Consider using YAML or PHP for this configuration -->
        <framework:log type="8" logLevel="error"/>
        <framework:log type="2" logLevel="error"/>
        <!-- ... -->
    </framework:config>
</container>

1
2
3
4
5
6
7
8
9

// config/packages/framework.php
use Psr\Log\LogLevel;
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework) {
    $framework->phpErrors()->log(\E_DEPRECATED, LogLevel::ERROR);
    $framework->phpErrors()->log(\E_USER_DEPRECATED, LogLevel::ERROR);
    // ...
};

throw ¶

type: boolean default: %kernel.debug%

Throw PHP errors as \ErrorException instances. The parameter debug.error_handler.throw_at controls the threshold.

app ¶

type: string default: cache.adapter.filesystem

The cache adapter used by the cache.app service. The FrameworkBundle ships with multiple adapters: cache.adapter.apcu, cache.adapter.doctrine, cache.adapter.system, cache.adapter.filesystem, cache.adapter.psr6, cache.adapter.redis, cache.adapter.memcached and cache.adapter.pdo.

There's also a special adapter called cache.adapter.array which stores contents in memory using a PHP array and it's used to disable caching (mostly on the dev environment).

system ¶

type: string default: cache.adapter.system

The cache adapter used by the cache.system service. It supports the same adapters available for the cache.app service.

directory ¶

type: string default: %kernel.cache_dir%/pools

The path to the cache directory used by services inheriting from the cache.adapter.filesystem adapter (including cache.app).

default_doctrine_provider ¶

type: string

The service name to use as your default Doctrine provider. The provider is available as the cache.default_doctrine_provider service.

default_psr6_provider ¶

type: string

The service name to use as your default PSR-6 provider. It is available as the cache.default_psr6_provider service.

default_redis_provider ¶

type: string default: redis://localhost

The DSN to use by the Redis provider. The provider is available as the cache.default_redis_provider service.

default_memcached_provider ¶

type: string default: memcached://localhost

The DSN to use by the Memcached provider. The provider is available as the cache.default_memcached_provider service.

default_pdo_provider ¶

type: string default: doctrine.dbal.default_connection

The service id of the database connection, which should be either a PDO or a Doctrine DBAL instance. The provider is available as the cache.default_pdo_provider service.

pools ¶

type: array

A list of cache pools to be created by the framework extension.

To configure a Redis cache pool with a default lifetime of 1 hour, do the following:

1
2
3
4
5
6
7

# config/packages/framework.yaml
framework:
    cache:
        pools:
            cache.mycache:
                adapter: cache.adapter.redis
                default_lifetime: 3600

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:cache>
            <framework:pool
                name="cache.mycache"
                adapter="cache.adapter.redis"
                default-lifetime="3600"
            />
        </framework:cache>
        <!-- ... -->
    </framework:config>
</container>

1
2
3
4
5
6
7
8
9

// config/packages/framework.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework) {
    $framework->cache()
        ->pool('cache.mycache')
            ->adapters(['cache.adapter.redis'])
            ->defaultLifetime(3600);
};

prefix_seed ¶

type: string default: _%kernel.project_dir%.%kernel.container_class%

This value is used as part of the "namespace" generated for the cache item keys. A common practice is to use the unique name of the application (e.g. symfony.com) because that prevents naming collisions when deploying multiple applications into the same path (on different servers) that share the same cache backend.

It's also useful when using blue/green deployment strategies and more generally, when you need to abstract out the actual deployment directory (for example, when warming caches offline).

enabled ¶

type: boolean default: true

Whether to enable the support for lock or not. This setting is automatically set to true when one of the child settings is configured.

resources ¶

type: array

A map of lock stores to be created by the framework extension, with the name as key and DSN as value:

1
2
3

# config/packages/lock.yaml
framework:
    lock: '%env(LOCK_DSN)%'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

<!-- config/packages/lock.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:lock>
            <framework:resource name="default">%env(LOCK_DSN)%</framework:resource>
        </framework:lock>
    </framework:config>
</container>

1
2
3
4
5
6
7

// config/packages/lock.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework) {
    $framework->lock()
        ->resource('default', [env('LOCK_DSN')]);
};

enabled ¶

type: boolean default: true

Whether to enable the support for semaphore or not. This setting is automatically set to true when one of the child settings is configured.

resources ¶

type: array

A map of semaphore stores to be created by the framework extension, with the name as key and DSN as value:

1
2
3

# config/packages/semaphore.yaml
framework:
    semaphore: '%env(SEMAPHORE_DSN)%'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

<!-- config/packages/semaphore.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:semaphore>
            <framework:resource name="default">%env(SEMAPHORE_DSN)%</framework:resource>
        </framework:semaphore>
    </framework:config>
</container>

1
2
3
4
5
6
7

// config/packages/semaphore.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework) {
    $framework->semaphore()
        ->resource('default', ['%env(SEMAPHORE_DSN)%']);
};

dsn ¶

type: string default: null

The DSN used by the mailer. When several DSN may be used, use transports option (see below) instead.

transports ¶

type: array

A list of DSN that can be used by the mailer. A transport name is the key and the dsn is the value.

message_bus ¶

type: string default: null or default bus if Messenger component is installed

Service identifier of the message bus to use when using the Messenger component (e.g. messenger.default_bus).

envelope ¶

1
2
3
4
5
6

# config/packages/mailer.yaml
framework:
    mailer:
        dsn: 'smtp://localhost:25'
        envelope:
            recipients: ['admin@symfony.com', 'lead@symfony.com']

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

<!-- config/packages/mailer.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
    <framework:config>
        <framework:mailer dsn="smtp://localhost:25">
            <framework:envelope>
                <framework:recipient>admin@symfony.com</framework:recipient>
                <framework:recipient>lead@symfony.com</framework:recipient>
            </framework:envelope>
        </framework:mailer>
    </framework:config>
</container>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

// config/packages/mailer.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

return static function (ContainerConfigurator $containerConfigurator): void {
    $containerConfigurator->extension('framework', [
        'mailer' => [
            'dsn' => 'smtp://localhost:25',
            'envelope' => [
                'recipients' => [
                    'admin@symfony.com',
                    'lead@symfony.com',
                ],
            ],
        ],
    ]);
};

headers ¶

type: array

Headers to add to emails. The key (name attribute in xml format) is the header name and value the header value.

enabled ¶

type: boolean default: true or false depending on your installation

Adds a Link HTTP header to the response.

enabled ¶

type: boolean default: false

Whether to enable the support for workflows or not. This setting is automatically set to true when one of the child settings is configured.

name ¶

type: prototype

Name of the workflow you want to create.