class Redis extends Facade

Properties

static protected Container|null $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 MockInterface|null
spy()

Convert the facade into a Mockery spy.

from  Facade
static MockInterface
partialMock()

Initiate a partial mock on the facade.

from  Facade
static CompositeExpectation|Expectation|HigherOrderMessage
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage
expects()

Initiate a mock expectation on the facade.

from  Facade
static MockInterface
createFreshMockInstance()

Create a fresh mock instance for the given class.

from  Facade
static MockInterface
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 void
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 Container|null
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(Container|null $app)

Set the application instance.

from  Facade
static mixed
__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 mixed
command(string $method, array $parameters = '[]')

No description

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

No description

static void
array()

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

static void
disableEvents()

No description

static void
enableEvents()

No description

funnel(string $name)

No description

static void
listen(Closure $callback)

No description

static void
listenForFailures(Closure $callback)

No description

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

No description

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

No description

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

No description

throttle(string $name)

No description

static Redis
discard()

No description

static int
flushByPattern(string $pattern)

No description

static void
flushMacros()

No description

static string
getName()

No description

static bool
hasMacro(string $name)

No description

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

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

void
static()

($callback is null ? \Redis|\RedisCluster : array<int, mixed>|false) transaction(callable|null $callback = 'null')

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

No description

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

No description

static Subscriber
subscriber()

No description

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

No description

static mixed
withoutSerializationOrCompression(callable $callback)

No description

static mixed
withPinnedConnection(callable $callback)

No description

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

No description

static string
_digest(mixed $value)

No description

static string
_pack(mixed $value)

No description

static string
_serialize(mixed $value)

Serialize a value using configured serializer

static mixed
_unpack(string $value)

No description

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

No description

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

No description

static RedisCluster
bgrewriteaof()

No description

static RedisCluster
bgSave()

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

Blocking left pop from list

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

Blocking right pop from list

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

No description

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

No description

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

No description

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

No description

static bool
clearLastError()

No description

static void
clearTransferredBytes()

No description

static bool
compressed()

No description

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

No description

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

No description

static RedisCluster
dbSize()

No description

static Redis|string
debug(string $key)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static RedisCluster|string
digest(string $key)

No description

static RedisCluster|string
dump(string $key)

No description

static RedisCluster|string
echo(string $str)

No description

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

Evaluate Lua script

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

No description

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

Evaluate Lua script by SHA1

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

No description

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

No description

static Redis
exec()

No description

static mixed
executeRaw(array $parameters)

Execute raw Redis command

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

No description

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

No description

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

No description

static RedisCluster
expiretime(string $key)

No description

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

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 RedisCluster
flushAll(bool|null $sync = 'null')

No description

static mixed
flushdb(mixed ...$arguments)

Flush database

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

No description

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

No description

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

No description

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

No description

static RedisCluster
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 RedisCluster
geosearchstore(string $dst, string $src, array|string $position, array|int|float $shape, string $unit, array $options = '[]')

No description

static mixed
get(string $key)

Get the value of a key

static mixed
getAuth()

No description

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

No description

static int
getDBNum()

No description

static RedisCluster|string
getDel(string $key)

No description

static Dispatcher|null
getEventDispatcher()

No description

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

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 RedisCluster|string
getRange(string $key, int $start, int $end)

No description

static float
getReadTimeout()

No description

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

No description

static false|float
getTimeout()

No description

static array
getTransferredBytes()

No description

static RedisCluster
getWithMeta(string $key)

No description

static bool
hasHashTag(string $key)

No description

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

Delete hash fields

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

No description

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

No description

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

No description

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

No description

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

Get hash field value

static RedisCluster
hGetAll(string $key)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static RedisCluster
hkeys(string $key)

Get all hash field names

static RedisCluster
hlen(string $key)

Get number of hash fields

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

Get hash field values

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

Set hash field values

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

Set hash field values

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

No description

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

Set hash field if not exists

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

No description

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

No description

static RedisCluster
hVals(string $key)

No description

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

No description

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

No description

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

No description

static RedisCluster
info(string ...$sections)

No description

static bool
isConnected()

No description

static RedisCluster
keys(string $pattern)

No description

static int
lastSave()

No description

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

No description

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

No description

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

No description

static RedisCluster
llen(string $key)

Get list length

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

Remove list elements

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

No description

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

No description

static bool
lz4Compressed()

No description

static bool
lzfCompressed()

No description

static RedisCluster
mget(array $keys)

Get the values of multiple keys

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 RedisCluster
mset(array $key_values)

No description

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

No description

static RedisCluster
msetnx(array $key_values)

No description

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

No description

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

No description

static RedisCluster
persist(string $key)

No description

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

No description

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

No description

static RedisCluster
pexpiretime(string $key)

No description

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

No description

static RedisCluster
pfcount(array|string $key_or_keys)

No description

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

No description

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

No description

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

No description

