class TraceableAdapter implements AdapterInterface, CacheInterface, PruneableInterface, ResettableInterface

An adapter that collects data about all cache calls.

Properties

protected $pool

Methods

__construct(AdapterInterface $pool)

No description

mixed
get(string $key, callable $callback, float $beta = null, array $metadata = null)

Fetches a value from the pool or computes it if not found.

getItem($key)

{@inheritdoc}

hasItem($key)

{@inheritdoc}

deleteItem($key)

{@inheritdoc}

save(CacheItemInterface $item)

{@inheritdoc}

saveDeferred(CacheItemInterface $item)

{@inheritdoc}

getItems(array $keys = [])

{@inheritdoc}

clear()

{@inheritdoc}

deleteItems(array $keys)

{@inheritdoc}

commit()

{@inheritdoc}

bool
prune()

No description

reset()

No description

bool
delete(string $key)

Removes an item from the pool.

getCalls()

No description

clearCalls()

No description

start($name)

No description

Details

at line 33
__construct(AdapterInterface $pool)

Parameters

AdapterInterface $pool

at line 41
mixed get(string $key, callable $callback, float $beta = null, array $metadata = null)

Fetches a value from the pool or computes it if not found.

On cache misses, a callback is called that should return the missing value. This callback is given a PSR-6 CacheItemInterface instance corresponding to the requested key, that could be used e.g. for expiration control. It could also be an ItemInterface instance when its additional features are needed.

Parameters

string $key The key of the item to retrieve from the cache
callable $callback Should return the computed value for the given key/item
float $beta A float that, as it grows, controls the likeliness of triggering early expiration. 0 disables it, INF forces immediate expiration. The default (or providing null) is implementation dependent but should typically be 1.0, which should provide optimal stampede protection. See https://en.wikipedia.org/wiki/Cache_stampede#Probabilistic_early_expiration
array $metadata &$metadata The metadata of the cached item {see ItemInterface::getMetadata()}

Return Value

mixed The value corresponding to the provided key

Exceptions

InvalidArgumentException When $key is not valid or when $beta is negative

at line 73
CacheItem getItem($key)

{@inheritdoc}

Parameters

$key

Return Value

CacheItem

at line 93
hasItem($key)

{@inheritdoc}

Parameters

$key

at line 106
deleteItem($key)

{@inheritdoc}

Parameters

$key

at line 119
save(CacheItemInterface $item)

{@inheritdoc}

Parameters

CacheItemInterface $item

at line 132
saveDeferred(CacheItemInterface $item)

{@inheritdoc}

Parameters

CacheItemInterface $item

at line 145
Traversable|CacheItem[] getItems(array $keys = [])

{@inheritdoc}

Parameters

array $keys

Return Value

Traversable|CacheItem[]

at line 171
clear()

{@inheritdoc}

at line 184
deleteItems(array $keys)

{@inheritdoc}

Parameters

array $keys

at line 198
commit()

{@inheritdoc}

at line 211
bool prune()

Return Value

bool

at line 227
reset()

at line 243
bool delete(string $key)

Removes an item from the pool.

Parameters

string $key The key to delete

Return Value

bool True if the item was successfully removed, false if there was any error

Exceptions

InvalidArgumentException When $key is not valid

at line 253
getCalls()

at line 258
clearCalls()

at line 263
protected start($name)

Parameters

$name