Class AbstractRedisStore

An abstract Redis key-value store to support multiple Redis clients without code duplication.

Webmozart\KeyValueStore\AbstractRedisStore implements Webmozart\KeyValueStore\Api\KeyValueStore

Direct known subclasses

Webmozart\KeyValueStore\PhpRedisStore, Webmozart\KeyValueStore\PredisStore

Abstract
Namespace: Webmozart\KeyValueStore
Since: 1.0
Author: Bernhard Schussek bschussek@gmail.com
Author: Titouan Galopin galopintitouan@gmail.com
Located at AbstractRedisStore.php

Methods summary
`abstract protected mixed`	# `clientNotFoundValue( )` Return the value corresponding to "not found" for the internal client. Return the value corresponding to "not found" for the internal client. Returns mixed
`abstract protected mixed`	# `clientGet( string $key )` Call the internal client method to fetch a key. Don't have to catch the exceptions. Call the internal client method to fetch a key. Don't have to catch the exceptions. Parameters `$key` The key to fetch Returns mixed The raw value
`abstract protected array`	# `clientGetMultiple( array $keys )` Call the internal client method to fetch multiple keys. Don't have to catch the exceptions. Call the internal client method to fetch multiple keys. Don't have to catch the exceptions. Parameters `$keys` The keys to fetch Returns array The raw values
`abstract protected`	# `clientSet( string $key, mixed $value )` Call the internal client method to set a value associated to a key. Don't have to catch the exceptions. Call the internal client method to set a value associated to a key. Don't have to catch the exceptions. Parameters `$key` `$value`
`abstract protected boolean`	# `clientRemove( string $key )` Call the internal client method to remove a key. Don't have to catch the exceptions. Call the internal client method to remove a key. Don't have to catch the exceptions. Parameters `$key` Returns boolean true if the removal worked, false otherwise
`abstract protected boolean`	# `clientExists( string $key )` Call the internal client method to check if a key exists. Don't have to catch the exceptions. Call the internal client method to check if a key exists. Don't have to catch the exceptions. Parameters `$key` Returns boolean
`abstract protected`	# `clientClear( )` Call the internal client method to clear all the keys. Don't have to catch the exceptions. Call the internal client method to clear all the keys. Don't have to catch the exceptions.
`abstract protected array`	# `clientKeys( )` Call the internal client method to fetch all the keys. Don't have to catch the exceptions. Call the internal client method to fetch all the keys. Don't have to catch the exceptions. Returns array The keys
`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 `Webmozart\KeyValueStore\Api\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. Implementation of `Webmozart\KeyValueStore\Api\KeyValueStore::getMultiple()`
`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 `Webmozart\KeyValueStore\Api\ReadException` If the store cannot be read. `Webmozart\KeyValueStore\Api\NoSuchKeyException` If a key was not found. InvalidKeyException If a key is not a string or integer. UnserializationFailedException If a stored value cannot be unserialized. Implementation of `Webmozart\KeyValueStore\Api\KeyValueStore::getMultipleOrFail()`
`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 `Webmozart\KeyValueStore\Api\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. Implementation of `Webmozart\KeyValueStore\Api\KeyValueStore::get()`
`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 `$key` The key to get. Returns mixed The value of the key. Throws `Webmozart\KeyValueStore\Api\ReadException` If the store cannot be read. `Webmozart\KeyValueStore\Api\NoSuchKeyException` If the key was not found. InvalidKeyException If the key is not a string or integer. UnserializationFailedException If the stored value cannot be unserialized. Implementation of `Webmozart\KeyValueStore\Api\KeyValueStore::getOrFail()`
`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 `Webmozart\KeyValueStore\Api\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. Implementation of `Webmozart\KeyValueStore\Api\KeyValueStore::set()`
`public boolean`	# `remove( integer\|string $key )` Removes a key from the store. Removes a key from the store. Parameters `$key` The key to remove. Returns boolean Returns `true` if a key was removed from the store. Throws `Webmozart\KeyValueStore\Api\WriteException` If the store cannot be written. InvalidKeyException If the key is not a string or integer. Implementation of `Webmozart\KeyValueStore\Api\KeyValueStore::remove()`
`public boolean`	# `exists( integer\|string $key )` Returns whether a key exists. Returns whether a key exists. Parameters `$key` The key to test. Returns boolean Whether the key exists in the store. Throws `Webmozart\KeyValueStore\Api\ReadException` If the store cannot be read. InvalidKeyException If the key is not a string or integer. Implementation of `Webmozart\KeyValueStore\Api\KeyValueStore::exists()`
`public`	# `clear( )` Removes all keys from the store. Removes all keys from the store. Throws `Webmozart\KeyValueStore\Api\WriteException` If the store cannot be written. Implementation of `Webmozart\KeyValueStore\Api\KeyValueStore::clear()`
`public array`	# `keys( )` Returns all keys currently stored in the store. Returns all keys currently stored in the store. Returns array The keys stored in the store. Each key is either a string or an integer. The order of the keys is undefined. Throws `Webmozart\KeyValueStore\Api\ReadException` If the store cannot be read. Implementation of `Webmozart\KeyValueStore\Api\KeyValueStore::keys()`

Properties summary
`protected object`	`$client` Redis client. Redis client.	#

Namespaces

Classes

Class AbstractRedisStore

Direct known subclasses

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Throws

Implementation of

Returns

Throws

Implementation of