Skip to content

Commit 837adff

Browse files
committed
Rename cache/ to http_cache/
1 parent 473b446 commit 837adff

11 files changed

+19
-18
lines changed

Diff for: form/csrf_protection.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,6 @@ section.
6767
CSRF tokens are meant to be different for every user. This is why you
6868
need to be cautious if you try to cache pages with forms including this
6969
kind of protection. For more information, see
70-
:doc:`/cache/form_csrf_caching`.
70+
:doc:`/http_cache/form_csrf_caching`.
7171

7272
.. _`Cross-site request forgery`: http://en.wikipedia.org/wiki/Cross-site_request_forgery

Diff for: forms.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -726,7 +726,7 @@ Learn more
726726

727727
* :doc:`/controller/upload_file`
728728
* :doc:`/reference/forms/types`
729-
* :doc:`/cache/form_csrf_caching`
729+
* :doc:`/http_cache/form_csrf_caching`
730730

731731
.. _`Symfony Form component`: https://github.com/symfony/form
732732
.. _`DateTime`: http://php.net/manual/en/class.datetime.php

Diff for: http_cache.rst

+9-9
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Caching on the Shoulders of Giants
1515
With HTTP Caching, you cache the full output of a page (i.e. the response) and bypass
1616
your application *entirely* on subsequent requests. Of course, caching entire responses
1717
isn't always possible for highly dynamic sites, or is it? With
18-
:doc:`Edge Side Includes (ESI) </cache/esi>`, you can use the power of HTTP caching
18+
:doc:`Edge Side Includes (ESI) </http_cache/esi>`, you can use the power of HTTP caching
1919
on only *fragments* of your site.
2020

2121
The Symfony cache system is different because it relies on the simplicity
@@ -76,7 +76,7 @@ but is a great way to start.
7676

7777
.. tip::
7878

79-
For details on setting up Varnish, see :doc:`/cache/varnish`.
79+
For details on setting up Varnish, see :doc:`/http_cache/varnish`.
8080

8181
Enabling the proxy is easy: each application comes with a caching kernel (``AppCache``)
8282
that wraps the default one (``AppKernel``). The caching Kernel *is* the reverse
@@ -153,7 +153,7 @@ information about cache hits and misses.
153153

154154
Fortunately, since all reverse proxies are effectively the same, you should
155155
be able to switch to something more robust - like Varnish - without any problems.
156-
See :doc:`How to use Varnish </cache/varnish>`
156+
See :doc:`How to use Varnish </http_cache/varnish>`
157157

158158
.. index::
159159
single: Cache; HTTP
@@ -242,7 +242,7 @@ for debugging information about cache hits and misses.
242242

243243
.. tip::
244244

245-
The URI of the request is used as the cache key (unless you :doc:`vary </cache/cache_vary>`).
245+
The URI of the request is used as the cache key (unless you :doc:`vary </http_cache/cache_vary>`).
246246

247247
This is *super* performant and simple to use. But, cache *invalidation* is not supported.
248248
If your content change, you'll need to wait until your cache expires for the page
@@ -257,7 +257,7 @@ If you need to set cache headers for many different controller actions, check ou
257257
`FOSHttpCacheBundle`_. It provides a way to define cache headers based on the URL
258258
pattern and other request properties.
259259

260-
Finally, for more information about expiration caching, see :doc:`/cache/expiration`.
260+
Finally, for more information about expiration caching, see :doc:`/http_cache/expiration`.
261261

262262
.. _http-cache-validation-intro:
263263

@@ -276,7 +276,7 @@ If you need to see updated content *immediately*, you either need to
276276
:ref:`invalidate <http-cache-invalidation>` your cache *or* use the validation
277277
caching model.
278278

279-
For details, see :doc:`/cache/validation`.
279+
For details, see :doc:`/http_cache/validation`.
280280

281281
.. index::
282282
single: Cache; Safe methods
@@ -331,13 +331,13 @@ Cache invalidation is *not* part of the HTTP specification. Still, it can be rea
331331
useful to delete various HTTP cache entries as soon as some content on your site
332332
is updated.
333333

334-
For details, see :doc:`/cache/cache_invalidation`.
334+
For details, see :doc:`/http_cache/cache_invalidation`.
335335

336336
Using Edge Side Includes
337337
------------------------
338338

339339
When pages contain dynamic parts, you may not be able to cache entire pages,
340-
but only parts of it. Read :doc:`/cache/esi` to find out how to configure
340+
but only parts of it. Read :doc:`/http_cache/esi` to find out how to configure
341341
different cache strategies for specific parts of your page.
342342

