silverstripe-framework/docs/en/howto/cache-control.md
Gabriele Brosulo 6683f3d283 Update cache-control.md
Added useful information after half an hour trying to have cache working :)
2014-10-23 14:00:32 +01:00

1.5 KiB

Cache control

By default, PHP add caching headers that make the page appear "purely dynamic".
This isn't usually appropriate for most sites, even ones that are updated reasonably frequently.
In particular, the default PHP cache-control settings prevent sites from appearing in the internet archive.
SilverStripe overrides the default settings with the following:

Default setting:

  • 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.

Overriding these defaults

  • [api:HTTP::$cache_age] can be used to set the max-age component of the cache-control line, in seconds.
    Set it to 0 to disable caching; the "no-cache" clause in Cache-Control and Pragma will be included. It works only for live sites, if SS_ENVIRONMENT_TYPE is set to "dev" [api:HTTP::$cache_age] will be always overridden with 0.
  • [api:HTTP::register_modification_date()] can be used to set the modification date to something more recent than the default.

How it works:

  • [api:DataObject::__construct()] calls [api:HTTP::register_modification_date()] whenever a record comes from the database
  • Controller::run() calls [api:HTTP::add_cache_headers()] before outputting the page