1. class
  2. mako
  3. \
  4. redis
  5. \
  6. Redis

Redis

class Redis

Redis client.

Constants

CRLF

Command terminator.
CRLF_LENGTH

Command terminator length.

Properties

protected string $password Redis password.
protected int $database Redis database.
protected bool $pipelined Is pipelining enabled?
protected array $commands Pipelined commands.
protected Connection $connection Redis connection.
protected array $clusterClients Cluster clients.
protected string $lastCommand Last command.

Methods

__construct(Connection $connection, array $options = [])

Constructor.

Connection
getConnection()

Returns the connection.

array
getClusterClients()

Returns the cluster clients.

Redis
createClusterClient(string $server)

Creates a cluster client.

Redis
getClusterClient(string $serverInfo)

Gets a cluster client.

mixed
handleErrorResponse(string $response)

Handles redis error responses.

string
handleStatusResponse(string $response)

Handles a status response.

int
handleIntegerResponse(string $response)

Handles a integer response.

string|null
handleBulkResponse(string $response)

Handles a bulk response.

array|null
handleMultiBulkResponse(string $response)

Handles a multi-bulk response.

mixed
getResponse()

Returns response from redis server.

array
buildCommand(string $name, array $arguments = [])

Builds command.

sendCommand(string $command)

Sends command to server.

mixed
sendCommandAndGetResponse(string $command)

Executes raw Redis commands and returns the response.

subscribe(array $channels, Closure $subscriber, array $accept, string $subscribe, string $unsubscribe)

Subscribes to the chosen channels.

subscribeTo(array $channels, Closure $subscriber, array $accept = ['message'])

Subscribes to the chosen channels.

subscribeToPattern(array $channels, Closure $subscriber, array $accept = ['pmessage'])

Subscribes to the chosen channels.

monitor(Closure $monitor)

Monitors the redis server.

array
pipeline(Closure $pipeline)

Pipeline commands.

mixed
__call(string $name, array $arguments)

Sends command to Redis server and returns response or appends command to the pipeline and returns the client.

mixed
append()

No description

mixed
auth()

No description

mixed
bgrewriteaof()

No description

mixed
bgsave()

No description

mixed
bitcount()

No description

mixed
bitfield()

No description

mixed
bitop()

No description

mixed
bitpos()

No description

mixed
blpop()

No description

mixed
brpop()

No description

mixed
brpoplpush()

No description

mixed
bzpopmin()

No description

mixed
bzpopmax()

No description

mixed
clientId()

No description

mixed
clientKill()

No description

mixed
clientList()

No description

mixed
clientGetname()

No description

mixed
clientPause()

No description

mixed
clientReply()

No description

mixed
clientSetname()

No description

mixed
clientUnblock()

No description

mixed
clusterAddslots()

No description

mixed
clusterCountFailureReports()

No description

mixed
clusterCountkeysinslot()

No description

mixed
clusterDelslots()

No description

mixed
clusterFailover()

No description

mixed
clusterForget()

No description

mixed
clusterGetkeysinslot()

No description

mixed
clusterInfo()

No description

mixed
clusterKeyslot()

No description

mixed
clusterMeet()

No description

mixed
clusterNodes()

No description

mixed
clusterReplicate()

No description

mixed
clusterReset()

No description

mixed
clusterSaveconfig()

No description

mixed
clusterSetConfigEpoch()

No description

mixed
clusterSetslot()

No description

mixed
clusterSlaves()

No description

mixed
clusterReplicas()

No description

mixed
clusterSlots()

No description

mixed
command()

No description

mixed
commandCount()

No description

mixed
commandGetkeys()

No description

mixed
commandInfo()

No description

mixed
configGet()

No description

mixed
configRewrite()

No description

mixed
configSet()

No description

mixed
configResetstat()

No description

mixed
dbsize()

No description

mixed
debugObject()

No description

mixed
debugSegfault()

No description

mixed
decr()

No description

mixed
decrby()

No description

mixed
del()

No description

mixed
discard()

No description

mixed
dump()

No description

mixed
echo()

No description

mixed
eval()

No description

mixed
evalsha()

No description

mixed
exec()

No description

mixed
exists()

No description

mixed
expire()

No description

mixed
expireat()

No description

mixed
flushall()

No description

mixed
flushdb()

No description

mixed
geoadd()

No description

mixed
geohash()

No description

mixed
geopos()

No description

mixed
geodist()

No description

mixed
georadius()

No description

mixed
georadiusbymember()

No description

mixed
get()

No description

mixed
getbit()

No description

mixed
getrange()

No description

mixed
getset()

No description

mixed
hdel()

No description

mixed
hexists()

No description

mixed
hget()

No description

mixed
hgetall()

No description

mixed
hincrby()

No description

mixed
hincrbyfloat()

No description

mixed
hkeys()

No description

mixed
hlen()

No description

mixed
hmget()

No description

mixed
hmset()

No description

mixed
hset()

No description

mixed
hsetnx()

No description

mixed
hstrlen()

No description

mixed
hvals()

No description

mixed
incr()

No description

mixed
incrby()

No description

mixed
incrbyfloat()

No description

mixed
info()

No description

mixed
keys()

No description

mixed
lastsave()

No description

mixed
lindex()

No description

mixed
linsert()

No description

mixed
llen()

No description

mixed
lpop()

No description

mixed
lpush()

No description

mixed
lpushx()

No description

mixed
lrange()

No description

mixed
lrem()

No description

mixed
lset()

No description

mixed
ltrim()

No description

mixed
memoryDoctor()

No description

mixed
memoryHelp()

No description

mixed
memoryMallocStats()

No description

mixed
memoryPurge()

No description

mixed
memoryStats()

No description

mixed
memoryUsage()

No description

mixed
mget()

No description

mixed
migrate()

No description

mixed
move()

No description

mixed
mset()

No description

mixed
msetnx()

No description

mixed
multi()

No description

mixed
object()

No description

mixed
persist()

No description

mixed
pexpire()

No description

mixed
pexpireat()

No description

mixed
pfadd()

No description

mixed
pfcount()

No description

mixed
pfmerge()

No description

mixed
ping()

No description

mixed
psetex()

No description

mixed
pubsub()

No description

mixed
pttl()

No description

mixed
publish()

No description

mixed
quit()

No description

mixed
randomkey()

No description

mixed
readonly()

No description

mixed
readwrite()

No description

mixed
rename()

No description

mixed
renamenx()

No description

mixed
restore()

No description

mixed
role()

No description

mixed
rpop()

No description

mixed
rpoplpush()

No description

mixed
rpush()

No description

mixed
rpushx()

No description

mixed
sadd()

No description

mixed
save()

No description

mixed
scard()

No description

mixed
scriptDebug()

No description

mixed
scriptExists()

No description

mixed
scriptFlush()

No description

mixed
scriptKill()

No description

mixed
scriptLoad()

No description

mixed
sdiff()

No description

mixed
sdiffstore()

No description

mixed
select()

No description

mixed
set()

No description

mixed
setbit()

No description

mixed
setex()

No description

mixed
setnx()

No description

mixed
setrange()

No description

mixed
shutdown()

No description

mixed
sinter()

No description

mixed
sinterstore()

No description

mixed
sismember()

No description

mixed
slaveof()

No description

mixed
replicaof()

No description

mixed
slowlog()

No description

mixed
smembers()

No description

mixed
smove()

No description

mixed
sort()

No description

mixed
spop()

No description

mixed
srandmember()

No description

mixed
srem()

No description

mixed
strlen()

No description

mixed
sunion()

No description

mixed
sunionstore()

No description

mixed
swapdb()

No description

mixed
sync()

No description

mixed
time()

No description

mixed
touch()

No description

mixed
ttl()

No description

mixed
type()

No description

mixed
unlink()

No description

mixed
unwatch()

No description

mixed
wait()

No description

mixed
watch()

No description

mixed
zadd()

No description

mixed
zcard()

No description

mixed
zcount()

No description

mixed
zincrby()

No description

mixed
zinterstore()

No description

mixed
zlexcount()

No description

mixed
zpopmax()

No description

mixed
zpopmin()

No description

mixed
zrange()

No description

mixed
zrangebylex()

No description

mixed
zrevrangebylex()

No description

mixed
zrangebyscore()

No description

