1. interface
  2. XELOS
  3. \
  4. Framework
  5. \
  6. XF
  7. \
  8. Lib
  9. \
  10. Cache
  11. \
  12. Interfaces
  13. \
  14. CacheHandlerInterface

CacheHandlerInterface

interface CacheHandlerInterface

Interface xelos_cache_interface for Caching Backend Adapters

Methods

mixed
clear_cache(bool $enforce_in_cmd)

Clear whole Cache

bool
connect()

Connect to the Caching Backend

mixed
get(string $key)

No description

array
get_detailed_status()

No description

array
get_grouped_cached_keys()

No description

init()

No description

bool
is_cli_supported()

No description

bool|mixed|null
remove(string $key)

No description

int
remove_group(string $group)

No description

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

No description

Details

at line 70
mixed clear_cache(bool $enforce_in_cmd)

Clear whole Cache

Parameters

bool $enforce_in_cmd

Return Value

mixed

at line 19
bool connect()

Connect to the Caching Backend

Return Value

bool

Return true if connection is successful and caching can be used

at line 45
mixed get(string $key)

No description

Parameters

string $key

Cache Key

Return Value

mixed

Returns the cached value of the passed Cache Key

at line 89
array get_detailed_status()

No description

Return Value

array

at line 82
array get_grouped_cached_keys()

No description

Return Value

array

at line 13
init()

No description

at line 95
bool is_cli_supported()

No description

Return Value

bool

True if Caching Adapter supports caching in CMD Mode

at line 55
bool|mixed|null remove(string $key)

No description

Parameters

string $key

Cache Key

Return Value

bool|mixed|null

at line 63
int remove_group(string $group)

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)

Return Value

int

number of deleted keys

at line 37
bool set(string $key, mixed $value, int $time)

No description

Parameters

string $key

Cache Key
mixed $value

Cache Value
int $time

TTL in seconds

Return Value

bool