class Redis extends Facade

Properties

static protected $app

The application instance being facaded.

from  Facade
static protected array $resolvedInstance

The resolved object instances.

from  Facade
static protected bool $cached

Indicates if the resolved instance should be cached.

from  Facade

Methods

static void
resolved(Closure $callback)

Run a Closure when the facade has been resolved.

from  Facade
static 
spy()

Convert the facade into a Mockery spy.

from  Facade
static 
partialMock()

Initiate a partial mock on the facade.

from  Facade
static 
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static 
expects()

Initiate a mock expectation on the facade.

from  Facade
static 
createFreshMockInstance()

Create a fresh mock instance for the given class.

from  Facade
static 
createMock()

Create a fresh mock instance for the given class.

from  Facade
static bool
isMock()

Determines whether a mock is set as the instance of the facade.

from  Facade
static string|null
getMockableClass()

Get the mockable class for the bound instance.

from  Facade
static 
swap(mixed $instance)

Hotswap the underlying instance behind the facade.

from  Facade
static bool
isFake()

Determines whether a "fake" has been set as the facade instance.

from  Facade
static mixed
getFacadeRoot()

Get the root object behind the facade.

from  Facade
static string
getFacadeAccessor()

Get the registered name of the component.

static mixed
resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

from  Facade
static void
clearResolvedInstance(string|null $name = null)

Clear a resolved facade instance.

from  Facade
static void
clearResolvedInstances()

Clear all of the resolved instances.

from  Facade
static Collection
defaultAliases()

Get the application default aliases.

from  Facade
static 
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(mixed $app)

Set the application instance.

from  Facade
static 
__callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

from  Facade
static array
ignoredFacadeDocumenterMethods()

Get methods that should be excluded from the generated facade docblock.

static RedisProxy
connection(UnitEnum|string|null $name = 'null')

No description

static void
purge(UnitEnum|string|null $name = 'null')

No description

static void
array()

<int|string, string> pack(array<int|string, mixed> $values)

static void
enableEvents()

No description

static void
disableEvents()

No description

static void
listen(Closure $callback)

No description

static void
listenForFailures(Closure $callback)

No description

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

No description

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

No description

static mixed
command(string $method, array $parameters = '[]')

No description

throttle(string $name)

No description

funnel(string $name)

No description

static string
getName()

No description

static bool
isCluster()

No description

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

No description

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

No description

static bool
hasMacro(string $name)

No description

static void
flushMacros()

No description

static void
scan(mixed $cursor, mixed ...$arguments)

No description

static void
hScan(mixed $key, mixed $cursor, mixed ...$arguments)

No description

static void
zScan(mixed $key, mixed $cursor, mixed ...$arguments)

No description

static void
sScan(mixed $key, mixed $cursor, mixed ...$arguments)

No description

static mixed
withConnection(callable $callback, bool $transform = 'true')

No description

static mixed
withPinnedConnection(callable $callback)

No description

static mixed
withoutSerializationOrCompression(callable $callback)

No description

static Subscriber
subscriber()

No description

static int
flushByPattern(string $pattern)

No description

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

No description

static RedisCluster
transaction(callable|null $callback = 'null')

No description

static Redis
discard()

No description

static Dispatcher|null
getEventDispatcher()

No description

static bool
hasHashTag(string $key)

No description

static bool
serialized()

No description

static bool
compressed()

No description

static mixed
evalWithShaCache(string $script, string[] $keys = '[]', mixed[] $args = '[]')

No description

static mixed
get(string $key)

Get the value of a key

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

Set the value of a key

static array
mget(array $keys)

Get the values of multiple keys

static Redis
setnx(string $key, mixed $value)

Set key if not exists

static Redis
hmget(string $key, array $fields)

Get hash field values

static Redis
hmset(string $key, array $fieldValues)

Set hash field values

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

Set hash field if not exists

static mixed
hget(string $key, string $member)

Get hash field value

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

Set hash field values

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

Remove list elements

static Redis
llen(string $key)

Get list length

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

Blocking left pop from list

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

Blocking right pop from list

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

Remove and return random set member

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

Remove members from set

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

Add members to sorted set

static Redis
zcard(string $key)

Get sorted set cardinality

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

Count sorted set members by score range

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

Get sorted set members by score range

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

No description

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

Intersect sorted sets

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

Union sorted sets

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

Evaluate Lua script

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

Evaluate Lua script by SHA1

static mixed
flushdb(mixed ...$arguments)

Flush database

static mixed
executeRaw(array $parameters)

Execute raw Redis command

static Redis
smembers(string $key)

Get all set members

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

Delete hash fields

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

Remove sorted set members

static Redis
hlen(string $key)

Get number of hash fields

