Docs updates

This commit is contained in:
Aaron Carlino 2018-05-30 16:44:47 +12:00 committed by Damian Mooyman
parent 489aca2fc9
commit 0b18090003

View File

@ -2,21 +2,21 @@
### Versioned cache segmentation ### Versioned cache segmentation
The cache API now maintains separate cache pools for each versioned stage. This prevents users from caching draft data and then exposing it on the live stage. `SS_Cache` now maintains separate cache pools for each versioned stage. This prevents developers from caching draft data and then accidentally exposing it on the live stage without potentially required authorisation checks. Unless you rely on caching across stages, you don't need to change your own code for this change to take effect. Note that cache keys will be internally rewritten, causing any existing cache items to become invalid when this change is deployed.
```php ```php
// Before: // Before:
$cache = SS_Cache::factory('myapp'); $cache = SS_Cache::factory('myapp');
Versioned::set_reading_mode('Stage.Live');
$cache->save('Some draft content. Not for public viewing yet.', 'my_key');
Versioned::set_reading_mode('Stage.Stage'); Versioned::set_reading_mode('Stage.Stage');
$cache->save('Some draft content. Not for public viewing yet.', 'my_key');
Versioned::set_reading_mode('Stage.Live');
$cache->load('my_key'); // 'Some draft content. Not for public viewing yet' $cache->load('my_key'); // 'Some draft content. Not for public viewing yet'
// After: // After:
$cache = SS_Cache::factory('myapp'); $cache = SS_Cache::factory('myapp');
Versioned::set_reading_mode('Stage.Live');
$cache->save('Some draft content. Not for public viewing yet.', 'my_key');
Versioned::set_reading_mode('Stage.Stage'); Versioned::set_reading_mode('Stage.Stage');
$cache->save('Some draft content. Not for public viewing yet.', 'my_key');
Versioned::set_reading_mode('Stage.Live');
$cache->load('my_key'); // null $cache->load('my_key'); // null
``` ```
Data that is not content sensitive can be cached across stages by simply opting out of the segmented cache with the `disable-container` argument. Data that is not content sensitive can be cached across stages by simply opting out of the segmented cache with the `disable-container` argument.