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

Commit 716f826

Browse files
geoffrey-briergeoffrey-brier
committed
[Cache] Document "framework.cache.directory" option
1 parent 3b2a45c commit 716f826

File tree

1 file changed

+154
-0
lines changed

1 file changed

+154
-0
lines changed

‎reference/configuration/framework.rst

Lines changed: 154 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+
* `name`_
114+
* `adapter`_
115+
* `public`_
116+
* `default_lifetime`_
117+
* `provider`_
118+
* `clearer`_
105119

106120
secret
107121
~~~~~~
@@ -1446,6 +1460,129 @@ 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+
Available adapters are:
1478+
- cache.adapter.apcu
1479+
- cache.adapter.doctrine
1480+
- cache.adapter.system
1481+
- cache.adapter.filesystem
1482+
- cache.adapter.psr6
1483+
- cache.adapter.redis
1484+
1485+
system
1486+
......
1487+
1488+
**type**: ``string`` **default**: ``cache.adapter.system``
1489+
1490+
The cache adapter behind the ``cache.system`` service.
1491+
1492+
Available adapters are:
1493+
1494+
- cache.adapter.apcu
1495+
- cache.adapter.doctrine
1496+
- cache.adapter.system
1497+
- cache.adapter.filesystem
1498+
- cache.adapter.psr6
1499+
- cache.adapter.redis
1500+
1501+
directory
1502+
.........
1503+
1504+
**type**: ``string`` **default**: ``%kernel.cache_dir%/pools``
1505+
1506+
The path to the cache directory used by the ``cache.adapter.filesystem`` adapter.
1507+
1508+
default_doctrine_provider
1509+
.........................
1510+
1511+
**type**: ``string``
1512+
1513+
The service name to use as the doctrine provider.
1514+
1515+
default_psr6_provider
1516+
.....................
1517+
1518+
**type**: ``string`` **default**: ``%kernel.cache_dir%/pools``
1519+
1520+
The service name to use as the psr6 provider.
1521+
1522+
default_redis_provider
1523+
......................
1524+
1525+
**type**: ``string`` **default**: ``redis://localhost``
1526+
1527+
The dsn to use as the redis provider.
1528+
1529+
pools
1530+
.....
1531+
1532+
**type**: ``array``
1533+
1534+
A list of cache pools to be created by the framework extension.
1535+
1536+
name
1537+
""""
1538+
1539+
**type**: ``prototype``
1540+
1541+
Name of the pool you want to create.
1542+
1543+
.. note::
1544+
1545+
Your pool names must differ from ``cache.app`` or ``cache.system``.
1546+
1547+
adapter
1548+
#######
1549+
1550+
**type**: ``string`` **default**: ``cache.app``
1551+
1552+
A cache adapter.
1553+
1554+
public
1555+
######
1556+
1557+
**type**: ``boolean`` **default**: ``false``
1558+
1559+
Whether your service should be public or not.
1560+
1561+
default_lifetime
1562+
################
1563+
1564+
**type**: ``integer``
1565+
1566+
Default lifetime of your cache items.
1567+
1568+
provider
1569+
########
1570+
1571+
**type**: ``string``
1572+
1573+
The service name to use as provider when the specified adapter needs one.
1574+
1575+
clearer
1576+
#######
1577+
1578+
**type**: ``string``
1579+
1580+
The cache clearer to use to clear your PSR-6 cache.
1581+
1582+
.. note::
1583+
1584+
For more information see :class:`Symfony\Component\HttpKernel\CacheClearer\Psr6CacheClearer`
1585+
14491586
Full Default Configuration
14501587
--------------------------
14511588

@@ -1580,6 +1717,23 @@ Full Default Configuration
15801717
file_cache_dir: '%kernel.cache_dir%/annotations'
15811718
debug: '%kernel.debug%'
15821719
1720+
# cache configuration
1721+
cache:
1722+
app: cache.app
1723+
system: cache.system
1724+
directory: '%kernel.cache_dir%/pools'
1725+
default_doctrine_provider: ~
1726+
default_psr6_provider: ~
1727+
default_redis_provider: 'redis://localhost'
1728+
pools:
1729+
# Prototype
1730+
name:
1731+
adapter: cache.app
1732+
public: false
1733+
default_lifetime: ~
1734+
provider: ~
1735+
clearer: ~
1736+
15831737
.. _`HTTP Host header attacks`: http://www.skeletonscribe.net/2013/05/practical-http-host-header-attacks.html
15841738
.. _`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
15851739
.. _`Doctrine Cache`: http://docs.doctrine-project.org/projects/doctrine-common/en/latest/reference/caching.html

0 commit comments

Comments
 (0)
0