static Redis
hkeys(string $key)

Get all hash field names

static string
_serialize(mixed $value)

Serialize a value using configured serializer

static string
_digest(mixed $value)

No description

static string
_pack(mixed $value)

No description

static mixed
_unpack(string $value)

No description

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

No description

static Redis
append(string $key, mixed $value)

No description

static Redis
bgSave()

No description

static Redis
bgrewriteaof()

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static bool
clearLastError()

No description

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

No description

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

No description

static Redis
dbSize()

No description

static Redis|string
debug(string $key)

No description

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

No description

static Redis
decrBy(string $key, int $value)

No description

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

No description

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

No description

static Redis
delifeq(string $key, mixed $value)

No description

static Redis|string
digest(string $key)

No description

static Redis|string
dump(string $key)

No description

static Redis|string
echo(string $str)

No description

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

No description

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

No description

static Redis
exec()

No description

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

No description

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

No description

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

No description

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

No description

static Redis
expiretime(string $key)

No description

static Redis
pexpiretime(string $key)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static mixed
getAuth()

No description

static Redis
getBit(string $key, int $idx)

No description

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

No description

static int
getDBNum()

No description

static Redis|string
getDel(string $key)

No description

static string
getHost()

No description

static null|string
getLastError()

No description

static int
getMode()

No description

static mixed
getOption(int $option)

No description

static null|string
getPersistentID()

No description

static int
getPort()

No description

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

No description

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

No description

static float
getReadTimeout()

No description

static Redis|string
getset(string $key, mixed $value)

No description

static false|float
getTimeout()

No description

static array
getTransferredBytes()

No description

static void
clearTransferredBytes()

No description

static Redis
getWithMeta(string $key)

No description

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

No description

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

No description

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

No description

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

No description

static Redis
httl(string $key, array $fields)

No description

static Redis
hpttl(string $key, array $fields)

No description

static Redis
hexpiretime(string $key, array $fields)

No description

static Redis
hpexpiretime(string $key, array $fields)

No description

static Redis
hpersist(string $key, array $fields)

No description

static Redis
hExists(string $key, string $field)

No description

static Redis
hGetAll(string $key)

No description

static mixed
hGetWithMeta(string $key, string $member)

No description

static Redis
hgetdel(string $key, array $fields)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static Redis
hStrLen(string $key, string $field)

No description

static Redis
hVals(string $key)

No description

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

No description

static Redis
incrBy(string $key, int $value)

No description

static Redis
incrByFloat(string $key, float $value)

No description

static Redis
info(string ...$sections)

No description

static bool
isConnected()

No description

static void
keys(string $pattern)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static Redis
lPushx(string $key, mixed $value)

No description

static Redis
rPushx(string $key, mixed $value)

No description

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

No description

static int
lastSave()

No description

static mixed
lindex(string $key, int $index)

No description

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

No description

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

No description

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

No description

static Redis
move(string $key, int $index)

No description

static Redis
mset(array $key_values)

No description

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

No description

static Redis
msetnx(array $key_values)

No description

static Redis
multi(int $value = '1')

No description

static Redis|string
object(string $subcommand, string $key)

No description

static Redis
persist(string $key)

No description

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

No description

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

No description

static Redis
pfadd(string $key, array $elements)

No description

static Redis
pfcount(array|string $key_or_keys)

No description

static Redis
pfmerge(string $dst, array $srckeys)

No description

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

No description

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

No description

static Redis
pttl(string $key)

No description

static Redis
publish(string $channel, string $message)

No description

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

No description

static Redis
punsubscribe(array $patterns)

No description

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

No description

static Redis|string
randomKey()

No description

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

No description

static Redis
rename(string $old_name, string $new_name)

No description

static Redis
renameNx(string $key_src, string $key_dst)

No description

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

No description

static mixed
role()

No description

static Redis|string
rpoplpush(string $srckey, string $dstkey)

No description

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

No description

static int
sAddArray(string $key, array $values)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static Redis
save()

No description

static Redis
scard(string $key)

No description

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

No description

static Redis
select(int $db)

No description

static false|string
serverName()

No description

static false|string
serverVersion()

No description

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

No description

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

No description

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

No description

static Redis
sismember(string $key, mixed $value)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static Redis
strlen(string $key)

No description

static Redis
sunsubscribe(array $channels)

No description

static Redis
swapdb(int $src, int $dst)

No description

static Redis
time()

No description

static Redis
ttl(string $key)

No description

static Redis
type(string $key)

No description

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

No description

static Redis
unsubscribe(array $channels)

No description

static Redis
unwatch()

No description

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

No description

static Redis
vcard(string $key)

No description

static Redis
vdim(string $key)

No description

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

No description

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

No description

static Redis
vinfo(string $key)

