Redis

The Redis cache backend.

This is a nice, reliable caching backend that allows for clustering using the Redis clustering feature.

Available config options:

• server - The redis server to connect to. Currently only a single server is supported. Default: localhost.
• port - The port to connect to the server on. Default: 6379

Properties

weight

protected int $weight = 2

role

private array $role

socket

public Client $socket

master

public Client $master

buffer

private string $buffer

offset

private int $offset

delim

private string $delim = '"\r\n"'

updateExpire

private bool $updateExpire

local

private array $local

garbage

private array $garbage

Methods

available

public available(): bool

init

public init(string $namespace): void

Parameters

Parameter	Type	Description
$namespace	string

cmd

public cmd(array $cmds, bool $useMaster = false): mixed

Parameters

Parameter	Type	Description
$cmds	array
$useMaster	bool

select

public select(int $db): bool

Parameters

Parameter	Type	Description
$db	int

close

public close(): bool

has

public has(string $key, bool $checkEmpty = false): bool

Parameters

Parameter	Type	Description
$key	string
$checkEmpty	bool

get

public get(string $key): mixed

Parameters

Parameter	Type	Description
$key	string

set

public set(string $key, mixed $value, int $timeout = 0): bool

Parameters

Parameter	Type	Description
$key	string
$value	mixed
$timeout	int

remove

public remove(string $key): bool

Parameters

Parameter	Type	Description
$key	string

clear

public clear(): bool

toArray

public toArray(): void

count

public count(): int

connect

private connect(string $host, int $port = 6379): Client

Parameters

Parameter	Type	Description
$host	string
$port	int

getChunk

private getChunk(Client $socket, ?int $bytes): string

Parameters

Parameter	Type	Description
$socket	Client
$bytes	int

decode

Decodes a RESP data chunk.

private decode(Client $socket, ?string $chunk): mixed

Parameters

Parameter	Type	Description
$socket	Client
$chunk	string

encode

Encodes data into the RESP protocol.

private encode(mixed $data): void

Parameters

Parameter	Type	Description
$data	mixed	The data to encode

keepalive

private keepalive(): void

---

Generated by Hazaar API Doc Generator