class PageCache implements FlushableInterface (View source)

Properties

static PageCache|null $library

Methods

deliver(PageCacheRecord $record)

Build a Response object starting from a cached page.

static PageCache
getLibrary()

Get the page cache library.

bool
shouldCheckCache(Request $req)

Determine if we should check if a page is in the cache.

outputCacheHeaders(Page $c) deprecated

Send the cache-related HTTP headers for a page to the current response.

array
getCacheHeaders(Page $c)

Get the cache-related HTTP headers for a page.

bool
shouldAddToCache(PageView $v)

Check if a page contained in a PageView should be stored in the cache.

string|null
getCacheKey(Page|Request|PageCacheRecord|mixed $mixed)

Get the key that identifies the cache entry for a page or a request.

string|null
getCacheHost(Page|Request|mixed $mixed)

Get the host name under which the page or request belongs to.

getRecord(Page|Request|mixed $mixed)

Get the cached item for a page or a request.

set(Page $c, string $content)

Store a page in the cache.

purgeByRecord(PageCacheRecord $rec)

Remove a cache entry given the record retrieved from the cache.

purge(Page $c)

Remove a cache entry given the page.

flush()

Removes all values from the cache.

Details

Response deliver(PageCacheRecord $record)

Build a Response object starting from a cached page.

Parameters

PageCacheRecord $record the cache record containing the cached page data

Return Value

Response

static PageCache getLibrary()

Get the page cache library.

Return Value

PageCache

bool shouldCheckCache(Request $req)

Determine if we should check if a page is in the cache.

Parameters

Request $req

Return Value

bool

outputCacheHeaders(Page $c) deprecated

deprecated Headers are no longer set directly. Instead, use the $pageCache->deliver() method to retrieve a response object and either return it from a controller method or, if you must, use $response->prepare($request)->send()

Send the cache-related HTTP headers for a page to the current response.

Parameters

Page $c

array getCacheHeaders(Page $c)

Get the cache-related HTTP headers for a page.

Parameters

Page $c

Return Value

array Keys are the header names; values are the header values

bool shouldAddToCache(PageView $v)

Check if a page contained in a PageView should be stored in the cache.

Parameters

PageView $v

Return Value

bool

string|null getCacheKey(Page|Request|PageCacheRecord|mixed $mixed)

Get the key that identifies the cache entry for a page or a request.

Parameters

Page|Request|PageCacheRecord|mixed $mixed

Return Value

string|null Returns NULL if $mixed is not a recognized type, a string otherwise

string|null getCacheHost(Page|Request|mixed $mixed)

Get the host name under which the page or request belongs to.

Parameters

Page|Request|mixed $mixed

Return Value

string|null Returns NULL if $mixed is not a recognized type, a string otherwise

abstract PageCacheRecord|null getRecord(Page|Request|mixed $mixed)

Get the cached item for a page or a request.

Parameters

Page|Request|mixed $mixed

Return Value

PageCacheRecord|null Return NULL if $mixed is not a recognized type, or if it's the record is not in the cache

abstract set(Page $c, string $content)

Store a page in the cache.

Parameters

Page $c The page to be stored in the cache
string $content The whole HTML of the page to be stored in the cache

abstract purgeByRecord(PageCacheRecord $rec)

Remove a cache entry given the record retrieved from the cache.

Parameters

PageCacheRecord $rec

abstract purge(Page $c)

Remove a cache entry given the page.

Parameters

Page $c

abstract flush()

Removes all values from the cache.

See also

\Concrete\Core\Cache\FlushableInterface::flush()