No description

static Redis
vismember(string $key, mixed $member)

No description

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

No description

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

No description

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

No description

static Redis
vrem(string $key, mixed $member)

No description

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

No description

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

No description

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

No description

static false|int
wait(int $numreplicas, int $timeout)

No description

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

No description

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

No description

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

No description

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

No description

static Redis
xdel(string $key, array $ids)

No description

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

No description

static 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

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

No description

static Redis
xlen(string $key)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static Redis
zRank(string $key, mixed $member)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static Redis
zRevRank(string $key, mixed $member)

No description

static Redis
zScore(string $key, mixed $member)

No description

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

No description

static Redis
zdiffstore(string $dst, array $keys)

No description

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

No description

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

No description

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

No description

Details

in Facade at line 55
static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Boot-only. The callback is registered on the worker-global container and runs for every subsequent resolution of the facade accessor.

Parameters

Closure $callback

Return Value

void

in Facade at line 71
static spy()

Convert the facade into a Mockery spy.

in Facade at line 89
static partialMock()

Initiate a partial mock on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

in Facade at line 105
static shouldReceive()

Initiate a mock expectation on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

in Facade at line 121
static expects()

Initiate a mock expectation on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

in Facade at line 135
static protected createFreshMockInstance()

Create a fresh mock instance for the given class.

in Facade at line 147
static protected createMock()

Create a fresh mock instance for the given class.

in Facade at line 157
static protected bool isMock()

Determines whether a mock is set as the instance of the facade.

Return Value

bool

in Facade at line 168
static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

in Facade at line 184
static swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Tests only. Replaces the worker-wide resolved facade instance and container binding; runtime use races across coroutines and changes every subsequent facade call.

Parameters

mixed $instance

in Facade at line 196
static bool isFake()

Determines whether a "fake" has been set as the facade instance.

Return Value

bool

in Facade at line 207
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 350
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

in Facade at line 223
static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 246
static void clearResolvedInstance(string|null $name = null)

Clear a resolved facade instance.

Boot or tests only. Clears a worker-wide facade cache entry; concurrent coroutines may still hold the previous resolved instance.

Parameters

string|null $name

Return Value

void

in Facade at line 257
static void clearResolvedInstances()

Clear all of the resolved instances.

Boot or tests only. Clears the worker-wide facade cache; concurrent coroutines may still hold previously resolved instances.

Return Value

void

in Facade at line 265
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 324
static getFacadeApplication()

Get the application instance behind the facade.

in Facade at line 337
static void setFacadeApplication(mixed $app)

Set the application instance.

Tests only. Replaces the worker-wide facade application reference; runtime use races across coroutines and breaks every facade lookup.

Parameters

mixed $app

Return Value

void

in Facade at line 347
static __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Exceptions

RuntimeException

at line 317
static protected array ignoredFacadeDocumenterMethods()

Get methods that should be excluded from the generated facade docblock.

Excludes connection-bound methods, unavailable pooled commands, and internal trait aliases.

Return Value

array

at line 307
static RedisProxy connection(UnitEnum|string|null $name = 'null')

No description

Parameters

UnitEnum|string|null $name

Return Value

RedisProxy

at line 307
static void purge(UnitEnum|string|null $name = 'null')

No description

Parameters

UnitEnum|string|null $name

Return Value

void

at line 307
static void array()

<int|string, string> pack(array<int|string, mixed> $values)

Return Value

void

at line 307
static void enableEvents()

No description

Return Value

void

at line 307
static void disableEvents()

No description

Return Value

void

at line 307
static void listen(Closure $callback)

No description

Parameters

Closure $callback

Return Value

void

at line 307
static void listenForFailures(Closure $callback)

No description

Parameters

Closure $callback

Return Value

void

at line 307
static void subscribe(array|string $channels, Closure $callback)

No description

Parameters

array|string $channels
Closure $callback

Return Value

void

at line 307
static void psubscribe(array|string $channels, Closure $callback)

No description

Parameters

array|string $channels
Closure $callback

Return Value

void

at line 307
static mixed command(string $method, array $parameters = '[]')

No description

Parameters

string $method
array $parameters

Return Value

mixed

at line 307
static DurationLimiterBuilder throttle(string $name)

No description

Parameters

string $name

Return Value

DurationLimiterBuilder

at line 307
static ConcurrencyLimiterBuilder funnel(string $name)

No description

Parameters

string $name

Return Value

ConcurrencyLimiterBuilder

at line 307
static string getName()

No description

Return Value

string

at line 307
static bool isCluster()

No description

Return Value

bool

at line 307
static void macro(string $name, callable|object $macro)

No description

Parameters

string $name
callable|object $macro

Return Value

void

