Class CachingDecorator
A caching decorator implementing a cache layer for any store.
-
Webmozart\KeyValueStore\Decorator\AbstractDecorator
implements
Webmozart\KeyValueStore\Api\KeyValueStore
-
Webmozart\KeyValueStore\Decorator\CachingDecorator
Methods summary
public
|
#
__construct( Webmozart\KeyValueStore\Api\KeyValueStore $store, Doctrine\Common\Cache\Cache $cache, integer $ttl = 0 )
Creates the store.
Parameters
- $store
- The cached store.
- $cache
- The cache.
- $ttl
The time-to-live for cache entries. If set to
0, cache entries never expire. Throws
InvalidArgumentException
If the provided cache is not supported
Overrides
|
public
|
#
set( integer|string $key, mixed $value )
Sets the value for a key in the store.
Sets the value for a key in the store.
Parameters
- $key
- The key to set.
- $value
- The value to set for the key.
Throws
WriteException If the store cannot be written.
InvalidKeyException If the key is not a string or integer.
SerializationFailedException If the value cannot be serialized.
UnsupportedValueException If the value is not supported by the
implementation.
Overrides
|
public
mixed
|
#
get( integer|string $key, mixed $default = null )
Returns the value of a key in the store.
Returns the value of a key in the store.
Parameters
- $key
- The key to get.
- $default
The default value to return if the key does
not exist. Returns
mixed The value of the key or the default value if the key does
not exist.
Throws
ReadException If the store cannot be read.
InvalidKeyException If the key is not a string or integer.
UnserializationFailedException If the stored value cannot be
unserialized.
Overrides
|
public
mixed
|
#
getOrFail( integer|string $key )
Returns the value of a key in the store.
Returns the value of a key in the store.
Parameters
Returns
mixed
The value of the key.
Throws
ReadException If the store cannot be read.
Webmozart\KeyValueStore\Api\NoSuchKeyExceptionIf the key was not found.
InvalidKeyException If the key is not a string or integer.
UnserializationFailedException If the stored value cannot be
unserialized.
Overrides
|
public
array
|
#
getMultiple( array $keys, mixed $default = null )
Returns the values of multiple keys in the store.
Returns the values of multiple keys in the store.
Parameters
- $keys
- The keys to get. The keys must be strings or integers.
- $default
The default value to return for keys that are not
found. Returns
array
The values of the passed keys, indexed by the keys.
Throws
ReadException If the store cannot be read.
InvalidKeyException If a key is not a string or integer.
UnserializationFailedException If a stored value cannot be
unserialized.
Overrides
|
public
array
|
#
getMultipleOrFail( array $keys )
Returns the values of multiple keys in the store.
Returns the values of multiple keys in the store.
Parameters
- $keys
- The keys to get. The keys must be strings or integers.
Returns
array
The values of the passed keys, indexed by the keys.
Throws
ReadException If the store cannot be read.
Webmozart\KeyValueStore\Api\NoSuchKeyExceptionIf a key was not found.
InvalidKeyException If a key is not a string or integer.
UnserializationFailedException If a stored value cannot be
unserialized.
Overrides
|
public
boolean
|
#
remove( integer|string $key )
Removes a key from the store.
Removes a key from the store.
Parameters
Returns
boolean
Returns true if a key was removed from the store.
Throws
WriteException
If the store cannot be written.
InvalidKeyException
If the key is not a string or integer.
Overrides
|
public
boolean
|
#
exists( integer|string $key )
Returns whether a key exists.
Returns whether a key exists.
Parameters
Returns
boolean
Whether the key exists in the store.
Throws
ReadException
If the store cannot be read.
InvalidKeyException
If the key is not a string or integer.
Overrides
|
public
|
#
clear( )
Removes all keys from the store.
Removes all keys from the store.
Throws
WriteException
If the store cannot be written.
Overrides
|