[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/administrator/components/com_cache/src/Model/ -> CacheModel.php (summary)

(no description)

Copyright: (C) 2006 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 277 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

CacheModel:: (10 methods):
  __construct()
  populateState()
  getStoreId()
  getData()
  getCache()
  getTotal()
  getPagination()
  clean()
  cleanlist()
  purge()


Class: CacheModel  - X-Ref

Cache Model

__construct($config = array()   X-Ref
Constructor.

param: array  $config  An optional associative array of configuration settings.

populateState($ordering = 'group', $direction = 'asc')   X-Ref
Method to auto-populate the model state.

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

param: string  $ordering   Field for ordering.
param: string  $direction  Direction of ordering.
return: void

getStoreId($id = '')   X-Ref
Method to get a store id based on model configuration state.

This is necessary because the model is used by the component and
different modules that might need different sets of data or different
ordering requirements.

param: string  $id  A prefix for the store id.
return: string  A store id.

getData()   X-Ref
Method to get cache data

return: array

getCache()   X-Ref
Method to get cache instance.

return: CacheController

getTotal()   X-Ref
Get the number of current Cache Groups.

return: integer

getPagination()   X-Ref
Method to get a pagination object for the cache.

return: Pagination

clean($group = '')   X-Ref
Clean out a cache group as named by param.
If no param is passed clean all cache groups.

param: string  $group  Cache group name.
return: boolean  True on success, false otherwise

cleanlist($array)   X-Ref
Purge an array of cache groups.

param: array  $array  Array of cache group names.
return: array  Array with errors, if they exist.

purge()   X-Ref
Purge all cache items.

return: boolean  True if successful; false otherwise.



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer