class PhpRedisConnector implements Connector (View source)

Methods

connect(array $config, array $options)

Create a new connection.

connectToCluster(array $config, array $clusterOptions, array $options)

Create a new clustered PhpRedis connection.

string
buildClusterConnectionString(array $server)

Build a single cluster seed string from an array.

Redis
createClient(array $config)

Create the Redis client instance.

void
establishConnection(Redis $client, array $config)

Establish a connection with the Redis host.

RedisCluster
createRedisClusterInstance(array $servers, array $options)

Create a new redis cluster instance.

string
formatHost(array $options)

Format the host using the scheme if available.

array
normalizeContext(array $context)

Normalize the SSL context for a single Redis connection.

array
normalizeClusterContext(array $context)

Normalize the SSL context for a RedisCluster connection.

string|array|null
formatClusterPassword(array $options)

Format the password for a Redis cluster connection.

int
parseBackoffAlgorithm(mixed $algorithm)

Parse a "friendly" backoff algorithm name into an integer.

Details

Connection connect(array $config, array $options)

Create a new connection.

Parameters

array $config
array $options

Return Value

Connection

Connection connectToCluster(array $config, array $clusterOptions, array $options)

Create a new clustered PhpRedis connection.

Parameters

array $config
array $clusterOptions
array $options

Return Value

Connection

protected string buildClusterConnectionString(array $server)

Build a single cluster seed string from an array.

Parameters

array $server

Return Value

string

protected Redis createClient(array $config)

Create the Redis client instance.

Parameters

array $config

Return Value

Redis

Exceptions

LogicException

protected void establishConnection(Redis $client, array $config)

Establish a connection with the Redis host.

Parameters

Redis $client
array $config

Return Value

void

protected RedisCluster createRedisClusterInstance(array $servers, array $options)

Create a new redis cluster instance.

Parameters

array $servers
array $options

Return Value

RedisCluster

protected string formatHost(array $options)

Format the host using the scheme if available.

Parameters

array $options

Return Value

string

protected array normalizeContext(array $context)

Normalize the SSL context for a single Redis connection.

Redis::connect() expects the context as ['stream' => ['verify_peer' => false, ...]].

Parameters

array $context

Return Value

array

protected array normalizeClusterContext(array $context)

Normalize the SSL context for a RedisCluster connection.

RedisCluster::__construct() expects a flat context ['verify_peer' => false, ...].

Parameters

array $context

Return Value

array

protected string|array|null formatClusterPassword(array $options)

Format the password for a Redis cluster connection.

Parameters

array $options

Return Value

string|array|null

protected int parseBackoffAlgorithm(mixed $algorithm)

Parse a "friendly" backoff algorithm name into an integer.

Parameters

mixed $algorithm

Return Value

int

Exceptions

InvalidArgumentException

Laravel Cloud is the best place to deploy Laravel, Nuxt, Express, Hono, Node.js, Bun, Go, Flask, Python, and more, with dedicated infrastructure available on AWS through Laravel Private Cloud.