tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

Updated caching docs (out of sync with implementation)

Browse Source 
See https://github.com/silverstripe/silverstripe-framework/issues/8272
This commit is contained in:
Ingo Schommer 2018-07-19 11:21:36 +12:00 committed by Daniel Hensby
parent d426ecbb89
commit 9300e802f7
No known key found for this signature in database
GPG Key ID: D8DEBC4C8E7BC8B9
1 changed files with 8 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/en/02_Developer_Guides/08_Performance/02_HTTP_Cache_Headers.md
View File

@ -8,7 +8,7 @@ summary: Set the correct HTTP cache headers for your responses.
By default, SilverStripe sends headers which signal to HTTP caches By default, SilverStripe sends headers which signal to HTTP caches
that the response should be not considered cacheable. that the response should be not considered cacheable.
HTTP caches can either be intermediary caches (e.g. CDNs and proxies), or clients (e.g. browsers). HTTP caches can either be intermediary caches (e.g. CDNs and proxies), or clients (e.g. browsers).
The cache headers sent are `Cache-Control: no-store, no-cache, must-revalidate`; The cache headers sent are `Cache-Control: no-cache, must-revalidate`;
HTTP caching can be a great way to speed up your website, but needs to be properly applied. HTTP caching can be a great way to speed up your website, but needs to be properly applied.
Getting it wrong can accidentally expose draft pages or other protected content. Getting it wrong can accidentally expose draft pages or other protected content.
@ -59,8 +59,8 @@ Does not set `private` directive, use `privateCache()` if this is explicitly req
Simple way to set cache control header to a cacheable state. Simple way to set cache control header to a cacheable state.
Use this method over `publicCache()` if you are unsure about caching details. Use this method over `publicCache()` if you are unsure about caching details.
Removes `no-store` and `no-cache` directives; other directives will remain in place. Removes the `no-store` directive unless a `max-age` is set; other directives will remain in place.
Use alongside `setMaxAge()` to indicate caching. Use alongside `setMaxAge()` to activate caching.
Does not set `public` directive. Usually, `setMaxAge()` is sufficient. Use `publicCache()` if this is explicitly required Does not set `public` directive. Usually, `setMaxAge()` is sufficient. Use `publicCache()` if this is explicitly required
([details](https://developers.google.com/web/fundamentals/performance/optimizing-content-efficiency/http-caching#public_vs_private)) ([details](https://developers.google.com/web/fundamentals/performance/optimizing-content-efficiency/http-caching#public_vs_private))
@ -184,24 +184,13 @@ class PageController extends ContentController
} }
``` ```
## Defaults
By default, PHP adds caching headers that make the page appear purely dynamic. This isn't usually appropriate for most
sites, even ones that are updated reasonably frequently. SilverStripe overrides the default settings with the following
headers:
* The `Last-Modified` date is set to be most recent modification date of any database record queried in the generation
of the page.
* The `Expiry` date is set by taking the age of the page and adding that to the current time.
* `Cache-Control` is set to `max-age=86400, must-revalidate`
* Since a visitor cookie is set, the site won't be cached by proxies.
* Ajax requests are never cached.
## Max Age ## Max Age
The cache age determines the lifetime of your cache, in seconds. The cache age determines the lifetime of your cache, in seconds.
It only takes effect if you instruct the cache control It only takes effect if you instruct the cache control
that your response is cacheable in the first place (via `enableCache()` or via modifying the `HTTP.cache_control` defaults). that your response is cacheable in the first place
(via `enableCache()`, `publicCache()` or `privateCache()`),
or via modifying the `HTTP.cache_control` defaults).
```php ```php
use SilverStripe\Control\Middleware\HTTPCacheControlMiddleware; use SilverStripe\Control\Middleware\HTTPCacheControlMiddleware;
@ -209,7 +198,8 @@ HTTPCacheControlMiddleware::singleton()
->setMaxAge(60) ->setMaxAge(60)
``` ```
Note that `setMaxAge(0)` is NOT sufficient to disable caching in all cases. Note that `setMaxAge(0)` is NOT sufficient to disable caching in all cases,
use `disableCache()` instead.
### Last Modified ### Last Modified