SiteAction
Adds functions for dealing with various cache control circumstances.
If you add code here then these will apply to all pages. You can override these functions if you want to have special behaviour for a particular page.
Table of Contents
- $maxage : int
- checketag() : bool
- Check an etag to see if we need to send the page again or not.
- checkmodtime() : bool
- Check a timestamp to see if we need to send the page again or not.
- exists() : bool
- Returns true of the request would generate a page.
- lastmodified() : int
- Get a last modified time for the page
- makeetag() : string
- Make an etag for an item
- makemaxage() : int
- Make a max age value for an item
- set304Cache() : void
- Set any cache headers that are wanted on a 304 response
- setCache() : void
- Set any cache headers that are wanted for a normal page delivery
Properties
$maxage
protected
static int
$maxage
= 3600
- the default maxage for a page. This is a static because you can't have consts in a trait....
Methods
checketag()
Check an etag to see if we need to send the page again or not.
public
checketag(Context $context, string $tag) : bool
Parameters
- $context : Context
-
The context object for the site
- $tag : string
-
The etag value to check
Return values
bool —checkmodtime()
Check a timestamp to see if we need to send the page again or not.
public
checkmodtime(Context $context, string $time) : bool
This always returns FALSE, indicating that we need to send the page again. The assumption is that pages that implement etags will override this function appropriately to do actual value checking.
Parameters
- $context : Context
-
The context object for the site
- $time : string
-
The time value to check
Tags
Return values
bool —exists()
Returns true of the request would generate a page.
public
exists(Context $context) : bool
This needs to be overridden if it is to be used. Currently returns TRUE, thus assuming that pages always exist....
Parameters
- $context : Context
-
The context object for the site
Tags
Return values
bool —lastmodified()
Get a last modified time for the page
public
lastmodified(Context $context) : int
By default this returns the current time. For pages that need to use this in anger, then this function may need to be overridden.
Parameters
- $context : Context
-
The context object for the site
Tags
Return values
int —makeetag()
Make an etag for an item
public
makeetag(Context $context) : string
This needs to be overridden by pages that can generate etags
Parameters
- $context : Context
-
The context object for the site
Tags
Return values
string —makemaxage()
Make a max age value for an item
public
makemaxage(Context $context) : int
This needs to be overridden by pages that want to use this
Parameters
- $context : Context
-
The context object for the site
Tags
Return values
int —set304Cache()
Set any cache headers that are wanted on a 304 response
public
set304Cache(Context $context) : void
Parameters
- $context : Context
-
The context object for the site
Tags
Return values
void —setCache()
Set any cache headers that are wanted for a normal page delivery
public
setCache(Context $context) : void
Parameters
- $context : Context
-
The context object