Skip to content

Commit 12e9a3c

Browse files
geoffrey-brierxabbuh
authored andcommitted
[Cache] Document "framework.cache" node
1 parent c5ef9e1 commit 12e9a3c

File tree

1 file changed

+140
-0
lines changed

1 file changed

+140
-0
lines changed

reference/configuration/framework.rst

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,19 @@ Configuration
106106
* `log`_
107107
* `throw`_
108108
* :ref:`cache <reference-cache>`
109+
* :ref:`app <reference-cache-app>`
110+
* `system`_
111+
* `directory`_
112+
* `default_doctrine_provider`_
113+
* `default_psr6_provider`_
114+
* `default_redis_provider`_
115+
* `pools`_
116+
* :ref:`name <reference-cache-pools-name>`
117+
* `adapter`_
118+
* `public`_
119+
* `default_lifetime`_
120+
* `provider`_
121+
* `clearer`_
109122
* `prefix_seed`_
110123

111124
secret
@@ -696,6 +709,8 @@ installation.
696709
You can see an example of the usage of this in
697710
:doc:`/doctrine/pdo_session_storage`.
698711

712+
.. _name:
713+
699714
name
700715
....
701716

@@ -1567,6 +1582,114 @@ Throw PHP errors as ``\ErrorException`` instances. The parameter
15671582
cache
15681583
~~~~~
15691584

1585+
.. _reference-cache-app:
1586+
1587+
app
1588+
...
1589+
1590+
**type**: ``string`` **default**: ``cache.adapter.filesystem``
1591+
1592+
The cache adapter behind the ``cache.app`` service.
1593+
1594+
.. note::
1595+
1596+
The framework bundle ships with multiple adapters : apcu, doctrine, system, filesystem, psr6, redis.
1597+
1598+
system
1599+
......
1600+
1601+
**type**: ``string`` **default**: ``cache.adapter.system``
1602+
1603+
The cache adapter behind the ``cache.system`` service.
1604+
1605+
directory
1606+
.........
1607+
1608+
**type**: ``string`` **default**: ``%kernel.cache_dir%/pools``
1609+
1610+
The path to the cache directory used by services inheriting from the ``cache.adapter.filesystem`` adapter
1611+
(including ``cache.app``).
1612+
1613+
default_doctrine_provider
1614+
.........................
1615+
1616+
**type**: ``string``
1617+
1618+
The service name to use as your default doctrine provider.
1619+
1620+
default_psr6_provider
1621+
.....................
1622+
1623+
**type**: ``string`` **default**: ``%kernel.cache_dir%/pools``
1624+
1625+
The service name to use as your default psr6 provider.
1626+
1627+
default_redis_provider
1628+
......................
1629+
1630+
**type**: ``string`` **default**: ``redis://localhost``
1631+
1632+
The dsn to use by the redis provider.
1633+
1634+
pools
1635+
.....
1636+
1637+
**type**: ``array``
1638+
1639+
A list of cache pools to be created by the framework extension.
1640+
1641+
.. _reference-cache-pools-name:
1642+
1643+
name
1644+
""""
1645+
1646+
**type**: ``prototype``
1647+
1648+
Name of the pool you want to create.
1649+
1650+
.. note::
1651+
1652+
Your pool name must differ from ``cache.app`` or ``cache.system``.
1653+
1654+
adapter
1655+
#######
1656+
1657+
**type**: ``string`` **default**: ``cache.app``
1658+
1659+
A cache adapter.
1660+
1661+
public
1662+
######
1663+
1664+
**type**: ``boolean`` **default**: ``false``
1665+
1666+
Whether your service should be public or not.
1667+
1668+
default_lifetime
1669+
################
1670+
1671+
**type**: ``integer``
1672+
1673+
Default lifetime of your cache items.
1674+
1675+
provider
1676+
########
1677+
1678+
**type**: ``string``
1679+
1680+
The service name to use as provider when the specified adapter needs one.
1681+
1682+
clearer
1683+
#######
1684+
1685+
**type**: ``string``
1686+
1687+
The cache clearer used to clear your PSR-6 cache.
1688+
1689+
.. seealso::
1690+
1691+
For more information, see :class:`Symfony\\Component\\HttpKernel\\CacheClearer\\Psr6CacheClearer`
1692+
15701693
prefix_seed
15711694
...........
15721695

@@ -1724,6 +1847,23 @@ Full Default Configuration
17241847
log: false
17251848
throw: '%kernel.debug%'
17261849
1850+
# cache configuration
1851+
cache:
1852+
app: cache.app
1853+
system: cache.system
1854+
directory: '%kernel.cache_dir%/pools'
1855+
default_doctrine_provider: ~
1856+
default_psr6_provider: ~
1857+
default_redis_provider: 'redis://localhost'
1858+
pools:
1859+
# Prototype
1860+
name:
1861+
adapter: cache.app
1862+
public: false
1863+
default_lifetime: ~
1864+
provider: ~
1865+
clearer: ~
1866+
17271867
.. _`HTTP Host header attacks`: http://www.skeletonscribe.net/2013/05/practical-http-host-header-attacks.html
17281868
.. _`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
17291869
.. _`Doctrine Cache`: http://docs.doctrine-project.org/projects/doctrine-common/en/latest/reference/caching.html

0 commit comments

Comments
 (0)