Skip to content

Commit 79fd49a

Browse files
committed
feature #7200 Added docs for framework.cache.prefix_seed (javiereguiluz)
This PR was squashed before being merged into the 3.2 branch (closes #7200). Discussion ---------- Added docs for framework.cache.prefix_seed This fixes #7162. The contents are a copy+paste of the excellent comments by @xabbuh and @nicolas-grekas in the related issue. Commits ------- 0bf898c Added docs for framework.cache.prefix_seed
2 parents fcd1e05 + 0bf898c commit 79fd49a

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

reference/configuration/framework.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,8 @@ Configuration
105105
* `php_errors`_
106106
* `log`_
107107
* `throw`_
108+
* `cache <reference-cache>`_
109+
* `prefix_seed`_
108110

109111
secret
110112
~~~~~~
@@ -1485,6 +1487,27 @@ throw
14851487
Throw PHP errors as ``\ErrorException`` instances. The parameter
14861488
``debug.error_handler.throw_at`` controls the threshold.
14871489

1490+
cache
1491+
~~~~~
1492+
1493+
prefix_seed
1494+
...........
1495+
1496+
.. versionadded:: 3.2
1497+
The ``prefix_seed`` option was introduced in Symfony 3.2.
1498+
1499+
**type**: ``string`` **default**: ``null``
1500+
1501+
If defined, this value is used as part of the "namespace" generated for the
1502+
cache item keys. A common practice is to use the unique name of the application
1503+
(e.g. ``symfony.com``) because that prevents naming collisions when deploying
1504+
multiple applications into the same path (on different servers) that share the
1505+
same cache backend.
1506+
1507+
It's also useful when using `blue/green deployment`_ strategies and more
1508+
generally, when you need to abstract out the actual deployment directory (for
1509+
example, when warming caches offline).
1510+
14881511
Full Default Configuration
14891512
--------------------------
14901513

@@ -1629,3 +1652,4 @@ Full Default Configuration
16291652
.. _`Doctrine Cache`: http://docs.doctrine-project.org/projects/doctrine-common/en/latest/reference/caching.html
16301653
.. _`egulias/email-validator`: https://github.com/egulias/EmailValidator
16311654
.. _`PhpStormProtocol`: https://github.com/aik099/PhpStormProtocol
1655+
.. _`blue/green deployment`: http://martinfowler.com/bliki/BlueGreenDeployment.html

0 commit comments

Comments
 (0)