at line 307
static void mixin(object $mixin, bool $replace = 'true')

No description

Parameters

object $mixin
bool $replace

Return Value

void

at line 307
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

at line 307
static void flushMacros()

No description

Return Value

void

at line 307
static void scan(mixed $cursor, mixed ...$arguments)

No description

Parameters

mixed $cursor
mixed ...$arguments

Return Value

void

at line 307
static void hScan(mixed $key, mixed $cursor, mixed ...$arguments)

No description

Parameters

mixed $key
mixed $cursor
mixed ...$arguments

Return Value

void

at line 307
static void zScan(mixed $key, mixed $cursor, mixed ...$arguments)

No description

Parameters

mixed $key
mixed $cursor
mixed ...$arguments

Return Value

void

at line 307
static void sScan(mixed $key, mixed $cursor, mixed ...$arguments)

No description

Parameters

mixed $key
mixed $cursor
mixed ...$arguments

Return Value

void

at line 307
static mixed withConnection(callable $callback, bool $transform = 'true')

No description

Parameters

callable $callback
bool $transform

Return Value

mixed

at line 307
static mixed withPinnedConnection(callable $callback)

No description

Parameters

callable $callback

Return Value

mixed

at line 307
static mixed withoutSerializationOrCompression(callable $callback)

No description

Parameters

callable $callback

Return Value

mixed

at line 307
static Subscriber subscriber()

No description

Return Value

Subscriber

at line 307
static int flushByPattern(string $pattern)

No description

Parameters

string $pattern

Return Value

int

at line 307
static Redis pipeline(callable|null $callback = 'null')

No description

Parameters

callable|null $callback

Return Value

Redis

at line 307
static RedisCluster transaction(callable|null $callback = 'null')

No description

Parameters

callable|null $callback

Return Value

RedisCluster

at line 307
static Redis discard()

No description

Return Value

Redis

at line 307
static Dispatcher|null getEventDispatcher()

No description

Return Value

Dispatcher|null

at line 307
static bool hasHashTag(string $key)

No description

Parameters

string $key

Return Value

bool

at line 307
static bool serialized()

No description

Return Value

bool

at line 307
static bool compressed()

No description

Return Value

bool

at line 307
static mixed evalWithShaCache(string $script, string[] $keys = '[]', mixed[] $args = '[]')

No description

Parameters

string $script
string[] $keys
mixed[] $args

Return Value

mixed

at line 307
static mixed get(string $key)

Get the value of a key

Parameters

string $key

Return Value

mixed

at line 307
static 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 307
static array mget(array $keys)

Get the values of multiple keys

Parameters

array $keys

Return Value

array

at line 307
static Redis setnx(string $key, mixed $value)

Set key if not exists

Parameters

string $key
mixed $value

Return Value

Redis

at line 307
static Redis hmget(string $key, array $fields)

Get hash field values

Parameters

string $key
array $fields

Return Value

Redis

at line 307
static Redis hmset(string $key, array $fieldValues)

Set hash field values

Parameters

string $key
array $fieldValues

Return Value

Redis

at line 307
static 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 307
static mixed hget(string $key, string $member)

Get hash field value

Parameters

string $key
string $member

Return Value

mixed

at line 307
static Redis hset(string $key, mixed ...$fields_and_vals)

Set hash field values

Parameters

string $key
mixed ...$fields_and_vals

Return Value

Redis

at line 307
static 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 307
static Redis llen(string $key)

Get list length

Parameters

string $key

Return Value

Redis

at line 307
static 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 307
static 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 307
static mixed spop(string $key, int $count = '0')

Remove and return random set member

Parameters

string $key
int $count

Return Value

mixed

at line 307
static 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 307
static 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 307
static Redis zcard(string $key)

Get sorted set cardinality

Parameters

string $key

Return Value

Redis

at line 307
static 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 307
static 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 307
static 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 307
static int zinterstore(string $output, array $keys, array $options = '[]')

Intersect sorted sets

Parameters

string $output
array $keys
array $options

Return Value

int

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

Union sorted sets

Parameters

string $output
array $keys
array $options

Return Value

int

at line 307
static mixed eval(string $script, int $numberOfKeys, mixed ...$arguments)

Evaluate Lua script

Parameters

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

Return Value

mixed

at line 307
static 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 307
static mixed flushdb(mixed ...$arguments)

Flush database

Parameters

mixed ...$arguments

Return Value

mixed

at line 307
static mixed executeRaw(array $parameters)

Execute raw Redis command

Parameters

array $parameters

Return Value

mixed

at line 307
static Redis smembers(string $key)

Get all set members

Parameters

string $key

Return Value

Redis

at line 307
static 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 307
static 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 307
static Redis hlen(string $key)

