Class JCacheControllerPage

Description

Joomla! Cache page type object

  • since: 11.1

Located in /libraries/joomla/cache/controller/page.php (line 19)

JCacheController
   |
   --JCacheControllerPage
Variable Summary
string $_group
integer $_id
object Cache $_locktest
Method Summary
boolean get ([string $id = false], [string $group = 'page'], [boolean $wrkarounds = true])
boolean store ([boolean $wrkarounds = true])
string _makeId ()
void _noChange ()
void _setEtag (string $etag)
Variables
string $_group (line 31)
  • var: Cache group
  • since: 11.1
  • access: protected
integer $_id (line 25)
  • var: ID property for the cache page object.
  • since: 11.1
  • access: protected
object Cache $_locktest = null (line 37)
  • var: lock test
  • since: 11.1
  • access: protected

Inherited Variables

Inherited from JCacheController

JCacheController::$cache
JCacheController::$options
Methods
get (line 50)

Get the cached page data

  • return: True if the cache is hit (false else)
  • since: 11.1
  • access: public
boolean get ([string $id = false], [string $group = 'page'], [boolean $wrkarounds = true])
  • string $id: The cache data id
  • string $group: The cache data group
  • boolean $wrkarounds: True to use wrkarounds

Redefinition of:
JCacheController::get()
Get stored cached data by id and group
store (line 122)

Stop the cache buffer and store the cached data

  • return: True if cache stored
  • since: 11.1
  • access: public
boolean store ([boolean $wrkarounds = true])
  • boolean $wrkarounds: True to use wrkarounds

Redefinition of:
JCacheController::store()
Store data to cache by id and group
_makeId (line 164)

Generate a page cache id

  • return: MD5 Hash : page cache id
  • todo: Discuss whether this should be coupled to a data hash or a request hash ... perhaps hashed with a serialized request
  • since: 11.1
  • access: protected
string _makeId ()
_noChange (line 177)

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

  • since: 11.1
  • access: protected
void _noChange ()
_setEtag (line 195)

Set the ETag header in the response

  • since: 11.1
  • access: protected
void _setEtag (string $etag)
  • string $etag: The entity tag (etag) to set

Inherited Methods

Inherited From JCacheController

JCacheController::__construct()
JCacheController::addIncludePath()
JCacheController::get()
JCacheController::getInstance()
JCacheController::setCaching()
JCacheController::setLifeTime()
JCacheController::store()
JCacheController::__call()

Documentation generated on Mon, 25 Jun 2012 13:58:30 -0500 by phpDocumentor 1.4.4