diff --git a/cache.rst b/cache.rst index a22912c36b1..b0d65f52740 100644 --- a/cache.rst +++ b/cache.rst @@ -156,19 +156,19 @@ will create pools with service IDs that follow the pattern ``cache.[type]``. > diff --git a/components/cache/adapters/apcu_adapter.rst b/components/cache/adapters/apcu_adapter.rst index c85050e9b4c..99d76ce5d27 100644 --- a/components/cache/adapters/apcu_adapter.rst +++ b/components/cache/adapters/apcu_adapter.rst @@ -1,5 +1,3 @@ -.. _apcu-adapter: - APCu Cache Adapter ================== diff --git a/components/cache/adapters/chain_adapter.rst b/components/cache/adapters/chain_adapter.rst index 9a91234096e..586857d2e4d 100644 --- a/components/cache/adapters/chain_adapter.rst +++ b/components/cache/adapters/chain_adapter.rst @@ -1,5 +1,3 @@ -.. _component-cache-chain-adapter: - Chain Cache Adapter =================== diff --git a/components/cache/adapters/couchbasebucket_adapter.rst b/components/cache/adapters/couchbasebucket_adapter.rst index f1e0c13b2b0..5312371a2bb 100644 --- a/components/cache/adapters/couchbasebucket_adapter.rst +++ b/components/cache/adapters/couchbasebucket_adapter.rst @@ -1,5 +1,3 @@ -.. _couchbase-adapter: - Couchbase Bucket Cache Adapter ============================== @@ -8,8 +6,8 @@ Couchbase Bucket Cache Adapter The Couchbase Bucket adapter was introduced in Symfony 5.1. This adapter stores the values in-memory using one (or more) `Couchbase server`_ -instances. Unlike the :ref:`APCu adapter `, and similarly to the -:ref:`Memcached adapter `, it is not limited to the current server's +instances. Unlike the :doc:`APCu adapter `, and similarly to the +:doc:`Memcached adapter `, it is not limited to the current server's shared memory; you can store contents independent of your PHP environment. The ability to utilize a cluster of servers to provide redundancy and/or fail-over is also available. diff --git a/components/cache/adapters/couchbasecollection_adapter.rst b/components/cache/adapters/couchbasecollection_adapter.rst index a0c5e28c9a8..66586c816ee 100644 --- a/components/cache/adapters/couchbasecollection_adapter.rst +++ b/components/cache/adapters/couchbasecollection_adapter.rst @@ -1,5 +1,3 @@ -.. _couchbase-collection-adapter: - Couchbase Collection Cache Adapter ================================== @@ -8,8 +6,8 @@ Couchbase Collection Cache Adapter The Couchbase Collection adapter was introduced in Symfony 5.4. This adapter stores the values in-memory using one (or more) `Couchbase server`_ -instances. Unlike the :ref:`APCu adapter `, and similarly to the -:ref:`Memcached adapter `, it is not limited to the current server's +instances. Unlike the :doc:`APCu adapter `, and similarly to the +:doc:`Memcached adapter `, it is not limited to the current server's shared memory; you can store contents independent of your PHP environment. The ability to utilize a cluster of servers to provide redundancy and/or fail-over is also available. diff --git a/components/cache/adapters/doctrine_adapter.rst b/components/cache/adapters/doctrine_adapter.rst index 3b894e8388b..b345d310029 100644 --- a/components/cache/adapters/doctrine_adapter.rst +++ b/components/cache/adapters/doctrine_adapter.rst @@ -1,5 +1,3 @@ -.. _doctrine-adapter: - Doctrine Cache Adapter ====================== diff --git a/components/cache/adapters/doctrine_dbal_adapter.rst b/components/cache/adapters/doctrine_dbal_adapter.rst index 3b955832147..fc04410bffc 100644 --- a/components/cache/adapters/doctrine_dbal_adapter.rst +++ b/components/cache/adapters/doctrine_dbal_adapter.rst @@ -1,5 +1,3 @@ -.. _doctrine-dbal-adapter: - Doctrine DBAL Cache Adapter =========================== diff --git a/components/cache/adapters/filesystem_adapter.rst b/components/cache/adapters/filesystem_adapter.rst index 237ac3bc60e..4c447b3de82 100644 --- a/components/cache/adapters/filesystem_adapter.rst +++ b/components/cache/adapters/filesystem_adapter.rst @@ -1,10 +1,8 @@ -.. _component-cache-filesystem-adapter: - Filesystem Cache Adapter ======================== This adapter offers improved application performance for those who cannot install -tools like :ref:`APCu ` or :ref:`Redis ` in their +tools like :doc:`APCu ` or :doc:`Redis ` in their environment. It stores the cache item expiration and content as regular files in a collection of directories on a locally mounted filesystem. @@ -39,9 +37,10 @@ and cache root path as constructor parameters:: The overhead of filesystem IO often makes this adapter one of the *slower* choices. If throughput is paramount, the in-memory adapters - (:ref:`Apcu `, :ref:`Memcached `, and - :ref:`Redis `) or the database adapters - (:ref:`Doctrine DBAL `, :ref:`PDO `) are recommended. + (:doc:`Apcu `, :doc:`Memcached `, + and :doc:`Redis `) or the database adapters + (:doc:`Doctrine DBAL `, :doc:`PDO `) + are recommended. .. note:: diff --git a/components/cache/adapters/memcached_adapter.rst b/components/cache/adapters/memcached_adapter.rst index f2de83251c9..d68d3e3b9ac 100644 --- a/components/cache/adapters/memcached_adapter.rst +++ b/components/cache/adapters/memcached_adapter.rst @@ -1,11 +1,9 @@ -.. _memcached-adapter: - Memcached Cache Adapter ======================= This adapter stores the values in-memory using one (or more) `Memcached server`_ -instances. Unlike the :ref:`APCu adapter `, and similarly to the -:ref:`Redis adapter `, it is not limited to the current server's +instances. Unlike the :doc:`APCu adapter `, and similarly to the +:doc:`Redis adapter `, it is not limited to the current server's shared memory; you can store contents independent of your PHP environment. The ability to utilize a cluster of servers to provide redundancy and/or fail-over is also available. diff --git a/components/cache/adapters/pdo_adapter.rst b/components/cache/adapters/pdo_adapter.rst index 4920520196f..34815a51eb0 100644 --- a/components/cache/adapters/pdo_adapter.rst +++ b/components/cache/adapters/pdo_adapter.rst @@ -1,5 +1,3 @@ -.. _pdo-adapter: - PDO Cache Adapter ================= diff --git a/components/cache/adapters/php_files_adapter.rst b/components/cache/adapters/php_files_adapter.rst index dce77657292..efd2cf0e964 100644 --- a/components/cache/adapters/php_files_adapter.rst +++ b/components/cache/adapters/php_files_adapter.rst @@ -1,9 +1,7 @@ -.. _component-cache-files-adapter: - PHP Files Cache Adapter ======================= -Similarly to :ref:`Filesystem Adapter `, this cache +Similarly to :doc:`Filesystem Adapter `, this cache implementation writes cache entries out to disk, but unlike the Filesystem cache adapter, the PHP Files cache adapter writes and reads back these cache files *as native PHP code*. For example, caching the value ``['my', 'cached', 'array']`` will write out a cache diff --git a/components/cache/adapters/redis_adapter.rst b/components/cache/adapters/redis_adapter.rst index a7530e6d3f0..dc711d6b8e0 100644 --- a/components/cache/adapters/redis_adapter.rst +++ b/components/cache/adapters/redis_adapter.rst @@ -1,5 +1,3 @@ -.. _redis-adapter: - Redis Cache Adapter =================== @@ -12,8 +10,8 @@ Redis Cache Adapter This adapter stores the values in-memory using one (or more) `Redis server`_ instances. -Unlike the :ref:`APCu adapter `, and similarly to the -:ref:`Memcached adapter `, it is not limited to the current server's +Unlike the :doc:`APCu adapter `, and similarly to the +:doc:`Memcached adapter `, it is not limited to the current server's shared memory; you can store contents independent of your PHP environment. The ability to utilize a cluster of servers to provide redundancy and/or fail-over is also available. diff --git a/components/cache/cache_pools.rst b/components/cache/cache_pools.rst index bd4488f2b48..c92a22a136b 100644 --- a/components/cache/cache_pools.rst +++ b/components/cache/cache_pools.rst @@ -192,7 +192,7 @@ Pruning Cache Items ------------------- Some cache pools do not include an automated mechanism for pruning expired cache items. -For example, the :ref:`FilesystemAdapter ` cache +For example, the :doc:`FilesystemAdapter ` cache does not remove expired cache items *until an item is explicitly requested and determined to be expired*, for example, via a call to ``Psr\Cache\CacheItemPoolInterface::getItem``. Under certain workloads, this can cause stale cache entries to persist well past their @@ -202,11 +202,11 @@ expired cache items. This shortcoming has been solved through the introduction of :class:`Symfony\\Component\\Cache\\PruneableInterface`, which defines the abstract method :method:`Symfony\\Component\\Cache\\PruneableInterface::prune`. The -:ref:`ChainAdapter `, -:ref:`DoctrineDbalAdapter `, and -:ref:`FilesystemAdapter `, -:ref:`PdoAdapter `, and -:ref:`PhpFilesAdapter ` all implement this new interface, +:doc:`ChainAdapter `, +:doc:`DoctrineDbalAdapter `, and +:doc:`FilesystemAdapter `, +:doc:`PdoAdapter `, and +:doc:`PhpFilesAdapter ` all implement this new interface, allowing manual removal of stale cache items:: use Symfony\Component\Cache\Adapter\FilesystemAdapter; @@ -215,7 +215,7 @@ allowing manual removal of stale cache items:: // ... do some set and get operations $cache->prune(); -The :ref:`ChainAdapter ` implementation does not directly +The :doc:`ChainAdapter ` implementation does not directly contain any pruning logic itself. Instead, when calling the chain adapter's :method:`Symfony\\Component\\Cache\\Adapter\\ChainAdapter::prune` method, the call is delegated to all its compatible cache adapters (and those that do not implement ``PruneableInterface`` are