mixed
zrank()

No description

mixed
zrem()

No description

mixed
zremrangebylex()

No description

mixed
zremrangebyrank()

No description

mixed
zremrangebyscore()

No description

mixed
zrevrange()

No description

mixed
zrevrangebyscore()

No description

mixed
zrevrank()

No description

mixed
zscore()

No description

mixed
zunionstore()

No description

mixed
scan()

No description

mixed
sscan()

No description

mixed
hscan()

No description

mixed
zscan()

No description

mixed
xinfo()

No description

mixed
xadd()

No description

mixed
xtrim()

No description

mixed
xdel()

No description

mixed
xrange()

No description

mixed
xrevrange()

No description

mixed
xlen()

No description

mixed
xread()

No description

mixed
xgroup()

No description

mixed
xreadgroup()

No description

mixed
xack()

No description

mixed
xclaim()

No description

mixed
xpending()

No description

Details

at line 327
__construct(Connection $connection, array $options = [])

Constructor.

Parameters

Connection $connection Redis connection
array $options Options

at line 347
Connection getConnection()

Returns the connection.

Return Value

Connection

at line 357
array getClusterClients()

Returns the cluster clients.

Return Value

array

at line 368
protected Redis createClusterClient(string $server)

Creates a cluster client.

Parameters

string $server Server string

Return Value

Redis

at line 383
protected Redis getClusterClient(string $serverInfo)

Gets a cluster client.

Parameters

string $serverInfo Cluster slot and server string

Return Value

Redis

at line 401
protected mixed handleErrorResponse(string $response)

Handles redis error responses.

Parameters

string $response Error response

Return Value

mixed

at line 423
protected string handleStatusResponse(string $response)

Handles a status response.

Parameters

string $response Redis response

Return Value

string

at line 434
protected int handleIntegerResponse(string $response)

Handles a integer response.

Parameters

string $response Redis response

Return Value

int

at line 445
protected string|null handleBulkResponse(string $response)

Handles a bulk response.

Parameters

string $response Redis response

Return Value

string|null

at line 463
protected array|null handleMultiBulkResponse(string $response)

Handles a multi-bulk response.

Parameters

string $response Redis response

Return Value

array|null

at line 487
protected mixed getResponse()

Returns response from redis server.

Return Value

mixed

at line 515
protected array buildCommand(string $name, array $arguments = [])

Builds command.

Parameters

string $name Camel cased or snake cased command name
array $arguments Command arguments

Return Value

array

at line 550
protected sendCommand(string $command)

Sends command to server.

Parameters

string $command Command

at line 563
protected mixed sendCommandAndGetResponse(string $command)

Executes raw Redis commands and returns the response.

Parameters

string $command Command

Return Value

mixed

at line 579
protected subscribe(array $channels, Closure $subscriber, array $accept, string $subscribe, string $unsubscribe)

Subscribes to the chosen channels.

Parameters

array $channels Channels
Closure $subscriber Subscriber
array $accept Message types to accept
string $subscribe Subscribe command
string $unsubscribe Unsubscribe command

at line 608
subscribeTo(array $channels, Closure $subscriber, array $accept = ['message'])

Subscribes to the chosen channels.

Parameters

array $channels Channels
Closure $subscriber Subscriber
array $accept Message types to accept

at line 620
subscribeToPattern(array $channels, Closure $subscriber, array $accept = ['pmessage'])

Subscribes to the chosen channels.

Parameters

array $channels Channels
Closure $subscriber Subscriber
array $accept Message types to accept

at line 630
monitor(Closure $monitor)

Monitors the redis server.

Parameters

Closure $monitor Monitor closure

at line 651
array pipeline(Closure $pipeline)

Pipeline commands.

Parameters

Closure $pipeline Pipelined commands

Return Value

array

at line 693
mixed __call(string $name, array $arguments)

Sends command to Redis server and returns response or appends command to the pipeline and returns the client.

Parameters

string $name Method name
array $arguments Method arguments

Return Value

mixed

at line 256
mixed append()

Return Value

mixed

at line 256
mixed auth()

Return Value

mixed

at line 256
mixed bgrewriteaof()

Return Value

mixed

at line 256
mixed bgsave()

Return Value

