Class CacheModelCache

Description

Cache Model

  • since: 1.6

Located in /administrator/components/com_cache/models/cache.php (line 21)

JObject
   |
   --JModel
      |
      --JModelList
         |
         --CacheModelCache
Variable Summary
Array $_data
object $_pagination
integer $_total
Method Summary
void clean ([String $group = ''])
void cleanlist ( $array)
object getCache ()
array getClient ()
array getData ()
integer getPagination ()
int getTotal ()
void populateState ([ $ordering = null], [ $direction = null])
void purge ()
Variables
Array $_data = array() (line 28)

An Array of CacheItems indexed by cache group ID

  • access: protected
object $_pagination = null (line 42)

Pagination object

  • access: protected
integer $_total = null (line 35)

Group total

  • access: protected

Inherited Variables

Inherited from JModelList

JModelList::$cache
JModelList::$context
JModelList::$filter_fields
JModelList::$query

Inherited from JModel

JModel::$event_clean_cache
JModel::$name
JModel::$option
JModel::$state
JModel::$_db
JModel::$__state_set

Inherited from JObject

JObject::$_errors
Methods
clean (line 168)

Clean out a cache group as named by param.

If no param is passed clean all cache groups.

  • access: public
void clean ([String $group = ''])
  • String $group
cleanlist (line 174)
  • access: public
void cleanlist ( $array)
  • $array
getCache (line 107)

Method to get cache instance

  • access: public
object getCache ()
getClient (line 128)

Method to get client data

  • access: public
array getClient ()
getData (line 70)

Method to get cache data

  • access: public
array getData ()
getPagination (line 152)

Method to get a pagination object for the cache

  • access: public
integer getPagination ()

Redefinition of:
JModelList::getPagination()
Method to get a JPagination object for the data set.
getTotal (line 138)

Get the number of current Cache Groups

  • access: public
int getTotal ()

Redefinition of:
JModelList::getTotal()
Method to get the total number of items for the data set.
populateState (line 51)

Method to auto-populate the model state.

Note. Calling getState in this method will result in recursion.

  • since: 1.6
  • access: protected
void populateState ([ $ordering = null], [ $direction = null])
  • $ordering
  • $direction

Redefinition of:
JModelList::populateState()
Method to auto-populate the model state.
purge (line 181)
  • access: public
void purge ()

Inherited Methods

Inherited From JModelList

JModelList::__construct()
JModelList::getItems()
JModelList::getListQuery()
JModelList::getPagination()
JModelList::getStart()
JModelList::getStoreId()
JModelList::getTotal()
JModelList::getUserStateFromRequest()
JModelList::populateState()
JModelList::_getListQuery()

Inherited From JModel

JModel::__construct()
JModel::addIncludePath()
JModel::addTablePath()
JModel::cleanCache()
JModel::getDbo()
JModel::getInstance()
JModel::getName()
JModel::getState()
JModel::getTable()
JModel::populateState()
JModel::setDbo()
JModel::setState()
JModel::_createFileName()
JModel::_createTable()
JModel::_getList()
JModel::_getListCount()

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()
JObject::__toString()

Documentation generated on Mon, 25 Jun 2012 13:52:40 -0500 by phpDocumentor 1.4.4