Documentation

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
setCache() Set any cache headers that are wanted for a normal page delivery void
set304Cache() Set any cache headers that are wanted on a 304 response void
makeetag() Make an etag for an item string
makemaxage() Make a max age value for an item int
exists() Returns true of the request would generate a page. bool
lastmodified() Get a last modified time for the page int
checkmodtime() Check a timestamp to see if we need to send the page again or not. bool
checketag() Check an etag to see if we need to send the page again or not. bool

Properties

Methods

setCache()

Set any cache headers that are wanted for a normal page delivery

public setCache( $context : Context ) : void
Parameters
$context : Context

The context object

Tags
psalm-suppress

PossiblyUnusedMethod

phpcsSuppress

NunoMaduro\PhpInsights\Domain\Sniffs\ForbiddenSetterSniff

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
phpcsSuppress

NunoMaduro\PhpInsights\Domain\Sniffs\ForbiddenSetterSniff

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
psalm-suppress

PossiblyUnusedParam

phpcsSuppress

SlevomatCodingStandard.Functions.UnusedParameter

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
psalm-suppress

PossiblyUnusedParam

phpcsSuppress

SlevomatCodingStandard.Functions.UnusedParameter

Return values
int

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
psalm-suppress

PossiblyUnusedParam

phpcsSuppress

SlevomatCodingStandard.Functions.UnusedParameter

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
psalm-suppress

PossiblyUnusedParam

phpcsSuppress

SlevomatCodingStandard.Functions.UnusedParameter

Return values
int

checkmodtime()

Check a timestamp to see if we need to send the page again or not.

public checkmodtime( $context : Context , $time : string ) : 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
psalm-suppress

PossiblyUnusedParam

phpcsSuppress

SlevomatCodingStandard.Functions.UnusedParameter

Return values
bool

checketag()

Check an etag to see if we need to send the page again or not.

public checketag( $context : Context , $tag : string ) : bool
Parameters
$context : Context

The context object for the site

$tag : string

The etag value to check

Return values
bool

Search results