8000 [Cache] Document "framework.cache" node · symfony/symfony-docs@cdf1046 · GitHub
[go: up one dir, main page]
Skip to content

Commit cdf1046

Browse files
geoffrey-briergeoffrey-brier
committed
[Cache] Document "framework.cache" node
1 parent 3b2a45c commit cdf1046

File tree

1 file changed

+144
-0
lines changed

1 file changed

+144
-0
lines changed

‎reference/configuration/framework.rst

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,20 @@ Configuration
102102
* :ref:`cache <reference-serializer-cache>`
103103
* :ref:`enable_annotations <reference-serializer-enable_annotations>`
104104
* :ref:`name_converter <reference-serializer-name_converter>`
105+
* :ref:`cache <reference-cache>`
106+
* :ref:`app <reference-cache-app>`
107+
* `system`_
108+
* `directory`_
109+
* `default_doctrine_provider`_
110+
* `default_psr6_provider`_
111+
* `default_redis_provider`_
112+
* `pools`_
113+
* :ref:`name <reference-cache-pools-name>`
114+
* `adapter`_
115+
* `public`_
116+
* `default_lifetime`_
117+
* `provider`_
118+
* `clearer`_
105119

106120
secret
107121
~~~~~~
@@ -1446,6 +1460,119 @@ value.
14461460
For more information, see
14471461
:ref:`component-serializer-converting-property-names-when-serializing-and-deserializing`.
14481462

1463+
.. _reference-cache:
1464+
1465+
cache
1466+
~~~~~
1467+
1468+
.. _reference-cache-app:
1469+
1470+
app
1471+
...
1472+
1473+
**type**: ``string`` **default**: ``cache.adapter.filesystem``
1474+
1475+
The cache adapter behind the ``cache.app`` service.
1476+
1477+
.. note::
1478+
1479+
The framework bundle ships with multiple adapters : apcu, doctrine, system, filesystem, psr6, redis.
1480+
1481+
system
1482+
......
1483+
1484+
**type**: ``string`` **default**: ``cache.adapter.system``
1485+
1486+
The cache adapter behind the ``cache.system`` service.
1487+
1488+
directory
1489+
.........
1490+
1491+
**type**: ``string`` **default**: ``%kernel.cache_dir%/pools``
1492+
1493+
The path to the cache directory used by services inheriting from the ``cache.adapter.filesystem`` adapter
1494+
(including ``cache.app``).
1495+
1496+
default_doctrine_provider
1497+
.........................
1498+
1499+
**type**: ``string``
1500+
1501+
The service name to use as your default doctrine provider.
1502+
1503+
default_psr6_provider
1504+
.....................
1505+
1506+
**type**: ``string`` **default**: ``%kernel.cache_dir%/pools``
1507+
1508+
The service name to use as your default psr6 provider.
1509+
1510+
default_redis_provider
1511+
......................
1512+
1513+
**type**: ``string`` **default**: ``redis://localhost``
1514+
1515+
The dsn to use by the redis provider.
1516+
1517+
pools
1518+
.....
1519+
1520+
**type**: ``array``
1521+
1522+
A list of cache pools to be created by the framework extension.
1523+
1524+
.. _reference-cache-pools-name:
1525+
1526+
name
1527+
""""
1528+
1529+
**type**: ``prototype``
1530+
1531+
Name of the pool you want to create.
1532+
1533+
.. note::
1534+
1535+
Your pool name must differ from ``cache.app`` or ``cache.system``.
1536+
1537+
adapter
1538+
#######
1539+
1540+
**type**: ``string`` **default**: ``cache.app``
1541+
1542+
A cache adapter.
1543+
1544+
public
1545+
######
1546+
1547+
**type**: ``boolean`` **default**: ``false``
1548+
1549+
Whether your service should be public or not.
1550+
1551+
default_lifetime
1552+
################
1553+
1554+
**type**: ``integer``
1555+
1556+
Default lifetime of your cache items.
1557+
1558+
provider
1559+
########
1560+
1561+
**type**: ``string``
1562+
1563+
The service name to use as provider when the specified adapter needs one.
1564+
1565+
clearer
1566+
#######
1567+
1568+
**type**: ``string``
1569+
1570+
The cache clearer used to clear your PSR-6 cache.
1571+
1572+
.. seealso::
1573+
1574+
For more information, see :class:`Symfony\\Component\\HttpKernel\\CacheClearer\\Psr6CacheClearer`
1575+
14491576
Full Default Configuration
14501577
--------------------------
14511578

@@ -1580,6 +1707,23 @@ Full Default Configuration
15801707
file_cache_dir: '%kernel.cache_dir%/annotations'
15811708
debug: '%kernel.debug%'
15821709
1710+
# cache configuration
1711+
cache:
1712+
app: cache.app
1713+
system: cache.system
1714+
directory: '%kernel.cache_dir%/pools'
1715+
default_doctrine_provider: ~
1716+
default_psr6_provider: ~
1717+
default_redis_provider: 'redis://localhost'
1718+
pools:
1719+
# Prototype
1720+
name:
1721+
adapter: cache.app
1722+
public: false
1723+
default_lifetime: ~
1724+
provider: ~
1725+
clearer: ~
1726+
15831727
.. _`HTTP Host header attacks`: http://www.skeletonscribe.net/2013/05/practical-http-host-header-attacks.html
15841728
.. _`Security Advisory Blog post`: https://symfony.com/blog/security-releases-symfony-2-0-24-2-1-12-2-2-5-and-2-3-3-released#cve-2013-4752-request-gethost-poisoning
15851729
.. _`Doctrine Cache`: http://docs.doctrine-project.org/projects/doctrine-common/en/latest/reference/caching.html

0 commit comments

Comments
 (0)
0