Documentation

PhpRedisConnector
in package

Table of Contents

connect()  : PhpRedisConnection
Create a new clustered PhpRedis connection.
connectToCluster()  : PhpRedisClusterConnection
Create a new clustered PhpRedis connection.
buildClusterConnectionString()  : string
Build a single cluster seed string from array.
createClient()  : Redis
Create the Redis client instance.
createRedisClusterInstance()  : RedisCluster
Create a new redis cluster instance.
establishConnection()  : void
Establish a connection with the Redis host.

Methods

connect()

Create a new clustered PhpRedis connection.

public connect(array<string|int, mixed> $config, array<string|int, mixed> $options) : PhpRedisConnection
Parameters
$config : array<string|int, mixed>
$options : array<string|int, mixed>
Return values
PhpRedisConnection —

connectToCluster()

Create a new clustered PhpRedis connection.

public connectToCluster(array<string|int, mixed> $config, array<string|int, mixed> $clusterOptions, array<string|int, mixed> $options) : PhpRedisClusterConnection
Parameters
$config : array<string|int, mixed>
$clusterOptions : array<string|int, mixed>
$options : array<string|int, mixed>
Return values
PhpRedisClusterConnection —

buildClusterConnectionString()

Build a single cluster seed string from array.

protected buildClusterConnectionString(array<string|int, mixed> $server) : string
Parameters
$server : array<string|int, mixed>
Return values
string —

createClient()

Create the Redis client instance.

protected createClient(array<string|int, mixed> $config) : Redis
Parameters
$config : array<string|int, mixed>
Return values
Redis —

createRedisClusterInstance()

Create a new redis cluster instance.

protected createRedisClusterInstance(array<string|int, mixed> $servers, array<string|int, mixed> $options) : RedisCluster
Parameters
$servers : array<string|int, mixed>
$options : array<string|int, mixed>
Return values
RedisCluster —

establishConnection()

Establish a connection with the Redis host.

protected establishConnection(Redis $client, array<string|int, mixed> $config) : void
Parameters
$client : Redis
$config : array<string|int, mixed>
Return values
void —

Search results