Redis

Redis socket-backed cache backend.

class Redis extends \Hazaar\Cache\Backend

Extends: Hazaar\Cache\Backend

Implements cache operations over the Redis RESP protocol using a low-level socket client. Values are stored under namespaced Redis keys and support optional TTL/keepalive behavior controlled by backend options.

This backend provides object storage support by serializing complex values into hash fields and reconstructing them on read.

Properties

weight

Backend priority weight used when selecting backends in a chain.

protected int $weight = 2

Type: int

config

Typed view of this backend's options.

private Redis\Options $config

Type: Hazaar\Cache\Backend\Redis\Options

socket

public Client $socket

Type: Hazaar\Socket\Client

buffer

Internal receive buffer for RESP decoding.

private string $buffer

Type: string

offset

Current offset into the receive buffer.

private int $offset

Type: int

delim

RESP line delimiter sequence.

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

Type: string

Methods

available

Indicates whether required socket support is available.

public available(): bool

Returns: bool

init

Initializes Redis connection, selects DB index, and configures capabilities.

public init(string $namespace): void

Returns: void

Parameters

Parameter	Type	Description
$namespace	string	active cache namespace

cmd

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

Returns: mixed

Parameters

Parameter	Type	Description
$cmds	array
$useMaster	bool

select

public select(int $db): bool

Returns: bool

Parameters

Parameter	Type	Description
$db	int

close

public close(): bool

Returns: bool

has

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

Returns: bool

Parameters

Parameter	Type	Description
$key	string
$checkEmpty	bool

get

public get(string $key): mixed

Returns: mixed

Parameters

Parameter	Type	Description
$key	string

set

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

Returns: bool

Parameters

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

remove

public remove(string $key): bool

Returns: bool

Parameters

Parameter	Type	Description
$key	string

clear

public clear(): bool

Returns: bool

toArray

public toArray(): array

Returns: array

count

public count(): int

Returns: int

connect

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

Returns: Hazaar\Socket\Client

Parameters

Parameter	Type	Description
$host	string
$port	int

getChunk

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

Returns: string

Parameters

Parameter	Type	Description
$socket	Hazaar\Socket\Client
$bytes	int

decode

Decodes a RESP data chunk.

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

Returns: mixed

Parameters

Parameter	Type	Description
$socket	Hazaar\Socket\Client
$chunk	string

encode

Encodes data into the RESP protocol.

private encode(mixed $data): array

Returns: array

Parameters

Parameter	Type	Description
$data	mixed	The data to encode

encodeValue

private encodeValue(mixed $value): string

Returns: string

Parameters

Parameter	Type	Description
$value	mixed

deconstructValue

Deconstructs a value into an array of keys and values.

private deconstructValue(mixed $value): array

Returns: array

Parameters

Parameter	Type	Description
$value	mixed	The value to deconstruct

reconstructValue

Reconstructs a value from an array of keys and values.

private reconstructValue(array $rawValues): mixed

Returns: mixed

Parameters

Parameter	Type	Description
$rawValues	array	The raw values to reconstruct

---

Generated by Hazaar API Doc Generator on Fri, 04 Sep 2026 23:32:16 +0000