8000 Improve doc · symfony/symfony-docs@ff46950 · GitHub
[go: up one dir, main page]

Skip to content

Commit ff46950

Browse files
Improve doc
1 parent bf56559 commit ff46950

File tree

2 files changed

+18
-2
lines changed

2 files changed

+18
-2
lines changed

components/cache/cache_pools.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
single: Doctrine Cache
55
single: Redis Cache
66

7+
.. _component-cache-cache-pools:
8+
79
Cache Pools
810
===========
911

reference/configuration/framework.rst

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1476,6 +1476,12 @@ app
14761476

14771477
The cache adapter used by the ``cache.app`` service.
14781478

1479+
.. tip::
1480+
1481+
It might be tough to understand at the beginning, so to avoid confusion remember that all pools perform the
1482+
same actions but on different medium given the adapter they are based on. Internally, a pool wraps the definition
1483+
of an adapter.
1484+
14791485
.. note::
14801486

14811487
The framework bundle ships with multiple adapters: apcu, doctrine, system,
@@ -1524,6 +1530,10 @@ pools
15241530

15251531
A list of cache pools to be created by the framework extension.
15261532

1533+
.. seealso::
1534+
1535+
For more information about how pools works, see :ref:`cache pools <component-cache-cache-pools>`.
1536+
15271537
.. _reference-cache-pools-name:
15281538

15291539
name
@@ -1542,7 +1552,11 @@ adapter
15421552

15431553
**type**: ``string`` **default**: ``cache.app``
15441554

1545-
A cache adapter.
1555+
The name of the adapter to use. You could also use your own implementation.
1556+
1557+
.. note::
1558+
1559+
Your service MUST implement the :class:`Psr\\Cache\\CacheItemPoolInterface` interface.
15461560

15471561
public
15481562
######
@@ -1574,7 +1588,7 @@ The cache clearer used to clear your PSR-6 cache.
15741588

15751589
.. seealso::
15761590

1577-
For more information, see :class:`Symfony\\Component\\HttpKernel\\CacheClearer\\Psr6CacheClearer`
1591+
For more information, see :class:`Symfony\\Component\\HttpKernel\\CacheClearer\\Psr6CacheClearer`.
15781592

15791593
Full Default Configuration
15801594
--------------------------

0 commit comments

Comments
 (0)
0