decache (line 149)
Remove an item from the general cache (most commonly used for blocks).
void
decache
(ID_TEXT $cached_for, [?array $identifier = NULL])
-
ID_TEXT
$cached_for: The type of what we are cacheing (e.g. block name)
-
?array
$identifier: A map of identifiying characteristics (NULL: no identifying characteristics, decache all)
find_cache_on (line 179)
Find the cache-on parameters for 'codename's cacheing style (prevents us needing to load up extra code to find it).
?array
find_cache_on
(ID_TEXT $codename)
-
ID_TEXT
$codename: The codename of what will be checked for cacheing
get_cache_entry (line 213)
Find the cached result of what is named by codename and the further constraints.
?mixed
get_cache_entry
(ID_TEXT $codename, LONG_TEXT $cache_identifier, [integer $ttl = 10000], [boolean $tempcode = false])
-
ID_TEXT
$codename: The codename to check for cacheing
-
LONG_TEXT
$cache_identifier: The further restraints (a serialized map)
-
integer
$ttl: The TTL for the cache entry
-
boolean
$tempcode: Whether we are cacheing Tempcode (needs special care)
init__caches (line 24)
Standard code module initialisation function.
void
init__caches
()
persistant_cache_delete (line 125)
Delete data from the persistant cache.
void
persistant_cache_delete
(mixed $key)
persistant_cache_empty (line 136)
Remove all data from the persistant cache.
void
persistant_cache_empty
()
persistant_cache_get (line 94)
Get data from the persistant cache.
?mixed
persistant_cache_get
(mixed $key, [?TIME $min_cache_date = NULL])
-
mixed
$key: Key
-
?TIME
$min_cache_date: Minimum timestamp that entries from the cache may hold (NULL: don't care)
persistant_cache_set (line 112)
Put data into the persistant cache.
void
persistant_cache_set
(mixed $key, mixed $data, [boolean $server_wide = false], [?integer $expire_secs = NULL])
-
mixed
$key: Key
-
mixed
$data: The data
-
boolean
$server_wide: Whether it is server-wide data
-
?integer
$expire_secs: The expiration time in seconds. (NULL: Default expiry in 5 minutes, or never if it is server-wide).