Hypervel\Redis\RedisConnection

abstract class RedisConnection extends Connection

Abstract base class for pooled Redis connections with Laravel-style method transformations.

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
protected float	$createdAt
protected float	$lifetimeExpiresAt
protected bool	$availableForReuse
protected Dispatcher\|null	$eventDispatcher
protected array	$config
protected int\|null	$database	Current redis database.
protected bool	$watching	Determine if the native connection is watching keys.
protected bool	$shouldTransform	Determine if the connection calls should be transformed to Laravel style.

Methods

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

Create a new Redis connection instance.

void

release()

Release the connection back to pool.

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.

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.

static void

macro(string $name, callable|object $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

__call(mixed $name, mixed $arguments)

Pass other method calls down to the underlying client.

string

getName()

Get the connection name.

Dispatcher|null

getEventDispatcher()

Get the event dispatcher instance.

bool

reconnect()

Reconnect to Redis.

void

markReconnected()

Mark the underlying Redis client as freshly connected.

void

setOptions(Redis|RedisCluster $redis)

Set configured options on a Redis or RedisCluster client.

array

configuredPhpRedisOptions()

Get the phpredis options configured on the connection.

int

phpRedisOption(string $name)

Resolve a phpredis option name to its native option constant.

int

parseBackoffAlgorithm(mixed $algorithm)

Parse a friendly phpredis backoff algorithm name.

bool

close()

Close the current connection.

bool

heartbeatCheck(float $timeout)

Check the Redis client for heartbeat health.

bool|Redis

discardTransaction()

Execute the native Redis DISCARD command.

void

clearWatchState()

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

void

setDatabase(int|null $database)

Set current redis database.

bool

isIdleExpired(float|null $now = null)

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

float

getCreatedAt()

Get the connection generation creation time.

bool

isLifetimeExpired(float|null $now = null)

Determine if this connection generation has reached its maximum lifetime.

bool

shouldInvalidateAfter(RedisException $exception)

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

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.

bool

pingForHeartbeat()

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

void

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

Log a redis connection message.

RedisConnection

shouldTransform(bool $shouldTransform = true)

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

bool

getShouldTransform()

Get the current transformation state.

string|null

callGet(string $key)

Returns the value of the given key.

array

callMget(array $keys)

Get the values of all the given keys.

array

prepareSet(mixed ...$arguments)

Prepare arguments for the set command.

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.

int

callSetnx(string $key, mixed $value)

Set the given key if it doesn't exist.

array

prepareHmget(mixed ...$arguments)

Prepare arguments for the hmget command.

array

callHmget(string $key, mixed ...$dictionary)

Get the value of the given hash fields.

array

prepareHmset(mixed ...$arguments)

Prepare arguments for the hmset command.

bool

callHmset(string $key, mixed ...$dictionary)

Set the given hash fields to their respective values.

int

callHsetnx(string $hash, string $key, mixed $value)

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

array

prepareLrem(mixed ...$arguments)

Prepare arguments for the lrem command.

false|int

callLrem(string $key, int $count, mixed $value)

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

array|null

callBlpop(mixed ...$arguments)

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

array|null

callBrpop(mixed ...$arguments)

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

mixed

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

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

array

prepareZadd(mixed ...$arguments)

Prepare arguments for the zadd command.

int

callZadd(string $key, mixed ...$dictionary)

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

array

prepareZrangebyscore(mixed ...$arguments)

Prepare arguments for the zrangebyscore command.

array

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

Return elements with score between $min and $max.

array

prepareZrevrangebyscore(mixed ...$arguments)

Prepare arguments for the zrevrangebyscore command.

array

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

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

array

prepareZinterstore(mixed ...$arguments)

Prepare arguments for the zinterstore command.

int

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

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

array

prepareZunionstore(mixed ...$arguments)

Prepare arguments for the zunionstore command.

int

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

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

array

getScanOptions(array $arguments)

Get the Redis scan options.

mixed

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

Scans all keys based on options.

mixed

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

Scans the given set for all values based on options.

mixed

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

Scans the given hash for all values based on options.

mixed

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

Scans the given set for all values based on options.

array

prepareEval(mixed ...$arguments)

Prepare arguments for the eval command.

mixed

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

Evaluate a script and return its result.

array

prepareEvalsha(mixed ...$arguments)

Prepare arguments for the evalsha command.

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.

array

prepareExecuteRaw(mixed ...$arguments)

Prepare arguments for the executeRaw command.

mixed

callExecuteRaw(array $parameters)

Execute a raw command.

never

callSubscribe(string $name, array $arguments)

Reject subscriptions on raw pooled connections.

bool

serialized()

Determine if a custom serializer is configured on the connection.

bool

compressed()

Determine if compression is configured on the connection.

mixed

withoutSerializationOrCompression(callable $callback)

Execute the given callback without serialization or compression.

array

pack(array $values)

Pack values for use in Lua script ARGV parameters.

mixed

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

No description

mixed

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

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

Generator

safeScan(string $pattern, int $count = 1000)

Safely scan the Redis keyspace for keys matching a pattern.

int

flushByPattern(string $pattern)

Flush (delete) all Redis keys matching a pattern.

mixed

get(string $key)

Get the value of a key

bool

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

Set the value of a key

array

mget(array $keys)

Get the values of multiple keys

Redis

setnx(string $key, mixed $value)

Set key if not exists

Redis

setNx(string $key, mixed $value)

Set key if not exists

Redis

hmget(string $key, array $fields)

Get hash field values

Redis

hmset(string $key, array $fieldValues)

Set hash field values

Redis

hsetnx(string $hash, string $key, mixed $value)

Set hash field if not exists

mixed

hget(string $key, string $member)

Get hash field value

Redis

hset(string $key, mixed ...$fields_and_vals)

Set hash field values

false|int

lrem(string $key, int $count, mixed $value)

Remove list elements

Redis

llen(string $key)

Get list length

Redis

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

Blocking left pop from list

Redis

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

Blocking right pop from list

mixed

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

Remove and return random set member

Redis

sRem(string $key, mixed $value, mixed ...$other_values)

Remove members from set

Redis

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

Add members to sorted set

Redis

zcard(string $key)

Get sorted set cardinality

Redis

zcount(string $key, int|string $start, int|string $end)

Count sorted set members by score range

Redis

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

Get sorted set members by score range

Redis

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

No description

int

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

Intersect sorted sets

int

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

Union sorted sets

mixed

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

Evaluate Lua script

mixed

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

Evaluate Lua script by SHA1

mixed

flushdb(mixed ...$arguments)

Flush database

mixed

executeRaw(array $parameters)

Execute raw Redis command

mixed

pipeline(callable|null $callback = 'null')

Execute commands in a pipeline

Redis

smembers(string $key)

Get all set members

Redis

hdel(string $key, string $field, string ...$other_fields)

Delete hash fields

Redis

zrem(mixed $key, mixed $member, mixed ...$other_members)

Remove sorted set members

Redis

hlen(string $key)

Get number of hash fields

Redis

hkeys(string $key)

Get all hash field names

string

_serialize(mixed $value)

Serialize a value using configured serializer

string

_digest(mixed $value)

No description

string

_pack(mixed $value)

No description

mixed

_unpack(string $value)

No description

mixed

acl(string $subcmd, string ...$args)

No description

Redis

append(string $key, mixed $value)

No description

Redis

auth(mixed $credentials)

No description

Redis

bgSave()

No description

Redis

bgrewriteaof()

No description

Redis

waitaof(int $numlocal, int $numreplicas, int $timeout)

No description

Redis

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

No description

Redis

bitop(string $operation, string $deskey, string $srckey, string ...$other_keys)

No description

Redis

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

No description

Redis

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

No description

Redis

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

No description

Redis|string

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

No description

Redis

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

No description

Redis

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

No description

Redis

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

No description

Redis

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

No description

Redis

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

No description

Redis

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

No description

bool

clearLastError()

No description

mixed

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

No description

mixed

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

No description

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

Redis

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

No description

Redis

dbSize()

No description

Redis|string

debug(string $key)

No description

Redis

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

No description

Redis

decrBy(string $key, int $value)

No description

Redis

del(array|string $key, string ...$other_keys)

No description

Redis

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

No description

Redis

delifeq(string $key, mixed $value)

No description

Redis|string

digest(string $key)

No description

Redis|string

dump(string $key)

No description

Redis|string

echo(string $str)

No description

mixed

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

No description

mixed

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

No description

Redis

exec()

No description

Redis

exists(mixed $key, mixed ...$other_keys)

No description

Redis

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

No description

Redis

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

No description

Redis

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

No description

Redis

expiretime(string $key)

No description

Redis

pexpiretime(string $key)

No description

mixed

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

No description

mixed

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

No description

Redis

flushAll(bool|null $sync = 'null')

No description

mixed

flushDB(mixed ...$arguments)

No description

Redis|string

function(string $operation, mixed ...$args)

No description

Redis

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

No description

Redis

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

No description

Redis

geohash(string $key, string $member, string ...$other_members)

No description

Redis

geopos(string $key, string $member, string ...$other_members)

No description

mixed

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

No description

mixed

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

No description

mixed

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

No description

mixed

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

No description

array

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

No description

Redis

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

No description

mixed

getAuth()

No description

Redis

getBit(string $key, int $idx)

No description

Redis|string

getEx(string $key, array $options = '[]')

No description

int

getDBNum()

No description

Redis|string

getDel(string $key)

No description

string

getHost()

No description

null|string

getLastError()

No description

int

getMode()

No description

mixed

getOption(int $option)

No description

null|string

getPersistentID()

No description

int

getPort()

No description

Redis|string

getRange(string $key, int $start, int $end)

No description

Redis|string

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

No description

float

getReadTimeout()

No description

Redis|string

getset(string $key, mixed $value)

No description

false|float

getTimeout()

No description

array

getTransferredBytes()

No description

void

clearTransferredBytes()

No description

Redis

getWithMeta(string $key)

No description

Redis

hDel(string $key, string $field, string ...$other_fields)

No description

Redis

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

No description

Redis

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

No description

Redis

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

No description

Redis

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

No description

Redis

httl(string $key, array $fields)

No description

Redis

hpttl(string $key, array $fields)

No description

Redis

hexpiretime(string $key, array $fields)

No description

Redis

hpexpiretime(string $key, array $fields)

No description

Redis

hpersist(string $key, array $fields)

No description

Redis

hExists(string $key, string $field)

No description

mixed

hGet(string $key, string $member)

No description

Redis

hGetAll(string $key)

No description

mixed

hGetWithMeta(string $key, string $member)

No description

Redis

hgetdel(string $key, array $fields)

No description

Redis

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

No description

Redis

hIncrBy(string $key, string $field, int $value)

No description

Redis

hIncrByFloat(string $key, string $field, float $value)

No description

Redis

hKeys(string $key)

No description

Redis

hLen(string $key)

No description

Redis

hMget(string $key, array $fields)

No description

Redis

hMset(string $key, array $fieldValues)

No description

Redis|string

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

No description

Redis

hSet(string $key, mixed ...$fields_and_vals)

No description

Redis

hSetNx(string $hash, string $key, mixed $value)

No description

Redis

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

No description

Redis

hStrLen(string $key, string $field)

No description

Redis

hVals(string $key)

No description

Redis

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

No description

Redis

incrBy(string $key, int $value)

No description

Redis

incrByFloat(string $key, float $value)

No description

Redis

info(string ...$sections)

No description

bool

isConnected()

No description

void

keys(string $pattern)

No description

void

lInsert(string $key, string $pos, mixed $pivot, mixed $value)

No description

Redis

lLen(string $key)

No description

Redis|string

lMove(string $src, string $dst, string $wherefrom, string $whereto)

No description

Redis|string

blmove(string $src, string $dst, string $wherefrom, string $whereto, float $timeout)

No description

Redis|string

lPop(string $key, int $count = '0')

No description

Redis

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

No description

Redis

lPush(string $key, mixed ...$elements)

No description

Redis

rPush(string $key, mixed ...$elements)

No description

Redis

lPushx(string $key, mixed $value)

No description

Redis

rPushx(string $key, mixed $value)

No description

Redis

lSet(string $key, int $index, mixed $value)

No description

int

lastSave()

No description

mixed

lindex(string $key, int $index)

No description

Redis

lrange(string $key, int $start, int $end)

No description

Redis

ltrim(string $key, int $start, int $end)

No description

Redis

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

No description

Redis

move(string $key, int $index)

No description

Redis

mset(array $key_values)

No description

Redis

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

No description

Redis

msetnx(array $key_values)

No description

Redis

multi(int $value = '1')

No description

Redis|string

object(string $subcommand, string $key)

No description

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

Redis

persist(string $key)

No description

bool

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

No description

Redis

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

No description

Redis

pfadd(string $key, array $elements)

No description

Redis

pfcount(array|string $key_or_keys)

No description

Redis

pfmerge(string $dst, array $srckeys)

No description

Redis|string

ping(string|null $message = 'null')

No description

Redis

psetex(string $key, int $expire, mixed $value)

No description

void

psubscribe(array|string $channels, Closure $callback)

No description

Redis

pttl(string $key)

No description

Redis

publish(string $channel, string $message)

No description

mixed

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

No description

Redis

punsubscribe(array $patterns)

No description

Redis|string

rPop(string $key, int $count = '0')

No description

Redis|string

randomKey()

No description

mixed

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

No description

Redis

rename(string $old_name, string $new_name)

No description

Redis

renameNx(string $key_src, string $key_dst)

No description

Redis

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

No description

mixed

role()

No description

Redis|string

rpoplpush(string $srckey, string $dstkey)

No description

Redis

sAdd(string $key, mixed $value, mixed ...$other_values)

No description

int

sAddArray(string $key, array $values)

No description

Redis

sDiff(string $key, string ...$other_keys)

No description

Redis

sDiffStore(string $dst, string $key, string ...$other_keys)

No description

Redis

sInter(array|string $key, string ...$other_keys)

No description

Redis

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

No description

Redis

sInterStore(array|string $key, string ...$other_keys)

No description

Redis

sMembers(string $key)

No description

Redis

sMisMember(string $key, string $member, string ...$other_members)

No description

Redis

sMove(string $src, string $dst, mixed $value)

No description

mixed

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

No description

mixed

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

No description

Redis

sUnion(string $key, string ...$other_keys)

No description

Redis

sUnionStore(string $dst, string $key, string ...$other_keys)

No description

Redis

save()

No description

Redis

scard(string $key)

No description

mixed

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

No description

Redis

select(int $db)

No description

false|string

serverName()

No description

false|string

serverVersion()

No description

Redis

setBit(string $key, int $idx, bool $value)

No description

Redis

setRange(string $key, int $index, string $value)

No description

bool

setOption(int $option, mixed $value)

No description

Redis

setex(string $key, int $expire, mixed $value)

No description

Redis

sismember(string $key, mixed $value)

No description

Redis

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

No description

Redis

touch(array|string $key_or_array, string ...$more_keys)

No description

mixed

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

No description

mixed

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

No description

mixed

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

No description

Redis

srem(string $key, mixed $value, mixed ...$other_values)

No description

Redis

strlen(string $key)

No description

void

subscribe(array|string $channels, Closure $callback)

No description

Redis

sunsubscribe(array $channels)

No description

Redis

swapdb(int $src, int $dst)

No description

Redis

time()

No description

Redis

ttl(string $key)

No description

Redis

type(string $key)

No description

Redis

unlink(array|string $key, string ...$other_keys)

No description

Redis

unsubscribe(array $channels)

No description

Redis

unwatch()

No description

Redis

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

No description

Redis

vcard(string $key)

No description

Redis

vdim(string $key)

No description

Redis

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

No description

Redis|string

vgetattr(string $key, mixed $member, bool $decode = 'true')

No description

Redis

vinfo(string $key)

No description

Redis

vismember(string $key, mixed $member)

No description

Redis

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

No description

Redis|string

vrandmember(string $key, int $count = '0')

No description

Redis

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

No description

Redis

vrem(string $key, mixed $member)

No description

Redis

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

No description

Redis

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

No description

Redis

watch(array|string $key, string ...$other_keys)

No description

false|int

wait(int $numreplicas, int $timeout)

No description

false|int

xack(string $key, string $group, array $ids)

No description

Redis|string

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

No description

Redis

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

No description

Redis

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

No description

Redis

xdel(string $key, array $ids)

No description

Redis

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

No description

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

mixed

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

No description

Redis

xlen(string $key)

No description

Redis

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

No description

Redis

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

No description

Redis

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

No description

Redis

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

No description

Redis

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

No description

Redis

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

No description

Redis

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

No description

Redis

zCard(string $key)

No description

Redis

zCount(string $key, int|string $start, int|string $end)

No description

Redis

zIncrBy(string $key, float $value, mixed $member)

No description

Redis

zLexCount(string $key, string $min, string $max)

No description

Redis

zMscore(string $key, mixed $member, mixed ...$other_members)

No description

Redis

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

No description

Redis

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

No description

Redis

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

No description

Redis

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

No description

Redis

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

No description

Redis

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

No description

Redis|string

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

No description

Redis

zRank(string $key, mixed $member)

No description

Redis

zRem(mixed $key, mixed $member, mixed ...$other_members)

No description

Redis

zRemRangeByLex(string $key, string $min, string $max)

No description

Redis

zRemRangeByRank(string $key, int $start, int $end)

No description

Redis

zRemRangeByScore(string $key, string $start, string $end)

No description

Redis

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

No description

Redis

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

No description

Redis

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

No description

Redis

zRevRank(string $key, mixed $member)

No description

Redis

zScore(string $key, mixed $member)

No description

Redis

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

No description

Redis

zdiffstore(string $dst, array $keys)

No description

Redis

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

No description

Redis

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

No description

Redis

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

No description

Details

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

Create a new Redis connection instance.

Parameters

Container	$container
PoolInterface	$pool
array	$config

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

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

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)`

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

at line 415
`__call(mixed $name, mixed $arguments)`

Pass other method calls down to the underlying client.

Parameters

mixed	$name
mixed	$arguments

at line 542
`string getName()`

Get the connection name.

Return Value

string

at line 550
`Dispatcher|null getEventDispatcher()`

Get the event dispatcher instance.

Return Value

Dispatcher|null

at line 558
`abstract bool reconnect()`

Reconnect to Redis.

Return Value

bool

at line 563
`protected void markReconnected()`

Mark the underlying Redis client as freshly connected.

Return Value

void

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

at line 609
`protected array configuredPhpRedisOptions()`

Get the phpredis options configured on the connection.

Return Value

array

at line 629
`protected int phpRedisOption(string $name)`

Resolve a phpredis option name to its native option constant.

Parameters

string

$name

Return Value

int

at line 653
`protected int parseBackoffAlgorithm(mixed $algorithm)`

Parse a friendly phpredis backoff algorithm name.

Parameters

mixed

$algorithm

Return Value

int

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

at line 699
`bool heartbeatCheck(float $timeout)`

Check the Redis client for heartbeat health.

Parameters

float

$timeout

Return Value

bool

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

at line 819
`void clearWatchState()`

internal

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

Return Value

void

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

Set current redis database.

Parameters

int|null

$database

Return Value

void

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

at line 848
`float getCreatedAt()`

Get the connection generation creation time.

Return Value

float

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

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 889
`protected bool isQueueingMode()`

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

Returns false by default. PhpRedisConnection overrides to check the actual mode on the \Redis client.

Return Value

bool

at line 897
`bool isCluster()`

Determine if the connection is to a Redis Cluster.

Return Value

bool

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

at line 921
`protected bool pingForHeartbeat()`

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

Return Value

bool

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

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

at line 977
`bool getShouldTransform()`

Get the current transformation state.

Return Value

bool

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

Returns the value of the given key.

Parameters

string

$key

Return Value

string|null

at line 995
`protected array callMget(array $keys)`

Get the values of all the given keys.

Parameters

array

$keys

Return Value

array

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

Prepare arguments for the set command.

Parameters

mixed

...$arguments

Return Value

array

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

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

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

Prepare arguments for the hmget command.

Parameters

mixed

...$arguments

Return Value

array

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

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

Prepare arguments for the hmset command.

Parameters

mixed

...$arguments

Return Value

array

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

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

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

Prepare arguments for the lrem command.

Parameters

mixed

...$arguments

Return Value

array

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

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

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

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

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

Prepare arguments for the zadd command.

Parameters

mixed

...$arguments

Return Value

array

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

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

Prepare arguments for the zrangebyscore command.

Parameters

mixed

...$arguments

Return Value

array

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

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

Prepare arguments for the zrevrangebyscore command.

Parameters

mixed

...$arguments

Return Value

array

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

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

Prepare arguments for the zinterstore command.

Parameters

mixed

...$arguments

Return Value

array

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

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

Prepare arguments for the zunionstore command.

Parameters

mixed

...$arguments

Return Value

array

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

at line 1304
`protected array getScanOptions(array $arguments)`

Get the Redis scan options.

Parameters

array

$arguments

Return Value

array

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

Scans all keys based on options.

Parameters

mixed	$cursor
array	...$arguments

Return Value

mixed

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

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

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

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

Prepare arguments for the eval command.

Parameters

mixed

...$arguments

Return Value

array

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

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

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

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

Prepare arguments for the executeRaw command.

Parameters

mixed

...$arguments

Return Value

array

at line 1494
`protected mixed callExecuteRaw(array $parameters)`

Execute a raw command.

Parameters

array

$parameters

Return Value

mixed

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

at line 1524
`bool serialized()`

Determine if a custom serializer is configured on the connection.

Return Value

bool

at line 1532
`bool compressed()`

Determine if compression is configured on the connection.

Return Value

bool

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

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

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

No description

Parameters

string	$opt
mixed	...$args

Return Value

mixed

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

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

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

at line 329
`mixed get(string $key)`

Get the value of a key

Parameters

string

$key

Return Value

mixed

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

at line 329
`array mget(array $keys)`

Get the values of multiple keys

Parameters

array

$keys

Return Value

array

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

Set key if not exists

Parameters

string	$key
mixed	$value

Return Value

Redis

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

Set key if not exists

Parameters

string	$key
mixed	$value

Return Value

Redis

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

Get hash field values

Parameters

string	$key
array	$fields

Return Value

Redis

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

Set hash field values

Parameters

string	$key
array	$fieldValues

Return Value

Redis

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

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

Get hash field value

Parameters

string	$key
string	$member

Return Value

mixed

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

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

at line 329
`Redis llen(string $key)`

Get list length

Parameters

string

$key

Return Value

Redis

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

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

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

Remove and return random set member

Parameters

string	$key
int	$count

Return Value

mixed

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

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

at line 329
`Redis zcard(string $key)`

Get sorted set cardinality

Parameters

string

$key

Return Value

Redis

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

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

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

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

Intersect sorted sets

Parameters

string	$output
array	$keys
array	$options

Return Value

int

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

Union sorted sets

Parameters

string	$output
array	$keys
array	$options

Return Value

int

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

Evaluate Lua script

Parameters

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

Return Value

mixed

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

at line 329
`mixed flushdb(mixed ...$arguments)`

Flush database

Parameters

mixed

...$arguments

Return Value

mixed

at line 329
`mixed executeRaw(array $parameters)`

Execute raw Redis command

Parameters

array

$parameters

Return Value

mixed

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

Execute commands in a pipeline

Parameters

callable|null

$callback

Return Value

mixed

at line 329
`Redis smembers(string $key)`

Get all set members

Parameters

string

$key

Return Value

Redis

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

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

at line 329
`Redis hlen(string $key)`

Get number of hash fields

Parameters

string

$key

Return Value

Redis

at line 329
`Redis hkeys(string $key)`

Get all hash field names

Parameters

string

$key

Return Value

Redis

at line 329
`string _serialize(mixed $value)`

Serialize a value using configured serializer

Parameters

mixed

$value

Return Value

string

at line 329
`string _digest(mixed $value)`

No description

Parameters

mixed

$value

Return Value

string

at line 329
`string _pack(mixed $value)`

No description

Parameters

mixed

$value

Return Value

string

at line 329
`mixed _unpack(string $value)`

No description

Parameters

string

$value

Return Value

mixed

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

No description

Parameters

string	$subcmd
string	...$args

Return Value

mixed

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

No description

Parameters

string	$key
mixed	$value

Return Value

Redis

at line 329
`Redis auth(mixed $credentials)`

No description

Parameters

mixed

$credentials

Return Value

Redis

at line 329
`Redis bgSave()`

No description

Return Value

Redis

at line 329
`Redis bgrewriteaof()`

No description

Return Value

Redis

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

No description

Parameters

int	$numlocal
int	$numreplicas
int	$timeout

Return Value

Redis

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

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

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

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

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

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

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

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

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

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

No description

Parameters

array	$keys
string	$from
int	$count

Return Value

Redis

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

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

No description

Parameters

array	$keys
string	$from
int	$count

Return Value

Redis

at line 329
`bool clearLastError()`

No description

Return Value

bool

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

No description

Parameters

string\|null	$opt
mixed	...$args

Return Value

mixed

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

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

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

at line 329
`Redis dbSize()`

No description

Return Value

Redis

at line 329
`Redis|string debug(string $key)`

No description

Parameters

string

$key

Return Value

Redis|string

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

No description

Parameters

string	$key
int	$by

Return Value

Redis

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

No description

Parameters

string	$key
int	$value

Return Value

Redis

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

No description

Parameters

array\|string	$key
string	...$other_keys

Return Value

Redis

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

No description

Parameters

string	$key
array\|null	$options

Return Value

Redis

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

No description

Parameters

string	$key
mixed	$value

Return Value

Redis

at line 329
`Redis|string digest(string $key)`

No description

Parameters

string

$key

Return Value

Redis|string

at line 329
`Redis|string dump(string $key)`

No description

Parameters

string

$key

Return Value

Redis|string

at line 329
`Redis|string echo(string $str)`

No description

Parameters

string

$str

Return Value

Redis|string

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

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

at line 329
`Redis exec()`

No description

Return Value

Redis

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

No description

Parameters

mixed	$key
mixed	...$other_keys

Return Value

Redis

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

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

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

at line 329
`Redis expiretime(string $key)`

No description

Parameters

string

$key

Return Value

Redis

at line 329
`Redis pexpiretime(string $key)`

No description

Parameters

string

$key

Return Value

Redis

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

No description

Parameters

string	$fn
array	$keys
array	$args

Return Value

mixed

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

No description

Parameters

string	$fn
array	$keys
array	$args

Return Value

mixed

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

No description

Parameters

bool|null

$sync

Return Value

Redis

at line 329
`mixed flushDB(mixed ...$arguments)`

No description

Parameters

mixed

...$arguments

Return Value

mixed

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

No description

Parameters

string	$operation
mixed	...$args

Return Value

Redis|string

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

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

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

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

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

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

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

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

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

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

at line 329
`mixed getAuth()`

No description

Return Value

mixed

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

No description

Parameters

string	$key
int	$idx

Return Value

Redis

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

No description

Parameters

string	$key
array	$options

Return Value

Redis|string

at line 329
`int getDBNum()`

No description

Return Value

int

at line 329
`Redis|string getDel(string $key)`

No description

Parameters

string

$key

Return Value

Redis|string

at line 329
`string getHost()`

No description

Return Value

string

at line 329
`null|string getLastError()`

No description

Return Value

null|string

at line 329
`int getMode()`

No description

Return Value

int

at line 329
`mixed getOption(int $option)`

No description

Parameters

int

$option

Return Value

mixed

at line 329
`null|string getPersistentID()`

No description

Return Value

null|string

at line 329
`int getPort()`

No description

Return Value

int

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

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

at line 329
`float getReadTimeout()`

No description

Return Value

float

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

No description

Parameters

string	$key
mixed	$value

Return Value

Redis|string

at line 329
`false|float getTimeout()`

No description

Return Value

false|float

at line 329
`array getTransferredBytes()`

No description

Return Value

array

at line 329
`void clearTransferredBytes()`

No description

Return Value

void

at line 329
`Redis getWithMeta(string $key)`

No description

Parameters

string

$key

Return Value

Redis

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

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

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

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

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

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

No description

Parameters

string	$key
array	$fields

Return Value

Redis

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

No description

Parameters

string	$key
array	$fields

Return Value

Redis

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

No description

Parameters

string	$key
array	$fields

Return Value

Redis

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

No description

Parameters

string	$key
array	$fields

Return Value

Redis

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

No description

Parameters

string	$key
array	$fields

Return Value

Redis

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

No description

Parameters

string	$key
string	$field

Return Value

Redis

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

No description

Parameters

string	$key
string	$member

Return Value

mixed

at line 329
`Redis hGetAll(string $key)`

No description

Parameters

string

$key

Return Value

Redis

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

No description

Parameters

string	$key
string	$member

Return Value

mixed

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

No description

Parameters

string	$key
array	$fields

Return Value

Redis

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

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

No description

Parameters

string	$key
string	$field
int	$value

Return Value

Redis

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

No description

Parameters

string	$key
string	$field
float	$value

Return Value

Redis

at line 329
`Redis hKeys(string $key)`

No description

Parameters

string

$key

Return Value

Redis

at line 329
`Redis hLen(string $key)`

No description

Parameters

string

$key

Return Value

Redis

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

No description

Parameters

string	$key
array	$fields

Return Value

Redis

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

No description

Parameters

string	$key
array	$fieldValues

Return Value

Redis

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

No description

Parameters

string	$key
array\|null	$options

Return Value

Redis|string

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

No description

Parameters

string	$key
mixed	...$fields_and_vals

Return Value

Redis

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

No description

Parameters

string	$hash
string	$key
mixed	$value

Return Value

Redis

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

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

No description

Parameters

string	$key
string	$field

Return Value

Redis

at line 329
`Redis hVals(string $key)`

No description

Parameters

string

$key

Return Value

Redis

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

No description

Parameters

string	$key
int	$by

Return Value

Redis

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

No description

Parameters

string	$key
int	$value

Return Value

Redis

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

No description

Parameters

string	$key
float	$value

Return Value

Redis

at line 329
`Redis info(string ...$sections)`

No description

Parameters

string

...$sections

Return Value

Redis

at line 329
`bool isConnected()`

No description

Return Value

bool

at line 329
`void keys(string $pattern)`

No description

Parameters

string

$pattern

Return Value

void

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

at line 329
`Redis lLen(string $key)`

No description

Parameters

string

$key

Return Value

Redis

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

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

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

No description

Parameters

string	$key
int	$count

Return Value

Redis|string

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

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

No description

Parameters

string	$key
mixed	...$elements

Return Value

Redis

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

No description

Parameters

string	$key
mixed	...$elements

Return Value

Redis

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

No description

Parameters

string	$key
mixed	$value

Return Value

Redis

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

No description

Parameters

string	$key
mixed	$value

Return Value

Redis

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

No description

Parameters

string	$key
int	$index
mixed	$value

Return Value

Redis

at line 329
`int lastSave()`

No description

Return Value

int

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

No description

Parameters

string	$key
int	$index

Return Value

mixed

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

No description

Parameters

string	$key
int	$start
int	$end

Return Value

Redis

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

No description

Parameters

string	$key
int	$start
int	$end

Return Value

Redis

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

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

No description

Parameters

string	$key
int	$index

Return Value

Redis

at line 329
`Redis mset(array $key_values)`

No description

Parameters

array

$key_values

Return Value

Redis

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

at line 329
`Redis msetnx(array $key_values)`

No description

Parameters

array

$key_values

Return Value

Redis

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

No description

Parameters

int

$value

Return Value

Redis

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

No description

Parameters

string	$subcommand
string	$key

Return Value

Redis|string

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

at line 329
`Redis persist(string $key)`

No description

Parameters

string

$key

Return Value

Redis

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

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

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

No description

Parameters

string	$key
array	$elements

Return Value

Redis

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

No description

Parameters

array|string

$key_or_keys

Return Value

Redis

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

No description

Parameters

string	$dst
array	$srckeys

Return Value

Redis

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

No description

Parameters

string|null

$message

Return Value

Redis|string

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

No description

Parameters

string	$key
int	$expire
mixed	$value

Return Value

Redis

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

No description

Parameters

array\|string	$channels
Closure	$callback

Return Value

void

at line 329
`Redis pttl(string $key)`

No description

Parameters

string

$key

Return Value

Redis

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

No description

Parameters

string	$channel
string	$message

Return Value

Redis

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

No description

Parameters

string	$command
mixed	$arg

Return Value

mixed

at line 329
`Redis punsubscribe(array $patterns)`

No description

Parameters

array

$patterns

Return Value

Redis

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

No description

Parameters

string	$key
int	$count

Return Value

Redis|string

at line 329
`Redis|string randomKey()`

No description

Return Value

Redis|string

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

No description

Parameters

string	$command
mixed	...$args

Return Value

mixed

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

No description

Parameters

string	$old_name
string	$new_name

Return Value

Redis

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

No description

Parameters

string	$key_src
string	$key_dst

Return Value

Redis

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

at line 329
`mixed role()`

No description

Return Value

mixed

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

No description

Parameters

string	$srckey
string	$dstkey

Return Value

Redis|string

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

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

No description

Parameters

string	$key
array	$values

Return Value

int

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

No description

Parameters

string	$key
string	...$other_keys

Return Value

Redis

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

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

No description

Parameters

array\|string	$key
string	...$other_keys

Return Value

Redis

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

No description

Parameters

array	$keys
int	$limit

Return Value

Redis

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

No description

Parameters

array\|string	$key
string	...$other_keys

Return Value

Redis

at line 329
`Redis sMembers(string $key)`

No description

Parameters

string

$key

Return Value

Redis

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

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

No description

Parameters

string	$src
string	$dst
mixed	$value

Return Value

Redis

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

No description

Parameters

string	$key
int	$count

Return Value

mixed

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

No description

Parameters

string	$key
int	$count

Return Value

mixed

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

No description

Parameters

string	$key
string	...$other_keys

Return Value

Redis

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

at line 329
`Redis save()`

No description

Return Value

Redis

at line 329
`Redis scard(string $key)`

No description

Parameters

string

$key

Return Value

Redis

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

No description

Parameters

string	$command
mixed	...$args

Return Value

mixed

at line 329
`Redis select(int $db)`

No description

Parameters

int

$db

Return Value

Redis

at line 329
`false|string serverName()`

No description

Return Value

false|string

at line 329
`false|string serverVersion()`

No description

Return Value

false|string

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

No description

Parameters

string	$key
int	$idx
bool	$value

Return Value

Redis

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

No description

Parameters

string	$key
int	$index
string	$value

Return Value

Redis

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

No description

Parameters

int	$option
mixed	$value

Return Value

bool

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

No description

Parameters

string	$key
int	$expire
mixed	$value

Return Value

Redis

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

No description

Parameters

string	$key
mixed	$value

Return Value

Redis

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

No description

Parameters

string\|null	$host
int	$port

Return Value

Redis

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

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

No description

Parameters

string	$operation
int	$length

Return Value

mixed

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

No description

Parameters

string	$key
array\|null	$options

Return Value

mixed

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

No description

Parameters

string	$key
array\|null	$options

Return Value

mixed

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

at line 329
`Redis strlen(string $key)`

No description

Parameters

string

$key

Return Value

Redis

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

No description

Parameters

array\|string	$channels
Closure	$callback

Return Value

void

at line 329
`Redis sunsubscribe(array $channels)`

No description

Parameters

array

$channels

Return Value

Redis

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

No description

Parameters

int	$src
int	$dst

Return Value

Redis

at line 329
`Redis time()`

No description

Return Value

Redis

at line 329
`Redis ttl(string $key)`

No description

Parameters

string

$key

Return Value

Redis

at line 329
`Redis type(string $key)`

No description

Parameters

string

$key

Return Value

Redis

at line 329
`Redis unlink(array|string $key, string ...$other_keys)`

No description

Parameters

array\|string	$key
string	...$other_keys

Return Value

Redis

at line 329
`Redis unsubscribe(array $channels)`

No description

Parameters

array

$channels

Return Value

Redis

at line 329
`Redis unwatch()`

No description

Return Value

Redis

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

at line 329
`Redis vcard(string $key)`

No description

Parameters

string

$key

Return Value

Redis

at line 329
`Redis vdim(string $key)`

No description

Parameters

string

$key

Return Value

Redis

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

No description

Parameters

string	$key
mixed	$member
bool	$raw

Return Value

Redis

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

at line 329
`Redis vinfo(string $key)`

No description

Parameters

string

$key

Return Value

Redis

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

No description

Parameters

string	$key
mixed	$member

Return Value

Redis

at line 329
`Redis vlinks(string $key, mixed $member, bool $withscores = 'false')`

No description

Parameters

string	$key
mixed	$member
bool	$withscores

Return Value

Redis

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

No description

Parameters

string	$key
int	$count

Return Value

Redis|string

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

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

No description

Parameters

string	$key
mixed	$member

Return Value

Redis

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

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

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

No description

Parameters

array\|string	$key
string	...$other_keys

Return Value

Redis

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

No description

Parameters

int	$numreplicas
int	$timeout

Return Value

false|int

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

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

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

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

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

No description

Parameters

string	$key
array	$ids

Return Value

Redis

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

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

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

at line 329
`Redis xlen(string $key)`

No description

Parameters

string

$key

Return Value

Redis

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

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

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

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

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

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

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

at line 329
`Redis zCard(string $key)`

No description

Parameters

string

$key

Return Value

Redis

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

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

No description

Parameters

string	$key
float	$value
mixed	$member

Return Value

Redis

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

No description

Parameters

string	$key
string	$min
string	$max

Return Value

Redis

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

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

No description

Parameters

string	$key
int\|null	$count

Return Value

Redis

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

No description

Parameters

string	$key
int\|null	$count

Return Value

Redis

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

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

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

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

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

No description

Parameters

string	$key
array\|null	$options

Return Value

Redis|string

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

No description

Parameters

string	$key
mixed	$member

Return Value

Redis

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

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

No description

Parameters

string	$key
string	$min
string	$max

Return Value

Redis

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

No description

Parameters

string	$key
int	$start
int	$end

Return Value

Redis

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

No description

Parameters

string	$key
string	$start
string	$end

Return Value

Redis

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

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

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

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

No description

Parameters

string	$key
mixed	$member

Return Value

Redis

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

No description

Parameters

string	$key
mixed	$member

Return Value

Redis

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

No description

Parameters

array	$keys
array\|null	$options

Return Value

Redis

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

No description

Parameters

string	$dst
array	$keys

Return Value

Redis

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

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

No description

Parameters

array	$keys
int	$limit

Return Value

Redis

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

RedisConnection

Traits

Constants

Properties

Methods

Details

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

Parameters

at line 732 void release()

Return Value

in Connection at line 68 void discard()

Return Value

in Connection at line 76 mixed getConnection()

Return Value

at line 513 bool check()

Return Value

in Connection at line 109 float getLastUseTime()

Return Value

in Connection at line 117 float getLastReleaseTime()

Return Value

in Connection at line 125 protected void markInvalid()

Return Value

in Connection at line 133 protected void markValid()

Return Value

at line 495 mixed getActiveConnection()

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

Exceptions

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

Parameters

Return Value

in Macroable at line 68 static void flushMacros()

Return Value

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

Parameters

Return Value

Exceptions

at line 415 __call(mixed $name, mixed $arguments)

Parameters

at line 542 string getName()

Return Value

at line 550 Dispatcher|null getEventDispatcher()

Return Value

at line 558 abstract bool reconnect()

Return Value

at line 563 protected void markReconnected()

Return Value

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

Parameters

Return Value

at line 609 protected array configuredPhpRedisOptions()

Return Value

at line 629 protected int phpRedisOption(string $name)

Parameters

Return Value

at line 653 protected int parseBackoffAlgorithm(mixed $algorithm)

Parameters

Return Value

at line 680 bool close()

Return Value

at line 699 bool heartbeatCheck(float $timeout)

Parameters

Return Value

at line 803 bool|Redis discardTransaction()

Return Value

at line 819 void clearWatchState()

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

at line 848 float getCreatedAt()

Return Value

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

at line 732
`void release()`

in Connection at line 68
`void discard()`

in Connection at line 76
`mixed getConnection()`

at line 513
`bool check()`

in Connection at line 109
`float getLastUseTime()`

in Connection at line 117
`float getLastReleaseTime()`

in Connection at line 125
`protected void markInvalid()`

in Connection at line 133
`protected void markValid()`

at line 495
`mixed getActiveConnection()`

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

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

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

in Macroable at line 68
`static void flushMacros()`

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

at line 415
`__call(mixed $name, mixed $arguments)`

at line 542
`string getName()`

at line 550
`Dispatcher|null getEventDispatcher()`

at line 558
`abstract bool reconnect()`

at line 563
`protected void markReconnected()`

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

at line 609
`protected array configuredPhpRedisOptions()`

at line 629
`protected int phpRedisOption(string $name)`

at line 653
`protected int parseBackoffAlgorithm(mixed $algorithm)`

at line 680
`bool close()`

at line 699
`bool heartbeatCheck(float $timeout)`

at line 803
`bool|Redis discardTransaction()`

at line 819
`void clearWatchState()`

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

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

at line 848
`float getCreatedAt()`

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

at line 868
`protected bool shouldInvalidateAfter(RedisException $exception)`

at line 889
`protected bool isQueueingMode()`

at line 897
`bool isCluster()`

at line 905
`static bool hasHashTag(string $key)`

at line 921
`protected bool pingForHeartbeat()`

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

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

at line 977
`bool getShouldTransform()`

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

at line 995
`protected array callMget(array $keys)`

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

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

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

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

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

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

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

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

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

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

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

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

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

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