1. interface
  2. Comodojo
  3. \
  4. Cache
  5. \
  6. Interfaces
  7. \
  8. EnhancedCacheItemPoolInterface

EnhancedCacheItemPoolInterface

interface EnhancedCacheItemPoolInterface implements CacheItemPoolInterface (View source)

Constants

CACHE_SUCCESS

CACHE_ERROR

Methods

string
getId()

Returns the internal pool's id

int
getState()

Returns the current state

string|null
getStateMessage()

Returns the current state

DateTimeInterface|null
getStateTime()

Returns the time when the state was determined

EnhancedCacheItemPoolInterface
setState($state, $message = null)

Put provider in error state

bool
test()

Test the pool

string
getNamespace()

Get current namespace

string|null
setNamespace(string $namespace)

Set current namespace

string|null
clearNamespace()

Chear the whole (current) namespace

EnhancedCacheItemPoolStats
getStats()

Get provider statistics

Details

at line 32
string getId()

Returns the internal pool's id

Return Value

string

at line 39
int getState()

Returns the current state

Return Value

int 0 if no error.

at line 46
string|null getStateMessage()

Returns the current state

Return Value

string|null Last error message (if any).

at line 53
DateTimeInterface|null getStateTime()

Returns the time when the state was determined

Return Value

DateTimeInterface|null

at line 62
EnhancedCacheItemPoolInterface setState($state, $message = null)

Put provider in error state

Parameters

$state
$message

Return Value

EnhancedCacheItemPoolInterface The invoked object.

at line 73
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

at line 80
string getNamespace()

Get current namespace

Return Value

string

at line 88
string|null setNamespace(string $namespace)

Set current namespace

Parameters

string $namespace Namespace where $key resides

Return Value

string|null

at line 95
string|null clearNamespace()

Chear the whole (current) namespace

Return Value

string|null

at line 102
EnhancedCacheItemPoolStats getStats()

Get provider statistics

Return Value

EnhancedCacheItemPoolStats