PageController

Extends CacheController

Joomla! Cache page type object

since

1.7.0

package

Joomla CMS

Methods

__call

Magic method to proxy CacheController method calls to Cache

__call( name, mixed||string|int arguments) : 
inherited
since

1.7.0

Arguments

name

stringName of the function

arguments

array<string|int, mixed>Array of arguments for the function

Response

mixed

__construct

Constructor

__construct(mixed||string|int options) : 
inherited
since

1.7.0

Arguments

options

array<string|int, mixed>Array of options

Response

mixed

_makeId

Generate a page cache id

_makeId() : 
since

1.7.0

todo

Discuss whether this should be coupled to a data hash or a request hash ... perhaps hashed with a serialized request

Response

stringMD5 Hash

_noChange

There is no change in page data so send an unmodified header and die gracefully

_noChange() : 
since

1.7.0

Response

void

_setEtag

Set the ETag header in the response

_setEtag( etag) : 
since

1.7.0

Arguments

etag

stringThe entity tag (etag) to set

Response

void

addIncludePath

Add a directory where Cache should search for controllers. You may either pass a string or an array of directories.

addIncludePath(array|string path = '') : mixed||string|int
inherited static deprecated
since

1.7.0

deprecated

4.2 will be removed in 6.0 Use the cache controller factory instead Example: Factory::getContainer()->get(CacheControllerFactoryInterface::class)->createCacheController($type, $options);

Arguments

path

array<string|int, mixed>|stringA path to search.

Response

array<string|int, mixed>An array with directory elements

get

Get the cached page data

get( id = false,  group = 'page') : 
since

1.7.0

Arguments

id

boolThe cache data ID

group

stringThe cache data group

Response

mixedBoolean false on no result, cached object otherwise

getInstance

Returns a reference to a cache adapter object, always creating it

getInstance( type = 'output', mixed||string|int options = []) : \Joomla\CMS\Cache\CacheController
inherited static deprecated
since

1.7.0

throws

RuntimeException

deprecated

4.2 will be removed in 6.0 Use the cache controller factory instead Example: Factory::getContainer()->get(CacheControllerFactoryInterface::class)->createCacheController($type, $options);

Arguments

type

stringThe cache object type to instantiate; default is output.

options

array<string|int, mixed>Array of options

Response

CacheController

store

Stop the cache buffer and store the cached data

store( data,  id,  group = null,  wrkarounds = true) : 
since

1.7.0

Arguments

data

mixedThe data to store

id

stringThe cache data ID

group

stringThe cache data group

wrkarounds

boolTrue to use workarounds

Response

bool

Properties

cache

Cache object

inherited
since

1.7.0

Type(s)

Cache

options

Array of options

inherited
since

1.7.0

Type(s)

array<string|int, mixed>

_id

ID property for the cache page object.

since

1.7.0

Type(s)

int

_group

Cache group

since

1.7.0

Type(s)

string

_locktest

Cache lock test

since

1.7.0

Type(s)

stdClass