mixed

at line 256
mixed bitcount()

Return Value

mixed

at line 256
mixed bitfield()

Return Value

mixed

at line 256
mixed bitop()

Return Value

mixed

at line 256
mixed bitpos()

Return Value

mixed

at line 256
mixed blpop()

Return Value

mixed

at line 256
mixed brpop()

Return Value

mixed

at line 256
mixed brpoplpush()

Return Value

mixed

at line 256
mixed bzpopmin()

Return Value

mixed

at line 256
mixed bzpopmax()

Return Value

mixed

at line 256
mixed clientId()

Return Value

mixed

at line 256
mixed clientKill()

Return Value

mixed

at line 256
mixed clientList()

Return Value

mixed

at line 256
mixed clientGetname()

Return Value

mixed

at line 256
mixed clientPause()

Return Value

mixed

at line 256
mixed clientReply()

Return Value

mixed

at line 256
mixed clientSetname()

Return Value

mixed

at line 256
mixed clientUnblock()

Return Value

mixed

at line 256
mixed clusterAddslots()

Return Value

mixed

at line 256
mixed clusterCountFailureReports()

Return Value

mixed

at line 256
mixed clusterCountkeysinslot()

Return Value

mixed

at line 256
mixed clusterDelslots()

Return Value

mixed

at line 256
mixed clusterFailover()

Return Value

mixed

at line 256
mixed clusterForget()

Return Value

mixed

at line 256
mixed clusterGetkeysinslot()

Return Value

mixed

at line 256
mixed clusterInfo()

Return Value

mixed

at line 256
mixed clusterKeyslot()

Return Value

mixed

at line 256
mixed clusterMeet()

Return Value

mixed

at line 256
mixed clusterNodes()

Return Value

mixed

at line 256
mixed clusterReplicate()

Return Value

mixed

at line 256
mixed clusterReset()

Return Value

mixed

at line 256
mixed clusterSaveconfig()

Return Value

mixed

at line 256
mixed clusterSetConfigEpoch()

Return Value

mixed

at line 256
mixed clusterSetslot()

Return Value

mixed

at line 256
mixed clusterSlaves()

Return Value

mixed

at line 256
mixed clusterReplicas()

Return Value

mixed

at line 256
mixed clusterSlots()

Return Value

mixed

at line 256
mixed command()

Return Value

mixed

at line 256
mixed commandCount()

Return Value

mixed

at line 256
mixed commandGetkeys()

Return Value

mixed

at line 256
mixed commandInfo()

Return Value

mixed

at line 256
mixed configGet()

Return Value

mixed

at line 256
mixed configRewrite()

Return Value

mixed

at line 256
mixed configSet()

Return Value

mixed

at line 256
mixed configResetstat()

Return Value

mixed

at line 256
mixed dbsize()

Return Value

mixed

at line 256
mixed debugObject()

Return Value

mixed

at line 256
mixed debugSegfault()

Return Value

mixed

at line 256
mixed decr()

Return Value

mixed

at line 256
mixed decrby()

Return Value

mixed

at line 256
mixed del()

Return Value

mixed

at line 256
mixed discard()

Return Value

mixed

at line 256
mixed dump()

Return Value

mixed

at line 256
mixed echo()

Return Value

mixed

at line 256
mixed eval()

Return Value

mixed

at line 256
mixed evalsha()

Return Value

mixed

at line 256
mixed exec()

Return Value

mixed

at line 256
mixed exists()

Return Value

mixed

at line 256
mixed expire()

Return Value

mixed

at line 256
mixed expireat()

Return Value

mixed

at line 256
mixed flushall()

Return Value

mixed

at line 256
mixed flushdb()

Return Value

mixed

at line 256
mixed geoadd()

Return Value

mixed

at line 256
mixed geohash()

Return Value

mixed

at line 256
mixed geopos()

Return Value

mixed

at line 256
mixed geodist()

Return Value

mixed

at line 256
mixed georadius()

Return Value

mixed

at line 256
mixed georadiusbymember()

Return Value

mixed

at line 256
mixed get()

Return Value

mixed

at line 256
mixed getbit()

Return Value

mixed

at line 256
mixed getrange()

Return Value

mixed

