@@ -109,6 +109,19 @@ Configuration
109
109
* `log `_
110
110
* `throw `_
111
111
* :ref: `cache <reference-cache >`
112
+ * :ref: `app <reference-cache-app >`
113
+ * `system `_
114
+ * `directory `_
115
+ * `default_doctrine_provider `_
116
+ * `default_psr6_provider `_
117
+ * `default_redis_provider `_
118
+ * `pools `_
119
+ * :ref: `name <reference-cache-pools-name >`
120
+ * `adapter `_
121
+ * `public `_
122
+ * `default_lifetime `_
123
+ * `provider `_
124
+ * `clearer `_
112
125
* `prefix_seed `_
113
126
114
127
secret
@@ -699,6 +712,8 @@ installation.
699
712
You can see an example of the usage of this in
700
713
:doc: `/doctrine/pdo_session_storage `.
701
714
715
+ .. _name :
716
+
702
717
name
703
718
....
704
719
@@ -1599,6 +1614,129 @@ Throw PHP errors as ``\ErrorException`` instances. The parameter
1599
1614
cache
1600
1615
~~~~~
1601
1616
1617
+ .. _reference-cache-app :
1618
+
1619
+ app
1620
+ ...
1621
+
1622
+ **type **: ``string `` **default **: ``cache.adapter.filesystem ``
1623
+
1624
+ The cache adapter used by the ``cache.app `` service. The FrameworkBundle
1625
+ ships with multiple adapters: ``apcu ``, ``doctrine ``, ``system ``, ``filesystem ``,
1626
+ ``psr6 `` and ``redis ``.
1627
+
1628
+ .. tip ::
1629
+
1630
+ It might be tough to understand at the beginning, so to avoid confusion remember that all pools perform the
1631
+ same actions but on different medium given the adapter they are based on. Internally, a pool wraps the definition
1632
+ of an adapter.
1633
+
1634
+ system
1635
+ ......
1636
+
1637
+ **type **: ``string `` **default **: ``cache.adapter.system ``
1638
+
1639
+ The cache adapter used by the ``cache.system `` service.
1640
+
1641
+ directory
1642
+ .........
1643
+
1644
+ **type **: ``string `` **default **: ``%kernel.cache_dir%/pools ``
1645
+
1646
+ The path to the cache directory used by services inheriting from the
1647
+ ``cache.adapter.filesystem `` adapter (including ``cache.app ``).
1648
+
1649
+ default_doctrine_provider
1650
+ .........................
1651
+
1652
+ **type **: ``string ``
1653
+
1654
+ The service name to use as your default Doctrine provider. The provider is
1655
+ available as the ``cache.doctrine `` service.
1656
+
1657
+ default_psr6_provider
1658
+ .....................
1659
+
1660
+ **type **: ``string ``
1661
+
1662
+ The service name to use as your default PSR-6 provider. It is available as
1663
+ the ``cache.psr6 `` service.
1664
+
1665
+ default_redis_provider
1666
+ ......................
1667
+
1668
+ **type **: ``string `` **default **: ``redis://localhost ``
1669
+
1670
+ The DSN to use by the Redis provider. The provider is available as the ``cache.redis ``
1671
+ service.
1672
+
1673
+ pools
1674
+ .....
1675
+
1676
+ **type **: ``array ``
1677
+
1678
+ A list of cache pools to be created by the framework extension.
1679
+
1680
+ .. seealso ::
1681
+
1682
+ For more information about how pools works, see :ref: `cache pools <component-cache-cache-pools >`.
1683
+
1684
+ .. _reference-cache-pools-name :
1685
+
1686
+ name
1687
+ """"
1688
+
1689
+ **type **: ``prototype ``
1690
+
1691
+ Name of the pool you want to create.
1692
+
1693
+ .. note ::
1694
+
1695
+ Your pool name must differ from ``cache.app `` or ``cache.system ``.
1696
+
1697
+ adapter
1698
+ """""""
1699
+
1700
+ **type **: ``string `` **default **: ``cache.app ``
1701
+
1702
+ The name of the adapter to use. You could also use your own implementation.
1703
+
1704
+ .. note ::
1705
+
1706
+ Your service MUST implement the :class: `Psr\\ Cache\\ CacheItemPoolInterface ` interface.
1707
+
1708
+ public
1709
+ """"""
1710
+
1711
+ **type **: ``boolean `` **default **: ``false ``
1712
+
1713
+ Whether your service should be public or not.
1714
+
1715
+ default_lifetime
1716
+ """"""""""""""""
1717
+
1718
+ **type **: ``integer ``
1719
+
1720
+ Default lifetime of your cache items in seconds.
1721
+
1722
+ provider
1723
+ """"""""
1724
+
1725
+ **type **: ``string ``
1726
+
1727
+ The service name to use as provider when the specified adapter needs one.
1728
+
1729
+ clearer
1730
+ """""""
1731
+
1732
+ **type **: ``string ``
1733
+
1734
+ The cache clearer used to clear your PSR-6 cache.
1735
+
1736
+ .. seealso ::
1737
+
1738
+ For more information, see :class: `Symfony\\ Component\\ HttpKernel\\ CacheClearer\\ Psr6CacheClearer `.
1739
+
1602
1740
prefix_seed
1603
1741
...........
1604
1742
@@ -1761,6 +1899,23 @@ Full Default Configuration
1761
1899
log : false
1762
1900
throw : ' %kernel.debug%'
1763
1901
1902
+ # cache configuration
1903
+ cache :
1904
+ app : cache.app
1905
+ system : cache.system
1906
+ directory : ' %kernel.cache_dir%/pools'
1907
+ default_doctrine_provider : ~
1908
+ default_psr6_provider : ~
1909
+ default_redis_provider : ' redis://localhost'
1910
+ pools :
1911
+ # Prototype
1912
+ name :
1913
+ adapter : cache.app
1914
+ public : false
1915
+ default_lifetime : ~
1916
+ provider : ~
1917
+ clearer : ~
1918
+
1764
1919
.. _`HTTP Host header attacks` : http://www.skeletonscribe.net/2013/05/practical-http-host-header-attacks.html
1765
1920
.. _`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
1766
1921
.. _`Doctrine Cache` : http://docs.doctrine-project.org/projects/doctrine-common/en/latest/reference/caching.html
0 commit comments