343343
Summary
@@ -357,7 +357,7 @@ Learn more
357357
:maxdepth: 1
358358
:glob:
359359

360-
cache/*
360+
http_cache/*
361361

362362
.. _`Things Caches Do`: http://2ndscale.com/writings/things-caches-do
363363
.. _`Cache Tutorial`: http://www.mnot.net/cache_docs/
File renamed without changes.
File renamed without changes.

Diff for: cache/esi.rst renamed to http_cache/esi.rst

File renamed without changes.
File renamed without changes.

Diff for: cache/form_csrf_caching.rst renamed to http_cache/form_csrf_caching.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ How to Cache Most of the Page and still be able to Use CSRF Protection
2929
----------------------------------------------------------------------
3030

3131
To cache a page that contains a CSRF token, you can use more advanced caching
32-
techniques like :doc:`ESI fragments </cache/esi>`, where you cache the full
32+
techniques like :doc:`ESI fragments </http_cache/esi>`, where you cache the full
3333
page and embedding the form inside an ESI tag with no cache at all.
3434

3535
Another option would be to load the form via an uncached AJAX request, but
@@ -39,4 +39,4 @@ Or you can even load just the CSRF token with an AJAX request and replace the
3939
form field value with it.
4040

4141
.. _`Cross-site request forgery`: http://en.wikipedia.org/wiki/Cross-site_request_forgery
42-
.. _`Security CSRF Component`: https://github.com/symfony/security-csrf
42+
.. _`Security CSRF Component`: https://github.com/symfony/security-csrf

Diff for: cache/validation.rst renamed to http_cache/validation.rst

+1
Original file line numberDiff line numberDiff line change
@@ -228,5 +228,6 @@ the response status code to ``304``, removes the content, and removes some
228228
headers that must not be present for ``304`` responses (see
229229
:method:`Symfony\\Component\\HttpFoundation\\Response::setNotModified`).
230230

231+
.. _`expiration model`: https://tools.ietf.org/html/rfc2616#section-13.2
231232
.. _`validation model`: http://tools.ietf.org/html/rfc2616#section-13.3
232233
.. _`FrameworkExtraBundle documentation`: https://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/cache.html

Diff for: cache/varnish.rst renamed to http_cache/varnish.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ How to Use Varnish to Speed up my Website
77
Because Symfony's cache uses the standard HTTP cache headers, the
88
:ref:`symfony-gateway-cache` can easily be replaced with any other reverse
99
proxy. `Varnish`_ is a powerful, open-source, HTTP accelerator capable of serving
10-
cached content fast and including support for :doc:`Edge Side Includes </cache/esi>`.
10+
cached content fast and including support for :doc:`Edge Side Includes </http_cache/esi>`.
1111

1212
.. index::
1313
single: Varnish; configuration
@@ -80,7 +80,7 @@ at least for some parts of the site, e.g. when using forms with
8080
:doc:`CSRF Protection </form/csrf_protection>`. In this situation, make sure to
8181
:doc:`only start a session when actually needed </session/avoid_session_start>`
8282
and clear the session when it is no longer needed. Alternatively, you can look
83-
into :doc:`/cache/form_csrf_caching`.
83+
into :doc:`/http_cache/form_csrf_caching`.
8484

8585
Cookies created in JavaScript and used only in the frontend, e.g. when using
8686
Google Analytics, are nonetheless sent to the server. These cookies are not
@@ -168,7 +168,7 @@ using Varnish 3:
168168
Enable Edge Side Includes (ESI)
169169
-------------------------------
170170

171-
As explained in the :doc:`Edge Side Includes chapter </cache/esi>`, Symfony
171+
As explained in the :doc:`Edge Side Includes chapter </http_cache/esi>`, Symfony
172172
detects whether it talks to a reverse proxy that understands ESI or not. When
173173
you use the Symfony reverse proxy, you don't need to do anything. But to make
174174
Varnish instead of Symfony resolve the ESI tags, you need some configuration

Diff for: performance.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -142,8 +142,8 @@ is no longer a reason to use a bootstrap file.
142142
Learn more
143143
----------
144144

145-
* :doc:`/cache/varnish`
146-
* :doc:`/cache/form_csrf_caching`
145+
* :doc:`/http_cache/varnish`
146+
* :doc:`/http_cache/form_csrf_caching`
147147

148148
.. _`byte code caches`: https://en.wikipedia.org/wiki/List_of_PHP_accelerators
149149
.. _`OPcache`: http://php.net/manual/en/book.opcache.php

0 commit comments

Comments
 (0)