tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-06-29 16:09:23 +02:00
Code Issues Projects Releases Wiki Activity

DOCS Update doc errors

Browse Source
This commit is contained in:
Daniel Hensby 2018-06-13 14:29:10 +01:00
parent 687d0a6af1
commit 0b308c871d
No known key found for this signature in database
GPG Key ID: B00D1E9767F0B06E
3 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -20,11 +20,11 @@ are a great way to learn about HTTP caching.
### Overview ### Overview
In order to support developers in making safe choices around HTTP caching, In order to support developers in making safe choices around HTTP caching,
we're using a `HTTPCacheControl` class to control if a response we're using a `HTTPCacheControlMiddleware` class to control if a response
should be considered public or private. This is an abstraction on existing should be considered public or private. This is an abstraction on existing
lowlevel APIs like `HTTP::add_cache_headers()` and `SS_HTTPResponse->addHeader()`. lowlevel APIs like `HTTP::add_cache_headers()` and `HTTPResponse->addHeader()`.
The `HTTPCacheControl` API makes it easier to express your caching preferences The `HTTPCacheControlMiddleware` API makes it easier to express your caching preferences
without running the risk of overriding essential core safety measures. without running the risk of overriding essential core safety measures.
Most commonly, these APIs will prevent HTTP caching of draft content. Most commonly, these APIs will prevent HTTP caching of draft content.
@ -96,7 +96,7 @@ The priority order is as followed, sorted in descending order
### Global opt-in for page content ### Global opt-in for page content
Enable caching for all page content (through `Page_Controller`). Enable caching for all page content (through `PageController`).
```php ```php
<?php <?php
@ -141,7 +141,7 @@ class PageController extends ContentController
HTTPCacheControlMiddleware::singleton() HTTPCacheControlMiddleware::singleton()
->disableCache(); ->disableCache();
return $this->myPrivateResponse();; return $this->myPrivateResponse();
} }
} }
``` ```
@ -173,7 +173,7 @@ class PageController extends ContentController
{ {
public function init() public function init()
{ {
HTTPCacheControlMiddleware::inst() HTTPCacheControlMiddleware::singleton()
->enableCache($force=true) // DANGER ZONE ->enableCache($force=true) // DANGER ZONE
->setMaxAge(60); // 1 minute ->setMaxAge(60); // 1 minute
@ -199,7 +199,7 @@ headers:
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 public 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()` or via modifying the `HTTP.cache_control` defaults).
```php ```php
use SilverStripe\Control\Middleware\HTTPCacheControlMiddleware; use SilverStripe\Control\Middleware\HTTPCacheControlMiddleware;
@ -222,7 +222,7 @@ HTTP::register_modification_date('2014-10-10');
### Vary ### Vary
A `Vary` header tells caches which aspects of the response should be considered A `Vary` header tells caches which aspects of the response should be considered
when calculating a cache key, usually in addition to the full URL path. when calculating a cache key, usually in addition to the full URL.
By default, SilverStripe will output a `Vary` header with the following content: By default, SilverStripe will output a `Vary` header with the following content:
``` ```

10
docs/en/04_Changelogs/4.2.0.md
View File

@ -209,7 +209,7 @@ SilverStripe\Core\Injector\Injector:
In order to support developers in making safe choices around HTTP caching, In order to support developers in making safe choices around HTTP caching,
we've introduced a `HTTPCacheControlMiddleware` class to control if a response we've introduced a `HTTPCacheControlMiddleware` class to control if a response
should be considered public or private. This is an abstraction on existing should be considered public or private. This is an abstraction on existing
lowlevel APIs like `HTTP::add_cache_headers()` and `SS_HTTPResponse->addHeader()`. lowlevel APIs like `HTTP::add_cache_headers()` and `HTTPResponse->addHeader()`.
This change introduces smaller but necessary changes to HTTP caching headers This change introduces smaller but necessary changes to HTTP caching headers
sent by SilverStripe. If you are relying on HTTP caching in your implementation, sent by SilverStripe. If you are relying on HTTP caching in your implementation,
@ -240,7 +240,7 @@ for details on the new API.
##### Global opt-in for page content ##### Global opt-in for page content
Enable caching for all page content (through `Page_Controller`). Enable caching for all page content (through `PageController`).
```diff ```diff
<?php <?php
@ -254,7 +254,7 @@ class PageController extends ContentController
public function init() public function init()
{ {
- HTTP::set_cache_age(60); - HTTP::set_cache_age(60);
+ HTTPCacheControlMiddleware::inst() + HTTPCacheControlMiddleware::singleton()
+ ->enableCache() + ->enableCache()
+ ->setMaxAge(60); // 1 minute + ->setMaxAge(60); // 1 minute
@ -286,7 +286,7 @@ class PageController extends ContentController
public function myprivateaction($request) public function myprivateaction($request)
{ {
- HTTP::set_cache_age(0); - HTTP::set_cache_age(0);
+ HTTPCacheControl::inst() + HTTPCacheControlMiddleware::singleton()
+ ->disableCache(); + ->disableCache();
return $this->myPrivateResponse(); return $this->myPrivateResponse();
@ -323,7 +323,7 @@ class PageController extends ContentController
public function init() public function init()
{ {
- HTTP::set_cache_age(60); - HTTP::set_cache_age(60);
+ HTTPCacheControl::inst() + HTTPCacheControlMiddleware::singleton()
+ ->enableCache($force=true) // DANGER ZONE + ->enableCache($force=true) // DANGER ZONE
+ ->setMaxAge(60); // 1 minute + ->setMaxAge(60); // 1 minute

2
src/Control/Middleware/HTTPCacheControlMiddleware.php
View File

@ -769,7 +769,7 @@ class HTTPCacheControlMiddleware implements HTTPMiddleware, Resettable
// Errors disable cache (unless some errors are cached intentionally by usercode) // Errors disable cache (unless some errors are cached intentionally by usercode)
if ($response->isError()) { if ($response->isError()) {
// Even if publicCache(true) is specfied, errors will be uncachable // Even if publicCache(true) is specified, errors will be uncacheable
$this->disableCache(true); $this->disableCache(true);
} }
} }