1. class
  2. Comodojo
  3. \
  4. SimpleCache
  5. \
  6. Providers
  7. \
  8. AbstractEnhancedProvider

AbstractEnhancedProvider

abstract class AbstractEnhancedProvider extends AbstractProvider implements EnhancedSimpleCacheInterface (View source)

Traits

StatefulTrait
NamespaceTrait

Properties

protected LoggerInterface $logger Current logger from AbstractProvider
protected $driver
protected string $namespace Determine the current cache scope (default: GLOBAL) from NamespaceTrait
protected $default_properties
protected $properties

Methods

__construct(array $properties = [], LoggerInterface $logger = null)

Class constructor

getLogger()

{@inheritdoc}

from AbstractProvider
setLogger(LoggerInterface $logger = null)

{@inheritdoc}

from AbstractProvider
get($key, $default = null)

No description

set($key, $value, $ttl = null)

No description

delete($key)

No description

clear()

No description

getMultiple($keys, $default = null)

No description

setMultiple($values, $ttl = null)

No description

deleteMultiple($keys)

No description

has($key)

No description

setId($id)

No description

from StatefulTrait
getId()

No description

from StatefulTrait
getState()

No description

from StatefulTrait
getStateMessage()

No description

from StatefulTrait
getStateTime()

No description

from StatefulTrait
setState($state, $message = null)

No description

from StatefulTrait
getNamespace()

{@inheritdoc}

from NamespaceTrait
setNamespace($namespace = null)

{@inheritdoc}

from NamespaceTrait
getProperties()

No description

EnhancedCacheItemPoolStats
getStats()

Disable provider

clearNamespace()

No description

bool
test()

Test the pool

Details

at line 48
__construct(array $properties = [], LoggerInterface $logger = null)

Class constructor

Parameters

array $properties
LoggerInterface $logger

Exceptions

CacheException

in AbstractProvider at line 48
getLogger()

{@inheritdoc}

in AbstractProvider at line 57
setLogger(LoggerInterface $logger = null)

{@inheritdoc}

Parameters

LoggerInterface $logger

at line 64
get($key, $default = null)

Parameters

$key
$default

at line 87
set($key, $value, $ttl = null)

Parameters

$key
$value
$ttl

at line 118
delete($key)

Parameters

$key

at line 139
clear()

at line 156
getMultiple($keys, $default = null)

Parameters

$keys
$default

at line 186
setMultiple($values, $ttl = null)

Parameters

$values
$ttl

at line 225
deleteMultiple($keys)

Parameters

$keys

at line 252
has($key)

Parameters

$key

in StatefulTrait at line 31
protected setId($id)

Parameters

$id

in StatefulTrait at line 39
getId()

in StatefulTrait at line 45
getState()

in StatefulTrait at line 51
getStateMessage()

in StatefulTrait at line 57
getStateTime()

in StatefulTrait at line 63
setState($state, $message = null)

Parameters

$state
$message

in NamespaceTrait at line 34
getNamespace()

{@inheritdoc}

in NamespaceTrait at line 43
setNamespace($namespace = null)

{@inheritdoc}

Parameters

$namespace

at line 58
getProperties()

at line 273
abstract EnhancedCacheItemPoolStats getStats()

Disable provider

Return Value

EnhancedCacheItemPoolStats

at line 275
clearNamespace()

at line 292
bool test()

Test the pool

Test should be used to ensure the status flag is setted correctly. If test is passed, the status should be == CACHE_SUCCESS, otherwise it should correspond to CACHE_ERROR

Return Value

bool