TagAwareAdapterInterface
extends
AdapterInterface
in
Interface for invalidating cached items using tags.
Tags
Table of Contents
- clear() : bool
- Deletes all items in the pool.
- commit() : bool
- Persists any deferred cache items.
- deleteItem() : bool
- Removes the item from the pool.
- deleteItems() : bool
- Removes multiple items from the pool.
- getItem() : CacheItemInterface
- Returns a Cache Item representing the specified key.
- getItems() : array<string|int, mixed>|Traversable
- Returns a traversable set of cache items.
- hasItem() : bool
- Confirms if the cache contains specified cache item.
- invalidateTags() : bool
- Invalidates cached items using tags.
- save() : bool
- Persists a cache item immediately.
- saveDeferred() : bool
- Sets a cache item to be persisted later.
Methods
clear()
Deletes all items in the pool.
public
clear() : bool
Return values
bool —commit()
Persists any deferred cache items.
public
commit() : bool
Return values
bool —deleteItem()
Removes the item from the pool.
public
deleteItem(string $key) : bool
Parameters
- $key : string
Tags
Return values
bool —deleteItems()
Removes multiple items from the pool.
public
deleteItems(array<string|int, string> $keys) : bool
Parameters
- $keys : array<string|int, string>
Tags
Return values
bool —getItem()
Returns a Cache Item representing the specified key.
public
getItem(string $key) : CacheItemInterface
This method must always return a CacheItemInterface object, even in case of a cache miss. It MUST NOT return null.
Parameters
- $key : string
Tags
Return values
CacheItemInterface —getItems()
Returns a traversable set of cache items.
public
getItems([array<string|int, string> $keys = array() ]) : array<string|int, mixed>|Traversable
Parameters
- $keys : array<string|int, string> = array()
Tags
Return values
array<string|int, mixed>|Traversable —hasItem()
Confirms if the cache contains specified cache item.
public
hasItem(string $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 : string
Tags
Return values
bool —invalidateTags()
Invalidates cached items using tags.
public
invalidateTags(array<string|int, string> $tags) : bool
Parameters
- $tags : array<string|int, string>
-
An array of tags to invalidate
Tags
Return values
bool —save()
Persists a cache item immediately.
public
save(CacheItemInterface $item) : bool
Parameters
- $item : CacheItemInterface
Return values
bool —saveDeferred()
Sets a cache item to be persisted later.
public
saveDeferred(CacheItemInterface $item) : bool
Parameters
- $item : CacheItemInterface