Skip to content

[Reference] Update the default values of some options #20940

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 6, 2025
Merged

[Reference] Update the default values of some options #20940

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions reference/configuration/framework.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,32 +86,32 @@ trace_level

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)
(default: ``'full'`` if in debug; ``'none'`` otherwise)

trace_header
............

**type**: ``string``
**type**: ``string`` **default**: ``'X-Symfony-Cache'``

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

default_ttl
...........

**type**: ``integer``
**type**: ``integer`` **default**: ``0``

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)
Cache-Control or Expires headers override this value.

private_headers
...............

**type**: ``array``
**type**: ``array`` **default**: ``['Authorization', 'Cookie']``

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)
Cache-Control directive.

skip_response_headers
.....................
Expand All @@ -132,7 +132,7 @@ allow_reload

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)
for compliance with RFC 2616.

allow_revalidate
................
Expand All @@ -141,27 +141,27 @@ allow_revalidate

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)
for compliance with RFC 2616.

stale_while_revalidate
......................

**type**: ``integer``
**type**: ``integer`` **default**: ``2``

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).
a stale response while it revalidates it in the background.
This setting is overridden by the stale-while-revalidate HTTP Cache-Control
extension (see RFC 5861).

stale_if_error
..............

**type**: ``integer``
**type**: ``integer`` **default**: ``60``

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
which the cache can serve a stale response when an error is encountered.
This setting is overridden by the stale-if-error HTTP
Cache-Control extension (see RFC 5861).

terminate_on_cache_hit
Expand Down