Get number of hash fields

Parameters

string $key

Return Value

Redis

at line 307
static Redis hkeys(string $key)

Get all hash field names

Parameters

string $key

Return Value

Redis

at line 307
static string _serialize(mixed $value)

Serialize a value using configured serializer

Parameters

mixed $value

Return Value

string

at line 307
static string _digest(mixed $value)

No description

Parameters

mixed $value

Return Value

string

at line 307
static string _pack(mixed $value)

No description

Parameters

mixed $value

Return Value

string

at line 307
static mixed _unpack(string $value)

No description

Parameters

string $value

Return Value

mixed

at line 307
static mixed acl(string $subcmd, string ...$args)

No description

Parameters

string $subcmd
string ...$args

Return Value

mixed

at line 307
static Redis append(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

Redis

at line 307
static Redis bgSave()

No description

Return Value

Redis

at line 307
static Redis bgrewriteaof()

No description

Return Value

Redis

at line 307
static Redis waitaof(int $numlocal, int $numreplicas, int $timeout)

No description

Parameters

int $numlocal
int $numreplicas
int $timeout

Return Value

Redis

at line 307
static 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 307
static 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 307
static 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 307
static 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 307
static 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 307
static 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 307
static 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 307
static Redis zmpop(array $keys, string $from, int $count = '1')

No description

Parameters

array $keys
string $from
int $count

Return Value

Redis

at line 307
static 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 307
static Redis lmpop(array $keys, string $from, int $count = '1')

No description

Parameters

array $keys
string $from
int $count

Return Value

Redis

at line 307
static bool clearLastError()

No description

Return Value

bool

at line 307
static 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 307
static 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 307
static Redis dbSize()

No description

Return Value

Redis

at line 307
static Redis|string debug(string $key)

No description

Parameters

string $key

Return Value

Redis|string

at line 307
static Redis decr(string $key, int $by = '1')

No description

Parameters

string $key
int $by

Return Value

Redis

at line 307
static Redis decrBy(string $key, int $value)

No description

Parameters

string $key
int $value

Return Value

Redis

at line 307
static Redis del(array|string $key, string ...$other_keys)

No description

Parameters

array|string $key
string ...$other_keys

Return Value

Redis

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

No description

Parameters

string $key
array|null $options

Return Value

Redis

at line 307
static Redis delifeq(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

Redis

at line 307
static Redis|string digest(string $key)

No description

Parameters

string $key

Return Value

Redis|string

at line 307
static Redis|string dump(string $key)

No description

Parameters

string $key

Return Value

Redis|string

at line 307
static Redis|string echo(string $str)

No description

Parameters

string $str

Return Value

Redis|string

at line 307
static 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 307
static 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 307
static Redis exec()

No description

Return Value

Redis

at line 307
static Redis exists(mixed $key, mixed ...$other_keys)

No description

Parameters

mixed $key
mixed ...$other_keys

Return Value

Redis

at line 307
static 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 307
static 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 307
static 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 307
static Redis expiretime(string $key)

No description

Parameters

string $key

Return Value

Redis

at line 307
static Redis pexpiretime(string $key)

No description

Parameters

string $key

Return Value

Redis

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

No description

Parameters

string $fn
array $keys
array $args

Return Value

mixed

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

No description

Parameters

string $fn
array $keys
array $args

Return Value

mixed

at line 307
static Redis flushAll(bool|null $sync = 'null')

No description

Parameters

bool|null $sync

Return Value

Redis

at line 307
static Redis|string function(string $operation, mixed ...$args)

No description

Parameters

string $operation
mixed ...$args

Return Value

Redis|string

at line 307
static 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 307
static 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 307
static Redis geohash(string $key, string $member, string ...$other_members)

No description

Parameters

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

Return Value

Redis

at line 307
static Redis geopos(string $key, string $member, string ...$other_members)

No description

Parameters

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

Return Value

Redis

at line 307
static 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 307
static 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 307
static 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 307
static 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 307
static 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 307
static 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 307
static mixed getAuth()

No description

Return Value

mixed

at line 307
static Redis getBit(string $key, int $idx)

No description

Parameters

string $key
int $idx

Return Value

Redis

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

No description

Parameters

string $key
array $options

Return Value

Redis|string

at line 307
static int getDBNum()

No description

Return Value

int

at line 307
static Redis|string getDel(string $key)

No description

Parameters

string $key

Return Value

Redis|string

at line 307
static string getHost()

No description

Return Value

string

at line 307
static null|string getLastError()

No description

Return Value

null|string

at line 307
static int getMode()

No description

Return Value

int

at line 307
static mixed getOption(int $option)

No description

Parameters

int $option

Return Value

mixed

at line 307
static null|string getPersistentID()

No description

Return Value

null|string

at line 307
static int getPort()

No description

Return Value

int

at line 307
static Redis|string getRange(string $key, int $start, int $end)

No description

Parameters

string $key
int $start
int $end

Return Value

Redis|string

at line 307
static 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 307
static float getReadTimeout()

No description

Return Value

float

at line 307
static Redis|string getset(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

Redis|string

at line 307
static false|float getTimeout()

No description

Return Value

false|float

at line 307
static array getTransferredBytes()

No description

Return Value

array

at line 307
static void clearTransferredBytes()

No description

Return Value

void

at line 307
static Redis getWithMeta(string $key)

No description

Parameters

string $key

Return Value

Redis

at line 307
static 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 307
static 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 307
static 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 307
static 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 307
static Redis httl(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

Redis

at line 307
static Redis hpttl(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

Redis

at line 307
static Redis hexpiretime(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

Redis

at line 307
static Redis hpexpiretime(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

Redis

at line 307
static Redis hpersist(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

Redis

at line 307
static Redis hExists(string $key, string $field)

No description

Parameters

string $key
string $field

Return Value

Redis

at line 307
static Redis hGetAll(string $key)

No description

Parameters

string $key

Return Value

Redis

at line 307
static mixed hGetWithMeta(string $key, string $member)

No description

Parameters

string $key
string $member

Return Value

mixed

at line 307
static Redis hgetdel(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

Redis

at line 307
static 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 307
static Redis hIncrBy(string $key, string $field, int $value)

No description

Parameters

string $key
string $field
int $value

Return Value

Redis

at line 307
static Redis hIncrByFloat(string $key, string $field, float $value)

No description

Parameters

string $key
string $field
float $value

Return Value

Redis

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

No description

Parameters

string $key
array|null $options

Return Value

Redis|string

at line 307
static 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 307
static Redis hStrLen(string $key, string $field)

No description

Parameters

string $key
string $field

Return Value

Redis

at line 307
static Redis hVals(string $key)

No description

Parameters

string $key

Return Value

Redis

at line 307
static Redis incr(string $key, int $by = '1')

No description

Parameters

string $key
int $by

Return Value

Redis

at line 307
static Redis incrBy(string $key, int $value)

No description

Parameters

string $key
int $value

Return Value

Redis

at line 307
static Redis incrByFloat(string $key, float $value)

No description

Parameters

string $key
float $value

Return Value

Redis

at line 307
static Redis info(string ...$sections)

No description

Parameters

string ...$sections

Return Value

Redis

at line 307
static bool isConnected()

No description

Return Value

bool

at line 307
static void keys(string $pattern)

No description

Parameters

string $pattern

Return Value

void

at line 307
static 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 307
static 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 307
static 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 307
static Redis|string lPop(string $key, int $count = '0')

No description

Parameters

string $key
int $count

Return Value

Redis|string

at line 307
static 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 307
static Redis lPush(string $key, mixed ...$elements)

No description

Parameters

string $key
mixed ...$elements

Return Value

Redis

at line 307
static Redis rPush(string $key, mixed ...$elements)

No description

Parameters

string $key
mixed ...$elements

Return Value

Redis

at line 307
static Redis lPushx(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

Redis

at line 307
static Redis rPushx(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

Redis

at line 307
static Redis lSet(string $key, int $index, mixed $value)

No description

Parameters

string $key
int $index
mixed $value

Return Value

Redis

at line 307
static int lastSave()

No description

Return Value

int

at line 307
static mixed lindex(string $key, int $index)

No description

Parameters

string $key
int $index

Return Value

mixed

at line 307
static Redis lrange(string $key, int $start, int $end)

No description

Parameters

string $key
int $start
int $end

Return Value

Redis

at line 307
static Redis ltrim(string $key, int $start, int $end)

No description

Parameters

string $key
int $start
int $end

Return Value

Redis

at line 307
static 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 307
static Redis move(string $key, int $index)

No description

Parameters

string $key
int $index

Return Value

Redis

at line 307
static Redis mset(array $key_values)

No description

Parameters

array $key_values

Return Value

Redis

at line 307
static 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 307
static Redis msetnx(array $key_values)

No description

Parameters

array $key_values

Return Value

Redis

at line 307
static Redis multi(int $value = '1')

No description

Parameters

int $value

Return Value

Redis

at line 307
static Redis|string object(string $subcommand, string $key)

No description

Parameters

string $subcommand
string $key

Return Value

Redis|string

at line 307
static Redis persist(string $key)

No description

Parameters

string $key

Return Value

Redis

at line 307
static 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 307
static 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 307
static Redis pfadd(string $key, array $elements)

No description

Parameters

string $key
array $elements

Return Value

Redis

at line 307
static Redis pfcount(array|string $key_or_keys)

No description

Parameters

array|string $key_or_keys

Return Value

Redis

at line 307
static Redis pfmerge(string $dst, array $srckeys)

No description

Parameters

string $dst
array $srckeys

Return Value

Redis

at line 307
static Redis|string ping(string|null $message = 'null')

No description

Parameters

string|null $message

Return Value

Redis|string

at line 307
static Redis psetex(string $key, int $expire, mixed $value)

No description

Parameters

string $key
int $expire
mixed $value

Return Value

Redis

at line 307
static Redis pttl(string $key)

No description

Parameters

string $key

Return Value

Redis

at line 307
static Redis publish(string $channel, string $message)

No description

Parameters

string $channel
string $message

Return Value

Redis

at line 307
static mixed pubsub(string $command, mixed $arg = 'null')

No description

Parameters

string $command
mixed $arg

Return Value

mixed

at line 307
static Redis punsubscribe(array $patterns)

No description

Parameters

array $patterns

Return Value

Redis

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

No description

Parameters

string $key
int $count

Return Value

Redis|string

at line 307
static Redis|string randomKey()

No description

Return Value

Redis|string

at line 307
static mixed rawcommand(string $command, mixed ...$args)

No description

Parameters

string $command
mixed ...$args

Return Value

mixed

at line 307
static Redis rename(string $old_name, string $new_name)

No description

Parameters

string $old_name
string $new_name

Return Value

Redis

at line 307
static Redis renameNx(string $key_src, string $key_dst)

No description

Parameters

string $key_src
string $key_dst

Return Value

Redis

at line 307
static 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 307
static mixed role()

No description

Return Value

mixed

at line 307
static Redis|string rpoplpush(string $srckey, string $dstkey)

No description

Parameters

string $srckey
string $dstkey

Return Value

Redis|string

at line 307
static Redis sAdd(string $key, mixed $value, mixed ...$other_values)

No description

Parameters

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

Return Value

Redis

at line 307
static int sAddArray(string $key, array $values)

No description

Parameters

string $key
array $values

Return Value

int

at line 307
static Redis sDiff(string $key, string ...$other_keys)

No description

Parameters

string $key
string ...$other_keys

Return Value

Redis

at line 307
static Redis sDiffStore(string $dst, string $key, string ...$other_keys)

No description

Parameters

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

Return Value

Redis

at line 307
static Redis sInter(array|string $key, string ...$other_keys)

No description

Parameters

array|string $key
string ...$other_keys

Return Value

Redis

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

No description

Parameters

array $keys
int $limit

Return Value

Redis

at line 307
static Redis sInterStore(array|string $key, string ...$other_keys)

No description

Parameters

array|string $key
string ...$other_keys

Return Value

Redis

at line 307
static Redis sMisMember(string $key, string $member, string ...$other_members)

No description

Parameters

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

Return Value

Redis

at line 307
static Redis sMove(string $src, string $dst, mixed $value)

No description

Parameters

string $src
string $dst
mixed $value

Return Value

Redis

at line 307
static mixed sRandMember(string $key, int $count = '0')

No description

Parameters

string $key
int $count

Return Value

mixed

at line 307
static Redis sUnion(string $key, string ...$other_keys)

No description

Parameters

string $key
string ...$other_keys

Return Value

Redis

at line 307
static Redis sUnionStore(string $dst, string $key, string ...$other_keys)

No description

Parameters

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

Return Value

Redis

at line 307
static Redis save()

No description

Return Value

Redis

at line 307
static Redis scard(string $key)

No description

Parameters

string $key

Return Value

Redis

at line 307
static mixed script(string $command, mixed ...$args)

No description

Parameters

string $command
mixed ...$args

Return Value

mixed

at line 307
static Redis select(int $db)

No description

Parameters

int $db

Return Value

Redis

at line 307
static false|string serverName()

No description

Return Value

false|string

at line 307
static false|string serverVersion()

No description

Return Value

false|string

at line 307
static Redis setBit(string $key, int $idx, bool $value)

No description

Parameters

string $key
int $idx
bool $value

Return Value

Redis

at line 307
static Redis setRange(string $key, int $index, string $value)

No description

Parameters

string $key
int $index
string $value

Return Value

Redis

at line 307
static Redis setex(string $key, int $expire, mixed $value)

No description

Parameters

string $key
int $expire
mixed $value

Return Value

Redis

at line 307
static Redis sismember(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

Redis

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

No description

Parameters

string|null $host
int $port

Return Value

Redis

at line 307
static 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 307
static mixed slowlog(string $operation, int $length = '0')

No description

Parameters

string $operation
int $length

Return Value

mixed

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

No description

Parameters

string $key
array|null $options

Return Value

mixed

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

No description

Parameters

string $key
array|null $options

Return Value

mixed

at line 307
static Redis strlen(string $key)

No description

Parameters

string $key

Return Value

Redis

at line 307
static Redis sunsubscribe(array $channels)

No description

Parameters

array $channels

Return Value

Redis

at line 307
static Redis swapdb(int $src, int $dst)

No description

Parameters

int $src
int $dst

Return Value

Redis

at line 307
static Redis time()

No description

Return Value

Redis

at line 307
static Redis ttl(string $key)

No description

Parameters

string $key

Return Value

Redis

at line 307
static Redis type(string $key)

No description

Parameters

string $key

Return Value

Redis

No description

Parameters

array|string $key
string ...$other_keys

Return Value

Redis

at line 307
static Redis unsubscribe(array $channels)

No description

Parameters

array $channels

Return Value

Redis

at line 307
static Redis unwatch()

No description

Return Value

Redis

at line 307
static 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 307
static Redis vcard(string $key)

No description

Parameters

string $key

Return Value

Redis

at line 307
static Redis vdim(string $key)

No description

Parameters

string $key

Return Value

Redis

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

No description

Parameters

string $key
mixed $member
bool $raw

Return Value

Redis

at line 307
static 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 307
static Redis vinfo(string $key)

No description

Parameters

string $key

Return Value

Redis

at line 307
static Redis vismember(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

Redis

No description

Parameters

string $key
mixed $member
bool $withscores

Return Value

Redis

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

No description

Parameters

string $key
int $count

Return Value

Redis|string

at line 307
static 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 307
static Redis vrem(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

Redis

at line 307
static Redis vsetattr(string $key, mixed $member, array|string $attributes)

No description

Parameters

string $key
mixed $member
array|string $attributes

Return Value

Redis

at line 307
static 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 307
static Redis watch(array|string $key, string ...$other_keys)

No description

Parameters

array|string $key
string ...$other_keys

Return Value

Redis

at line 307
static false|int wait(int $numreplicas, int $timeout)

No description

Parameters

int $numreplicas
int $timeout

Return Value

false|int

at line 307
static false|int xack(string $key, string $group, array $ids)

No description

Parameters

string $key
string $group
array $ids

Return Value

false|int

at line 307
static 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 307
static 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 307
static 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 307
static Redis xdel(string $key, array $ids)

No description

Parameters

string $key
array $ids

Return Value

Redis

at line 307
static 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 307
static 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 307
static 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 307
static Redis xlen(string $key)

No description

Parameters

string $key

Return Value

Redis

at line 307
static 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 307
static 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 307
static Redis xread(array $streams, int $count = '-1', int $block = '-1')

No description

Parameters

array $streams
int $count
int $block

Return Value

Redis

at line 307
static 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 307
static 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 307
static 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 307
static Redis zIncrBy(string $key, float $value, mixed $member)

No description

Parameters

string $key
float $value
mixed $member

Return Value

Redis

at line 307
static Redis zLexCount(string $key, string $min, string $max)

No description

Parameters

string $key
string $min
string $max

Return Value

Redis

at line 307
static Redis zMscore(string $key, mixed $member, mixed ...$other_members)

No description

Parameters

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

Return Value

Redis

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

No description

Parameters

string $key
int|null $count

Return Value

Redis

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

No description

Parameters

string $key
int|null $count

Return Value

Redis

at line 307
static 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 307
static 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 307
static 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 307
static Redis|string zRandMember(string $key, array|null $options = 'null')

No description

Parameters

string $key
array|null $options

Return Value

Redis|string

at line 307
static Redis zRank(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

Redis

at line 307
static Redis zRemRangeByLex(string $key, string $min, string $max)

No description

Parameters

string $key
string $min
string $max

Return Value

Redis

at line 307
static Redis zRemRangeByRank(string $key, int $start, int $end)

No description

Parameters

string $key
int $start
int $end

Return Value

Redis

at line 307
static Redis zRemRangeByScore(string $key, string $start, string $end)

No description

Parameters

string $key
string $start
string $end

Return Value

Redis

at line 307
static 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 307
static 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 307
static Redis zRevRank(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

Redis

at line 307
static Redis zScore(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

Redis

at line 307
static Redis zdiff(array $keys, array|null $options = 'null')

No description

Parameters

array $keys
array|null $options

Return Value

Redis

at line 307
static Redis zdiffstore(string $dst, array $keys)

No description

Parameters

string $dst
array $keys

Return Value

Redis

at line 307
static 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 307
static Redis zintercard(array $keys, int $limit = '-1')

No description

Parameters

array $keys
int $limit

Return Value

Redis

at line 307
static 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