1. class
  2. Hypervel
  3. \
  4. Redis
  5. \
  6. PhpRedisConnection

PhpRedisConnection

class PhpRedisConnection extends RedisConnection

Standard phpredis connection for standalone Redis and Sentinel.

Traits

Macroable

Constants

private CONNECTION_LEVEL_PHPREDIS_OPTIONS

Top-level connection config keys that should be applied through setOption.

Properties

protected float $lastUseTime from  Connection
protected float $lastReleaseTime from  Connection
protected bool $invalid from  Connection
static protected array $macros

The registered string macros.

 from  Macroable
protected Redis|RedisCluster|null $connection from  RedisConnection
protected float $createdAt from  RedisConnection
protected float $lifetimeExpiresAt from  RedisConnection
protected bool $availableForReuse from  RedisConnection
protected Dispatcher|null $eventDispatcher from  RedisConnection
protected array $config from  RedisConnection
protected int|null $database

Current redis database.

 from  RedisConnection
protected bool $watching

Determine if the native connection is watching keys.

 from  RedisConnection
protected bool $shouldTransform

Determine if the connection calls should be transformed to Laravel style.

 from  RedisConnection

Methods

__construct(Container $container, PoolInterface $pool, array $config)

Create a new PhpRedis connection instance.

void
release()

Release the connection back to pool.

from  RedisConnection
void
discard()

Discard the connection from its pool.

from  Connection
mixed
getConnection()

Get the underlying connection, with retry on failure.

from  Connection
bool
check()

Check if the connection is still valid.

from  RedisConnection
float
getLastUseTime()

Get the last use time.

from  Connection
float
getLastReleaseTime()

Get the last release time.

from  Connection
void
markInvalid()

Mark the connection as invalid.

from  Connection
void
markValid()

Mark the connection as valid.

from  Connection
mixed
getActiveConnection()

Get the active connection.

