1. class
  2. Comodojo
  3. \
  4. Cache
  5. \
  6. Drivers
  7. \
  8. AbstractDriver

AbstractDriver

abstract class AbstractDriver implements CacheDriverInterface (View source)

Constants

DRIVER_NAME

Methods

AbstractDriver
__construct(array $configuration)

Class constructor

string
getName()

Get the driver name

bool
test()

Test the driver

string|null
get(string $key, string $namespace)

Get item from cache

bool
set(string $key, string $namespace, mixed $value, int $ttl = null)

Save item into cache

bool
delete(string $key, string $namespace)

Delete item from cache

bool
clear(string $namespace = null)

Clear namespace or whole cache

array
getMultiple(array $keys, string $namespace)

Get multiple items from cache

bool
setMultiple(array $key_values, string $namespace, int $ttl = null)

Save multiple items into cache

bool
deleteMultiple(array $keys, string $namespace)

Delete multiple items from cache

bool
has(array $key, string $namespace)

Check if item is in cache

array
stats()

Get cache driver statistics

Details

at line 31
abstract AbstractDriver __construct(array $configuration)

Class constructor

Parameters

array $configuration

Return Value

AbstractDriver

at line 36
string getName()

Get the driver name

Return Value

string

at line 45
abstract bool test()

Test the driver

The behaiour of this method may differ fro one driver to another. It could forward, for example, a dependency test, a in-cache test or both.

Return Value

bool

at line 50
abstract string|null get(string $key, string $namespace)

Get item from cache

Parameters

string $key The key
string $namespace Namespace where $key resides

Return Value

string|null

at line 55
abstract bool set(string $key, string $namespace, mixed $value, int $ttl = null)

Save item into cache

Parameters

string $key The key
string $namespace Namespace where $key resides
mixed $value Value
int $ttl Time to live of cache object (in seconds)

Return Value

bool

at line 60
abstract bool delete(string $key, string $namespace)

Delete item from cache

Parameters

string $key The key
string $namespace Namespace where $key resides

Return Value

bool

at line 65
abstract bool clear(string $namespace = null)

Clear namespace or whole cache

Parameters

string $namespace Namespace to clean or null to purge whole cache.

Return Value

bool

at line 70
abstract array getMultiple(array $keys, string $namespace)

Get multiple items from cache

Parameters

array $keys Array of keys
string $namespace Namespace where $keys reside

Return Value

array

at line 75
abstract bool setMultiple(array $key_values, string $namespace, int $ttl = null)

Save multiple items into cache

Parameters

array $key_values
string $namespace Namespace where $keys reside
int $ttl Time to live of cache objects (in seconds)

Return Value

bool

at line 80
abstract bool deleteMultiple(array $keys, string $namespace)

Delete multiple items from cache

Parameters

array $keys Array of keys
string $namespace Namespace where $keys reside

Return Value

bool

at line 85
abstract bool has(array $key, string $namespace)

Check if item is in cache

Parameters

array $key The key
string $namespace Namespace where $key resides

Return Value

bool

at line 90
abstract array stats()

Get cache driver statistics

The behaiour of this method may differ fro one driver to another. Providers will transform data in a EnhancedCacheItemPoolStats object.

Return Value

array