1. class
  2. XELOS
  3. \
  4. Framework
  5. \
  6. XF
  7. \
  8. Lib
  9. \
  10. Cache

Cache

class Cache

Constants

EVENT_ON_CLEAR_CACHE

EVENT_ON_CLEAR_REQUEST_CACHE

Properties

$connection_error

Methods

__construct()

No description

bool|null
clear_cache(bool $enforce_in_cmd = false)

No description

void
clear_request_cache()

No description

bool
connect()

Connect to configured cache adapter

disable_cache()

Disables the cache for the rest of this page call

bool
disable_cache_custom_config(bool $overwrite = false)

No description

enable_cache()

Enable the cache for the rest of this page call

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

No description

string
get_current_adapter_name()

Returns the full class name of the current adapter

array
get_detailed_status()

No description

array
get_grouped_cached_keys()

No description

get_status()

Returns current Cache Status

void
init()

No description

is_enabled()

Returns true of the caching system is active

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

No description

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

No description

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

No description

Details

at line 34
__construct()

No description

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

No description

Parameters

bool $enforce_in_cmd

Clear full cache

Return Value

bool|null

at line 256
void clear_request_cache()

No description

Return Value

void

at line 95
bool connect()

Connect to configured cache adapter

Return Value

bool

Returns true if connection succeeded

Exceptions

Exception

at line 351
disable_cache()

Disables the cache for the rest of this page call

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

No description

Parameters

bool $overwrite

Return Value

bool

at line 359
enable_cache()

Enable the cache for the rest of this page call

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

No description

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 381
string get_current_adapter_name()

Returns the full class name of the current adapter

Return Value

string

at line 306
array get_detailed_status()

No description

Return Value

array

at line 271
array get_grouped_cached_keys()

No description

Return Value

array

at line 283
get_status()

Returns current Cache Status

at line 74
void init()

No description

Return Value

void

Exceptions

Exception

at line 296
is_enabled()

Returns true of the caching system is active

at line 197
bool|mixed|null remove(string $key, bool $store = false)

No description

Parameters

string $key

Cache Key
bool $store

If this was a permastored

Return Value

bool|mixed|null

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

No description

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 170
bool set(string $key, mixed $value, int $time, bool $store = false)

No description

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