from  RedisConnection
static void
macro(string $name, callable|object $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Check if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
string
getName()

Get the connection name.

from  RedisConnection
Dispatcher|null
getEventDispatcher()

Get the event dispatcher instance.

from  RedisConnection
bool
reconnect()

Reconnect to Redis.

void
markReconnected()

Mark the underlying Redis client as freshly connected.

from  RedisConnection
void
setOptions(Redis|RedisCluster $redis)

Set configured options on a Redis or RedisCluster client.

from  RedisConnection
array
configuredPhpRedisOptions()

Get the phpredis options configured on the connection.

from  RedisConnection
int
phpRedisOption(string $name)

Resolve a phpredis option name to its native option constant.

from  RedisConnection
int
parseBackoffAlgorithm(mixed $algorithm)

Parse a friendly phpredis backoff algorithm name.

from  RedisConnection
bool
close()

Close the current connection.

from  RedisConnection
bool
heartbeatCheck(float $timeout)

Check the Redis client for heartbeat health.

from  RedisConnection
bool|Redis
discardTransaction()

Execute the native Redis DISCARD command.

from  RedisConnection
void
clearWatchState()

Clear the tracked watch state after callback-form transaction completion.

from  RedisConnection
void
setDatabase(int|null $database)

Set current redis database.

from  RedisConnection
bool
isIdleExpired(float|null $now = null)

Determine if this connection has been idle long enough to be evicted.

from  RedisConnection
float
getCreatedAt()

Get the connection generation creation time.

from  RedisConnection
bool
isLifetimeExpired(float|null $now = null)

Determine if this connection generation has reached its maximum lifetime.

from  RedisConnection
bool
shouldInvalidateAfter(RedisException $exception)

Determine whether a failed command left the connection unsafe to reuse.

from  RedisConnection
bool
isQueueingMode()

Determine if the underlying Redis client is in pipeline/multi mode.

bool
isCluster()

Determine if the connection is to a Redis Cluster.

static bool
hasHashTag(string $key)

Determine if the given key contains a Redis Cluster hash tag.

from  RedisConnection
bool
pingForHeartbeat()

Ping Redis for heartbeat health without shadowing the public Redis PING command.

from  RedisConnection
void
log(string $message, string $level = LogLevel::WARNING)

Log a redis connection message.

from  RedisConnection
RedisConnection
shouldTransform(bool $shouldTransform = true)

Determine if the connection calls should be transformed to Laravel style.

from  RedisConnection
bool
getShouldTransform()

Get the current transformation state.

from  RedisConnection
string|null
callGet(string $key)

Returns the value of the given key.

from  RedisConnection
array
callMget(array $keys)

Get the values of all the given keys.

from  RedisConnection
array
prepareSet(mixed ...$arguments)

Prepare arguments for the set command.

from  RedisConnection
bool
callSet(string $key, mixed $value, string|null $expireResolution = null, int|null $expireTTL = null, string|null $flag = null)

Set the string value in the argument as the value of the key.

from  RedisConnection
int
callSetnx(string $key, mixed $value)

Set the given key if it doesn't exist.

from  RedisConnection
array
prepareHmget(mixed ...$arguments)

Prepare arguments for the hmget command.

from  RedisConnection
array
callHmget(string $key, mixed ...$dictionary)

Get the value of the given hash fields.

from  RedisConnection
array
prepareHmset(mixed ...$arguments)

Prepare arguments for the hmset command.

from  RedisConnection
bool
callHmset(string $key, mixed ...$dictionary)

Set the given hash fields to their respective values.

from  RedisConnection
int
callHsetnx(string $hash, string $key, mixed $value)

Set the given hash field if it doesn't exist.

from  RedisConnection
array
prepareLrem(mixed ...$arguments)

Prepare arguments for the lrem command.

from  RedisConnection
false|int
callLrem(string $key, int $count, mixed $value)

Removes the first count occurrences of the value element from the list.

from  RedisConnection
array|null
callBlpop(mixed ...$arguments)

Removes and returns the first element of the list stored at key.

from  RedisConnection
array|null
callBrpop(mixed ...$arguments)

Removes and returns the last element of the list stored at key.

from  RedisConnection
mixed
callSpop(string $key, int|null $count = null)

Removes and returns random elements from the set value at key.

from  RedisConnection
array
prepareZadd(mixed ...$arguments)

Prepare arguments for the zadd command.

from  RedisConnection
int
callZadd(string $key, mixed ...$dictionary)

Add one or more members to a sorted set or update its score if it already exists.

from  RedisConnection
array
prepareZrangebyscore(mixed ...$arguments)

Prepare arguments for the zrangebyscore command.

from  RedisConnection
array
callZrangebyscore(string $key, mixed $min, mixed $max, array $options = [])

Return elements with score between $min and $max.

from  RedisConnection
array
prepareZrevrangebyscore(mixed ...$arguments)

Prepare arguments for the zrevrangebyscore command.

from  RedisConnection
array
callZrevrangebyscore(string $key, mixed $max, mixed $min, array $options = [])

Return elements with score between $max and $min in reverse order.

from  RedisConnection
array
prepareZinterstore(mixed ...$arguments)

Prepare arguments for the zinterstore command.

from  RedisConnection
int
callZinterstore(string $output, array $keys, array $options = [])

Find the intersection between sets and store in a new set.

from  RedisConnection
array
prepareZunionstore(mixed ...$arguments)

Prepare arguments for the zunionstore command.

from  RedisConnection
int
callZunionstore(string $output, array $keys, array $options = [])

Find the union between sets and store in a new set.

from  RedisConnection
array
getScanOptions(array $arguments)

Get the Redis scan options.

from  RedisConnection
mixed
scan(mixed $cursor, array ...$arguments)

Scans all keys based on options.

from  RedisConnection
mixed
zscan(string $key, mixed $cursor, array ...$arguments)

Scans the given set for all values based on options.

from  RedisConnection
mixed
hscan(string $key, mixed $cursor, array ...$arguments)

Scans the given hash for all values based on options.

from  RedisConnection
mixed
sscan(string $key, mixed $cursor, array ...$arguments)

Scans the given set for all values based on options.

from  RedisConnection
array
prepareEval(mixed ...$arguments)

Prepare arguments for the eval command.

from  RedisConnection
mixed
callEval(string $script, int $numberOfKeys, mixed ...$arguments)

Evaluate a script and return its result.

from  RedisConnection
array
prepareEvalsha(mixed ...$arguments)

Prepare arguments for the evalsha command.

from  RedisConnection
mixed
callEvalsha(string $script, int $numkeys, mixed ...$arguments)

Evaluate a LUA script serverside, from the SHA1 hash of the script instead of the script itself.

from  RedisConnection
array
prepareExecuteRaw(mixed ...$arguments)

Prepare arguments for the executeRaw command.

from  RedisConnection
mixed
callExecuteRaw(array $parameters)

Execute a raw command.

from  RedisConnection
never
callSubscribe(string $name, array $arguments)

Reject subscriptions on raw pooled connections.

from  RedisConnection
bool
serialized()

Determine if a custom serializer is configured on the connection.

from  RedisConnection
bool
compressed()

Determine if compression is configured on the connection.

from  RedisConnection
mixed
withoutSerializationOrCompression(callable $callback)

Execute the given callback without serialization or compression.

from  RedisConnection
array
pack(array $values)

Pack values for use in Lua script ARGV parameters.

from  RedisConnection
mixed
client(string $opt = '\'\'', mixed ...$args)

No description

from  RedisConnection
mixed
evalWithShaCache(string $script, array $keys = [], array $args = [])

Execute a Lua script using evalSha with automatic fallback to eval.

from  RedisConnection
Generator
safeScan(string $pattern, int $count = 1000)

Safely scan the Redis keyspace for keys matching a pattern.

from  RedisConnection
int
flushByPattern(string $pattern)

Flush (delete) all Redis keys matching a pattern.

from  RedisConnection
mixed
get(string $key)

Get the value of a key

from  RedisConnection
bool
set(string $key, mixed $value, mixed $expireResolution = 'null', mixed $expireTTL = 'null', mixed $flag = 'null')

Set the value of a key

from  RedisConnection
array
mget(array $keys)

Get the values of multiple keys

from  RedisConnection
Redis
setnx(string $key, mixed $value)

Set key if not exists

from  RedisConnection
Redis
setNx(string $key, mixed $value)

Set key if not exists

from  RedisConnection
Redis
hmget(string $key, array $fields)

Get hash field values

from  RedisConnection
Redis
hmset(string $key, array $fieldValues)

Set hash field values

from  RedisConnection
Redis
hsetnx(string $hash, string $key, mixed $value)

Set hash field if not exists

from  RedisConnection
mixed
hget(string $key, string $member)

Get hash field value

from  RedisConnection
Redis
hset(string $key, mixed ...$fields_and_vals)

Set hash field values

from  RedisConnection
false|int
lrem(string $key, int $count, mixed $value)

Remove list elements

from  RedisConnection
Redis
llen(string $key)

Get list length

from  RedisConnection
Redis
blpop(array|string $key_or_keys, float|int|string $timeout_or_key, mixed ...$extra_args)

Blocking left pop from list

from  RedisConnection
Redis
brpop(array|string $key_or_keys, float|int|string $timeout_or_key, mixed ...$extra_args)

Blocking right pop from list

from  RedisConnection
mixed
spop(string $key, int $count = '0')

Remove and return random set member

from  RedisConnection
Redis
sRem(string $key, mixed $value, mixed ...$other_values)

Remove members from set

from  RedisConnection
Redis
zadd(string $key, array|float $score_or_options, mixed ...$more_scores_and_mems)

Add members to sorted set

from  RedisConnection
Redis
zcard(string $key)

Get sorted set cardinality

from  RedisConnection
Redis
zcount(string $key, int|string $start, int|string $end)

Count sorted set members by score range

from  RedisConnection
Redis
zrangebyscore(string $key, string $min, string $max, array $options = '[]')

Get sorted set members by score range

from  RedisConnection
Redis
zrevrangebyscore(string $key, string $max, string $min, array $options = '[]') Get sorted set members by score range (reverse)

No description

from  RedisConnection
int
zinterstore(string $output, array $keys, array $options = '[]')

Intersect sorted sets

from  RedisConnection
int
zunionstore(string $output, array $keys, array $options = '[]')

Union sorted sets

from  RedisConnection
mixed
eval(string $script, int $numberOfKeys, mixed ...$arguments)

Evaluate Lua script

from  RedisConnection
mixed
evalsha(string $script, int $numkeys, mixed ...$arguments)

Evaluate Lua script by SHA1

from  RedisConnection
mixed
flushdb(mixed ...$arguments)

Flush database

from  RedisConnection
mixed
executeRaw(array $parameters)

Execute raw Redis command

from  RedisConnection
mixed
pipeline(callable|null $callback = 'null')

Execute commands in a pipeline

from  RedisConnection
Redis
smembers(string $key)

Get all set members

from  RedisConnection
Redis
hdel(string $key, string $field, string ...$other_fields)

Delete hash fields

from  RedisConnection
Redis
zrem(mixed $key, mixed $member, mixed ...$other_members)

Remove sorted set members

from  RedisConnection
Redis
hlen(string $key)

Get number of hash fields

from  RedisConnection
Redis
hkeys(string $key)

Get all hash field names

from  RedisConnection
string
_serialize(mixed $value)

Serialize a value using configured serializer

from  RedisConnection
string
_digest(mixed $value)

No description

from  RedisConnection
string
_pack(mixed $value)

No description

from  RedisConnection
mixed
_unpack(string $value)

No description

from  RedisConnection
mixed
acl(string $subcmd, string ...$args)

No description

from  RedisConnection
Redis
append(string $key, mixed $value)

No description

from  RedisConnection
Redis
auth(mixed $credentials)

No description

from  RedisConnection
Redis
bgSave()

No description

from  RedisConnection
Redis
bgrewriteaof()

No description

from  RedisConnection
Redis
waitaof(int $numlocal, int $numreplicas, int $timeout)

No description

from  RedisConnection
Redis
bitcount(string $key, int $start = '0', int $end = '-1', bool $bybit = 'false')

No description

from  RedisConnection
Redis
bitop(string $operation, string $deskey, string $srckey, string ...$other_keys)

No description

from  RedisConnection
Redis
bitpos(string $key, bool $bit, int $start = '0', int $end = '-1', bool $bybit = 'false')

No description

from  RedisConnection
Redis
blPop(array|string $key_or_keys, float|int|string $timeout_or_key, mixed ...$extra_args)

No description

from  RedisConnection
Redis
brPop(array|string $key_or_keys, float|int|string $timeout_or_key, mixed ...$extra_args)

No description

from  RedisConnection
Redis|string
brpoplpush(string $src, string $dst, float|int $timeout)

No description

from  RedisConnection
Redis
bzPopMax(array|string $key, int|string $timeout_or_key, mixed ...$extra_args)

No description

from  RedisConnection
Redis
bzPopMin(array|string $key, int|string $timeout_or_key, mixed ...$extra_args)

No description

from  RedisConnection
Redis
bzmpop(float $timeout, array $keys, string $from, int $count = '1')

No description

from  RedisConnection
Redis
zmpop(array $keys, string $from, int $count = '1')

No description

from  RedisConnection
Redis
blmpop(float $timeout, array $keys, string $from, int $count = '1')

No description

from  RedisConnection
Redis
lmpop(array $keys, string $from, int $count = '1')

No description

from  RedisConnection
bool
clearLastError()

No description

from  RedisConnection
mixed
command(string|null $opt = 'null', mixed ...$args)

No description

from  RedisConnection
mixed
config(string $operation, array|string|null $key_or_settings = 'null', string|null $value = 'null')

No description

from  RedisConnection
bool
connect(string $host, int $port = '6379', float $timeout = '0', string|null $persistent_id = 'null', int $retry_interval = '0', float $read_timeout = '0', array|null $context = 'null')

No description

from  RedisConnection
Redis
copy(string $src, string $dst, array|null $options = 'null')

No description

from  RedisConnection
Redis
dbSize()

No description

from  RedisConnection
Redis|string
debug(string $key)

No description

from  RedisConnection
Redis
decr(string $key, int $by = '1')

No description

from  RedisConnection
Redis
decrBy(string $key, int $value)

No description

from  RedisConnection
Redis
del(array|string $key, string ...$other_keys)

No description

from  RedisConnection
Redis
delex(string $key, array|null $options = 'null')

No description

from  RedisConnection
Redis
delifeq(string $key, mixed $value)

No description

from  RedisConnection
Redis|string
digest(string $key)

No description

from  RedisConnection
Redis|string
dump(string $key)

No description

from  RedisConnection
Redis|string
echo(string $str)

No description

from  RedisConnection
mixed
eval_ro(string $script_sha, array $args = '[]', int $num_keys = '0')

No description

from  RedisConnection
mixed
evalsha_ro(string $sha1, array $args = '[]', int $num_keys = '0')

No description

from  RedisConnection
Redis
exec()

No description

from  RedisConnection
Redis
exists(mixed $key, mixed ...$other_keys)

No description

from  RedisConnection
Redis
expire(string $key, int $timeout, string|null $mode = 'null')

No description

from  RedisConnection
Redis
expireAt(string $key, int $timestamp, string|null $mode = 'null')

No description

from  RedisConnection
Redis
failover(array|null $to = 'null', bool $abort = 'false', int $timeout = '0')

No description

from  RedisConnection
Redis
expiretime(string $key)

No description

from  RedisConnection
Redis
pexpiretime(string $key)

No description

from  RedisConnection
mixed
fcall(string $fn, array $keys = '[]', array $args = '[]')

No description

from  RedisConnection
mixed
fcall_ro(string $fn, array $keys = '[]', array $args = '[]')

No description

from  RedisConnection
Redis
flushAll(bool|null $sync = 'null')

No description

from  RedisConnection
mixed
flushDB(mixed ...$arguments)

No description

from  RedisConnection
Redis|string
function(string $operation, mixed ...$args)

No description

from  RedisConnection
Redis
geoadd(string $key, float $lng, float $lat, string $member, mixed ...$other_triples_and_options)

No description

from  RedisConnection
Redis
geodist(string $key, string $src, string $dst, string|null $unit = 'null')

No description

from  RedisConnection
Redis
geohash(string $key, string $member, string ...$other_members)

No description

from  RedisConnection
Redis
geopos(string $key, string $member, string ...$other_members)

No description

from  RedisConnection
mixed
georadius(string $key, float $lng, float $lat, float $radius, string $unit, array $options = '[]')

No description

from  RedisConnection
mixed
georadius_ro(string $key, float $lng, float $lat, float $radius, string $unit, array $options = '[]')

No description

from  RedisConnection
mixed
georadiusbymember(string $key, string $member, float $radius, string $unit, array $options = '[]')

No description

from  RedisConnection
mixed
georadiusbymember_ro(string $key, string $member, float $radius, string $unit, array $options = '[]')

No description

from  RedisConnection
array
geosearch(string $key, array|string $position, array|int|float $shape, string $unit, array $options = '[]')

No description

from  RedisConnection
Redis
geosearchstore(string $dst, string $src, array|string $position, array|int|float $shape, string $unit, array $options = '[]')

No description

from  RedisConnection
mixed
getAuth()

No description

from  RedisConnection
Redis
getBit(string $key, int $idx)

No description

from  RedisConnection
Redis|string
getEx(string $key, array $options = '[]')

No description

from  RedisConnection
int
getDBNum()

No description

from  RedisConnection
Redis|string
getDel(string $key)

No description

from  RedisConnection
string
getHost()

No description

from  RedisConnection
null|string
getLastError()

No description

from  RedisConnection
int
getMode()

No description

from  RedisConnection
mixed
getOption(int $option)

No description

from  RedisConnection
null|string
getPersistentID()

No description

from  RedisConnection
int
getPort()

No description

from  RedisConnection
Redis|string
getRange(string $key, int $start, int $end)

No description

from  RedisConnection
Redis|string
lcs(string $key1, string $key2, array|null $options = 'null')

No description

from  RedisConnection
float
getReadTimeout()

No description

from  RedisConnection
Redis|string
getset(string $key, mixed $value)

No description

from  RedisConnection
false|float
getTimeout()

No description

from  RedisConnection
array
getTransferredBytes()

No description

from  RedisConnection
void
clearTransferredBytes()

No description

from  RedisConnection
Redis
getWithMeta(string $key)

No description

from  RedisConnection
Redis
hDel(string $key, string $field, string ...$other_fields)

No description

from  RedisConnection
Redis
hexpire(string $key, int $ttl, array $fields, string|null $mode = 'null')

No description

from  RedisConnection
Redis
hpexpire(string $key, int $ttl, array $fields, string|null $mode = 'null')

No description

from  RedisConnection
Redis
hexpireat(string $key, int $time, array $fields, string|null $mode = 'null')

No description

from  RedisConnection
Redis
hpexpireat(string $key, int $mstime, array $fields, string|null $mode = 'null')

No description

from  RedisConnection
Redis
httl(string $key, array $fields)

No description

from  RedisConnection
Redis
hpttl(string $key, array $fields)

No description

from  RedisConnection
Redis
hexpiretime(string $key, array $fields)

No description

from  RedisConnection
Redis
hpexpiretime(string $key, array $fields)

No description

from  RedisConnection
Redis
hpersist(string $key, array $fields)

No description

from  RedisConnection
Redis
hExists(string $key, string $field)

No description

from  RedisConnection
mixed
hGet(string $key, string $member)

No description

from  RedisConnection
Redis
hGetAll(string $key)

No description

from  RedisConnection
mixed
hGetWithMeta(string $key, string $member)

No description

from  RedisConnection
Redis
hgetdel(string $key, array $fields)

No description

from  RedisConnection
Redis
hgetex(string $key, array $fields, string|array|null $expiry = 'null')

No description

from  RedisConnection
Redis
hIncrBy(string $key, string $field, int $value)

No description

from  RedisConnection
Redis
hIncrByFloat(string $key, string $field, float $value)

No description

from  RedisConnection
Redis
hKeys(string $key)

No description

from  RedisConnection
Redis
hLen(string $key)

No description

from  RedisConnection
Redis
hMget(string $key, array $fields)

No description

from  RedisConnection
Redis
hMset(string $key, array $fieldValues)

No description

from  RedisConnection
Redis|string
hRandField(string $key, array|null $options = 'null')

No description

from  RedisConnection
Redis
hSet(string $key, mixed ...$fields_and_vals)

No description

from  RedisConnection
Redis
hSetNx(string $hash, string $key, mixed $value)

No description

from  RedisConnection
Redis
hsetex(string $key, array $fields, array|null $expiry = 'null')

No description

from  RedisConnection
Redis
hStrLen(string $key, string $field)

No description

from  RedisConnection
Redis
hVals(string $key)

No description

from  RedisConnection
Redis
incr(string $key, int $by = '1')

No description

from  RedisConnection
Redis
incrBy(string $key, int $value)

No description

from  RedisConnection
Redis
incrByFloat(string $key, float $value)

No description

from  RedisConnection
Redis
info(string ...$sections)

No description

from  RedisConnection
bool
isConnected()

No description

from  RedisConnection
void
keys(string $pattern)

No description

from  RedisConnection
void
lInsert(string $key, string $pos, mixed $pivot, mixed $value)

No description

from  RedisConnection
Redis
lLen(string $key)

No description

from  RedisConnection
Redis|string
lMove(string $src, string $dst, string $wherefrom, string $whereto)

No description

from  RedisConnection
Redis|string
blmove(string $src, string $dst, string $wherefrom, string $whereto, float $timeout)

No description

from  RedisConnection
Redis|string
lPop(string $key, int $count = '0')

No description

from  RedisConnection
Redis
lPos(string $key, mixed $value, array|null $options = 'null')

No description

from  RedisConnection
Redis
lPush(string $key, mixed ...$elements)

No description

from  RedisConnection
Redis
rPush(string $key, mixed ...$elements)

No description

from  RedisConnection
Redis
lPushx(string $key, mixed $value)

No description

from  RedisConnection
Redis
rPushx(string $key, mixed $value)

No description

from  RedisConnection
Redis
lSet(string $key, int $index, mixed $value)

No description

from  RedisConnection
int
lastSave()

No description

from  RedisConnection
mixed
lindex(string $key, int $index)

No description

from  RedisConnection
Redis
lrange(string $key, int $start, int $end)

No description

from  RedisConnection
Redis
ltrim(string $key, int $start, int $end)

No description

from  RedisConnection
Redis
migrate(string $host, int $port, array|string $key, int $dstdb, int $timeout, bool $copy = 'false', bool $replace = 'false', mixed $credentials = 'null')

No description

from  RedisConnection
Redis
move(string $key, int $index)

No description

from  RedisConnection
Redis
mset(array $key_values)

No description

from  RedisConnection
Redis
msetex(array $key_values, int|float|array|null $expiry = 'null')

No description

from  RedisConnection
Redis
msetnx(array $key_values)

No description

from  RedisConnection
Redis
multi(int $value = '1')

No description

from  RedisConnection
Redis|string
object(string $subcommand, string $key)

No description

from  RedisConnection
bool
pconnect(string $host, int $port = '6379', float $timeout = '0', string|null $persistent_id = 'null', int $retry_interval = '0', float $read_timeout = '0', array|null $context = 'null')

No description

from  RedisConnection
Redis
persist(string $key)

No description

from  RedisConnection
bool
pexpire(string $key, int $timeout, string|null $mode = 'null')

No description

from  RedisConnection
Redis
pexpireAt(string $key, int $timestamp, string|null $mode = 'null')

No description

from  RedisConnection
Redis
pfadd(string $key, array $elements)

No description

from  RedisConnection
Redis
pfcount(array|string $key_or_keys)

No description

from  RedisConnection
Redis
pfmerge(string $dst, array $srckeys)

No description

from  RedisConnection
Redis|string
ping(string|null $message = 'null')

No description

from  RedisConnection
Redis
psetex(string $key, int $expire, mixed $value)

No description

from  RedisConnection
void
psubscribe(array|string $channels, Closure $callback)

No description

from  RedisConnection
Redis
pttl(string $key)

No description

from  RedisConnection
Redis
publish(string $channel, string $message)

No description

from  RedisConnection
mixed
pubsub(string $command, mixed $arg = 'null')

No description

from  RedisConnection
Redis
punsubscribe(array $patterns)

No description

from  RedisConnection
Redis|string
rPop(string $key, int $count = '0')

No description

from  RedisConnection
Redis|string
randomKey()

No description

from  RedisConnection
mixed
rawcommand(string $command, mixed ...$args)

No description

from  RedisConnection
Redis
rename(string $old_name, string $new_name)

No description

from  RedisConnection
Redis
renameNx(string $key_src, string $key_dst)

No description

from  RedisConnection
Redis
restore(string $key, int $ttl, string $value, array|null $options = 'null')

No description

from  RedisConnection
mixed
role()

No description

from  RedisConnection
Redis|string
rpoplpush(string $srckey, string $dstkey)

No description

from  RedisConnection
Redis
sAdd(string $key, mixed $value, mixed ...$other_values)

No description

from  RedisConnection
int
sAddArray(string $key, array $values)

No description

from  RedisConnection
Redis
sDiff(string $key, string ...$other_keys)

No description

from  RedisConnection
Redis
sDiffStore(string $dst, string $key, string ...$other_keys)

No description

from  RedisConnection
Redis
sInter(array|string $key, string ...$other_keys)

No description

from  RedisConnection
Redis
sintercard(array $keys, int $limit = '-1')

No description

from  RedisConnection
Redis
sInterStore(array|string $key, string ...$other_keys)

No description

from  RedisConnection
Redis
sMembers(string $key)

No description

from  RedisConnection
Redis
sMisMember(string $key, string $member, string ...$other_members)

No description

from  RedisConnection
Redis
sMove(string $src, string $dst, mixed $value)

No description

from  RedisConnection
mixed
sPop(string $key, int $count = '0')

No description

from  RedisConnection
mixed
sRandMember(string $key, int $count = '0')

No description

from  RedisConnection
Redis
sUnion(string $key, string ...$other_keys)

No description

from  RedisConnection
Redis
sUnionStore(string $dst, string $key, string ...$other_keys)

No description

from  RedisConnection
Redis
save()

No description

from  RedisConnection
Redis
scard(string $key)

No description

from  RedisConnection
mixed
script(string $command, mixed ...$args)

No description

from  RedisConnection
Redis
select(int $db)

No description

from  RedisConnection
false|string
serverName()

No description

from  RedisConnection
false|string
serverVersion()

No description

from  RedisConnection
Redis
setBit(string $key, int $idx, bool $value)

No description

from  RedisConnection
Redis
setRange(string $key, int $index, string $value)

No description

from  RedisConnection
bool
setOption(int $option, mixed $value)

No description

from  RedisConnection
Redis
setex(string $key, int $expire, mixed $value)

No description

from  RedisConnection
Redis
sismember(string $key, mixed $value)

No description

from  RedisConnection
Redis
replicaof(string|null $host = 'null', int $port = '6379')

No description

from  RedisConnection
Redis
touch(array|string $key_or_array, string ...$more_keys)

No description

from  RedisConnection
mixed
slowlog(string $operation, int $length = '0')

No description

from  RedisConnection
mixed
sort(string $key, array|null $options = 'null')

No description

from  RedisConnection
mixed
sort_ro(string $key, array|null $options = 'null')

No description

from  RedisConnection
Redis
srem(string $key, mixed $value, mixed ...$other_values)

No description

from  RedisConnection
Redis
strlen(string $key)

No description

from  RedisConnection
void
subscribe(array|string $channels, Closure $callback)

No description

from  RedisConnection
Redis
sunsubscribe(array $channels)

No description

from  RedisConnection
Redis
swapdb(int $src, int $dst)

No description

from  RedisConnection
Redis
time()

No description

from  RedisConnection
Redis
ttl(string $key)

No description

from  RedisConnection
Redis
type(string $key)

No description

from  RedisConnection
Redis
unlink(array|string $key, string ...$other_keys)

No description

from  RedisConnection
Redis
unsubscribe(array $channels)

No description

from  RedisConnection
Redis
unwatch()

No description

from  RedisConnection
Redis
vadd(string $key, array $values, mixed $element, array|null $options = 'null')

No description

from  RedisConnection
Redis
vcard(string $key)

No description

from  RedisConnection
Redis
vdim(string $key)

No description

from  RedisConnection
Redis
vemb(string $key, mixed $member, bool $raw = 'false')

No description

from  RedisConnection
Redis|string
vgetattr(string $key, mixed $member, bool $decode = 'true')

No description

from  RedisConnection
Redis
vinfo(string $key)

No description

from  RedisConnection
Redis
vismember(string $key, mixed $member)

No description

from  RedisConnection
Redis
vlinks(string $key, mixed $member, bool $withscores = 'false')

No description

from  RedisConnection
Redis|string
vrandmember(string $key, int $count = '0')

No description

from  RedisConnection
Redis
vrange(string $key, string $min, string $max, int $count = '-1')

No description

from  RedisConnection
Redis
vrem(string $key, mixed $member)

No description

from  RedisConnection
Redis
vsetattr(string $key, mixed $member, array|string $attributes)

No description

from  RedisConnection
Redis
vsim(string $key, mixed $member, array|null $options = 'null')

No description

from  RedisConnection
Redis
watch(array|string $key, string ...$other_keys)

No description

from  RedisConnection
false|int
wait(int $numreplicas, int $timeout)

No description

from  RedisConnection
false|int
xack(string $key, string $group, array $ids)

No description

from  RedisConnection
Redis|string
xadd(string $key, string $id, array $values, int $maxlen = '0', bool $approx = 'false', bool $nomkstream = 'false')

No description

from  RedisConnection
Redis
xautoclaim(string $key, string $group, string $consumer, int $min_idle, string $start, int $count = '-1', bool $justid = 'false')

No description

from  RedisConnection
Redis
xclaim(string $key, string $group, string $consumer, int $min_idle, array $ids, array $options)

No description

from  RedisConnection
Redis
xdel(string $key, array $ids)

No description

from  RedisConnection
Redis
xdelex(string $key, array $ids, string|null $mode = 'null')

No description

from  RedisConnection
mixed
xgroup(string $operation, string|null $key = 'null', string|null $group = 'null', string|null $id_or_consumer = 'null', bool $mkstream = 'false', int $entries_read = '-2')

No description

from  RedisConnection
mixed
xinfo(string $operation, string|null $arg1 = 'null', string|null $arg2 = 'null', int $count = '-1')

No description

from  RedisConnection
Redis
xlen(string $key)

No description

from  RedisConnection
Redis
xpending(string $key, string $group, string|null $start = 'null', string|null $end = 'null', int $count = '-1', string|null $consumer = 'null')

No description

from  RedisConnection
Redis
xrange(string $key, string $start, string $end, int $count = '-1')

No description

from  RedisConnection
Redis
xread(array $streams, int $count = '-1', int $block = '-1')

No description

from  RedisConnection
Redis
xreadgroup(string $group, string $consumer, array $streams, int $count = '1', int $block = '1')

No description

from  RedisConnection
Redis
xrevrange(string $key, string $end, string $start, int $count = '-1')

No description

from  RedisConnection
Redis
xtrim(string $key, string $threshold, bool $approx = 'false', bool $minid = 'false', int $limit = '-1')

No description

from  RedisConnection
Redis
zAdd(string $key, array|float $score_or_options, mixed ...$more_scores_and_mems)

No description

from  RedisConnection
Redis
zCard(string $key)

No description

from  RedisConnection
Redis
zCount(string $key, int|string $start, int|string $end)

No description

from  RedisConnection
Redis
zIncrBy(string $key, float $value, mixed $member)

No description

from  RedisConnection
Redis
zLexCount(string $key, string $min, string $max)

No description

from  RedisConnection
Redis
zMscore(string $key, mixed $member, mixed ...$other_members)

No description

from  RedisConnection
Redis
zPopMax(string $key, int|null $count = 'null')

No description

from  RedisConnection
Redis
zPopMin(string $key, int|null $count = 'null')

No description

from  RedisConnection
Redis
zRange(string $key, string|int $start, string|int $end, array|bool|null $options = 'null')

No description

from  RedisConnection
Redis
zRangeByLex(string $key, string $min, string $max, int $offset = '-1', int $count = '-1')

No description

from  RedisConnection
Redis
zRangeByScore(string $key, string $min, string $max, array $options = '[]')

No description

from  RedisConnection
Redis
zrangestore(string $dstkey, string $srckey, string $start, string $end, array|bool|null $options = 'null')

No description

from  RedisConnection
Redis|string
zRandMember(string $key, array|null $options = 'null')

No description

from  RedisConnection
Redis
zRank(string $key, mixed $member)

No description

from  RedisConnection
Redis
zRem(mixed $key, mixed $member, mixed ...$other_members)

No description

from  RedisConnection
Redis
zRemRangeByLex(string $key, string $min, string $max)

No description

from  RedisConnection
Redis
zRemRangeByRank(string $key, int $start, int $end)

No description

from  RedisConnection
Redis
zRemRangeByScore(string $key, string $start, string $end)

No description

from  RedisConnection
Redis
zRevRange(string $key, int $start, int $end, mixed $scores = 'null')

No description

from  RedisConnection
Redis
zRevRangeByLex(string $key, string $max, string $min, int $offset = '-1', int $count = '-1')

No description

from  RedisConnection
Redis
zRevRangeByScore(string $key, string $max, string $min, array $options = '[]')

No description

from  RedisConnection
Redis
zRevRank(string $key, mixed $member)

No description

from  RedisConnection
Redis
zScore(string $key, mixed $member)

No description

from  RedisConnection
Redis
zdiff(array $keys, array|null $options = 'null')

No description

from  RedisConnection
Redis
zdiffstore(string $dst, array $keys)

No description

from  RedisConnection
Redis
zinter(array $keys, array|null $weights = 'null', array|null $options = 'null')

No description

from  RedisConnection
Redis
zintercard(array $keys, int $limit = '-1')

No description

from  RedisConnection
Redis
zunion(array $keys, array|null $weights = 'null', array|null $options = 'null')

No description

from  RedisConnection
mixed
callFlushdb(mixed ...$arguments)

Flush the selected Redis database.

Redis
createRedis(array $config)

Create a redis connection.

string
formatHost(array $config)

Format the host using the scheme if available.

array
normalizeContext(array $context)

Normalize the SSL context for a standalone Redis connection.

Redis
createRedisSentinel()

Create a redis sentinel connection.

Details

at line 26
__construct(Container $container, PoolInterface $pool, array $config)

Create a new PhpRedis connection instance.

Parameters

Container $container
PoolInterface $pool
array $config

in RedisConnection at line 732
void release()

Release the connection back to pool.

Return Value

void

in Connection at line 68
void discard()

Discard the connection from its pool.

Return Value

void

in Connection at line 76
mixed getConnection()

Get the underlying connection, with retry on failure.

Return Value

mixed

in RedisConnection at line 513
bool check()

Check if the connection is still valid.

Return Value

bool

in Connection at line 109
float getLastUseTime()

Get the last use time.

Return Value

float

in Connection at line 117
float getLastReleaseTime()

Get the last release time.

Return Value

float

in Connection at line 125
protected void markInvalid()

Mark the connection as invalid.

Return Value

void

in Connection at line 133
protected void markValid()

Mark the connection as valid.

Return Value

void

in RedisConnection at line 495
mixed getActiveConnection()

Get the active connection.

Return Value

mixed

in Macroable at line 28
static void macro(string $name, callable|object $macro)

Register a custom macro.

Boot-only. Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.

Parameters

string $name
callable|object $macro

Return Value

void

in Macroable at line 41
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Boot-only. Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 57
static bool hasMacro(string $name)

Check if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 68
static void flushMacros()

Flush the existing macros.

Boot or tests only. Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.

Return Value

void

in Macroable at line 78
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 103
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in RedisConnection at line 542
string getName()

Get the connection name.

Return Value

string

in RedisConnection at line 550
Dispatcher|null getEventDispatcher()

Get the event dispatcher instance.

Return Value

Dispatcher|null

at line 39
bool reconnect()

Reconnect to Redis.

Return Value

bool

Exceptions

RedisException
ConnectionException

in RedisConnection at line 563
protected void markReconnected()

Mark the underlying Redis client as freshly connected.

Return Value

void

in RedisConnection at line 580
protected void setOptions(Redis|RedisCluster $redis)

Set configured options on a Redis or RedisCluster client.

Parameters

Redis|RedisCluster $redis

Return Value

void

in RedisConnection at line 609
protected array configuredPhpRedisOptions()

Get the phpredis options configured on the connection.

Return Value

array

in RedisConnection at line 629
protected int phpRedisOption(string $name)

Resolve a phpredis option name to its native option constant.

Parameters

string $name

Return Value

int

in RedisConnection at line 653
protected int parseBackoffAlgorithm(mixed $algorithm)

Parse a friendly phpredis backoff algorithm name.

Parameters

mixed $algorithm

Return Value

int

in RedisConnection at line 680
bool close()

Close the current connection.

Calling the native phpredis close() releases the underlying socket deterministically rather than relying on PHP refcount destruction - connections trapped in pool/connection reference cycles would otherwise keep their FDs open until the cycle collector runs.

Return Value

bool

in RedisConnection at line 699
bool heartbeatCheck(float $timeout)

Check the Redis client for heartbeat health.

Parameters

float $timeout

Return Value

bool

in RedisConnection at line 803
bool|Redis discardTransaction()

Execute the native Redis DISCARD command.

Use this method on a held connection because discard() removes the connection from its pool.

Return Value

bool|Redis

in RedisConnection at line 819
void clearWatchState()

internal  
 

Clear the tracked watch state after callback-form transaction completion.

Return Value

void

in RedisConnection at line 827
void setDatabase(int|null $database)

Set current redis database.

Parameters

int|null $database

Return Value

void

in RedisConnection at line 835
bool isIdleExpired(float|null $now = null)

Determine if this connection has been idle long enough to be evicted.

Parameters

float|null $now

Return Value

bool

in RedisConnection at line 848
float getCreatedAt()

Get the connection generation creation time.

Return Value

float

in RedisConnection at line 856
bool isLifetimeExpired(float|null $now = null)

Determine if this connection generation has reached its maximum lifetime.

Parameters

float|null $now

Return Value

bool

in RedisConnection at line 868
protected bool shouldInvalidateAfter(RedisException $exception)

Determine whether a failed command left the connection unsafe to reuse.

Parameters

RedisException $exception

Return Value

bool

at line 90
protected bool isQueueingMode()

Determine if the underlying Redis client is in pipeline/multi mode.

Return Value

bool

at line 82
bool isCluster()

Determine if the connection is to a Redis Cluster.

Return Value

bool

in RedisConnection at line 905
static bool hasHashTag(string $key)

Determine if the given key contains a Redis Cluster hash tag.

Parameters

string $key

Return Value

bool

in RedisConnection at line 921
protected bool pingForHeartbeat()

Ping Redis for heartbeat health without shadowing the public Redis PING command.

Return Value

bool

in RedisConnection at line 957
protected void log(string $message, string $level = LogLevel::WARNING)

Log a redis connection message.

Parameters

string $message
string $level

Return Value

void

in RedisConnection at line 967
RedisConnection shouldTransform(bool $shouldTransform = true)

Determine if the connection calls should be transformed to Laravel style.

Parameters

bool $shouldTransform

Return Value

RedisConnection

in RedisConnection at line 977
bool getShouldTransform()

Get the current transformation state.

Return Value

bool

in RedisConnection at line 985
protected string|null callGet(string $key)

Returns the value of the given key.

Parameters

string $key

Return Value

string|null

in RedisConnection at line 995
protected array callMget(array $keys)

Get the values of all the given keys.

Parameters

array $keys

Return Value

array

in RedisConnection at line 1007
protected array prepareSet(mixed ...$arguments)

Prepare arguments for the set command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1020
protected bool callSet(string $key, mixed $value, string|null $expireResolution = null, int|null $expireTTL = null, string|null $flag = null)

Set the string value in the argument as the value of the key.

Parameters

string $key
mixed $value
string|null $expireResolution
int|null $expireTTL
string|null $flag

Return Value

bool

in RedisConnection at line 1030
protected int callSetnx(string $key, mixed $value)

Set the given key if it doesn't exist.

Parameters

string $key
mixed $value

Return Value

int

in RedisConnection at line 1040
protected array prepareHmget(mixed ...$arguments)

Prepare arguments for the hmget command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1051
protected array callHmget(string $key, mixed ...$dictionary)

Get the value of the given hash fields.

Parameters

string $key
mixed ...$dictionary

Return Value

array

in RedisConnection at line 1065
protected array prepareHmset(mixed ...$arguments)

Prepare arguments for the hmset command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1083
protected bool callHmset(string $key, mixed ...$dictionary)

Set the given hash fields to their respective values.

Parameters

string $key
mixed ...$dictionary

Return Value

bool

in RedisConnection at line 1093
protected int callHsetnx(string $hash, string $key, mixed $value)

Set the given hash field if it doesn't exist.

Parameters

string $hash
string $key
mixed $value

Return Value

int

in RedisConnection at line 1103
protected array prepareLrem(mixed ...$arguments)

Prepare arguments for the lrem command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1113
protected false|int callLrem(string $key, int $count, mixed $value)

Removes the first count occurrences of the value element from the list.

Parameters

string $key
int $count
mixed $value

Return Value

false|int

in RedisConnection at line 1123
protected array|null callBlpop(mixed ...$arguments)

Removes and returns the first element of the list stored at key.

Parameters

mixed ...$arguments

Return Value

array|null

in RedisConnection at line 1133
protected array|null callBrpop(mixed ...$arguments)

Removes and returns the last element of the list stored at key.

Parameters

mixed ...$arguments

Return Value

array|null

in RedisConnection at line 1146
protected mixed callSpop(string $key, int|null $count = null)

Removes and returns random elements from the set value at key.

When called without count, returns a single element (string|false). When called with count, returns an array of elements.

Parameters

string $key
int|null $count

Return Value

mixed

in RedisConnection at line 1160
protected array prepareZadd(mixed ...$arguments)

Prepare arguments for the zadd command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1188
protected int callZadd(string $key, mixed ...$dictionary)

Add one or more members to a sorted set or update its score if it already exists.

Parameters

string $key
mixed ...$dictionary

Return Value

int

in RedisConnection at line 1200
protected array prepareZrangebyscore(mixed ...$arguments)

Prepare arguments for the zrangebyscore command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1218
protected array callZrangebyscore(string $key, mixed $min, mixed $max, array $options = [])

Return elements with score between $min and $max.

Parameters

string $key
mixed $min
mixed $max
array $options

Return Value

array

in RedisConnection at line 1230
protected array prepareZrevrangebyscore(mixed ...$arguments)

Prepare arguments for the zrevrangebyscore command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1248
protected array callZrevrangebyscore(string $key, mixed $max, mixed $min, array $options = [])

Return elements with score between $max and $min in reverse order.

Parameters

string $key
mixed $max
mixed $min
array $options

Return Value

array

in RedisConnection at line 1260
protected array prepareZinterstore(mixed ...$arguments)

Prepare arguments for the zinterstore command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1271
protected int callZinterstore(string $output, array $keys, array $options = [])

Find the intersection between sets and store in a new set.

Parameters

string $output
array $keys
array $options

Return Value

int

in RedisConnection at line 1283
protected array prepareZunionstore(mixed ...$arguments)

Prepare arguments for the zunionstore command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1294
protected int callZunionstore(string $output, array $keys, array $options = [])

Find the union between sets and store in a new set.

Parameters

string $output
array $keys
array $options

Return Value

int

in RedisConnection at line 1304
protected array getScanOptions(array $arguments)

Get the Redis scan options.

Parameters

array $arguments

Return Value

array

in RedisConnection at line 1320
mixed scan(mixed $cursor, array ...$arguments)

Scans all keys based on options.

Parameters

mixed $cursor
array ...$arguments

Return Value

mixed

in RedisConnection at line 1348
mixed zscan(string $key, mixed $cursor, array ...$arguments)

Scans the given set for all values based on options.

Parameters

string $key
mixed $cursor
array ...$arguments

Return Value

mixed

in RedisConnection at line 1377
mixed hscan(string $key, mixed $cursor, array ...$arguments)

Scans the given hash for all values based on options.

Parameters

string $key
mixed $cursor
array ...$arguments

Return Value

mixed

in RedisConnection at line 1406
mixed sscan(string $key, mixed $cursor, array ...$arguments)

Scans the given set for all values based on options.

Parameters

string $key
mixed $cursor
array ...$arguments

Return Value

mixed

in RedisConnection at line 1433
protected array prepareEval(mixed ...$arguments)

Prepare arguments for the eval command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1445
protected mixed callEval(string $script, int $numberOfKeys, mixed ...$arguments)

Evaluate a script and return its result.

Parameters

string $script
int $numberOfKeys
mixed ...$arguments

Return Value

mixed

in RedisConnection at line 1460
protected array prepareEvalsha(mixed ...$arguments)

Prepare arguments for the evalsha command.

Falls back to eval in MULTI/PIPELINE mode because script('load') cannot execute synchronously while the connection is queueing.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1472
protected mixed callEvalsha(string $script, int $numkeys, mixed ...$arguments)

Evaluate a LUA script serverside, from the SHA1 hash of the script instead of the script itself.

Parameters

string $script
int $numkeys
mixed ...$arguments

Return Value

mixed

in RedisConnection at line 1486
protected array prepareExecuteRaw(mixed ...$arguments)

Prepare arguments for the executeRaw command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1494
protected mixed callExecuteRaw(array $parameters)

Execute a raw command.

Parameters

array $parameters

Return Value

mixed

in RedisConnection at line 1513
protected never callSubscribe(string $name, array $arguments)

Reject subscriptions on raw pooled connections.

Pub/sub requires a dedicated, long-lived connection that is incompatible with connection pooling. Use the coroutine-native subscriber instead:

Redis::subscribe($channels, $callback);
Redis::psubscribe($channels, $callback);
$subscriber = Redis::subscriber();

Parameters

string $name
array $arguments

Return Value

never

Exceptions

BadMethodCallException

in RedisConnection at line 1524
bool serialized()

Determine if a custom serializer is configured on the connection.

Return Value

bool

in RedisConnection at line 1532
bool compressed()

Determine if compression is configured on the connection.

Return Value

bool

in RedisConnection at line 1544
mixed withoutSerializationOrCompression(callable $callback)

Execute the given callback without serialization or compression.

Temporarily disables phpredis serialization and compression on the raw connection for operations that require raw integer values (e.g., rate limiter counters), then restores the original settings.

Parameters

callable $callback

Return Value

mixed

in RedisConnection at line 1584
array pack(array $values)

Pack values for use in Lua script ARGV parameters.

Unlike regular Redis commands where phpredis auto-serializes, Lua ARGV parameters must be pre-serialized strings.

Requires phpredis 6.0+ which provides the _pack() method.

Parameters

array $values

Return Value

array

in RedisConnection at line 329
mixed client(string $opt = '\'\'', mixed ...$args)

No description

Parameters

string $opt
mixed ...$args

Return Value

mixed

in RedisConnection at line 1621
mixed evalWithShaCache(string $script, array $keys = [], array $args = [])

Execute a Lua script using evalSha with automatic fallback to eval.

Redis caches compiled Lua scripts by SHA1 hash. This method tries evalSha first (uses cached compiled script), and falls back to eval if the script isn't cached yet (NOSCRIPT error).

Unlike naive implementations that treat any false return as NOSCRIPT, this method properly distinguishes NOSCRIPT errors from other failures (syntax errors, OOM, WRONGTYPE, etc.) and throws on non-NOSCRIPT errors.

Parameters

string $script

The Lua script to execute
array $keys

Redis keys (passed as KEYS[] in Lua)
array $args

Additional arguments (passed as ARGV[] in Lua)

Return Value

mixed

The script's return value

Exceptions

LuaScriptException

in RedisConnection at line 1677
Generator safeScan(string $pattern, int $count = 1000)

Safely scan the Redis keyspace for keys matching a pattern.

This method handles the phpredis OPT_PREFIX complexity correctly:

  • Automatically prepends OPT_PREFIX to the scan pattern
  • Strips OPT_PREFIX from returned keys so they work with other commands

The connection must be held with transform disabled so SCAN retains its native phpredis cursor and result shape.

Parameters

string $pattern

The pattern to match (e.g., "cache:users:*"). Should NOT include OPT_PREFIX - it's handled automatically.
int $count

The COUNT hint for SCAN (not a limit, just a hint to Redis)

Return Value

Generator

Yields keys with OPT_PREFIX stripped

in RedisConnection at line 1701
int flushByPattern(string $pattern)

Flush (delete) all Redis keys matching a pattern.

Use this inside withConnection(..., transform: false) when doing multiple operations on the same connection. No connection lifecycle overhead since you're operating on an existing connection.

For standalone/one-off operations, use Redis::flushByPattern() instead, which handles connection lifecycle automatically.

Uses SCAN to iterate keys efficiently and deletes them in batches. Correctly handles OPT_PREFIX to avoid the double-prefixing bug.

Parameters

string $pattern

The pattern to match (e.g., "cache:test:*"). Should NOT include OPT_PREFIX - it's handled automatically.

Return Value

int

Number of keys deleted

in RedisConnection at line 329
mixed get(string $key)

Get the value of a key

Parameters

string $key

Return Value

mixed

in RedisConnection at line 329
bool set(string $key, mixed $value, mixed $expireResolution = 'null', mixed $expireTTL = 'null', mixed $flag = 'null')

Set the value of a key

Parameters

string $key
mixed $value
mixed $expireResolution
mixed $expireTTL
mixed $flag

Return Value

bool

in RedisConnection at line 329
array mget(array $keys)

Get the values of multiple keys

Parameters

array $keys

Return Value

array

in RedisConnection at line 329
Redis setnx(string $key, mixed $value)

Set key if not exists

Parameters

string $key
mixed $value

Return Value

Redis

in RedisConnection at line 329
Redis setNx(string $key, mixed $value)

Set key if not exists

Parameters

string $key
mixed $value

Return Value

Redis

in RedisConnection at line 329
Redis hmget(string $key, array $fields)

Get hash field values

Parameters

string $key
array $fields

Return Value

Redis

in RedisConnection at line 329
Redis hmset(string $key, array $fieldValues)

Set hash field values

Parameters

string $key
array $fieldValues

Return Value

Redis

in RedisConnection at line 329
Redis hsetnx(string $hash, string $key, mixed $value)

Set hash field if not exists

Parameters

string $hash
string $key
mixed $value

Return Value

Redis

in RedisConnection at line 329
mixed hget(string $key, string $member)

Get hash field value

Parameters

string $key
string $member

Return Value

mixed

in RedisConnection at line 329
Redis hset(string $key, mixed ...$fields_and_vals)

Set hash field values

Parameters

string $key
mixed ...$fields_and_vals

Return Value

Redis

in RedisConnection at line 329
false|int lrem(string $key, int $count, mixed $value)

Remove list elements

Parameters

string $key
int $count
mixed $value

Return Value

false|int

in RedisConnection at line 329
Redis llen(string $key)

Get list length

Parameters

string $key

Return Value

Redis

in RedisConnection at line 329
Redis blpop(array|string $key_or_keys, float|int|string $timeout_or_key, mixed ...$extra_args)

Blocking left pop from list

Parameters

array|string $key_or_keys
float|int|string $timeout_or_key
mixed ...$extra_args

Return Value

Redis

in RedisConnection at line 329
Redis brpop(array|string $key_or_keys, float|int|string $timeout_or_key, mixed ...$extra_args)

Blocking right pop from list

Parameters

array|string $key_or_keys
float|int|string $timeout_or_key
mixed ...$extra_args

Return Value

Redis

in RedisConnection at line 329
mixed spop(string $key, int $count = '0')

Remove and return random set member

Parameters

string $key
int $count

Return Value

mixed

in RedisConnection at line 329
Redis sRem(string $key, mixed $value, mixed ...$other_values)

Remove members from set

Parameters

string $key
mixed $value
mixed ...$other_values

Return Value

Redis

in RedisConnection at line 329
Redis zadd(string $key, array|float $score_or_options, mixed ...$more_scores_and_mems)

Add members to sorted set

Parameters

string $key
array|float $score_or_options
mixed ...$more_scores_and_mems

Return Value

Redis

in RedisConnection at line 329
Redis zcard(string $key)

Get sorted set cardinality

Parameters

string $key

Return Value

Redis

in RedisConnection at line 329
Redis zcount(string $key, int|string $start, int|string $end)

Count sorted set members by score range

Parameters

string $key
int|string $start
int|string $end

Return Value

Redis

in RedisConnection at line 329
Redis zrangebyscore(string $key, string $min, string $max, array $options = '[]')

Get sorted set members by score range

Parameters

string $key
string $min
string $max
array $options

Return Value

Redis

in RedisConnection at line 329
Redis zrevrangebyscore(string $key, string $max, string $min, array $options = '[]') Get sorted set members by score range (reverse)

No description

Parameters

string $key
string $max
string $min
array $options

Return Value

Redis

in RedisConnection at line 329
int zinterstore(string $output, array $keys, array $options = '[]')

Intersect sorted sets

Parameters

string $output
array $keys
array $options

Return Value

int

in RedisConnection at line 329
int zunionstore(string $output, array $keys, array $options = '[]')

Union sorted sets

Parameters

string $output
array $keys
array $options

Return Value

int

in RedisConnection at line 329
mixed eval(string $script, int $numberOfKeys, mixed ...$arguments)

Evaluate Lua script

Parameters

string $script
int $numberOfKeys
mixed ...$arguments

Return Value

mixed

in RedisConnection at line 329
mixed evalsha(string $script, int $numkeys, mixed ...$arguments)

Evaluate Lua script by SHA1

Parameters

string $script
int $numkeys
mixed ...$arguments

Return Value

mixed

in RedisConnection at line 329
mixed flushdb(mixed ...$arguments)

Flush database

Parameters

mixed ...$arguments

Return Value

mixed

in RedisConnection at line 329
mixed executeRaw(array $parameters)

Execute raw Redis command

Parameters

array $parameters

Return Value

mixed

in RedisConnection at line 329
mixed pipeline(callable|null $callback = 'null')

Execute commands in a pipeline

Parameters

callable|null $callback

Return Value

mixed

in RedisConnection at line 329
Redis smembers(string $key)

Get all set members

Parameters

string $key

Return Value

Redis

in RedisConnection at line 329
Redis hdel(string $key, string $field, string ...$other_fields)

Delete hash fields

Parameters

string $key
string $field
string ...$other_fields

Return Value

Redis

in RedisConnection at line 329
Redis zrem(mixed $key, mixed $member, mixed ...$other_members)

Remove sorted set members

Parameters

mixed $key
mixed $member
mixed ...$other_members

Return Value

Redis

in RedisConnection at line 329
Redis hlen(string $key)

Get number of hash fields

Parameters

string $key

Return Value

Redis

in RedisConnection at line 329
Redis hkeys(string $key)

Get all hash field names

Parameters

string $key

Return Value

Redis

in RedisConnection at line 329
string _serialize(mixed $value)

Serialize a value using configured serializer

Parameters

mixed $value

Return Value

string

in RedisConnection at line 329
string _digest(mixed $value)

No description

Parameters

mixed $value

Return Value

string

in RedisConnection at line 329
string _pack(mixed $value)

No description

Parameters

mixed $value

Return Value

string

in RedisConnection at line 329
mixed _unpack(string $value)

No description

Parameters

string $value

Return Value

mixed

in RedisConnection at line 329
mixed acl(string $subcmd, string ...$args)

No description

Parameters

string $subcmd
string ...$args

Return Value

mixed

in RedisConnection at line 329
Redis append(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

Redis

in RedisConnection at line 329
Redis auth(mixed $credentials)

No description

Parameters

mixed $credentials

Return Value

Redis

in RedisConnection at line 329
Redis bgSave()

No description

Return Value

Redis

in RedisConnection at line 329
Redis bgrewriteaof()

No description

Return Value

Redis

in RedisConnection at line 329
Redis waitaof(int $numlocal, int $numreplicas, int $timeout)

No description

Parameters

int $numlocal
int $numreplicas
int $timeout

Return Value

Redis

in RedisConnection at line 329
Redis bitcount(string $key, int $start = '0', int $end = '-1', bool $bybit = 'false')

No description

Parameters

string $key
int $start
int $end
bool $bybit

Return Value

Redis

in RedisConnection at line 329
Redis bitop(string $operation, string $deskey, string $srckey, string ...$other_keys)

No description

Parameters

string $operation
string $deskey
string $srckey
string ...$other_keys

Return Value

Redis

in RedisConnection at line 329
Redis bitpos(string $key, bool $bit, int $start = '0', int $end = '-1', bool $bybit = 'false')

No description

Parameters

string $key
bool $bit
int $start
int $end
bool $bybit

Return Value

Redis

in RedisConnection at line 329
Redis blPop(array|string $key_or_keys, float|int|string $timeout_or_key, mixed ...$extra_args)

No description

Parameters

array|string $key_or_keys
float|int|string $timeout_or_key
mixed ...$extra_args

Return Value

Redis

in RedisConnection at line 329
Redis brPop(array|string $key_or_keys, float|int|string $timeout_or_key, mixed ...$extra_args)

No description

Parameters

array|string $key_or_keys
float|int|string $timeout_or_key
mixed ...$extra_args

Return Value

Redis

in RedisConnection at line 329
Redis|string brpoplpush(string $src, string $dst, float|int $timeout)

No description

Parameters

string $src
string $dst
float|int $timeout

Return Value

Redis|string

in RedisConnection at line 329
Redis bzPopMax(array|string $key, int|string $timeout_or_key, mixed ...$extra_args)

No description

Parameters

array|string $key
int|string $timeout_or_key
mixed ...$extra_args

Return Value

Redis

in RedisConnection at line 329
Redis bzPopMin(array|string $key, int|string $timeout_or_key, mixed ...$extra_args)

No description

Parameters

array|string $key
int|string $timeout_or_key
mixed ...$extra_args

Return Value

Redis

in RedisConnection at line 329
Redis bzmpop(float $timeout, array $keys, string $from, int $count = '1')

No description

Parameters

float $timeout
array $keys
string $from
int $count

Return Value

Redis

in RedisConnection at line 329
Redis zmpop(array $keys, string $from, int $count = '1')

No description

Parameters

array $keys
string $from
int $count

Return Value

Redis

in RedisConnection at line 329
Redis blmpop(float $timeout, array $keys, string $from, int $count = '1')

No description

Parameters

float $timeout
array $keys
string $from
int $count

Return Value

Redis

in RedisConnection at line 329
Redis lmpop(array $keys, string $from, int $count = '1')

No description

Parameters

array $keys
string $from
int $count

Return Value

Redis

in RedisConnection at line 329
bool clearLastError()

No description

Return Value

bool

in RedisConnection at line 329
mixed command(string|null $opt = 'null', mixed ...$args)

No description

Parameters

string|null $opt
mixed ...$args

Return Value

mixed

in RedisConnection at line 329
mixed config(string $operation, array|string|null $key_or_settings = 'null', string|null $value = 'null')

No description

Parameters

string $operation
array|string|null $key_or_settings
string|null $value

Return Value

mixed

in RedisConnection at line 329
bool connect(string $host, int $port = '6379', float $timeout = '0', string|null $persistent_id = 'null', int $retry_interval = '0', float $read_timeout = '0', array|null $context = 'null')

No description

Parameters

string $host
int $port
float $timeout
string|null $persistent_id
int $retry_interval
float $read_timeout
array|null $context

Return Value

bool

in RedisConnection at line 329
Redis copy(string $src, string $dst, array|null $options = 'null')

No description

Parameters

string $src
string $dst
array|null $options

Return Value

Redis

in RedisConnection at line 329
Redis dbSize()

No description

Return Value

Redis

in RedisConnection at line 329
Redis|string debug(string $key)

No description

Parameters

string $key

Return Value

Redis|string

in RedisConnection at line 329
Redis decr(string $key, int $by = '1')

No description

Parameters

string $key
int $by

Return Value

Redis

in RedisConnection at line 329
Redis decrBy(string $key, int $value)

No description

Parameters

string $key
int $value

Return Value

Redis

in RedisConnection at line 329
Redis del(array|string $key, string ...$other_keys)

No description

Parameters

array|string $key
string ...$other_keys

Return Value

Redis

in RedisConnection at line 329
Redis delex(string $key, array|null $options = 'null')

No description

Parameters

string $key
array|null $options

Return Value

Redis

in RedisConnection at line 329
Redis delifeq(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

Redis

in RedisConnection at line 329
Redis|string digest(string $key)

No description

Parameters

string $key

Return Value

Redis|string

in RedisConnection at line 329
Redis|string dump(string $key)

No description

Parameters

string $key

Return Value

Redis|string

in RedisConnection at line 329
Redis|string echo(string $str)

No description

Parameters

string $str

Return Value

Redis|string

in RedisConnection at line 329
mixed eval_ro(string $script_sha, array $args = '[]', int $num_keys = '0')

No description

Parameters

string $script_sha
array $args
int $num_keys

Return Value

mixed

in RedisConnection at line 329
mixed evalsha_ro(string $sha1, array $args = '[]', int $num_keys = '0')

No description

Parameters

string $sha1
array $args
int $num_keys

Return Value

mixed

in RedisConnection at line 329
Redis exec()

No description

Return Value

Redis

in RedisConnection at line 329
Redis exists(mixed $key, mixed ...$other_keys)

No description

Parameters

mixed $key
mixed ...$other_keys

Return Value

Redis

in RedisConnection at line 329
Redis expire(string $key, int $timeout, string|null $mode = 'null')

No description

Parameters

string $key
int $timeout
string|null $mode

Return Value

Redis

in RedisConnection at line 329
Redis expireAt(string $key, int $timestamp, string|null $mode = 'null')

No description

Parameters

string $key
int $timestamp
string|null $mode

Return Value

Redis

in RedisConnection at line 329
Redis failover(array|null $to = 'null', bool $abort = 'false', int $timeout = '0')

No description

Parameters

array|null $to
bool $abort
int $timeout

Return Value

Redis

in RedisConnection at line 329
Redis expiretime(string $key)

No description

Parameters

string $key

Return Value

Redis

in RedisConnection at line 329
Redis pexpiretime(string $key)

No description

Parameters

string $key

Return Value

Redis

in RedisConnection at line 329
mixed fcall(string $fn, array $keys = '[]', array $args = '[]')

No description

Parameters

string $fn
array $keys
array $args

Return Value

mixed

in RedisConnection at line 329
mixed fcall_ro(string $fn, array $keys = '[]', array $args = '[]')

No description

Parameters

string $fn
array $keys
array $args

Return Value

mixed

in RedisConnection at line 329
Redis flushAll(bool|null $sync = 'null')

No description

Parameters

bool|null $sync

Return Value

Redis

in RedisConnection at line 329
mixed flushDB(mixed ...$arguments)

No description

Parameters

mixed ...$arguments

Return Value

mixed

in RedisConnection at line 329
Redis|string function(string $operation, mixed ...$args)

No description

Parameters

string $operation
mixed ...$args

Return Value

Redis|string

in RedisConnection at line 329
Redis geoadd(string $key, float $lng, float $lat, string $member, mixed ...$other_triples_and_options)

No description

Parameters

string $key
float $lng
float $lat
string $member
mixed ...$other_triples_and_options

Return Value

Redis

in RedisConnection at line 329
Redis geodist(string $key, string $src, string $dst, string|null $unit = 'null')

No description

Parameters

string $key
string $src
string $dst
string|null $unit

Return Value

Redis

in RedisConnection at line 329
Redis geohash(string $key, string $member, string ...$other_members)

No description

Parameters

string $key
string $member
string ...$other_members

Return Value

Redis

in RedisConnection at line 329
Redis geopos(string $key, string $member, string ...$other_members)

No description

Parameters

string $key
string $member
string ...$other_members

Return Value

Redis

in RedisConnection at line 329
mixed georadius(string $key, float $lng, float $lat, float $radius, string $unit, array $options = '[]')

No description

Parameters

string $key
float $lng
float $lat
float $radius
string $unit
array $options

Return Value

mixed

in RedisConnection at line 329
mixed georadius_ro(string $key, float $lng, float $lat, float $radius, string $unit, array $options = '[]')

No description

Parameters

string $key
float $lng
float $lat
float $radius
string $unit
array $options

Return Value

mixed

in RedisConnection at line 329
mixed georadiusbymember(string $key, string $member, float $radius, string $unit, array $options = '[]')

No description

Parameters

string $key
string $member
float $radius
string $unit
array $options

Return Value

mixed

in RedisConnection at line 329
mixed georadiusbymember_ro(string $key, string $member, float $radius, string $unit, array $options = '[]')

No description

Parameters

string $key
string $member
float $radius
string $unit
array $options

Return Value

mixed

in RedisConnection at line 329
array geosearch(string $key, array|string $position, array|int|float $shape, string $unit, array $options = '[]')

No description

Parameters

string $key
array|string $position
array|int|float $shape
string $unit
array $options

Return Value

array

in RedisConnection at line 329
Redis geosearchstore(string $dst, string $src, array|string $position, array|int|float $shape, string $unit, array $options = '[]')

No description

Parameters

string $dst
string $src
array|string $position
array|int|float $shape
string $unit
array $options

Return Value

Redis

in RedisConnection at line 329
mixed getAuth()

No description

Return Value

mixed

in RedisConnection at line 329
Redis getBit(string $key, int $idx)

No description

Parameters

string $key
int $idx

Return Value

Redis

in RedisConnection at line 329
Redis|string getEx(string $key, array $options = '[]')

No description

Parameters

string $key
array $options

Return Value

Redis|string

in RedisConnection at line 329
int getDBNum()

No description

Return Value

int

in RedisConnection at line 329
Redis|string getDel(string $key)

No description

Parameters

string $key

Return Value

Redis|string

in RedisConnection at line 329
string getHost()

No description

Return Value

string

in RedisConnection at line 329
null|string getLastError()

No description

Return Value

null|string

in RedisConnection at line 329
int getMode()

No description

Return Value

int

in RedisConnection at line 329
mixed getOption(int $option)

No description

Parameters

int $option

Return Value

mixed

in RedisConnection at line 329
null|string getPersistentID()

No description

Return Value

null|string

in RedisConnection at line 329
int getPort()

No description

Return Value

int

in RedisConnection at line 329
Redis|string getRange(string $key, int $start, int $end)

No description

Parameters

string $key
int $start
int $end

Return Value

Redis|string

in RedisConnection at line 329
Redis|string lcs(string $key1, string $key2, array|null $options = 'null')

No description

Parameters

string $key1
string $key2
array|null $options

Return Value

Redis|string

in RedisConnection at line 329
float getReadTimeout()

No description

Return Value

float

in RedisConnection at line 329
Redis|string getset(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

Redis|string

in RedisConnection at line 329
false|float getTimeout()

No description

Return Value

false|float

in RedisConnection at line 329
array getTransferredBytes()

No description

Return Value

array

in RedisConnection at line 329
void clearTransferredBytes()

No description

Return Value

void

in RedisConnection at line 329
Redis getWithMeta(string $key)

No description

Parameters

string $key

Return Value

Redis

in RedisConnection at line 329
Redis hDel(string $key, string $field, string ...$other_fields)

No description

Parameters

string $key
string $field
string ...$other_fields

Return Value

Redis

in RedisConnection at line 329
Redis hexpire(string $key, int $ttl, array $fields, string|null $mode = 'null')

No description

Parameters

string $key
int $ttl
array $fields
string|null $mode

Return Value

Redis

in RedisConnection at line 329
Redis hpexpire(string $key, int $ttl, array $fields, string|null $mode = 'null')

No description

Parameters

string $key
int $ttl
array $fields
string|null $mode

Return Value

Redis

in RedisConnection at line 329
Redis hexpireat(string $key, int $time, array $fields, string|null $mode = 'null')

No description

Parameters

string $key
int $time
array $fields
string|null $mode

Return Value

Redis

in RedisConnection at line 329
Redis hpexpireat(string $key, int $mstime, array $fields, string|null $mode = 'null')

No description

Parameters

string $key
int $mstime
array $fields
string|null $mode

Return Value

Redis

in RedisConnection at line 329
Redis httl(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

Redis

in RedisConnection at line 329
Redis hpttl(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

Redis

in RedisConnection at line 329
Redis hexpiretime(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

Redis

in RedisConnection at line 329
Redis hpexpiretime(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

Redis

in RedisConnection at line 329
Redis hpersist(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

Redis

in RedisConnection at line 329
Redis hExists(string $key, string $field)

No description

Parameters

string $key
string $field

Return Value

Redis

in RedisConnection at line 329
mixed hGet(string $key, string $member)

No description

Parameters

string $key
string $member

Return Value

mixed

in RedisConnection at line 329
Redis hGetAll(string $key)

No description

Parameters

string $key

Return Value

Redis

in RedisConnection at line 329
mixed hGetWithMeta(string $key, string $member)

No description

Parameters

string $key
string $member

Return Value

mixed

in RedisConnection at line 329
Redis hgetdel(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

Redis

in RedisConnection at line 329
Redis hgetex(string $key, array $fields, string|array|null $expiry = 'null')

No description

Parameters

string $key
array $fields
string|array|null $expiry

Return Value

Redis

in RedisConnection at line 329
Redis hIncrBy(string $key, string $field, int $value)

No description

Parameters

string $key
string $field
int $value

Return Value

Redis

in RedisConnection at line 329
Redis hIncrByFloat(string $key, string $field, float $value)

No description

Parameters

string $key
string $field
float $value

Return Value

Redis

in RedisConnection at line 329
Redis hKeys(string $key)

No description

Parameters

string $key

Return Value

Redis

in RedisConnection at line 329
Redis hLen(string $key)

No description

Parameters

string $key

Return Value

Redis

in RedisConnection at line 329
Redis hMget(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

Redis

in RedisConnection at line 329
Redis hMset(string $key, array $fieldValues)

No description

Parameters

string $key
array $fieldValues

Return Value

Redis

in RedisConnection at line 329
Redis|string hRandField(string $key, array|null $options = 'null')

No description

Parameters

string $key
array|null $options

Return Value

Redis|string

in RedisConnection at line 329
Redis hSet(string $key, mixed ...$fields_and_vals)

No description

Parameters

string $key
mixed ...$fields_and_vals

Return Value

Redis

in RedisConnection at line 329
Redis hSetNx(string $hash, string $key, mixed $value)

No description

Parameters

string $hash
string $key
mixed $value

Return Value

Redis

in RedisConnection at line 329
Redis hsetex(string $key, array $fields, array|null $expiry = 'null')

No description

Parameters

string $key
array $fields
array|null $expiry

Return Value

Redis

in RedisConnection at line 329
Redis hStrLen(string $key, string $field)

No description

Parameters

string $key
string $field

Return Value

Redis

in RedisConnection at line 329
Redis hVals(string $key)

No description

Parameters

string $key

Return Value

Redis

in RedisConnection at line 329
Redis incr(string $key, int $by = '1')

No description

Parameters

string $key
int $by

Return Value

Redis

in RedisConnection at line 329
Redis incrBy(string $key, int $value)

No description

Parameters

string $key
int $value

Return Value

Redis

in RedisConnection at line 329
Redis incrByFloat(string $key, float $value)

No description

Parameters

string $key
float $value

Return Value

Redis

in RedisConnection at line 329
Redis info(string ...$sections)

No description

Parameters

string ...$sections

Return Value

Redis

in RedisConnection at line 329
bool isConnected()

No description

Return Value

bool

in RedisConnection at line 329
void keys(string $pattern)

No description

Parameters

string $pattern

Return Value

void

in RedisConnection at line 329
void lInsert(string $key, string $pos, mixed $pivot, mixed $value)

No description

Parameters

string $key
string $pos
mixed $pivot
mixed $value

Return Value

void

in RedisConnection at line 329
Redis lLen(string $key)

No description

Parameters

string $key

Return Value

Redis

in RedisConnection at line 329
Redis|string lMove(string $src, string $dst, string $wherefrom, string $whereto)

No description

Parameters

string $src
string $dst
string $wherefrom
string $whereto

Return Value

Redis|string

in RedisConnection at line 329
Redis|string blmove(string $src, string $dst, string $wherefrom, string $whereto, float $timeout)

No description

Parameters

string $src
string $dst
string $wherefrom
string $whereto
float $timeout

Return Value

Redis|string

in RedisConnection at line 329
Redis|string lPop(string $key, int $count = '0')

No description

Parameters

string $key
int $count

Return Value

Redis|string

in RedisConnection at line 329
Redis lPos(string $key, mixed $value, array|null $options = 'null')

No description

Parameters

string $key
mixed $value
array|null $options

Return Value

Redis

in RedisConnection at line 329
Redis lPush(string $key, mixed ...$elements)

No description

Parameters

string $key
mixed ...$elements

Return Value

Redis

in RedisConnection at line 329
Redis rPush(string $key, mixed ...$elements)

No description

Parameters

string $key
mixed ...$elements

Return Value

Redis

in RedisConnection at line 329
Redis lPushx(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

Redis

in RedisConnection at line 329
Redis rPushx(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

Redis

in RedisConnection at line 329
Redis lSet(string $key, int $index, mixed $value)

No description

Parameters

string $key
int $index
mixed $value

Return Value

Redis

in RedisConnection at line 329
int lastSave()

No description

Return Value

int

in RedisConnection at line 329
mixed lindex(string $key, int $index)

No description

Parameters

string $key
int $index

Return Value

mixed

in RedisConnection at line 329
Redis lrange(string $key, int $start, int $end)

No description

Parameters

string $key
int $start
int $end

Return Value

Redis

in RedisConnection at line 329
Redis ltrim(string $key, int $start, int $end)

No description

Parameters

string $key
int $start
int $end

Return Value

Redis

in RedisConnection at line 329
Redis migrate(string $host, int $port, array|string $key, int $dstdb, int $timeout, bool $copy = 'false', bool $replace = 'false', mixed $credentials = 'null')

No description

Parameters

string $host
int $port
array|string $key
int $dstdb
int $timeout
bool $copy
bool $replace
mixed $credentials

Return Value

Redis

in RedisConnection at line 329
Redis move(string $key, int $index)

No description

Parameters

string $key
int $index

Return Value

Redis

in RedisConnection at line 329
Redis mset(array $key_values)

No description

Parameters

array $key_values

Return Value

Redis

in RedisConnection at line 329
Redis msetex(array $key_values, int|float|array|null $expiry = 'null')

No description

Parameters

array $key_values
int|float|array|null $expiry

Return Value

Redis

in RedisConnection at line 329
Redis msetnx(array $key_values)

No description

Parameters

array $key_values

Return Value

Redis

in RedisConnection at line 329
Redis multi(int $value = '1')

No description

Parameters

int $value

Return Value

Redis

in RedisConnection at line 329
Redis|string object(string $subcommand, string $key)

No description

Parameters

string $subcommand
string $key

Return Value

Redis|string

in RedisConnection at line 329
bool pconnect(string $host, int $port = '6379', float $timeout = '0', string|null $persistent_id = 'null', int $retry_interval = '0', float $read_timeout = '0', array|null $context = 'null')

No description

Parameters

string $host
int $port
float $timeout
string|null $persistent_id
int $retry_interval
float $read_timeout
array|null $context

Return Value

bool

in RedisConnection at line 329
Redis persist(string $key)

No description

Parameters

string $key

Return Value

Redis

in RedisConnection at line 329
bool pexpire(string $key, int $timeout, string|null $mode = 'null')

No description

Parameters

string $key
int $timeout
string|null $mode

Return Value

bool

in RedisConnection at line 329
Redis pexpireAt(string $key, int $timestamp, string|null $mode = 'null')

No description

Parameters

string $key
int $timestamp
string|null $mode

Return Value

Redis

in RedisConnection at line 329
Redis pfadd(string $key, array $elements)

No description

Parameters

string $key
array $elements

Return Value

Redis

in RedisConnection at line 329
Redis pfcount(array|string $key_or_keys)

No description

Parameters

array|string $key_or_keys

Return Value

Redis

in RedisConnection at line 329
Redis pfmerge(string $dst, array $srckeys)

No description

Parameters

string $dst
array $srckeys

Return Value

Redis

in RedisConnection at line 329
Redis|string ping(string|null $message = 'null')

No description

Parameters

string|null $message

Return Value

Redis|string

in RedisConnection at line 329
Redis psetex(string $key, int $expire, mixed $value)

No description

Parameters

string $key
int $expire
mixed $value

Return Value

Redis

in RedisConnection at line 329
void psubscribe(array|string $channels, Closure $callback)

No description

Parameters

array|string $channels
Closure $callback

Return Value

void

in RedisConnection at line 329
Redis pttl(string $key)

No description

Parameters

string $key

Return Value

Redis

in RedisConnection at line 329
Redis publish(string $channel, string $message)

No description

Parameters

string $channel
string $message

Return Value

Redis

in RedisConnection at line 329
mixed pubsub(string $command, mixed $arg = 'null')

No description

Parameters

string $command
mixed $arg

Return Value

mixed

in RedisConnection at line 329
Redis punsubscribe(array $patterns)

No description

Parameters

array $patterns

Return Value

Redis

in RedisConnection at line 329
Redis|string rPop(string $key, int $count = '0')

No description

Parameters

string $key
int $count

Return Value

Redis|string

in RedisConnection at line 329
Redis|string randomKey()

No description

Return Value

Redis|string

in RedisConnection at line 329
mixed rawcommand(string $command, mixed ...$args)

No description

Parameters

string $command
mixed ...$args

Return Value

mixed

in RedisConnection at line 329
Redis rename(string $old_name, string $new_name)

No description

Parameters

string $old_name
string $new_name

Return Value

Redis

in RedisConnection at line 329
Redis renameNx(string $key_src, string $key_dst)

No description

Parameters

string $key_src
string $key_dst

Return Value

Redis

in RedisConnection at line 329
Redis restore(string $key, int $ttl, string $value, array|null $options = 'null')

No description

Parameters

string $key
int $ttl
string $value
array|null $options

Return Value

Redis

in RedisConnection at line 329
mixed role()

No description

Return Value

mixed

in RedisConnection at line 329
Redis|string rpoplpush(string $srckey, string $dstkey)

No description

Parameters

string $srckey
string $dstkey

Return Value

Redis|string

in RedisConnection at line 329
Redis sAdd(string $key, mixed $value, mixed ...$other_values)

No description

Parameters

string $key
mixed $value
mixed ...$other_values

Return Value

Redis

in RedisConnection at line 329
int sAddArray(string $key, array $values)

No description

Parameters

string $key
array $values

Return Value

int

in RedisConnection at line 329
Redis sDiff(string $key, string ...$other_keys)

No description

Parameters

string $key
string ...$other_keys

Return Value

Redis

in RedisConnection at line 329
Redis sDiffStore(string $dst, string $key, string ...$other_keys)

No description

Parameters

string $dst
string $key
string ...$other_keys

Return Value

Redis

in RedisConnection at line 329
Redis sInter(array|string $key, string ...$other_keys)

No description

Parameters

array|string $key
string ...$other_keys

Return Value

Redis

in RedisConnection at line 329
Redis sintercard(array $keys, int $limit = '-1')

No description

Parameters

array $keys
int $limit

Return Value

Redis

in RedisConnection at line 329
Redis sInterStore(array|string $key, string ...$other_keys)

No description

Parameters

array|string $key
string ...$other_keys

Return Value

Redis

in RedisConnection at line 329
Redis sMembers(string $key)

No description

Parameters

string $key

Return Value

Redis

in RedisConnection at line 329
Redis sMisMember(string $key, string $member, string ...$other_members)

No description

Parameters

string $key
string $member
string ...$other_members

Return Value

Redis

in RedisConnection at line 329
Redis sMove(string $src, string $dst, mixed $value)

No description

Parameters

string $src
string $dst
mixed $value

Return Value

Redis

in RedisConnection at line 329
mixed sPop(string $key, int $count = '0')

No description

Parameters

string $key
int $count

Return Value

mixed

in RedisConnection at line 329
mixed sRandMember(string $key, int $count = '0')

No description

Parameters

string $key
int $count

Return Value

mixed

in RedisConnection at line 329
Redis sUnion(string $key, string ...$other_keys)

No description

Parameters

string $key
string ...$other_keys

Return Value

Redis

in RedisConnection at line 329
Redis sUnionStore(string $dst, string $key, string ...$other_keys)

No description

Parameters

string $dst
string $key
string ...$other_keys

Return Value

Redis

in RedisConnection at line 329
Redis save()

No description

Return Value

Redis

in RedisConnection at line 329
Redis scard(string $key)

No description

Parameters

string $key

Return Value

Redis

in RedisConnection at line 329
mixed script(string $command, mixed ...$args)

No description

Parameters

string $command
mixed ...$args

Return Value

mixed

in RedisConnection at line 329
Redis select(int $db)

No description

Parameters

int $db

Return Value

Redis

in RedisConnection at line 329
false|string serverName()

No description

Return Value

false|string

in RedisConnection at line 329
false|string serverVersion()

No description

Return Value

false|string

in RedisConnection at line 329
Redis setBit(string $key, int $idx, bool $value)

No description

Parameters

string $key
int $idx
bool $value

Return Value

Redis

in RedisConnection at line 329
Redis setRange(string $key, int $index, string $value)

No description

Parameters

string $key
int $index
string $value

Return Value

Redis

in RedisConnection at line 329
bool setOption(int $option, mixed $value)

No description

Parameters

int $option
mixed $value

Return Value

bool

in RedisConnection at line 329
Redis setex(string $key, int $expire, mixed $value)

No description

Parameters

string $key
int $expire
mixed $value

Return Value

Redis

in RedisConnection at line 329
Redis sismember(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

Redis

in RedisConnection at line 329
Redis replicaof(string|null $host = 'null', int $port = '6379')

No description

Parameters

string|null $host
int $port

Return Value

Redis

in RedisConnection at line 329
Redis touch(array|string $key_or_array, string ...$more_keys)

No description

Parameters

array|string $key_or_array
string ...$more_keys

Return Value

Redis

in RedisConnection at line 329
mixed slowlog(string $operation, int $length = '0')

No description

Parameters

string $operation
int $length

Return Value

mixed

in RedisConnection at line 329
mixed sort(string $key, array|null $options = 'null')

No description

Parameters

string $key
array|null $options

Return Value

mixed

in RedisConnection at line 329
mixed sort_ro(string $key, array|null $options = 'null')

No description

Parameters

string $key
array|null $options

Return Value

mixed

in RedisConnection at line 329
Redis srem(string $key, mixed $value, mixed ...$other_values)

No description

Parameters

string $key
mixed $value
mixed ...$other_values

Return Value

Redis

in RedisConnection at line 329
Redis strlen(string $key)

No description

Parameters

string $key

Return Value

Redis

in RedisConnection at line 329
void subscribe(array|string $channels, Closure $callback)

No description

Parameters

array|string $channels
Closure $callback

Return Value

void

in RedisConnection at line 329
Redis sunsubscribe(array $channels)

No description

Parameters

array $channels

Return Value

Redis

in RedisConnection at line 329
Redis swapdb(int $src, int $dst)

No description

Parameters

int $src
int $dst

Return Value

Redis

in RedisConnection at line 329
Redis time()

No description

Return Value

Redis

in RedisConnection at line 329
Redis ttl(string $key)

No description

Parameters

string $key

Return Value

Redis

in RedisConnection at line 329
Redis type(string $key)

No description

Parameters

string $key

Return Value

Redis

No description

Parameters

array|string $key
string ...$other_keys

Return Value

Redis

in RedisConnection at line 329
Redis unsubscribe(array $channels)

No description

Parameters

array $channels

Return Value

Redis

in RedisConnection at line 329
Redis unwatch()

No description

Return Value

Redis

in RedisConnection at line 329
Redis vadd(string $key, array $values, mixed $element, array|null $options = 'null')

No description

Parameters

string $key
array $values
mixed $element
array|null $options

Return Value

Redis

in RedisConnection at line 329
Redis vcard(string $key)

No description

Parameters

string $key

Return Value

Redis

in RedisConnection at line 329
Redis vdim(string $key)

No description

Parameters

string $key

Return Value

Redis

in RedisConnection at line 329
Redis vemb(string $key, mixed $member, bool $raw = 'false')

No description

Parameters

string $key
mixed $member
bool $raw

Return Value

Redis

in RedisConnection at line 329
Redis|string vgetattr(string $key, mixed $member, bool $decode = 'true')

No description

Parameters

string $key
mixed $member
bool $decode

Return Value

Redis|string

in RedisConnection at line 329
Redis vinfo(string $key)

No description

Parameters

string $key

Return Value

Redis

in RedisConnection at line 329
Redis vismember(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

Redis

No description

Parameters

string $key
mixed $member
bool $withscores

Return Value

Redis

in RedisConnection at line 329
Redis|string vrandmember(string $key, int $count = '0')

No description

Parameters

string $key
int $count

Return Value

Redis|string

in RedisConnection at line 329
Redis vrange(string $key, string $min, string $max, int $count = '-1')

No description

Parameters

string $key
string $min
string $max
int $count

Return Value

Redis

in RedisConnection at line 329
Redis vrem(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

Redis

in RedisConnection at line 329
Redis vsetattr(string $key, mixed $member, array|string $attributes)

No description

Parameters

string $key
mixed $member
array|string $attributes

Return Value

Redis

in RedisConnection at line 329
Redis vsim(string $key, mixed $member, array|null $options = 'null')

No description

Parameters

string $key
mixed $member
array|null $options

Return Value

Redis

in RedisConnection at line 329
Redis watch(array|string $key, string ...$other_keys)

No description

Parameters

array|string $key
string ...$other_keys

Return Value

Redis

in RedisConnection at line 329
false|int wait(int $numreplicas, int $timeout)

No description

Parameters

int $numreplicas
int $timeout

Return Value

false|int

in RedisConnection at line 329
false|int xack(string $key, string $group, array $ids)

No description

Parameters

string $key
string $group
array $ids

Return Value

false|int

in RedisConnection at line 329
Redis|string xadd(string $key, string $id, array $values, int $maxlen = '0', bool $approx = 'false', bool $nomkstream = 'false')

No description

Parameters

string $key
string $id
array $values
int $maxlen
bool $approx
bool $nomkstream

Return Value

Redis|string

in RedisConnection at line 329
Redis xautoclaim(string $key, string $group, string $consumer, int $min_idle, string $start, int $count = '-1', bool $justid = 'false')

No description

Parameters

string $key
string $group
string $consumer
int $min_idle
string $start
int $count
bool $justid

Return Value

Redis

in RedisConnection at line 329
Redis xclaim(string $key, string $group, string $consumer, int $min_idle, array $ids, array $options)

No description

Parameters

string $key
string $group
string $consumer
int $min_idle
array $ids
array $options

Return Value

Redis

in RedisConnection at line 329
Redis xdel(string $key, array $ids)

No description

Parameters

string $key
array $ids

Return Value

Redis

in RedisConnection at line 329
Redis xdelex(string $key, array $ids, string|null $mode = 'null')

No description

Parameters

string $key
array $ids
string|null $mode

Return Value

Redis

in RedisConnection at line 329
mixed xgroup(string $operation, string|null $key = 'null', string|null $group = 'null', string|null $id_or_consumer = 'null', bool $mkstream = 'false', int $entries_read = '-2')

No description

Parameters

string $operation
string|null $key
string|null $group
string|null $id_or_consumer
bool $mkstream
int $entries_read

Return Value

mixed

in RedisConnection at line 329
mixed xinfo(string $operation, string|null $arg1 = 'null', string|null $arg2 = 'null', int $count = '-1')

No description

Parameters

string $operation
string|null $arg1
string|null $arg2
int $count

Return Value

mixed

in RedisConnection at line 329
Redis xlen(string $key)

No description

Parameters

string $key

Return Value

Redis

in RedisConnection at line 329
Redis xpending(string $key, string $group, string|null $start = 'null', string|null $end = 'null', int $count = '-1', string|null $consumer = 'null')

No description

Parameters

string $key
string $group
string|null $start
string|null $end
int $count
string|null $consumer

Return Value

Redis

in RedisConnection at line 329
Redis xrange(string $key, string $start, string $end, int $count = '-1')

No description

Parameters

string $key
string $start
string $end
int $count

Return Value

Redis

in RedisConnection at line 329
Redis xread(array $streams, int $count = '-1', int $block = '-1')

No description

Parameters

array $streams
int $count
int $block

Return Value

Redis

in RedisConnection at line 329
Redis xreadgroup(string $group, string $consumer, array $streams, int $count = '1', int $block = '1')

No description

Parameters

string $group
string $consumer
array $streams
int $count
int $block

Return Value

Redis

in RedisConnection at line 329
Redis xrevrange(string $key, string $end, string $start, int $count = '-1')

No description

Parameters

string $key
string $end
string $start
int $count

Return Value

Redis

in RedisConnection at line 329
Redis xtrim(string $key, string $threshold, bool $approx = 'false', bool $minid = 'false', int $limit = '-1')

No description

Parameters

string $key
string $threshold
bool $approx
bool $minid
int $limit

Return Value

Redis

in RedisConnection at line 329
Redis zAdd(string $key, array|float $score_or_options, mixed ...$more_scores_and_mems)

No description

Parameters

string $key
array|float $score_or_options
mixed ...$more_scores_and_mems

Return Value

Redis

in RedisConnection at line 329
Redis zCard(string $key)

No description

Parameters

string $key

Return Value

Redis

in RedisConnection at line 329
Redis zCount(string $key, int|string $start, int|string $end)

No description

Parameters

string $key
int|string $start
int|string $end

Return Value

Redis

in RedisConnection at line 329
Redis zIncrBy(string $key, float $value, mixed $member)

No description

Parameters

string $key
float $value
mixed $member

Return Value

Redis

in RedisConnection at line 329
Redis zLexCount(string $key, string $min, string $max)

No description

Parameters

string $key
string $min
string $max

Return Value

Redis

in RedisConnection at line 329
Redis zMscore(string $key, mixed $member, mixed ...$other_members)

No description

Parameters

string $key
mixed $member
mixed ...$other_members

Return Value

Redis

in RedisConnection at line 329
Redis zPopMax(string $key, int|null $count = 'null')

No description

Parameters

string $key
int|null $count

Return Value

Redis

in RedisConnection at line 329
Redis zPopMin(string $key, int|null $count = 'null')

No description

Parameters

string $key
int|null $count

Return Value

Redis

in RedisConnection at line 329
Redis zRange(string $key, string|int $start, string|int $end, array|bool|null $options = 'null')

No description

Parameters

string $key
string|int $start
string|int $end
array|bool|null $options

Return Value

Redis

in RedisConnection at line 329
Redis zRangeByLex(string $key, string $min, string $max, int $offset = '-1', int $count = '-1')

No description

Parameters

string $key
string $min
string $max
int $offset
int $count

Return Value

Redis

in RedisConnection at line 329
Redis zRangeByScore(string $key, string $min, string $max, array $options = '[]')

No description

Parameters

string $key
string $min
string $max
array $options

Return Value

Redis

in RedisConnection at line 329
Redis zrangestore(string $dstkey, string $srckey, string $start, string $end, array|bool|null $options = 'null')

No description

Parameters

string $dstkey
string $srckey
string $start
string $end
array|bool|null $options

Return Value

Redis

in RedisConnection at line 329
Redis|string zRandMember(string $key, array|null $options = 'null')

No description

Parameters

string $key
array|null $options

Return Value

Redis|string

in RedisConnection at line 329
Redis zRank(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

Redis

in RedisConnection at line 329
Redis zRem(mixed $key, mixed $member, mixed ...$other_members)

No description

Parameters

mixed $key
mixed $member
mixed ...$other_members

Return Value

Redis

in RedisConnection at line 329
Redis zRemRangeByLex(string $key, string $min, string $max)

No description

Parameters

string $key
string $min
string $max

Return Value

Redis

in RedisConnection at line 329
Redis zRemRangeByRank(string $key, int $start, int $end)

No description

Parameters

string $key
int $start
int $end

Return Value

Redis

in RedisConnection at line 329
Redis zRemRangeByScore(string $key, string $start, string $end)

No description

Parameters

string $key
string $start
string $end

Return Value

Redis

in RedisConnection at line 329
Redis zRevRange(string $key, int $start, int $end, mixed $scores = 'null')

No description

Parameters

string $key
int $start
int $end
mixed $scores

Return Value

Redis

in RedisConnection at line 329
Redis zRevRangeByLex(string $key, string $max, string $min, int $offset = '-1', int $count = '-1')

No description

Parameters

string $key
string $max
string $min
int $offset
int $count

Return Value

Redis

in RedisConnection at line 329
Redis zRevRangeByScore(string $key, string $max, string $min, array $options = '[]')

No description

Parameters

string $key
string $max
string $min
array $options

Return Value

Redis

in RedisConnection at line 329
Redis zRevRank(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

Redis

in RedisConnection at line 329
Redis zScore(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

Redis

in RedisConnection at line 329
Redis zdiff(array $keys, array|null $options = 'null')

No description

Parameters

array $keys
array|null $options

Return Value

Redis

in RedisConnection at line 329
Redis zdiffstore(string $dst, array $keys)

No description

Parameters

string $dst
array $keys

Return Value

Redis

in RedisConnection at line 329
Redis zinter(array $keys, array|null $weights = 'null', array|null $options = 'null')

No description

Parameters

array $keys
array|null $weights
array|null $options

Return Value

Redis

in RedisConnection at line 329
Redis zintercard(array $keys, int $limit = '-1')

No description

Parameters

array $keys
int $limit

Return Value

Redis

in RedisConnection at line 329
Redis zunion(array $keys, array|null $weights = 'null', array|null $options = 'null')

No description

Parameters

array $keys
array|null $weights
array|null $options

Return Value

Redis

at line 98
protected mixed callFlushdb(mixed ...$arguments)

Flush the selected Redis database.

Parameters

mixed ...$arguments

Return Value

mixed

at line 114
protected Redis createRedis(array $config)

Create a redis connection.

Parameters

array $config

Return Value

Redis

Exceptions

ConnectionException
RedisException

at line 142
protected string formatHost(array $config)

Format the host using the scheme if available.

Parameters

array $config

Return Value

string

at line 175
protected array normalizeContext(array $context)

Normalize the SSL context for a standalone Redis connection.

Parameters

array $context

Return Value

array

at line 193
protected Redis createRedisSentinel()

Create a redis sentinel connection.

Return Value

Redis

Exceptions

ConnectionException