RedisAdapter
class RedisAdapter extends AbstractAdapter
Traits
RedisTrait | |
AbstractTrait | |
LoggerAwareTrait |
Methods
hasItem($key) {@inheritdoc} | from AbstractTrait | |
clear() {@inheritdoc} | from AbstractTrait | |
deleteItem($key) {@inheritdoc} | from AbstractTrait | |
deleteItems(array $keys) {@inheritdoc} | from AbstractTrait | |
bool | enableVersioning(bool $enable = true) Enables/disables versioning of items. | from AbstractTrait |
reset() {@inheritdoc} | from AbstractTrait | |
static | handleUnserializeCallback($class) | from AbstractTrait |
static AdapterInterface | createSystemCache(string $namespace, int $defaultLifetime, string $version, string $directory, LoggerInterface $logger = null) | from AbstractAdapter |
static Redis|Client | createConnection(string $dsn, array $options = array()) Creates a Redis connection using a DSN configuration. | from RedisTrait |
CacheItem | getItem($key) {@inheritdoc} | from AbstractAdapter |
getItems(array $keys = array()) {@inheritdoc} | from AbstractAdapter | |
save(CacheItemInterface $item) {@inheritdoc} | from AbstractAdapter | |
saveDeferred(CacheItemInterface $item) {@inheritdoc} | from AbstractAdapter | |
commit() {@inheritdoc} | from AbstractAdapter | |
__destruct() | from AbstractAdapter | |
init($redisClient, $namespace = '', $defaultLifetime) | from RedisTrait | |
__construct(Redis|RedisArray|RedisCluster|Client $redisClient, string $namespace = '', int $defaultLifetime) |
Details
hasItem($key)
{@inheritdoc}
Parameters
$key |
clear()
{@inheritdoc}
deleteItem($key)
{@inheritdoc}
Parameters
$key |
deleteItems(array $keys)
{@inheritdoc}
Parameters
array | $keys |
bool enableVersioning(bool $enable = true)
Enables/disables versioning of items.
When versioning is enabled, clearing the cache is atomic and doesn't require listing existing keys to proceed, but old keys may need garbage collection and extra round-trips to the back-end are required.
Calling this method also clears the memoized namespace version and thus forces a resynchonization of it.
Parameters
bool | $enable |
Return Value
bool | the previous state of versioning |
reset()
{@inheritdoc}
static handleUnserializeCallback($class)
Parameters
$class |
static AdapterInterface createSystemCache(string $namespace, int $defaultLifetime, string $version, string $directory, LoggerInterface $logger = null)
Parameters
string | $namespace | |
int | $defaultLifetime | |
string | $version | |
string | $directory | |
LoggerInterface | $logger |
Return Value
AdapterInterface |
static Redis|Client createConnection(string $dsn, array $options = array())
Creates a Redis connection using a DSN configuration.
Example DSN: - redis://localhost - redis://example.com:1234 - redis://[email protected]/13 - redis:///var/run/redis.sock - redis://secret@/var/run/redis.sock/13
Parameters
string | $dsn | |
array | $options | See self::$defaultConnectionOptions |
Return Value
Redis|Client | According to the "class" option |
Exceptions
InvalidArgumentException | when the DSN is invalid |
CacheItem getItem($key)
{@inheritdoc}
Parameters
$key |
Return Value
CacheItem |
getItems(array $keys = array())
{@inheritdoc}
return \Traversable|CacheItem[]
Parameters
array | $keys |
save(CacheItemInterface $item)
{@inheritdoc}
Parameters
CacheItemInterface | $item |
saveDeferred(CacheItemInterface $item)
{@inheritdoc}
Parameters
CacheItemInterface | $item |
commit()
{@inheritdoc}
__destruct()
init($redisClient, $namespace = '', $defaultLifetime)
Parameters
$redisClient | ||
$namespace | ||
$defaultLifetime |
__construct(Redis|RedisArray|RedisCluster|Client $redisClient, string $namespace = '', int $defaultLifetime)
Parameters
Redis|RedisArray|RedisCluster|Client | $redisClient | The redis client |
string | $namespace | The default namespace |
int | $defaultLifetime | The default lifetime |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Cache/Adapter/RedisAdapter.html