Skip to content

Commit bea31d5

Browse files
committed
Improved the docs
1 parent ec4233c commit bea31d5

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ that…
1919
* …instead of re-implementing locking and caching mechanisms again, uses the well
2020
tested Symfony Cache and Lock components, both with the local filesystem adapters
2121
by default.
22-
* …thanks to the `TagAwareAdapter` of the Cache component, supports tag based cache
23-
invalidation.
22+
* …thanks to the `TagAwareAdapterInterface` of the Cache component, supports tag
23+
based cache invalidation.
2424
* …thanks to the `PrunableInterface` of the Cache component, supports auto-pruning
2525
of expired entries on the filesystem trying to prevent flooding the filesystem.
26-
* …allows you to use a different PSR-6 cache adapters as well as a differenent
26+
* …allows you to use a different PSR-6 cache adapters as well as a different
2727
lock adapter than the local filesystem ones.
2828
However, **be careful about choosing the right adapters**, see warning below.
2929

@@ -86,8 +86,11 @@ passing an array of `$options` in the constructor:
8686

8787
**Type**: `string`
8888

89-
* **cache**: Explicitly specify the cache adapter you want to use. Make sure
90-
that `lock` and `cache` have the same scope. *See warning below!*
89+
* **cache**: Explicitly specify the cache adapter you want to use.
90+
91+
Note that if you want to make use of cache tagging, this cache must
92+
implement the `Symfony\Component\Cache\Adapter\TagAwareAdapterInterface`
93+
Make sure that `lock` and `cache` have the same scope. *See warning below!*
9194

9295
**Type**: `Symfony\Component\Cache\Adapter\AdapterInterface`
9396
**Default**: `FilesystemAdapter` instance with `cache_directory`

src/Psr6Store.php

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,11 @@ class Psr6Store implements Psr6StoreInterface
7272
* adapter and lock factory.
7373
*
7474
* - cache: Explicitly specify the cache adapter you want to
75-
* use. Make sure that lock and cache have the same
75+
* use. Note that if you want to make use of cache
76+
* tagging, this cache must implement the
77+
* Symfony\Component\Cache\Adapter\TagAwareAdapterInterface
78+
*
79+
* Make sure that lock and cache have the same
7680
* scope. *Read the warning in the README!*
7781
*
7882
* Type: Symfony\Component\Cache\Adapter\AdapterInterface

0 commit comments

Comments
 (0)