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

AbstractEnhancedProvider

abstract class AbstractEnhancedProvider extends AbstractProvider implements EnhancedCacheItemPoolInterface (View source)

Traits

StatefulTrait
NamespaceTrait

Properties

protected LoggerInterface $logger Current logger from AbstractProvider
protected string $namespace Determine the current cache scope (default: GLOBAL) from NamespaceTrait
protected $driver
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
getItem($key)

{@inheritdoc}

getItems(array $keys = [])

{@inheritdoc}

hasItem($key)

{@inheritdoc}

clear()

{@inheritdoc}

deleteItem($key)

{@inheritdoc}

deleteItems(array $keys)

{@inheritdoc}

save(CacheItemInterface $item)

{@inheritdoc}

saveDeferred(CacheItemInterface $item)

{@inheritdoc}

commit()

{@inheritdoc}

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
EnhancedCacheItemPoolStats
getStats()

Get provider statistics

getProperties()

No description

string|null
clearNamespace()

Chear the whole (current) namespace

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 72
getItem($key)

{@inheritdoc}

Parameters

$key

at line 235
getItems(array $keys = [])

{@inheritdoc}

Parameters

array $keys

at line 100
hasItem($key)

{@inheritdoc}

Parameters

$key

at line 124
clear()

{@inheritdoc}

at line 164
deleteItem($key)

{@inheritdoc}

Parameters

$key

at line 270
deleteItems(array $keys)

{@inheritdoc}

Parameters

array $keys

at line 188
save(CacheItemInterface $item)

{@inheritdoc}

Parameters

CacheItemInterface $item

at line 290
saveDeferred(CacheItemInterface $item)

{@inheritdoc}

Parameters

CacheItemInterface $item

at line 305
commit()

{@inheritdoc}

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 61
abstract EnhancedCacheItemPoolStats getStats()

Get provider statistics

Return Value

EnhancedCacheItemPoolStats

at line 63
getProperties()

at line 144
string|null clearNamespace()

Chear the whole (current) namespace

Return Value

string|null

at line 212
bool test()

Test the pool

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

Return Value

bool