Skip to content

Commit 8c624e6

Browse files
committed
doc cleanup
1 parent 6b2e74a commit 8c624e6

File tree

2 files changed

+26
-17
lines changed

2 files changed

+26
-17
lines changed

doc/cache-invalidator.rst

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -24,21 +24,14 @@ Create the cache invalidator by passing a proxy client as
2424

2525
$cacheInvalidator = new CacheInvalidator($client);
2626

27-
Supported invalidation methods
28-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
29-
30-
============= ======= ======= =======
31-
Client Purge Refresh Ban
32-
============= ======= ======= =======
33-
Varnish ✓ ✓ ✓
34-
NGINX ✓ ✓
35-
Symfony Cache ✓ ✓
36-
Noop ✓ ✓ ✓
37-
============= ======= ======= =======
38-
39-
.. note::
27+
Depending on the capabilities of the proxy client, some invalidation methods
28+
may not work. If you try to call an invalidation method that is not supported,
29+
an ``UnsupportedProxyOperationException`` is thrown. You can check for support
30+
by calling ``CacheInvalidator::support`` with the constant of the operation you
31+
need.
4032

41-
See :ref:`proxy client setup <client setup>` for more on constructing a client.
33+
See :doc:`proxy clients <proxy-clients>` for the details on setting up the
34+
proxy client and an overview of the supported operations of each client.
4235

4336
.. _cache invalidate:
4437

@@ -71,7 +64,7 @@ Invalidate a URL with added header(s)::
7164

7265
.. include:: includes/custom-headers.rst
7366

74-
Please note that purge will invalidate all variants, so you do not have to
67+
Please note that purge will invalidate all variants, so you do not need to
7568
send any headers that you vary on, such as ``Accept``.
7669

7770
.. _cache refresh:
@@ -167,9 +160,9 @@ You can also invalidate the cache based on any headers.
167160
Proxy client implementations should fill up the headers to at least have the
168161
default headers always present to simplify the cache configuration rules.
169162

170-
To invalidate on a custom header ``X-My-Header``, you would do::
163+
To invalidate on a custom header ``My-Header``, you would do::
171164

172-
$cacheInvalidator->invalidate(['X-My-Header' => 'my-value'])->flush();
165+
$cacheInvalidator->invalidate(['My-Header' => 'my-value'])->flush();
173166

174167
.. _flush:
175168

doc/proxy-clients.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,22 @@ The recommended usage is to have your application interact with the
1313
:doc:`cache invalidator <cache-invalidator>` which you set up with the proxy
1414
client suitable for the proxy server you use.
1515

16+
Supported invalidation methods
17+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18+
19+
Not all clients support all operations. This table provides an overview what
20+
each proxy client supports:
21+
22+
============= ======= ======= =======
23+
Client Purge Refresh Ban
24+
============= ======= ======= =======
25+
Varnish ✓ ✓ ✓
26+
NGINX ✓ ✓
27+
Symfony Cache ✓ ✓
28+
Noop ✓ ✓ ✓
29+
Multiplexer ✓ ✓ ✓
30+
============= ======= ======= =======
31+
1632
.. _client setup:
1733

1834
Setup

0 commit comments

Comments
 (0)