class Cache

Properties

$connection_error
$user_internal_cache

Methods

__construct()

No description

void
init()

No description

bool
connect()

Connect to configured cache adapter

mixed
get(string $key, bool $store = false)

No description

bool
set(string $key, mixed $value, int $time, bool $store = false)

No description

bool|mixed|NULL
remove(string $key, bool $store = false)

No description

int
remove_group(string $group, string $param = null)

No description

bool|null
clear_cache(bool $enforce_in_cmd = false)

No description

get_grouped_cached_keys()

No description

get_status()

Returns current Cache Status

is_enabled()

Returns true of the caching system is active

get_detailed_status()

No description

bool
disable_cache_custom_config(bool $overwrite = false)

No description

disable_cache()

Disables the cache for the rest of this page call

enable_cache()

Enable the cache for the rest of this page call

string
get_current_adapter_name()

Returns the full class name of the current adapter

Details

at line 30
__construct()

at line 68
void init()

Return Value

void

Exceptions

Exception

at line 90
bool connect()

Connect to configured cache adapter

Return Value

bool Returns true if connection succeeded

Exceptions

Exception

at line 147
mixed get(string $key, bool $store = false)

Parameters

string $key Cache Key
bool $store Set to true to use CACHE for temporary storage > Forces cache usage even if cache is temporary disabled

Return Value

mixed Returns the cached value of the passed Cache Key

at line 184
bool set(string $key, mixed $value, int $time, bool $store = false)

Parameters

string $key Cache Key - A Cache Key always contains a Cache Group as first element followed by an underscore (e.g. template_test123). All keys with the same group can be cleared at once. Some groups are being used by the system.
mixed $value Cache Value
int $time TTL in seconds
bool $store Set to true to use CACHE for temporary storage > Forces cache usage even if cache is temporary disabled

Return Value

bool

at line 216
bool|mixed|NULL remove(string $key, bool $store = false)

Parameters

string $key Cache Key
bool $store If this was a permastored

Return Value

bool|mixed|NULL

at line 241
int remove_group(string $group, string $param = null)

Parameters

string $group Cache Group (erases all keyy in one cache group - keys must start with this group id, e.g. db or template)
string $param If this function called as triggered event from Form helper the first arg is an obj and this param is the groupname

Return Value

int number of deleted keys

at line 273
bool|null clear_cache(bool $enforce_in_cmd = false)

Parameters

bool $enforce_in_cmd Clear full cache

Return Value

bool|null

at line 294
get_grouped_cached_keys()

at line 306
get_status()

Returns current Cache Status

at line 319
is_enabled()

Returns true of the caching system is active

at line 328
get_detailed_status()

at line 344
bool disable_cache_custom_config(bool $overwrite = false)

Parameters

bool $overwrite

Return Value

bool

at line 373
disable_cache()

Disables the cache for the rest of this page call

at line 381
enable_cache()

Enable the cache for the rest of this page call

at line 403
string get_current_adapter_name()

Returns the full class name of the current adapter

Return Value

string