PageController
Extends CacheControllerJoomla! Cache page type object
| since |
1.7.0 |
|---|---|
| package |
Joomla CMS |
Methods
__call
Magic method to proxy CacheController method calls to Cache
__call(string name, array arguments) : mixed
| since |
1.7.0 |
|---|
Arguments
- name
stringName of the function- arguments
arrayArray of arguments for the function
Response
mixed
__construct
Constructor
__construct(array options) : mixed
| since |
1.7.0 |
|---|
Arguments
- options
arrayArray of options
Response
mixed
_makeId
Generate a page cache id
_makeId() : string
| 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() : void
| since |
1.7.0 |
|---|
_setEtag
Set the ETag header in the response
_setEtag(string etag) : void
| since |
1.7.0 |
|---|
Arguments
- etag
stringThe entity tag (etag) to set
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 = '') : array
| since |
1.7.0 |
|---|
Arguments
- path
array|stringA path to search.
Response
arrayAn array with directory elements
get
Get stored cached data by ID and group
get(string id, string group = null) : mixed
| since |
1.7.0 |
|---|---|
| deprecated |
4.0 Implement own method in subclass |
Arguments
- id
stringThe 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(string type = 'output', array options = array()) : \Joomla\CMS\Cache\CacheController
| since |
1.7.0 |
|---|---|
| throws |
|
Arguments
- type
stringThe cache object type to instantiate; default is output.- options
arrayArray of options
Response
\Joomla\CMS\Cache\CacheController
store
Store data to cache by ID and group
store(mixed data, string id, string group = null, bool wrkarounds = true) : bool
| since |
1.7.0 |
|---|---|
| deprecated |
4.0 Implement own method in subclass |
Arguments
- data
mixedThe data to store- id
stringThe cache data ID- group
stringThe cache data group- wrkarounds
boolTrue to use wrkarounds
Response
boolTrue if cache stored
Properties
_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
cache
Cache object
| since |
1.7.0 |
|---|
Type(s)
\Joomla\CMS\Cache\Cache
options
Array of options
| since |
1.7.0 |
|---|
Type(s)
array