static RedisCluster
pttl(string $key)

No description

static RedisCluster
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 RedisCluster|string
randomKey()

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static mixed
role()

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static RedisCluster
save()

No description

static RedisCluster
scard(string $key)

No description

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

No description

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

No description

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

No description

static Redis
select(int $db)

No description

static bool
serialized()

No description

static false|string
serverName()

No description

static false|string
serverVersion()

No description

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

Set the value of a key

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

No description

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

No description

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

Set key if not exists

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static RedisCluster
smembers(string $key)

Get all set members

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

No description

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

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

Remove and return random set member

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

No description

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

Remove members from set

static RedisCluster
strlen(string $key)

No description

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

No description

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

No description

static Redis
sunsubscribe(array $channels)

No description

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

No description

static RedisCluster
time()

No description

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

No description

static RedisCluster
ttl(string $key)

No description

static RedisCluster
type(string $key)

No description

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

No description

static Redis
unsubscribe(array $channels)

No description

static Redis
unwatch()

No description

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

No description

static RedisCluster
vcard(string $key)

No description

static RedisCluster
vdim(string $key)

No description

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

No description

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

No description

static RedisCluster
vinfo(string $key)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static mixed
xgroup(string $operation, string|null $key = 'null', string|null $group = 'null', int|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 RedisCluster
xlen(string $key)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

Add members to sorted set

static RedisCluster
zcard(string $key)

Get sorted set cardinality

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

Count sorted set members by score range

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

No description

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

No description

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

No description

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

No description

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

No description

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

Intersect sorted sets

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static RedisCluster
zrangebyscore(string $key, float|int|string $min, float|int|string $max, array $options = '[]')

Get sorted set members by score range

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

No description

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

No description

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

Remove sorted set members

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

No description

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

No description

static RedisCluster
zRemRangeByScore(string $key, float|int|string $start, float|int|string $end)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static bool
zstdCompressed()

No description

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

No description

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

Union sorted sets

Details

in Facade at line 61
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 81
static MockInterface|null spy()

Convert the facade into a Mockery spy.

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

Return Value

MockInterface|null

in Facade at line 99
static MockInterface partialMock()

Initiate a partial mock on the facade.

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

Return Value

MockInterface

in Facade at line 115
static CompositeExpectation|Expectation|HigherOrderMessage shouldReceive()

Initiate a mock expectation on the facade.

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

Return Value

CompositeExpectation|Expectation|HigherOrderMessage

in Facade at line 131
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage expects()

Initiate a mock expectation on the facade.

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

Return Value

CompositeExpectation|Expectation|ExpectsHigherOrderMessage

in Facade at line 145
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 157
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 167
static protected bool isMock()

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

Return Value

bool

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

Get the mockable class for the bound instance.

Return Value

string|null

in Facade at line 194
static void 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

Return Value

void

in Facade at line 206
static bool isFake()

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

Return Value

bool

in Facade at line 217
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 357
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

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

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 256
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 267
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 275
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 335
static Container|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Container|null

in Facade at line 346
static void setFacadeApplication(Container|null $app)

Set the application instance.

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

Parameters

Container|null $app

Return Value

void

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

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException

at line 320
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 310
static mixed command(string $method, array $parameters = '[]')

No description

Parameters

string $method
array $parameters

Return Value

mixed

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

No description

Parameters

UnitEnum|string|null $name

Return Value

RedisProxy

at line 310
static void array()

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

Return Value

void

at line 310
static void disableEvents()

No description

Return Value

void

at line 310
static void enableEvents()

No description

Return Value

void

at line 310
static ConcurrencyLimiterBuilder funnel(string $name)

No description

Parameters

string $name

Return Value

ConcurrencyLimiterBuilder

at line 310
static void listen(Closure $callback)

No description

Parameters

Closure $callback

Return Value

void

at line 310
static void listenForFailures(Closure $callback)

No description

Parameters

Closure $callback

Return Value

void

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

No description

Parameters

array|string $channels
Closure $callback

Return Value

void

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

No description

Parameters

UnitEnum|string|null $name

Return Value

void

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

No description

Parameters

array|string $channels
Closure $callback

Return Value

void

at line 310
static DurationLimiterBuilder throttle(string $name)

No description

Parameters

string $name

Return Value

DurationLimiterBuilder

at line 310
static Redis discard()

No description

Return Value

Redis

at line 310
static int flushByPattern(string $pattern)

No description

Parameters

string $pattern

Return Value

int

at line 310
static void flushMacros()

No description

Return Value

void

at line 310
static string getName()

No description

Return Value

string

at line 310
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

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

No description

Parameters

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

Return Value

mixed

at line 310
static bool isCluster()

No description

Return Value

bool

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

No description

Parameters

string $name
callable|object $macro

Return Value

void

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

No description

Parameters

object $mixin
bool $replace

Return Value

void

at line 310
void static()

($callback is null ? \Redis|\RedisCluster : array<int, mixed>|false) transaction(callable|null $callback = 'null')

Return Value

void

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

No description

Parameters

mixed $cursor
mixed ...$arguments

Return Value

mixed

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

No description

Parameters

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

Return Value

mixed

at line 310
static Subscriber subscriber()

No description

Return Value

Subscriber

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

No description

Parameters

callable $callback
bool $transform

Return Value

mixed

at line 310
static mixed withoutSerializationOrCompression(callable $callback)

No description

Parameters

callable $callback

Return Value

mixed

at line 310
static mixed withPinnedConnection(callable $callback)

No description

Parameters

callable $callback

Return Value

mixed

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

No description

Parameters

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

Return Value

mixed

at line 310
static string _digest(mixed $value)

No description

Parameters

mixed $value

Return Value

string

at line 310
static string _pack(mixed $value)

No description

Parameters

mixed $value

Return Value

string

at line 310
static string _serialize(mixed $value)

Serialize a value using configured serializer

Parameters

mixed $value

Return Value

string

at line 310
static mixed _unpack(string $value)

No description

Parameters

string $value

Return Value

mixed

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

No description

Parameters

string $subcmd
string ...$args

Return Value

mixed

at line 310
static RedisCluster append(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

RedisCluster

at line 310
static RedisCluster bgrewriteaof()

No description

Return Value

RedisCluster

at line 310
static RedisCluster bgSave()

No description

Return Value

RedisCluster

at line 310
static RedisCluster 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

RedisCluster

at line 310
static RedisCluster bitop(string $operation, string $deskey, string $srckey, string ...$other_keys)

No description

Parameters

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

Return Value

RedisCluster

at line 310
static RedisCluster 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

RedisCluster

at line 310
static RedisCluster|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

RedisCluster|string

at line 310
static RedisCluster blmpop(float $timeout, array $keys, string $from, int $count = '1')

No description

Parameters

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

Return Value

RedisCluster

at line 310
static RedisCluster 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

RedisCluster

at line 310
static RedisCluster 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

RedisCluster

at line 310
static RedisCluster|string brpoplpush(string $src, string $dst, float|int $timeout)

No description

Parameters

string $src
string $dst
float|int $timeout

Return Value

RedisCluster|string

at line 310
static RedisCluster bzmpop(float $timeout, array $keys, string $from, int $count = '1')

No description

Parameters

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

Return Value

RedisCluster

at line 310
static RedisCluster 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

RedisCluster

at line 310
static RedisCluster 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

RedisCluster

at line 310
static bool clearLastError()

No description

Return Value

bool

at line 310
static void clearTransferredBytes()

No description

Return Value

void

at line 310
static bool compressed()

No description

Return Value

bool

at line 310
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 310
static RedisCluster copy(string $src, string $dst, array|null $options = 'null')

No description

Parameters

string $src
string $dst
array|null $options

Return Value

RedisCluster

at line 310
static RedisCluster dbSize()

No description

Return Value

RedisCluster

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

No description

Parameters

string $key

Return Value

Redis|string

at line 310
static RedisCluster decr(string $key, int $by = '1')

No description

Parameters

string $key
int $by

Return Value

RedisCluster

at line 310
static RedisCluster decrBy(string $key, int $value)

No description

Parameters

string $key
int $value

Return Value

RedisCluster

at line 310
static RedisCluster del(array|string $key, string ...$other_keys)

No description

Parameters

array|string $key
string ...$other_keys

Return Value

RedisCluster

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

No description

Parameters

string $key
array|null $options

Return Value

RedisCluster

at line 310
static RedisCluster delifeq(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

RedisCluster

at line 310
static RedisCluster|string digest(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|string

at line 310
static RedisCluster|string dump(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|string

at line 310
static RedisCluster|string echo(string $str)

No description

Parameters

string $str

Return Value

RedisCluster|string

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

Evaluate Lua script

Parameters

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

Return Value

mixed

at line 310
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 310
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 310
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 310
static mixed evalWithShaCache(string $script, string[] $keys = '[]', mixed[] $args = '[]')

No description

Parameters

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

Return Value

mixed

at line 310
static Redis exec()

No description

Return Value

Redis

at line 310
static mixed executeRaw(array $parameters)

Execute raw Redis command

Parameters

array $parameters

Return Value

mixed

at line 310
static RedisCluster exists(mixed $key, mixed ...$other_keys)

No description

Parameters

mixed $key
mixed ...$other_keys

Return Value

RedisCluster

at line 310
static RedisCluster expire(string $key, int $timeout, string|null $mode = 'null')

No description

Parameters

string $key
int $timeout
string|null $mode

Return Value

RedisCluster

at line 310
static RedisCluster expireAt(string $key, int $timestamp, string|null $mode = 'null')

No description

Parameters

string $key
int $timestamp
string|null $mode

Return Value

RedisCluster

at line 310
static RedisCluster expiretime(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

at line 310
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 310
static mixed fcall(string $fn, array $keys = '[]', array $args = '[]')

No description

Parameters

string $fn
array $keys
array $args

Return Value

mixed

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

No description

Parameters

string $fn
array $keys
array $args

Return Value

mixed

at line 310
static RedisCluster flushAll(bool|null $sync = 'null')

No description

Parameters

bool|null $sync

Return Value

RedisCluster

at line 310
static mixed flushdb(mixed ...$arguments)

Flush database

Parameters

mixed ...$arguments

Return Value

mixed

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

No description

Parameters

string $operation
mixed ...$args

Return Value

Redis|string

at line 310
static RedisCluster 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

RedisCluster

at line 310
static RedisCluster 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

RedisCluster

at line 310
static RedisCluster geohash(string $key, string $member, string ...$other_members)

No description

Parameters

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

Return Value

RedisCluster

at line 310
static RedisCluster geopos(string $key, string $member, string ...$other_members)

No description

Parameters

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

Return Value

RedisCluster

at line 310
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 310
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 310
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 310
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 310
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 310
static RedisCluster 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

RedisCluster

at line 310
static mixed get(string $key)

Get the value of a key

Parameters

string $key

Return Value

mixed

at line 310
static mixed getAuth()

No description

Return Value

mixed

at line 310
static RedisCluster getBit(string $key, int $idx)

No description

Parameters

string $key
int $idx

Return Value

RedisCluster

at line 310
static int getDBNum()

No description

Return Value

int

at line 310
static RedisCluster|string getDel(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|string

at line 310
static Dispatcher|null getEventDispatcher()

No description

Return Value

Dispatcher|null

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

No description

Parameters

string $key
array $options

Return Value

RedisCluster|string

at line 310
static string getHost()

No description

Return Value

string

at line 310
static null|string getLastError()

No description

Return Value

null|string

at line 310
static int getMode()

No description

Return Value

int

at line 310
static mixed getOption(int $option)

No description

Parameters

int $option

Return Value

mixed

at line 310
static null|string getPersistentID()

No description

Return Value

null|string

at line 310
static int getPort()

No description

Return Value

int

at line 310
static RedisCluster|string getRange(string $key, int $start, int $end)

No description

Parameters

string $key
int $start
int $end

Return Value

RedisCluster|string

at line 310
static float getReadTimeout()

No description

Return Value

float

at line 310
static RedisCluster|string getset(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

RedisCluster|string

at line 310
static false|float getTimeout()

No description

Return Value

false|float

at line 310
static array getTransferredBytes()

No description

Return Value

array

at line 310
static RedisCluster getWithMeta(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

at line 310
static bool hasHashTag(string $key)

No description

Parameters

string $key

Return Value

bool

at line 310
static RedisCluster hdel(string $key, string $field, string ...$other_fields)

Delete hash fields

Parameters

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

Return Value

RedisCluster

at line 310
static RedisCluster hExists(string $key, string $field)

No description

Parameters

string $key
string $field

Return Value

RedisCluster

at line 310
static RedisCluster 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

RedisCluster

at line 310
static RedisCluster 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

RedisCluster

at line 310
static RedisCluster hexpiretime(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

RedisCluster

at line 310
static mixed hget(string $key, string $member)

Get hash field value

Parameters

string $key
string $member

Return Value

mixed

at line 310
static RedisCluster hGetAll(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

at line 310
static RedisCluster hgetdel(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

RedisCluster

at line 310
static RedisCluster hgetex(string $key, array $fields, string|array|null $expiry = 'null')

No description

Parameters

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

Return Value

RedisCluster

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

No description

Parameters

string $key
string $member

Return Value

mixed

at line 310
static RedisCluster hIncrBy(string $key, string $field, int $value)

No description

Parameters

string $key
string $field
int $value

Return Value

RedisCluster

at line 310
static RedisCluster hIncrByFloat(string $key, string $field, float $value)

No description

Parameters

string $key
string $field
float $value

Return Value

RedisCluster

at line 310
static RedisCluster hkeys(string $key)

Get all hash field names

Parameters

string $key

Return Value

RedisCluster

at line 310
static RedisCluster hlen(string $key)

Get number of hash fields

Parameters

string $key

Return Value

RedisCluster

at line 310
static RedisCluster hmget(string $key, array $fields)

Get hash field values

Parameters

string $key
array $fields

Return Value

RedisCluster

at line 310
static RedisCluster hmset(string $key, array $fieldValues)

Set hash field values

Parameters

string $key
array $fieldValues

Return Value

RedisCluster

at line 310
static RedisCluster hpersist(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

RedisCluster

at line 310
static RedisCluster 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

RedisCluster

at line 310
static RedisCluster 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

RedisCluster

at line 310
static RedisCluster hpexpiretime(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

RedisCluster

at line 310
static RedisCluster hpttl(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

RedisCluster

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

No description

Parameters

string $key
array|null $options

Return Value

RedisCluster|string

at line 310
static RedisCluster hset(string $key, mixed ...$fields_and_vals)

Set hash field values

Parameters

string $key
mixed ...$fields_and_vals

Return Value

RedisCluster

at line 310
static RedisCluster hsetex(string $key, array $fields, array|null $expiry = 'null')

No description

Parameters

string $key
array $fields
array|null $expiry

Return Value

RedisCluster

at line 310
static RedisCluster hsetnx(string $hash, string $key, mixed $value)

Set hash field if not exists

Parameters

string $hash
string $key
mixed $value

Return Value

RedisCluster

at line 310
static RedisCluster hStrLen(string $key, string $field)

No description

Parameters

string $key
string $field

Return Value

RedisCluster

at line 310
static RedisCluster httl(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

RedisCluster

at line 310
static RedisCluster hVals(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

at line 310
static RedisCluster incr(string $key, int $by = '1')

No description

Parameters

string $key
int $by

Return Value

RedisCluster

at line 310
static RedisCluster incrBy(string $key, int $value)

No description

Parameters

string $key
int $value

Return Value

RedisCluster

at line 310
static RedisCluster incrByFloat(string $key, float $value)

No description

Parameters

string $key
float $value

Return Value

RedisCluster

at line 310
static RedisCluster info(string ...$sections)

No description

Parameters

string ...$sections

Return Value

RedisCluster

at line 310
static bool isConnected()

No description

Return Value

bool

at line 310
static RedisCluster keys(string $pattern)

No description

Parameters

string $pattern

Return Value

RedisCluster

at line 310
static int lastSave()

No description

Return Value

int

at line 310
static RedisCluster|string lcs(string $key1, string $key2, array|null $options = 'null')

No description

Parameters

string $key1
string $key2
array|null $options

Return Value

RedisCluster|string

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

No description

Parameters

string $key
int $index

Return Value

mixed

at line 310
static RedisCluster lInsert(string $key, string $pos, mixed $pivot, mixed $value)

No description

Parameters

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

Return Value

RedisCluster

at line 310
static RedisCluster llen(string $key)

Get list length

Parameters

string $key

Return Value

RedisCluster

at line 310
static RedisCluster|string lMove(string $src, string $dst, string $wherefrom, string $whereto)

No description

Parameters

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

Return Value

RedisCluster|string

at line 310
static RedisCluster lmpop(array $keys, string $from, int $count = '1')

No description

Parameters

array $keys
string $from
int $count

Return Value

RedisCluster

at line 310
static RedisCluster|string lPop(string $key, int $count = '0')

No description

Parameters

string $key
int $count

Return Value

RedisCluster|string

at line 310
static RedisCluster lPos(string $key, mixed $value, array|null $options = 'null')

No description

Parameters

string $key
mixed $value
array|null $options

Return Value

RedisCluster

at line 310
static RedisCluster lPush(string $key, mixed ...$elements)

No description

Parameters

string $key
mixed ...$elements

Return Value

RedisCluster

at line 310
static RedisCluster lPushx(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

RedisCluster

at line 310
static RedisCluster lrange(string $key, int $start, int $end)

No description

Parameters

string $key
int $start
int $end

Return Value

RedisCluster

at line 310
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 310
static RedisCluster lSet(string $key, int $index, mixed $value)

No description

Parameters

string $key
int $index
mixed $value

Return Value

RedisCluster

at line 310
static RedisCluster ltrim(string $key, int $start, int $end)

No description

Parameters

string $key
int $start
int $end

Return Value

RedisCluster

at line 310
static bool lz4Compressed()

No description

Return Value

bool

at line 310
static bool lzfCompressed()

No description

Return Value

bool

at line 310
static RedisCluster mget(array $keys)

Get the values of multiple keys

Parameters

array $keys

Return Value

RedisCluster

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

No description

Parameters

string $key
int $index

Return Value

Redis

at line 310
static RedisCluster mset(array $key_values)

No description

Parameters

array $key_values

Return Value

RedisCluster

at line 310
static RedisCluster msetex(array $key_values, int|float|array|null $expiry = 'null')

No description

Parameters

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

Return Value

RedisCluster

at line 310
static RedisCluster msetnx(array $key_values)

No description

Parameters

array $key_values

Return Value

RedisCluster

at line 310
static RedisCluster multi(int $value = '1')

No description

Parameters

int $value

Return Value

RedisCluster

at line 310
static RedisCluster|string object(string $subcommand, string $key)

No description

Parameters

string $subcommand
string $key

Return Value

RedisCluster|string

at line 310
static RedisCluster persist(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

at line 310
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 310
static RedisCluster pexpireAt(string $key, int $timestamp, string|null $mode = 'null')

No description

Parameters

string $key
int $timestamp
string|null $mode

Return Value

RedisCluster

at line 310
static RedisCluster pexpiretime(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

at line 310
static RedisCluster pfadd(string $key, array $elements)

No description

Parameters

string $key
array $elements

Return Value

RedisCluster

at line 310
static RedisCluster pfcount(array|string $key_or_keys)

No description

Parameters

array|string $key_or_keys

Return Value

RedisCluster

at line 310
static RedisCluster pfmerge(string $dst, array $srckeys)

No description

Parameters

string $dst
array $srckeys

Return Value

RedisCluster

at line 310
static RedisCluster|string ping(string|null $message = 'null')

No description

Parameters

string|null $message

Return Value

RedisCluster|string

at line 310
static RedisCluster psetex(string $key, int $expire, mixed $value)

No description

Parameters

string $key
int $expire
mixed $value

Return Value

RedisCluster

at line 310
static RedisCluster pttl(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

at line 310
static RedisCluster publish(string $channel, string $message)

No description

Parameters

string $channel
string $message

Return Value

RedisCluster

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

No description

Parameters

string $command
mixed $arg

Return Value

mixed

at line 310
static Redis punsubscribe(array $patterns)

No description

Parameters

array $patterns

Return Value

Redis

at line 310
static RedisCluster|string randomKey()

No description

Return Value

RedisCluster|string

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

No description

Parameters

string $command
mixed ...$args

Return Value

mixed

at line 310
static RedisCluster rename(string $old_name, string $new_name)

No description

Parameters

string $old_name
string $new_name

Return Value

RedisCluster

at line 310
static RedisCluster renameNx(string $key_src, string $key_dst)

No description

Parameters

string $key_src
string $key_dst

Return Value

RedisCluster

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

No description

Parameters

string|null $host
int $port

Return Value

Redis

at line 310
static RedisCluster 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

RedisCluster

at line 310
static mixed role()

No description

Return Value

mixed

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

No description

Parameters

string $key
int $count

Return Value

RedisCluster|string

at line 310
static RedisCluster|string rpoplpush(string $srckey, string $dstkey)

No description

Parameters

string $srckey
string $dstkey

Return Value

RedisCluster|string

at line 310
static RedisCluster rPush(string $key, mixed ...$elements)

No description

Parameters

string $key
mixed ...$elements

Return Value

RedisCluster

at line 310
static RedisCluster rPushx(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

RedisCluster

at line 310
static RedisCluster sAdd(string $key, mixed $value, mixed ...$other_values)

No description

Parameters

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

Return Value

RedisCluster

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

No description

Parameters

string $key
array $values

Return Value

int

at line 310
static RedisCluster save()

No description

Return Value

RedisCluster

at line 310
static RedisCluster scard(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

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

No description

Parameters

string $command
mixed ...$args

Return Value

mixed

at line 310
static RedisCluster sDiff(string $key, string ...$other_keys)

No description

Parameters

string $key
string ...$other_keys

Return Value

RedisCluster

at line 310
static RedisCluster sDiffStore(string $dst, string $key, string ...$other_keys)

No description

Parameters

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

Return Value

RedisCluster

at line 310
static Redis select(int $db)

No description

Parameters

int $db

Return Value

Redis

at line 310
static bool serialized()

No description

Return Value

bool

at line 310
static false|string serverName()

No description

Return Value

false|string

at line 310
static false|string serverVersion()

No description

Return Value

false|string

at line 310
static mixed set(string $key, mixed $value, mixed $expireResolution = 'null', int|null $expireTTL = 'null', string|null $flag = 'null')

Set the value of a key

Parameters

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

Return Value

mixed

at line 310
static RedisCluster setBit(string $key, int $idx, bool $value)

No description

Parameters

string $key
int $idx
bool $value

Return Value

RedisCluster

at line 310
static RedisCluster setex(string $key, int $expire, mixed $value)

No description

Parameters

string $key
int $expire
mixed $value

Return Value

RedisCluster

at line 310
static RedisCluster setnx(string $key, mixed $value)

Set key if not exists

Parameters

string $key
mixed $value

Return Value

RedisCluster

at line 310
static RedisCluster setRange(string $key, int $index, string $value)

No description

Parameters

string $key
int $index
string $value

Return Value

RedisCluster

at line 310
static RedisCluster sInter(array|string $key, string ...$other_keys)

No description

Parameters

array|string $key
string ...$other_keys

Return Value

RedisCluster

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

No description

Parameters

array $keys
int $limit

Return Value

RedisCluster

at line 310
static RedisCluster sInterStore(array|string $key, string ...$other_keys)

No description

Parameters

array|string $key
string ...$other_keys

Return Value

RedisCluster

at line 310
static RedisCluster sismember(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

RedisCluster

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

No description

Parameters

string $operation
int $length

Return Value

mixed

at line 310
static RedisCluster smembers(string $key)

Get all set members

Parameters

string $key

Return Value

RedisCluster

at line 310
static RedisCluster sMisMember(string $key, string $member, string ...$other_members)

No description

Parameters

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

Return Value

RedisCluster

at line 310
static RedisCluster sMove(string $src, string $dst, mixed $value)

No description

Parameters

string $src
string $dst
mixed $value

Return Value

RedisCluster

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

No description

Parameters

string $key
array|null $options

Return Value

mixed

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

No description

Parameters

string $key
array|null $options

Return Value

mixed

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

Remove and return random set member

Parameters

string $key
int $count

Return Value

mixed

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

No description

Parameters

string $key
int $count

Return Value

mixed

at line 310
static RedisCluster sRem(string $key, mixed $value, mixed ...$other_values)

Remove members from set

Parameters

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

Return Value

RedisCluster

at line 310
static RedisCluster strlen(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

at line 310
static RedisCluster sUnion(string $key, string ...$other_keys)

No description

Parameters

string $key
string ...$other_keys

Return Value

RedisCluster

at line 310
static RedisCluster sUnionStore(string $dst, string $key, string ...$other_keys)

No description

Parameters

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

Return Value

RedisCluster

at line 310
static Redis sunsubscribe(array $channels)

No description

Parameters

array $channels

Return Value

Redis

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

No description

Parameters

int $src
int $dst

Return Value

Redis

at line 310
static RedisCluster time()

No description

Return Value

RedisCluster

at line 310
static RedisCluster touch(array|string $key_or_array, string ...$more_keys)

No description

Parameters

array|string $key_or_array
string ...$more_keys

Return Value

RedisCluster

at line 310
static RedisCluster ttl(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

at line 310
static RedisCluster type(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

No description

Parameters

array|string $key
string ...$other_keys

Return Value

RedisCluster

at line 310
static Redis unsubscribe(array $channels)

No description

Parameters

array $channels

Return Value

Redis

at line 310
static Redis unwatch()

No description

Return Value

Redis

at line 310
static RedisCluster 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

RedisCluster

at line 310
static RedisCluster vcard(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

at line 310
static RedisCluster vdim(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

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

No description

Parameters

string $key
mixed $member
bool $raw

Return Value

RedisCluster

at line 310
static RedisCluster|string vgetattr(string $key, mixed $member, bool $decode = 'true')

No description

Parameters

string $key
mixed $member
bool $decode

Return Value

RedisCluster|string

at line 310
static RedisCluster vinfo(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

at line 310
static RedisCluster vismember(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

RedisCluster

No description

Parameters

string $key
mixed $member
bool $withscores

Return Value

RedisCluster

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

No description

Parameters

string $key
int $count

Return Value

RedisCluster|string

at line 310
static RedisCluster vrange(string $key, string $min, string $max, int $count = '-1')

No description

Parameters

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

Return Value

RedisCluster

at line 310
static RedisCluster vrem(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

RedisCluster

at line 310
static RedisCluster vsetattr(string $key, mixed $member, array|string $attributes)

No description

Parameters

string $key
mixed $member
array|string $attributes

Return Value

RedisCluster

at line 310
static RedisCluster vsim(string $key, mixed $member, array|null $options = 'null')

No description

Parameters

string $key
mixed $member
array|null $options

Return Value

RedisCluster

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

No description

Parameters

int $numreplicas
int $timeout

Return Value

false|int

at line 310
static RedisCluster waitaof(int $numlocal, int $numreplicas, int $timeout)

No description

Parameters

int $numlocal
int $numreplicas
int $timeout

Return Value

RedisCluster

at line 310
static RedisCluster watch(array|string $key, string ...$other_keys)

No description

Parameters

array|string $key
string ...$other_keys

Return Value

RedisCluster

at line 310
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 310
static RedisCluster|string xadd(string $key, int|string $id, array $values, int $maxlen = '0', bool $approx = 'false', bool $nomkstream = 'false')

No description

Parameters

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

Return Value

RedisCluster|string

at line 310
static RedisCluster xautoclaim(string $key, string $group, string $consumer, int $min_idle, int|string $start, int $count = '-1', bool $justid = 'false')

No description

Parameters

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

Return Value

RedisCluster

at line 310
static RedisCluster 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

RedisCluster

at line 310
static RedisCluster xdel(string $key, array $ids)

No description

Parameters

string $key
array $ids

Return Value

RedisCluster

at line 310
static RedisCluster xdelex(string $key, array $ids, string|null $mode = 'null')

No description

Parameters

string $key
array $ids
string|null $mode

Return Value

RedisCluster

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

No description

Parameters

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

Return Value

mixed

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

No description

Parameters

string $key

Return Value

RedisCluster

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

No description

Parameters

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

Return Value

RedisCluster

at line 310
static RedisCluster xrange(string $key, int|string $start, int|string $end, int $count = '-1')

No description

Parameters

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

Return Value

RedisCluster

at line 310
static RedisCluster xread(array $streams, int $count = '-1', int $block = '-1')

No description

Parameters

array $streams
int $count
int $block

Return Value

RedisCluster

at line 310
static RedisCluster 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

RedisCluster

at line 310
static RedisCluster xrevrange(string $key, int|string $end, int|string $start, int $count = '-1')

No description

Parameters

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

Return Value

RedisCluster

at line 310
static RedisCluster xtrim(string $key, int|string $threshold, bool $approx = 'false', bool $minid = 'false', int $limit = '-1')

No description

Parameters

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

Return Value

RedisCluster

at line 310
static RedisCluster 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

RedisCluster

at line 310
static RedisCluster zcard(string $key)

Get sorted set cardinality

Parameters

string $key

Return Value

RedisCluster

at line 310
static RedisCluster zcount(string $key, float|int|string $start, float|int|string $end)

Count sorted set members by score range

Parameters

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

Return Value

RedisCluster

at line 310
static RedisCluster zdiff(array $keys, array|null $options = 'null')

No description

Parameters

array $keys
array|null $options

Return Value

RedisCluster

at line 310
static RedisCluster zdiffstore(string $dst, array $keys)

No description

Parameters

string $dst
array $keys

Return Value

RedisCluster

at line 310
static RedisCluster zIncrBy(string $key, float $value, mixed $member)

No description

Parameters

string $key
float $value
mixed $member

Return Value

RedisCluster

at line 310
static RedisCluster zinter(array $keys, array|null $weights = 'null', array|null $options = 'null')

No description

Parameters

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

Return Value

RedisCluster

at line 310
static RedisCluster zintercard(array $keys, int $limit = '-1')

No description

Parameters

array $keys
int $limit

Return Value

RedisCluster

at line 310
static RedisCluster zinterstore(string $output, array $keys, array $options = '[]')

Intersect sorted sets

Parameters

string $output
array $keys
array $options

Return Value

RedisCluster

at line 310
static RedisCluster zLexCount(string $key, string $min, string $max)

No description

Parameters

string $key
string $min
string $max

Return Value

RedisCluster

at line 310
static RedisCluster zmpop(array $keys, string $from, int $count = '1')

No description

Parameters

array $keys
string $from
int $count

Return Value

RedisCluster

at line 310
static RedisCluster zMscore(string $key, mixed $member, mixed ...$other_members)

No description

Parameters

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

Return Value

RedisCluster

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

No description

Parameters

string $key
int|null $count

Return Value

RedisCluster

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

No description

Parameters

string $key
int|null $count

Return Value

RedisCluster

at line 310
static RedisCluster|string zRandMember(string $key, array|null $options = 'null')

No description

Parameters

string $key
array|null $options

Return Value

RedisCluster|string

at line 310
static RedisCluster 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

RedisCluster

at line 310
static RedisCluster 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

RedisCluster

at line 310
static RedisCluster zrangebyscore(string $key, float|int|string $min, float|int|string $max, array $options = '[]')

Get sorted set members by score range

Parameters

string $key
float|int|string $min
float|int|string $max
array $options

Return Value

RedisCluster

at line 310
static RedisCluster 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

RedisCluster

at line 310
static RedisCluster zRank(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

RedisCluster

at line 310
static RedisCluster zrem(mixed $key, mixed $member, mixed ...$other_members)

Remove sorted set members

Parameters

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

Return Value

RedisCluster

at line 310
static RedisCluster zRemRangeByLex(string $key, string $min, string $max)

No description

Parameters

string $key
string $min
string $max

Return Value

RedisCluster

at line 310
static RedisCluster zRemRangeByRank(string $key, int $start, int $end)

No description

Parameters

string $key
int $start
int $end

Return Value

RedisCluster

at line 310
static RedisCluster zRemRangeByScore(string $key, float|int|string $start, float|int|string $end)

No description

Parameters

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

Return Value

RedisCluster

at line 310
static RedisCluster zRevRange(string $key, int $start, int $end, mixed $scores = 'null')

No description

Parameters

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

Return Value

RedisCluster

at line 310
static RedisCluster 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

RedisCluster

at line 310
static RedisCluster zrevrangebyscore(string $key, float|int|string $max, float|int|string $min, array $options = '[]') Get sorted set members by score range (reverse)

No description

Parameters

string $key
float|int|string $max
float|int|string $min
array $options

Return Value

RedisCluster

at line 310
static RedisCluster zRevRank(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

RedisCluster

at line 310
static RedisCluster zScore(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

RedisCluster

at line 310
static bool zstdCompressed()

No description

Return Value

bool

at line 310
static RedisCluster zunion(array $keys, array|null $weights = 'null', array|null $options = 'null')

No description

Parameters

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

Return Value

RedisCluster

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

Union sorted sets

Parameters

string $output
array $keys
array $options

Return Value

RedisCluster