CacheBot Class Reference
[EasyCache System]

List of all members.

---

Detailed Description

this class is a wrapper that makes it easy to work with EasyCache, regardless of where you are or what caching method you use..

Definition at line 17 of file cache.inc.php.

Static Public Member Functions
	getBot ()
	get our cache object!
	setBot ($bot, $prefix= '')
	set our cache object.
	get ($key, $life=null)
	get data from teh cache...
	set ($key, $data, $life=null)
	set data in teh cache...
	delete ($key)
	delete specific data from teh cache...
	flush ()
	delete all the data from teh cache...
Private Member Functions
	__construct ()
	we're private so you can instantiate us.
Static Private Attributes
	$bot = null
	this is our EasyCache object

---

Member Function Documentation

CacheBot::__construct (   )  [private]

we're private so you can instantiate us. Definition at line 27 of file cache.inc.php.

CacheBot::delete (  $  key  )  [static]

delete specific data from teh cache... passes it off to the cache object. here to make use of autoload. Definition at line 122 of file cache.inc.php. Referenced by BaseObject::deleteCache(), BaseModule::deleteCachedPage(), BaseAdmin::drawDeleteCachePage(), BaseUser::logoutProcess(), and BaseModule::runCreateTableSql().

CacheBot::flush (   )  [static]

delete all the data from teh cache... passes it off to the cache object. here to make use of autoload. Definition at line 131 of file cache.inc.php. Referenced by BaseAdmin::drawClearCachePage().

CacheBot::get (  $  key, $  life = null )  [static]

get data from teh cache... passes it off to the cache object. here to make use of autoload. Parameters: $key  the key to get from the cache. $life  the life of the cache in seconds. you usually do this on the set, but for filecache all we can go off is the file modification time, so if you use files, pass in time to both get and set. they should be grouped together, so it should be easy. Definition at line 72 of file cache.inc.php. Referenced by BaseUser::checkAuthCache(), ObjectManager::doObjectSearch(), BaseAdmin::drawViewCachePage(), BaseObject::getCache(), REST::getCacheData(), BaseModule::getCachedPage(), BaseTags::getPopularTags(), BaseTags::getRelatedTags(), ObjectManager::getSearchQuery(), ObjectManager::loadObjects(), BaseJumper::lookupDbTable(), and BaseJumper::lookupDbTables().

CacheBot::getBot (   )  [static]

get our cache object! Returns: an EasyCache based object. Definition at line 36 of file cache.inc.php.

CacheBot::set (  $  key, $  data, $  life = null )  [static]

set data in teh cache... passes it off to the cache object. here to make use of autoload. Parameters: $key  the key to use to save our data under $data  the variable to cache $life  the life of the cache in seconds. Definition at line 98 of file cache.inc.php. Referenced by ObjectManager::doObjectSearch(), BaseTags::getPopularTags(), BaseTags::getRelatedTags(), ObjectManager::getSearchQuery(), BaseJumper::lookupDbTable(), BaseJumper::lookupDbTables(), REST::saveCacheData(), BaseUser::saveSession(), BaseObject::setCache(), and BaseModule::setCachedPage().

CacheBot::setBot (  $  bot, $  prefix = '' )  [static]

set our cache object. Parameters: $bot  a class extended form EasyCache that implements basic caching. Definition at line 54 of file cache.inc.php.

---

Member Data Documentation

CacheBot::$bot = null [static, private]

this is our EasyCache object Definition at line 22 of file cache.inc.php.

---

The documentation for this class was generated from the following file:

• lib/cache.inc.php

---