at line 256
mixed getset()

Return Value

mixed

at line 256
mixed hdel()

Return Value

mixed

at line 256
mixed hexists()

Return Value

mixed

at line 256
mixed hget()

Return Value

mixed

at line 256
mixed hgetall()

Return Value

mixed

at line 256
mixed hincrby()

Return Value

mixed

at line 256
mixed hincrbyfloat()

Return Value

mixed

at line 256
mixed hkeys()

Return Value

mixed

at line 256
mixed hlen()

Return Value

mixed

at line 256
mixed hmget()

Return Value

mixed

at line 256
mixed hmset()

Return Value

mixed

at line 256
mixed hset()

Return Value

mixed

at line 256
mixed hsetnx()

Return Value

mixed

at line 256
mixed hstrlen()

Return Value

mixed

at line 256
mixed hvals()

Return Value

mixed

at line 256
mixed incr()

Return Value

mixed

at line 256
mixed incrby()

Return Value

mixed

at line 256
mixed incrbyfloat()

Return Value

mixed

at line 256
mixed info()

Return Value

mixed

at line 256
mixed keys()

Return Value

mixed

at line 256
mixed lastsave()

Return Value

mixed

at line 256
mixed lindex()

Return Value

mixed

at line 256
mixed linsert()

Return Value

mixed

at line 256
mixed llen()

Return Value

mixed

at line 256
mixed lpop()

Return Value

mixed

at line 256
mixed lpush()

Return Value

mixed

at line 256
mixed lpushx()

Return Value

mixed

at line 256
mixed lrange()

Return Value

mixed

at line 256
mixed lrem()

Return Value

mixed

at line 256
mixed lset()

Return Value

mixed

at line 256
mixed ltrim()

Return Value

mixed

at line 256
mixed memoryDoctor()

Return Value

mixed

at line 256
mixed memoryHelp()

Return Value

mixed

at line 256
mixed memoryMallocStats()

Return Value

mixed

at line 256
mixed memoryPurge()

Return Value

mixed

at line 256
mixed memoryStats()

Return Value

mixed

at line 256
mixed memoryUsage()

Return Value

mixed

at line 256
mixed mget()

Return Value

mixed

at line 256
mixed migrate()

Return Value

mixed

at line 256
mixed move()

Return Value

mixed

at line 256
mixed mset()

Return Value

mixed

at line 256
mixed msetnx()

Return Value

mixed

at line 256
mixed multi()

Return Value

mixed

at line 256
mixed object()

Return Value

mixed

at line 256
mixed persist()

Return Value

mixed

at line 256
mixed pexpire()

Return Value

mixed

at line 256
mixed pexpireat()

Return Value

mixed

at line 256
mixed pfadd()

Return Value

mixed

at line 256
mixed pfcount()

Return Value

mixed

at line 256
mixed pfmerge()

Return Value

mixed

at line 256
mixed ping()

Return Value

mixed

at line 256
mixed psetex()

Return Value

mixed

at line 256
mixed pubsub()

Return Value

mixed

at line 256
mixed pttl()

Return Value

mixed

at line 256
mixed publish()

Return Value

mixed

at line 256
mixed quit()

Return Value

mixed

at line 256
mixed randomkey()

Return Value

mixed

at line 256
mixed readonly()

Return Value

mixed

at line 256
mixed readwrite()

Return Value

mixed

at line 256
mixed rename()

Return Value

mixed

at line 256
mixed renamenx()

Return Value

mixed

at line 256
mixed restore()

Return Value

mixed

at line 256
mixed role()

Return Value

mixed

at line 256
mixed rpop()

Return Value

mixed

at line 256
mixed rpoplpush()

Return Value

mixed

at line 256
mixed rpush()

Return Value

mixed

at line 256
mixed rpushx()

Return Value

mixed

at line 256
mixed sadd()

Return Value

mixed

at line 256
mixed save()

Return Value

mixed

at line 256
mixed scard()

Return Value

mixed

at line 256
mixed scriptDebug()

Return Value

mixed

at line 256
mixed scriptExists()

Return Value

mixed

at line 256
mixed scriptFlush()

Return Value

mixed

at line 256
mixed scriptKill()

Return Value

mixed

