Skip to content

Added docs for framework.cache.prefix_seed #7200

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.

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

Closed
wants to merge 3 commits into from
Closed
Changes from all commits
Commits
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
24 changes: 24 additions & 0 deletions reference/configuration/framework.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ Configuration
* `php_errors`_
* `log`_
* `throw`_
* `cache <reference-cache>`_
* `prefix_seed`_

secret
~~~~~~
Expand Down Expand Up @@ -1463,6 +1465,27 @@ throw
Throw PHP errors as ``\ErrorException`` instances. The parameter
``debug.error_handler.throw_at`` controls the threshold.

cache
~~~~~

prefix_seed
...........

.. versionadded:: 3.2
The ``prefix_seed`` option was introduced in Symfony 3.2.

**type**: ``string`` **default**: ``null``

If defined, 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).

Full Default Configuration
--------------------------

Expand Down Expand Up @@ -1607,3 +1630,4 @@ Full Default Configuration
.. _`Doctrine Cache`: http://docs.doctrine-project.org/projects/doctrine-common/en/latest/reference/caching.html
.. _`egulias/email-validator`: https://github.com/egulias/EmailValidator
.. _`PhpStormProtocol`: https://github.com/aik099/PhpStormProtocol
.. _`blue/green deployment`: http://martinfowler.com/bliki/BlueGreenDeployment.html