class Redis extends Facade (View source)

Properties

static protected Application|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
spy()

Convert the facade into a Mockery spy.

from  Facade
static MockInterface
partialMock()

Initiate a partial mock on the facade.

from  Facade
static Expectation
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static Expectation
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 $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 Application|null
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(Application|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 Connection
connection(UnitEnum|string|null $name = null)

No description

static Connection
resolve(string|null $name = null)

No description

static array
connections()

No description

static void
enableEvents()

No description

static void
disableEvents()

No description

static void
setDriver(string $driver)

No description

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

No description

static RedisManager
extend(string $driver, Closure $callback)

No description

static void
createSubscription(array|string $channels, Closure $callback, string $method = 'subscribe')

No description

funnel(string $name)

No description

throttle(string $name)

No description

static mixed
client()

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

static void
listen(Closure $callback)

No description

static void
listenForFailures(Closure $callback)

No description

static string|null
getName()

No description

static Connection
setName(string $name)

No description

static Dispatcher|null
getEventDispatcher()

No description

static void
setEventDispatcher(Dispatcher $events)

No description

static void
unsetEventDispatcher()

No description

static void
macro(string $name, object|callable $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 mixed
macroCall(string $method, array $parameters)

No description

static string
_compress(string $value)

No description

static string
_uncompress(string $value)

No description

static string
_prefix(string $key)

No description

static string
_serialize(mixed $value)

No description

static mixed
_unserialize(string $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|int|false
append(string $key, mixed $value)

No description

static Redis|bool
auth(mixed $credentials)

No description

static Redis|bool
bgSave()

No description

static Redis|bool
bgrewriteaof()

No description

static Redis|array|false
waitaof(int $numlocal, int $numreplicas, int $timeout)

No description

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

No description

static Redis|int|false
bitop(string $operation, string $deskey, string $srckey, string $other_keys)

No description

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

No description

static Redis|array|false|null
blPop(array|string $key_or_keys, string|int|float $timeout_or_key, mixed $extra_args)

No description

static Redis|array|false|null
brPop(array|string $key_or_keys, string|int|float $timeout_or_key, mixed $extra_args)

No description

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

No description

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

No description

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

No description

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

No description

static Redis|array|false|null
zmpop(array $keys, string $from, int $count = 1)

No description

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

No description

static Redis|array|false|null
lmpop(array $keys, string $from, int $count = 1)

No description

static bool
clearLastError()

No description

static bool
close()

No description

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

No description

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

No description

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

No description

static Redis|int|false
dbSize()

No description

static Redis|string
debug(string $key)

No description

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

No description

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

No description

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

No description

static Redis|int|false
delifeq(string $key, mixed $value)

No description

static Redis|bool
discard()

No description

static Redis|string|false
dump(string $key)

No description

static Redis|string|false
echo(string $str)

No description

static mixed
eval(string $script, array $args = [], int $num_keys)

No description

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

No description

static mixed
evalsha(string $sha1, array $args = [], int $num_keys)

No description

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

No description

static Redis|array|false
exec()

No description

static Redis|int|bool
exists(mixed $key, mixed $other_keys)

No description

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

No description

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

No description

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

No description

static Redis|int|false
expiretime(string $key)

No description

static Redis|int|false
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|bool
flushAll(bool|null $sync = null)

No description

static Redis|bool
flushDB(bool|null $sync = null)

No description

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

No description

static Redis|int|false
geoadd(string $key, float $lng, float $lat, string $member, mixed $other_triples_and_options)

No description

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

No description

static Redis|array|false
geohash(string $key, string $member, string $other_members)

No description

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

No description

static mixed
get(string $key)

No description

static Redis|array|false
getWithMeta(string $key)

No description

static mixed
getAuth()

No description

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

No description

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

No description

static int
getDBNum()

No description

static Redis|string|bool
getDel(string $key)

No description

static string
getHost()

No description

static string|null
getLastError()

No description

static int
getMode()

No description

static mixed
getOption(int $option)

No description

static string|null
getPersistentID()

No description

static int
getPort()

No description

static string|false
serverName()

No description

static string|false
serverVersion()

No description

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

No description

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

No description

static float
getReadTimeout()

No description

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

No description

static float|false
getTimeout()

No description

static array
getTransferredBytes()

No description

static void
clearTransferredBytes()

No description

static Redis|int|false
hDel(string $key, string $field, string $other_fields)

No description

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

No description

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

No description

static Redis|array|false
hGetAll(string $key)

No description

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

No description

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

No description

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

No description

static Redis|array|false
hKeys(string $key)

No description

static Redis|int|false
hLen(string $key)

No description

static Redis|array|false
hMget(string $key, array $fields)

No description

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

No description

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

No description

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

No description

static Redis|bool
hMset(string $key, array $fieldvals)

No description

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

No description

static Redis|int|false
hSet(string $key, mixed $fields_and_vals)

No description

static Redis|bool
hSetNx(string $key, string $field, mixed $value)

No description

static Redis|int|false
hStrLen(string $key, string $field)

No description

static Redis|array|false
hVals(string $key)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static Redis|array|bool
hscan(string $key, string|int|null $iterator, string|null $pattern = null, int $count)

No description

static Redis|int|false
expiremember(string $key, string $field, int $ttl, string|null $unit = null)

No description

static Redis|int|false
expirememberat(string $key, string $field, int $timestamp)

No description

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

No description

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

No description

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

No description

static Redis|array|false
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|int|false
lLen(string $key)

No description

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

No description

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

No description

static Redis|array|string|bool
lPop(string $key, int $count)

No description

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

No description

static Redis|int|false
lPush(string $key, mixed $elements)

No description

static Redis|int|false
rPush(string $key, mixed $elements)

No description

static Redis|int|false
lPushx(string $key, mixed $value)

No description

static Redis|int|false
rPushx(string $key, mixed $value)

No description

static Redis|bool
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|array|false
lrange(string $key, int $start, int $end)

No description

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

No description

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

No description

static Redis|array|false
mget(array $keys)

No description

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

No description

static Redis|bool
mset(array $key_values)

No description

static Redis|bool
msetnx(array $key_values)

No description

static Redis|bool
multi(int $value = 1)

No description

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

No description

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

No description

static Redis|bool
persist(string $key)

No description

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

No description

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

No description

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

No description

static Redis|int|false
pfcount(array|string $key_or_keys)

No description

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

No description

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

No description

static Redis|bool
pipeline()

No description

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

No description

static Redis|int|false
pttl(string $key)

No description

static Redis|int|false
publish(string $channel, string $message)

No description

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

No description

static Redis|array|bool
punsubscribe(array $patterns)

No description

static Redis|array|string|bool
rPop(string $key, int $count)

No description

static Redis|string|false
randomKey()

No description

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

No description

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

No description

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

No description

static Redis|bool
reset()

No description

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

No description

static mixed
role()

No description

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

No description

static Redis|int|false
sAdd(string $key, mixed $value, mixed $other_values)

No description

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

No description

static Redis|array|false
sDiff(string $key, string $other_keys)

No description

static Redis|int|false
sDiffStore(string $dst, string $key, string $other_keys)

No description

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

No description

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

No description

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

No description

static Redis|array|false
sMembers(string $key)

No description

static Redis|array|false
sMisMember(string $key, string $member, string $other_members)

No description

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

No description

static Redis|array|string|false
sPop(string $key, int $count)

No description

static mixed
sRandMember(string $key, int $count)

No description

static Redis|array|false
sUnion(string $key, string $other_keys)

No description

static Redis|int|false
sUnionStore(string $dst, string $key, string $other_keys)

No description

static Redis|bool
save()

No description

static array|false
scan(string|int|null $iterator, string|null $pattern = null, int $count, string|null $type = null)

No description

static Redis|int|false
scard(string $key)

No description

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

No description

static Redis|bool
select(int $db)

No description

static Redis|string|bool
set(string $key, mixed $value, mixed $options = null)

No description

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

No description

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

No description

static bool
setOption(int $option, mixed $value)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static mixed
slowlog(string $operation, int $length)

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|int|false
srem(string $key, mixed $value, mixed $other_values)

No description

static array|false
sscan(string $key, string|int|null $iterator, string|null $pattern = null, int $count)

No description

static bool
ssubscribe(array $channels, callable $cb)

No description

static Redis|int|false
strlen(string $key)

No description

static Redis|array|bool
sunsubscribe(array $channels)

No description

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

No description

static Redis|array
time()

No description

static Redis|int|false
ttl(string $key)

No description

static Redis|int|false
type(string $key)

No description

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

No description

static Redis|array|bool
unsubscribe(array $channels)

No description

static Redis|bool
unwatch()

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static Redis|int|false
xdel(string $key, array $ids)

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|int|false
xlen(string $key)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static Redis|int|false
vcard(string $key)

No description

static Redis|int|false
vdim(string $key)

No description

static Redis|array|false
vinfo(string $key)

No description

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

No description

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

No description

static Redis|array|string|false
vrandmember(string $key, int $count)

No description

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

No description

static Redis|int|false
vrem(string $key, mixed $member)

No description

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

No description

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

No description

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

No description

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

No description

static Redis|int|float|false
zAdd(string $key, array|float $score_or_options, mixed $more_scores_and_mems)

No description

static Redis|int|false
zCard(string $key)

No description

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

No description

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

No description

static Redis|int|false
zLexCount(string $key, string $min, string $max)

No description

static Redis|array|false
zMscore(string $key, mixed $member, mixed $other_members)

No description

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

No description

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

No description

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

No description

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

No description

static Redis|array|false
zRangeByScore(string $key, string $start, string $end, array $options = [])

No description

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

No description

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

No description

static Redis|int|false
zRank(string $key, mixed $member)

No description

static Redis|int|false
zRem(mixed $key, mixed $member, mixed $other_members)

No description

static Redis|int|false
zRemRangeByLex(string $key, string $min, string $max)

No description

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

No description

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

No description

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

No description

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

No description

static Redis|array|false
zRevRangeByScore(string $key, string $max, string $min, array|bool $options = [])

No description

static Redis|int|false
zRevRank(string $key, mixed $member)

No description

static Redis|float|false
zScore(string $key, mixed $member)

No description

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

No description

static Redis|int|false
zdiffstore(string $dst, array $keys)

No description

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

No description

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

No description

static Redis|int|false
zinterstore(string $dst, array $keys, array|null $weights = null, string|null $aggregate = null)

No description

static Redis|array|false
zscan(string $key, string|int|null $iterator, string|null $pattern = null, int $count)

No description

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

No description

static Redis|int|false
zunionstore(string $dst, array $keys, array|null $weights = null, string|null $aggregate = null)

No description

Details

static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Parameters

Closure $callback

Return Value

void

static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

static Expectation expects()

Initiate a mock expectation on the facade.

Return Value

Expectation

static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected bool isMock()

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

Return Value

bool

static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Parameters

mixed $instance

Return Value

void

static bool isFake()

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

Return Value

bool

static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

static void clearResolvedInstance(?string $name = null)

Clear a resolved facade instance.

Parameters

?string $name

Return Value

void

static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

static Application|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Application|null

static void setFacadeApplication(Application|null $app)

Set the application instance.

Parameters

Application|null $app

Return Value

void

static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException

static Connection connection(UnitEnum|string|null $name = null)

No description

Parameters

UnitEnum|string|null $name

Return Value

Connection

static Connection resolve(string|null $name = null)

No description

Parameters

string|null $name

Return Value

Connection

static array connections()

No description

Return Value

array

static void enableEvents()

No description

Return Value

void

static void disableEvents()

No description

Return Value

void

static void setDriver(string $driver)

No description

Parameters

string $driver

Return Value

void

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

No description

Parameters

string|null $name

Return Value

void

static RedisManager extend(string $driver, Closure $callback)

No description

Parameters

string $driver
Closure $callback

Return Value

RedisManager

static void createSubscription(array|string $channels, Closure $callback, string $method = 'subscribe')

No description

Parameters

array|string $channels
Closure $callback
string $method

Return Value

void

static ConcurrencyLimiterBuilder funnel(string $name)

No description

Parameters

string $name

Return Value

ConcurrencyLimiterBuilder

static DurationLimiterBuilder throttle(string $name)

No description

Parameters

string $name

Return Value

DurationLimiterBuilder

static mixed client()

No description

Return Value

mixed

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

No description

Parameters

array|string $channels
Closure $callback

Return Value

void

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

No description

Parameters

array|string $channels
Closure $callback

Return Value

void

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

No description

Parameters

string $method
array $parameters

Return Value

mixed

static void listen(Closure $callback)

No description

Parameters

Closure $callback

Return Value

void

static void listenForFailures(Closure $callback)

No description

Parameters

Closure $callback

Return Value

void

static string|null getName()

No description

Return Value

string|null

static Connection setName(string $name)

No description

Parameters

string $name

Return Value

Connection

static Dispatcher|null getEventDispatcher()

No description

Return Value

Dispatcher|null

static void setEventDispatcher(Dispatcher $events)

No description

Parameters

Dispatcher $events

Return Value

void

static void unsetEventDispatcher()

No description

Return Value

void

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

No description

Parameters

string $name
object|callable $macro

Return Value

void

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

No description

Parameters

object $mixin
bool $replace

Return Value

void

static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

static void flushMacros()

No description

Return Value

void

static mixed macroCall(string $method, array $parameters)

No description

Parameters

string $method
array $parameters

Return Value

mixed

static string _compress(string $value)

No description

Parameters

string $value

Return Value

string

static string _uncompress(string $value)

No description

Parameters

string $value

Return Value

string

static string _prefix(string $key)

No description

Parameters

string $key

Return Value

string

static string _serialize(mixed $value)

No description

Parameters

mixed $value

Return Value

string

static mixed _unserialize(string $value)

No description

Parameters

string $value

Return Value

mixed

static string _pack(mixed $value)

No description

Parameters

mixed $value

Return Value

string

static mixed _unpack(string $value)

No description

Parameters

string $value

Return Value

mixed

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

No description

Parameters

string $subcmd
string $args

Return Value

mixed

static Redis|int|false append(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

Redis|int|false

static Redis|bool auth(mixed $credentials)

No description

Parameters

mixed $credentials

Return Value

Redis|bool

static Redis|bool bgSave()

No description

Return Value

Redis|bool

static Redis|bool bgrewriteaof()

No description

Return Value

Redis|bool

static Redis|array|false waitaof(int $numlocal, int $numreplicas, int $timeout)

No description

Parameters

int $numlocal
int $numreplicas
int $timeout

Return Value

Redis|array|false

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

No description

Parameters

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

Return Value

Redis|int|false

static Redis|int|false 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|int|false

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

No description

Parameters

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

Return Value

Redis|int|false

static Redis|array|false|null blPop(array|string $key_or_keys, string|int|float $timeout_or_key, mixed $extra_args)

No description

Parameters

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

Return Value

Redis|array|false|null

static Redis|array|false|null brPop(array|string $key_or_keys, string|int|float $timeout_or_key, mixed $extra_args)

No description

Parameters

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

Return Value

Redis|array|false|null

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

No description

Parameters

string $src
string $dst
int|float $timeout

Return Value

Redis|string|false

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

No description

Parameters

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

Return Value

Redis|array|false

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

No description

Parameters

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

Return Value

Redis|array|false

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

No description

Parameters

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

Return Value

Redis|array|false|null

static Redis|array|false|null zmpop(array $keys, string $from, int $count = 1)

No description

Parameters

array $keys
string $from
int $count

Return Value

Redis|array|false|null

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

No description

Parameters

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

Return Value

Redis|array|false|null

static Redis|array|false|null lmpop(array $keys, string $from, int $count = 1)

No description

Parameters

array $keys
string $from
int $count

Return Value

Redis|array|false|null

static bool clearLastError()

No description

Return Value

bool

static bool close()

No description

Return Value

bool

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

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

No description

Parameters

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

Return Value

bool

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

No description

Parameters

string $src
string $dst
array|null $options

Return Value

Redis|bool

static Redis|int|false dbSize()

No description

Return Value

Redis|int|false

static Redis|string debug(string $key)

No description

Parameters

string $key

Return Value

Redis|string

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

No description

Parameters

string $key
int $by

Return Value

Redis|int|false

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

No description

Parameters

string $key
int $value

Return Value

Redis|int|false

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

No description

Parameters

array|string $key
string $other_keys

Return Value

Redis|int|false

static Redis|int|false delifeq(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

Redis|int|false

static Redis|bool discard()

No description

Return Value

Redis|bool

static Redis|string|false dump(string $key)

No description

Parameters

string $key

Return Value

Redis|string|false

static Redis|string|false echo(string $str)

No description

Parameters

string $str

Return Value

Redis|string|false

static mixed eval(string $script, array $args = [], int $num_keys)

No description

Parameters

string $script
array $args
int $num_keys

Return Value

mixed

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

No description

Parameters

string $script_sha
array $args
int $num_keys

Return Value

mixed

static mixed evalsha(string $sha1, array $args = [], int $num_keys)

No description

Parameters

string $sha1
array $args
int $num_keys

Return Value

mixed

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

No description

Parameters

string $sha1
array $args
int $num_keys

Return Value

mixed

static Redis|array|false exec()

No description

Return Value

Redis|array|false

static Redis|int|bool exists(mixed $key, mixed $other_keys)

No description

Parameters

mixed $key
mixed $other_keys

Return Value

Redis|int|bool

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

No description

Parameters

string $key
int $timeout
string|null $mode

Return Value

Redis|bool

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

No description

Parameters

string $key
int $timestamp
string|null $mode

Return Value

Redis|bool

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

No description

Parameters

array|null $to
bool $abort
int $timeout

Return Value

Redis|bool

static Redis|int|false expiretime(string $key)

No description

Parameters

string $key

Return Value

Redis|int|false

static Redis|int|false pexpiretime(string $key)

No description

Parameters

string $key

Return Value

Redis|int|false

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

No description

Parameters

string $fn
array $keys
array $args

Return Value

mixed

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

No description

Parameters

string $fn
array $keys
array $args

Return Value

mixed

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

No description

Parameters

bool|null $sync

Return Value

Redis|bool

static Redis|bool flushDB(bool|null $sync = null)

No description

Parameters

bool|null $sync

Return Value

Redis|bool

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

No description

Parameters

string $operation
mixed $args

Return Value

Redis|array|string|bool

static Redis|int|false 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|int|false

static Redis|float|false 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|float|false

static Redis|array|false geohash(string $key, string $member, string $other_members)

No description

Parameters

string $key
string $member
string $other_members

Return Value

Redis|array|false

static Redis|array|false geopos(string $key, string $member, string $other_members)

No description

Parameters

string $key
string $member
string $other_members

Return Value

Redis|array|false

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

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

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

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

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

static Redis|array|int|false 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|array|int|false

static mixed get(string $key)

No description

Parameters

string $key

Return Value

mixed

static Redis|array|false getWithMeta(string $key)

No description

Parameters

string $key

Return Value

Redis|array|false

static mixed getAuth()

No description

Return Value

mixed

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

No description

Parameters

string $key
int $idx

Return Value

Redis|int|false

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

No description

Parameters

string $key
array $options

Return Value

Redis|string|bool

static int getDBNum()

No description

Return Value

int

static Redis|string|bool getDel(string $key)

No description

Parameters

string $key

Return Value

Redis|string|bool

static string getHost()

No description

Return Value

string

static string|null getLastError()

No description

Return Value

string|null

static int getMode()

No description

Return Value

int

static mixed getOption(int $option)

No description

Parameters

int $option

Return Value

mixed

static string|null getPersistentID()

No description

Return Value

string|null

static int getPort()

No description

Return Value

int

static string|false serverName()

No description

Return Value

string|false

static string|false serverVersion()

No description

Return Value

string|false

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

No description

Parameters

string $key
int $start
int $end

Return Value

Redis|string|false

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

No description

Parameters

string $key1
string $key2
array|null $options

Return Value

Redis|array|string|int|false

static float getReadTimeout()

No description

Return Value

float

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

No description

Parameters

string $key
mixed $value

Return Value

Redis|string|false

static float|false getTimeout()

No description

Return Value

float|false

static array getTransferredBytes()

No description

Return Value

array

static void clearTransferredBytes()

No description

Return Value

void

static Redis|int|false hDel(string $key, string $field, string $other_fields)

No description

Parameters

string $key
string $field
string $other_fields

Return Value

Redis|int|false

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

No description

Parameters

string $key
string $field

Return Value

Redis|bool

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

No description

Parameters

string $key
string $member

Return Value

mixed

static Redis|array|false hGetAll(string $key)

No description

Parameters

string $key

Return Value

Redis|array|false

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

No description

Parameters

string $key
string $member

Return Value

mixed

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

No description

Parameters

string $key
string $field
int $value

Return Value

Redis|int|false

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

No description

Parameters

string $key
string $field
float $value

Return Value

Redis|float|false

static Redis|array|false hKeys(string $key)

No description

Parameters

string $key

Return Value

Redis|array|false

static Redis|int|false hLen(string $key)

No description

Parameters

string $key

Return Value

Redis|int|false

static Redis|array|false hMget(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

Redis|array|false

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

No description

Parameters

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

Return Value

Redis|array|false

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

No description

Parameters

string $key
array $fields
array|null $expiry

Return Value

Redis|int|false

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

No description

Parameters

string $key
array $fields

Return Value

Redis|array|false

static Redis|bool hMset(string $key, array $fieldvals)

No description

Parameters

string $key
array $fieldvals

Return Value

Redis|bool

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

No description

Parameters

string $key
array|null $options

Return Value

Redis|array|string|false

static Redis|int|false hSet(string $key, mixed $fields_and_vals)

No description

Parameters

string $key
mixed $fields_and_vals

Return Value

Redis|int|false

static Redis|bool hSetNx(string $key, string $field, mixed $value)

No description

Parameters

string $key
string $field
mixed $value

Return Value

Redis|bool

static Redis|int|false hStrLen(string $key, string $field)

No description

Parameters

string $key
string $field

Return Value

Redis|int|false

static Redis|array|false hVals(string $key)

No description

Parameters

string $key

Return Value

Redis|array|false

static Redis|array|false 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|array|false

static Redis|array|false 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|array|false

static Redis|array|false 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|array|false

static Redis|array|false 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|array|false

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

No description

Parameters

string $key
array $fields

Return Value

Redis|array|false

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

No description

Parameters

string $key
array $fields

Return Value

Redis|array|false

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

No description

Parameters

string $key
array $fields

Return Value

Redis|array|false

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

No description

Parameters

string $key
array $fields

Return Value

Redis|array|false

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

No description

Parameters

string $key
array $fields

Return Value

Redis|array|false

static Redis|array|bool hscan(string $key, string|int|null $iterator, string|null $pattern = null, int $count)

No description

Parameters

string $key
string|int|null $iterator
string|null $pattern
int $count

Return Value

Redis|array|bool

static Redis|int|false expiremember(string $key, string $field, int $ttl, string|null $unit = null)

No description

Parameters

string $key
string $field
int $ttl
string|null $unit

Return Value

Redis|int|false

static Redis|int|false expirememberat(string $key, string $field, int $timestamp)

No description

Parameters

string $key
string $field
int $timestamp

Return Value

Redis|int|false

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

No description

Parameters

string $key
int $by

Return Value

Redis|int|false

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

No description

Parameters

string $key
int $value

Return Value

Redis|int|false

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

No description

Parameters

string $key
float $value

Return Value

Redis|float|false

static Redis|array|false info(string $sections)

No description

Parameters

string $sections

Return Value

Redis|array|false

static bool isConnected()

No description

Return Value

bool

static void keys(string $pattern)

No description

Parameters

string $pattern

Return Value

void

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

static Redis|int|false lLen(string $key)

No description

Parameters

string $key

Return Value

Redis|int|false

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

No description

Parameters

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

Return Value

Redis|string|false

static Redis|string|false 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|false

static Redis|array|string|bool lPop(string $key, int $count)

No description

Parameters

string $key
int $count

Return Value

Redis|array|string|bool

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

No description

Parameters

string $key
mixed $value
array|null $options

Return Value

Redis|array|int|bool|null

static Redis|int|false lPush(string $key, mixed $elements)

No description

Parameters

string $key
mixed $elements

Return Value

Redis|int|false

static Redis|int|false rPush(string $key, mixed $elements)

No description

Parameters

string $key
mixed $elements

Return Value

Redis|int|false

static Redis|int|false lPushx(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

Redis|int|false

static Redis|int|false rPushx(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

Redis|int|false

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

No description

Parameters

string $key
int $index
mixed $value

Return Value

Redis|bool

static int lastSave()

No description

Return Value

int

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

No description

Parameters

string $key
int $index

Return Value

mixed

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

No description

Parameters

string $key
int $start
int $end

Return Value

Redis|array|false

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

No description

Parameters

string $key
mixed $value
int $count

Return Value

Redis|int|false

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

No description

Parameters

string $key
int $start
int $end

Return Value

Redis|bool

static Redis|array|false mget(array $keys)

No description

Parameters

array $keys

Return Value

Redis|array|false

static Redis|bool 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|bool

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

No description

Parameters

string $key
int $index

Return Value

Redis|bool

static Redis|bool mset(array $key_values)

No description

Parameters

array $key_values

Return Value

Redis|bool

static Redis|bool msetnx(array $key_values)

No description

Parameters

array $key_values

Return Value

Redis|bool

static Redis|bool multi(int $value = 1)

No description

Parameters

int $value

Return Value

Redis|bool

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

No description

Parameters

string $subcommand
string $key

Return Value

Redis|string|int|false

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

No description

Parameters

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

Return Value

bool

static Redis|bool persist(string $key)

No description

Parameters

string $key

Return Value

Redis|bool

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

No description

Parameters

string $key
int $timeout
string|null $mode

Return Value

bool

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

No description

Parameters

string $key
int $timestamp
string|null $mode

Return Value

Redis|bool

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

No description

Parameters

string $key
array $elements

Return Value

Redis|int

static Redis|int|false pfcount(array|string $key_or_keys)

No description

Parameters

array|string $key_or_keys

Return Value

Redis|int|false

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

No description

Parameters

string $dst
array $srckeys

Return Value

Redis|bool

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

No description

Parameters

string|null $message

Return Value

Redis|string|bool

static Redis|bool pipeline()

No description

Return Value

Redis|bool

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

No description

Parameters

string $key
int $expire
mixed $value

Return Value

Redis|bool

static Redis|int|false pttl(string $key)

No description

Parameters

string $key

Return Value

Redis|int|false

static Redis|int|false publish(string $channel, string $message)

No description

Parameters

string $channel
string $message

Return Value

Redis|int|false

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

No description

Parameters

string $command
mixed $arg

Return Value

mixed

static Redis|array|bool punsubscribe(array $patterns)

No description

Parameters

array $patterns

Return Value

Redis|array|bool

static Redis|array|string|bool rPop(string $key, int $count)

No description

Parameters

string $key
int $count

Return Value

Redis|array|string|bool

static Redis|string|false randomKey()

No description

Return Value

Redis|string|false

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

No description

Parameters

string $command
mixed $args

Return Value

mixed

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

No description

Parameters

string $old_name
string $new_name

Return Value

Redis|bool

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

No description

Parameters

string $key_src
string $key_dst

Return Value

Redis|bool

static Redis|bool reset()

No description

Return Value

Redis|bool

static Redis|bool 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|bool

static mixed role()

No description

Return Value

mixed

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

No description

Parameters

string $srckey
string $dstkey

Return Value

Redis|string|false

static Redis|int|false sAdd(string $key, mixed $value, mixed $other_values)

No description

Parameters

string $key
mixed $value
mixed $other_values

Return Value

Redis|int|false

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

No description

Parameters

string $key
array $values

Return Value

int

static Redis|array|false sDiff(string $key, string $other_keys)

No description

Parameters

string $key
string $other_keys

Return Value

Redis|array|false

static Redis|int|false sDiffStore(string $dst, string $key, string $other_keys)

No description

Parameters

string $dst
string $key
string $other_keys

Return Value

Redis|int|false

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

No description

Parameters

array|string $key
string $other_keys

Return Value

Redis|array|false

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

No description

Parameters

array $keys
int $limit

Return Value

Redis|int|false

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

No description

Parameters

array|string $key
string $other_keys

Return Value

Redis|int|false

static Redis|array|false sMembers(string $key)

No description

Parameters

string $key

Return Value

Redis|array|false

static Redis|array|false sMisMember(string $key, string $member, string $other_members)

No description

Parameters

string $key
string $member
string $other_members

Return Value

Redis|array|false

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

No description

Parameters

string $src
string $dst
mixed $value

Return Value

Redis|bool

static Redis|array|string|false sPop(string $key, int $count)

No description

Parameters

string $key
int $count

Return Value

Redis|array|string|false

static mixed sRandMember(string $key, int $count)

No description

Parameters

string $key
int $count

Return Value

mixed

static Redis|array|false sUnion(string $key, string $other_keys)

No description

Parameters

string $key
string $other_keys

Return Value

Redis|array|false

static Redis|int|false sUnionStore(string $dst, string $key, string $other_keys)

No description

Parameters

string $dst
string $key
string $other_keys

Return Value

Redis|int|false

static Redis|bool save()

No description

Return Value

Redis|bool

static array|false scan(string|int|null $iterator, string|null $pattern = null, int $count, string|null $type = null)

No description

Parameters

string|int|null $iterator
string|null $pattern
int $count
string|null $type

Return Value

array|false

static Redis|int|false scard(string $key)

No description

Parameters

string $key

Return Value

Redis|int|false

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

No description

Parameters

string $command
mixed $args

Return Value

mixed

static Redis|bool select(int $db)

No description

Parameters

int $db

Return Value

Redis|bool

static Redis|string|bool set(string $key, mixed $value, mixed $options = null)

No description

Parameters

string $key
mixed $value
mixed $options

Return Value

Redis|string|bool

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

No description

Parameters

string $key
int $idx
bool $value

Return Value

Redis|int|false

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

No description

Parameters

string $key
int $index
string $value

Return Value

Redis|int|false

static bool setOption(int $option, mixed $value)

No description

Parameters

int $option
mixed $value

Return Value

bool

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

No description

Parameters

string $key
int $expire
mixed $value

Return Value

void

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

No description

Parameters

string $key
mixed $value

Return Value

Redis|bool

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

No description

Parameters

string $key
mixed $value

Return Value

Redis|bool

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

No description

Parameters

string|null $host
int $port

Return Value

Redis|bool

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

No description

Parameters

array|string $key_or_array
string $more_keys

Return Value

Redis|int|false

static mixed slowlog(string $operation, int $length)

No description

Parameters

string $operation
int $length

Return Value

mixed

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

No description

Parameters

string $key
array|null $options

Return Value

mixed

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

No description

Parameters

string $key
array|null $options

Return Value

mixed

static Redis|int|false srem(string $key, mixed $value, mixed $other_values)

No description

Parameters

string $key
mixed $value
mixed $other_values

Return Value

Redis|int|false

static array|false sscan(string $key, string|int|null $iterator, string|null $pattern = null, int $count)

No description

Parameters

string $key
string|int|null $iterator
string|null $pattern
int $count

Return Value

array|false

static bool ssubscribe(array $channels, callable $cb)

No description

Parameters

array $channels
callable $cb

Return Value

bool

static Redis|int|false strlen(string $key)

No description

Parameters

string $key

Return Value

Redis|int|false

static Redis|array|bool sunsubscribe(array $channels)

No description

Parameters

array $channels

Return Value

Redis|array|bool

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

No description

Parameters

int $src
int $dst

Return Value

Redis|bool

static Redis|array time()

No description

Return Value

Redis|array

static Redis|int|false ttl(string $key)

No description

Parameters

string $key

Return Value

Redis|int|false

static Redis|int|false type(string $key)

No description

Parameters

string $key

Return Value

Redis|int|false

No description

Parameters

array|string $key
string $other_keys

Return Value

Redis|int|false

static Redis|array|bool unsubscribe(array $channels)

No description

Parameters

array $channels

Return Value

Redis|array|bool

static Redis|bool unwatch()

No description

Return Value

Redis|bool

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

No description

Parameters

array|string $key
string $other_keys

Return Value

Redis|bool

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

No description

Parameters

int $numreplicas
int $timeout

Return Value

int|false

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

No description

Parameters

string $key
string $group
array $ids

Return Value

int|false

static Redis|string|false xadd(string $key, string $id, array $values, int $maxlen, 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|false

static Redis|array|bool 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|array|bool

static Redis|array|bool 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|array|bool

static Redis|int|false xdel(string $key, array $ids)

No description

Parameters

string $key
array $ids

Return Value

Redis|int|false

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

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

static Redis|int|false xlen(string $key)

No description

Parameters

string $key

Return Value

Redis|int|false

static Redis|array|false 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|array|false

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

No description

Parameters

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

Return Value

Redis|array|bool

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

No description

Parameters

array $streams
int $count
int $block

Return Value

Redis|array|bool

static Redis|array|bool 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|array|bool

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

No description

Parameters

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

Return Value

Redis|array|bool

static Redis|int|false 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|int|false

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

No description

Parameters

string $key
mixed $member
array|null $options

Return Value

Redis|array|false

static Redis|int|false vcard(string $key)

No description

Parameters

string $key

Return Value

Redis|int|false

static Redis|int|false vdim(string $key)

No description

Parameters

string $key

Return Value

Redis|int|false

static Redis|array|false vinfo(string $key)

No description

Parameters

string $key

Return Value

Redis|array|false

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

No description

Parameters

string $key
mixed $member

Return Value

Redis|bool

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

No description

Parameters

string $key
mixed $member
bool $raw

Return Value

Redis|array|false

static Redis|array|string|false vrandmember(string $key, int $count)

No description

Parameters

string $key
int $count

Return Value

Redis|array|string|false

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

No description

Parameters

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

Return Value

Redis|array|false

static Redis|int|false vrem(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

Redis|int|false

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

No description

Parameters

string $key
mixed $member
array|string $attributes

Return Value

Redis|int|false

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

No description

Parameters

string $key
mixed $member
bool $decode

Return Value

Redis|array|string|false

No description

Parameters

string $key
mixed $member
bool $withscores

Return Value

Redis|array|false

static Redis|int|false 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|int|false

static Redis|int|float|false zAdd(string $key, array|float $score_or_options, mixed $more_scores_and_mems)

No description

Parameters

string $key
array|float $score_or_options
mixed $more_scores_and_mems

Return Value

Redis|int|float|false

static Redis|int|false zCard(string $key)

No description

Parameters

string $key

Return Value

Redis|int|false

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

No description

Parameters

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

Return Value

Redis|int|false

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

No description

Parameters

string $key
float $value
mixed $member

Return Value

Redis|float|false

static Redis|int|false zLexCount(string $key, string $min, string $max)

No description

Parameters

string $key
string $min
string $max

Return Value

Redis|int|false

static Redis|array|false zMscore(string $key, mixed $member, mixed $other_members)

No description

Parameters

string $key
mixed $member
mixed $other_members

Return Value

Redis|array|false

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

No description

Parameters

string $key
int|null $count

Return Value

Redis|array|false

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

No description

Parameters

string $key
int|null $count

Return Value

Redis|array|false

static Redis|array|false 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|array|false

static Redis|array|false 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|array|false

static Redis|array|false zRangeByScore(string $key, string $start, string $end, array $options = [])

No description

Parameters

string $key
string $start
string $end
array $options

Return Value

Redis|array|false

static Redis|int|false 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|int|false

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

No description

Parameters

string $key
array|null $options

Return Value

Redis|array|string

static Redis|int|false zRank(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

Redis|int|false

static Redis|int|false zRem(mixed $key, mixed $member, mixed $other_members)

No description

Parameters

mixed $key
mixed $member
mixed $other_members

Return Value

Redis|int|false

static Redis|int|false zRemRangeByLex(string $key, string $min, string $max)

No description

Parameters

string $key
string $min
string $max

Return Value

Redis|int|false

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

No description

Parameters

string $key
int $start
int $end

Return Value

Redis|int|false

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

No description

Parameters

string $key
string $start
string $end

Return Value

Redis|int|false

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

No description

Parameters

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

Return Value

Redis|array|false

static Redis|array|false 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|array|false

static Redis|array|false zRevRangeByScore(string $key, string $max, string $min, array|bool $options = [])

No description

Parameters

string $key
string $max
string $min
array|bool $options

Return Value

Redis|array|false

static Redis|int|false zRevRank(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

Redis|int|false

static Redis|float|false zScore(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

Redis|float|false

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

No description

Parameters

array $keys
array|null $options

Return Value

Redis|array|false

static Redis|int|false zdiffstore(string $dst, array $keys)

No description

Parameters

string $dst
array $keys

Return Value

Redis|int|false

static Redis|array|false 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|array|false

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

No description

Parameters

array $keys
int $limit

Return Value

Redis|int|false

static Redis|int|false zinterstore(string $dst, array $keys, array|null $weights = null, string|null $aggregate = null)

No description

Parameters

string $dst
array $keys
array|null $weights
string|null $aggregate

Return Value

Redis|int|false

static Redis|array|false zscan(string $key, string|int|null $iterator, string|null $pattern = null, int $count)

No description

Parameters

string $key
string|int|null $iterator
string|null $pattern
int $count

Return Value

Redis|array|false

static Redis|array|false 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|array|false

static Redis|int|false zunionstore(string $dst, array $keys, array|null $weights = null, string|null $aggregate = null)

No description

Parameters

string $dst
array $keys
array|null $weights
string|null $aggregate

Return Value

Redis|int|false