Documentation

TestPool
in package
implements CacheItemPoolInterface uses CacheTrait

Table of Contents

Interfaces

CacheItemPoolInterface
CacheItemPoolInterface generates CacheItemInterface objects.

Methods

clear()  : bool
Deletes all items in the pool.
commit()  : bool
Persists any deferred cache items.
delete()  : bool
deleteItem()  : bool
Removes the item from the pool.
deleteItems()  : bool
Removes multiple items from the pool.
get()  : mixed
getItem()  : CacheItemInterface
Returns a Cache Item representing the specified key.
getItems()  : iterable<string|int, mixed>
Returns a traversable set of cache items.
hasItem()  : bool
Confirms if the cache contains specified cache item.
save()  : bool
Persists a cache item immediately.
saveDeferred()  : bool
Sets a cache item to be persisted later.
doGet()  : mixed

Methods

clear()

Deletes all items in the pool.

public clear() : bool
Return values
bool —

True if the pool was successfully cleared. False if there was an error.

commit()

Persists any deferred cache items.

public commit() : bool
Return values
bool —

True if all not-yet-saved items were successfully saved or there were none. False otherwise.

delete()

public delete(string $key) : bool
Parameters
$key : string
Return values
bool

deleteItem()

Removes the item from the pool.

public deleteItem(mixed $key) : bool
Parameters
$key : mixed

The key to delete.

Return values
bool —

True if the item was successfully removed. False if there was an error.

deleteItems()

Removes multiple items from the pool.

public deleteItems([array<string|int, mixed> $keys = [] ]) : bool
Parameters
$keys : array<string|int, mixed> = []

An array of keys that should be removed from the pool.

Return values
bool —

True if the items were successfully removed. False if there was an error.

get()

public get(string $key, callable $callback[, float|null $beta = null ][, array<string|int, mixed>|null &$metadata = null ]) : mixed
Parameters
$key : string
$callback : callable
$beta : float|null = null
$metadata : array<string|int, mixed>|null = null

getItem()

Returns a Cache Item representing the specified key.

public getItem(mixed $key) : CacheItemInterface

This method must always return a CacheItemInterface object, even in case of a cache miss. It MUST NOT return null.

Parameters
$key : mixed

The key for which to return the corresponding Cache Item.

Return values
CacheItemInterface —

The corresponding Cache Item.

getItems()

Returns a traversable set of cache items.

public getItems([array<string|int, mixed> $key = [] ]) : iterable<string|int, mixed>
Parameters
$key : array<string|int, mixed> = []
Return values
iterable<string|int, mixed> —

An iterable collection of Cache Items keyed by the cache keys of each item. A Cache item will be returned for each key, even if that key is not found. However, if no keys are specified then an empty traversable MUST be returned instead.

hasItem()

Confirms if the cache contains specified cache item.

public hasItem(mixed $key) : bool

Note: This method MAY avoid retrieving the cached value for performance reasons. This could result in a race condition with CacheItemInterface::get(). To avoid such situation use CacheItemInterface::isHit() instead.

Parameters
$key : mixed

The key for which to check existence.

Return values
bool —

True if item exists in the cache, false otherwise.

save()

Persists a cache item immediately.

public save(CacheItemInterface $item) : bool
Parameters
$item : CacheItemInterface

The cache item to save.

Return values
bool —

True if the item was successfully persisted. False if there was an error.

saveDeferred()

Sets a cache item to be persisted later.

public saveDeferred(CacheItemInterface $item) : bool
Parameters
$item : CacheItemInterface

The cache item to save.

Return values
bool —

False if the item could not be queued or if a commit was attempted and failed. True otherwise.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results