at line 256
mixed scriptLoad()

Return Value

mixed

at line 256
mixed sdiff()

Return Value

mixed

at line 256
mixed sdiffstore()

Return Value

mixed

at line 256
mixed select()

Return Value

mixed

at line 256
mixed set()

Return Value

mixed

at line 256
mixed setbit()

Return Value

mixed

at line 256
mixed setex()

Return Value

mixed

at line 256
mixed setnx()

Return Value

mixed

at line 256
mixed setrange()

Return Value

mixed

at line 256
mixed shutdown()

Return Value

mixed

at line 256
mixed sinter()

Return Value

mixed

at line 256
mixed sinterstore()

Return Value

mixed

at line 256
mixed sismember()

Return Value

mixed

at line 256
mixed slaveof()

Return Value

mixed

at line 256
mixed replicaof()

Return Value

mixed

at line 256
mixed slowlog()

Return Value

mixed

at line 256
mixed smembers()

Return Value

mixed

at line 256
mixed smove()

Return Value

mixed

at line 256
mixed sort()

Return Value

mixed

at line 256
mixed spop()

Return Value

mixed

at line 256
mixed srandmember()

Return Value

mixed

at line 256
mixed srem()

Return Value

mixed

at line 256
mixed strlen()

Return Value

mixed

at line 256
mixed sunion()

Return Value

mixed

at line 256
mixed sunionstore()

Return Value

mixed

at line 256
mixed swapdb()

Return Value

mixed

at line 256
mixed sync()

Return Value

mixed

at line 256
mixed time()

Return Value

mixed

at line 256
mixed touch()

Return Value

mixed

at line 256
mixed ttl()

Return Value

mixed

at line 256
mixed type()

Return Value

mixed

Return Value

mixed

at line 256
mixed unwatch()

Return Value

mixed

at line 256
mixed wait()

Return Value

mixed

at line 256
mixed watch()

Return Value

mixed

at line 256
mixed zadd()

Return Value

mixed

at line 256
mixed zcard()

Return Value

mixed

at line 256
mixed zcount()

Return Value

mixed

at line 256
mixed zincrby()

Return Value

mixed

at line 256
mixed zinterstore()

Return Value

mixed

at line 256
mixed zlexcount()

Return Value

mixed

at line 256
mixed zpopmax()

Return Value

mixed

at line 256
mixed zpopmin()

Return Value

mixed

at line 256
mixed zrange()

Return Value

mixed

at line 256
mixed zrangebylex()

Return Value

mixed

at line 256
mixed zrevrangebylex()

Return Value

mixed

at line 256
mixed zrangebyscore()

Return Value

mixed

at line 256
mixed zrank()

Return Value

mixed

at line 256
mixed zrem()

Return Value

mixed

at line 256
mixed zremrangebylex()

Return Value

mixed

at line 256
mixed zremrangebyrank()

Return Value

mixed

at line 256
mixed zremrangebyscore()

Return Value

mixed

at line 256
mixed zrevrange()

Return Value

mixed

at line 256
mixed zrevrangebyscore()

Return Value

mixed

at line 256
mixed zrevrank()

Return Value

mixed

at line 256
mixed zscore()

Return Value

mixed

at line 256
mixed zunionstore()

Return Value

mixed

at line 256
mixed scan()

Return Value

mixed

at line 256
mixed sscan()

Return Value

mixed

at line 256
mixed hscan()

Return Value

mixed

at line 256
mixed zscan()

Return Value

mixed

at line 256
mixed xinfo()

Return Value

mixed

at line 256
mixed xadd()

Return Value

mixed

at line 256
mixed xtrim()

Return Value

mixed

at line 256
mixed xdel()

Return Value

mixed

at line 256
mixed xrange()

Return Value

mixed

at line 256
mixed xrevrange()

Return Value

mixed

at line 256
mixed xlen()

Return Value

mixed

at line 256
mixed xread()

Return Value

mixed

at line 256
mixed xgroup()

Return Value

mixed

at line 256
mixed xreadgroup()

Return Value

mixed

at line 256
mixed xack()

Return Value

mixed

at line 256
mixed xclaim()

Return Value

mixed

at line 256
mixed xpending()

Return Value

mixed