1. class
  2. Illuminate
  3. \
  4. Redis
  5. \
  6. Connections
  7. \
  8. Connection

Connection

abstract class Connection (View source)

Traits

Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
protected Redis $client

The Redis client.
protected string|null $name

The Redis connection name.
protected Dispatcher|null $events

The event dispatcher instance.

Methods

static void
macro(string $name, object|callable $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Pass other method calls down to the underlying client.

void
createSubscription(array|string $channels, Closure $callback, string $method = 'subscribe')

Subscribe to a set of given channels for messages.

ConcurrencyLimiterBuilder
funnel(string $name)

Funnel a callback for a maximum number of simultaneous executions.

DurationLimiterBuilder
throttle(string $name)

Throttle a callback for a maximum number of executions over a given duration.

mixed
client()

Get the underlying Redis client.

void
subscribe(array|string $channels, Closure $callback)

Subscribe to a set of given channels for messages.

void
psubscribe(array|string $channels, Closure $callback)

Subscribe to a set of given channels with wildcards.

mixed
command(string $method, array $parameters = [])

Run a command against the Redis database.

array
parseParametersForEvent(array $parameters)

Parse the command's parameters for event dispatching.

void
event(mixed $event) deprecated

Fire the given event if possible.

void
listen(Closure $callback)

Register a Redis command listener with the connection.

string|null
getName()

Get the connection name.

$this
setName(string $name)

Set the connections name.

Dispatcher
getEventDispatcher()

Get the event dispatcher used by the connection.

void
setEventDispatcher(Dispatcher $events)

Set the event dispatcher instance on the connection.

void
unsetEventDispatcher()

Unset the event dispatcher instance on the connection.

Details

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 223
mixed __call(string $method, array $parameters)

Pass other method calls down to the underlying client.

Parameters

string $method
array $parameters

Return Value

mixed

at line 47
abstract void createSubscription(array|string $channels, Closure $callback, string $method = 'subscribe')

Subscribe to a set of given channels for messages.

Parameters

array|string $channels
Closure $callback
string $method

Return Value

void

at line 55
ConcurrencyLimiterBuilder funnel(string $name)

Funnel a callback for a maximum number of simultaneous executions.

Parameters

string $name

Return Value

ConcurrencyLimiterBuilder

at line 66
DurationLimiterBuilder throttle(string $name)

Throttle a callback for a maximum number of executions over a given duration.

Parameters

string $name

Return Value

DurationLimiterBuilder

at line 76
mixed client()

Get the underlying Redis client.

Return Value

mixed

at line 88
void subscribe(array|string $channels, Closure $callback)

Subscribe to a set of given channels for messages.

Parameters

array|string $channels
Closure $callback

Return Value

void

at line 100
void psubscribe(array|string $channels, Closure $callback)

Subscribe to a set of given channels with wildcards.

Parameters

array|string $channels
Closure $callback

Return Value

void

at line 112
mixed command(string $method, array $parameters = [])

Run a command against the Redis database.

Parameters

string $method
array $parameters

Return Value

mixed

at line 133
protected array parseParametersForEvent(array $parameters)

Parse the command's parameters for event dispatching.

Parameters

array $parameters

Return Value

array

at line 146
protected void event(mixed $event) deprecated

deprecated since Laravel 11.x

Fire the given event if possible.

Parameters

mixed $event

Return Value

void

at line 157
void listen(Closure $callback)

Register a Redis command listener with the connection.

Parameters

Closure $callback

Return Value

void

at line 167
string|null getName()

Get the connection name.

Return Value

string|null

at line 178
$this setName(string $name)

Set the connections name.

Parameters

string $name

Return Value

$this

at line 190
Dispatcher getEventDispatcher()

Get the event dispatcher used by the connection.

Return Value

Dispatcher

at line 201
void setEventDispatcher(Dispatcher $events)

Set the event dispatcher instance on the connection.

Parameters

Dispatcher $events

Return Value

void

at line 211
void unsetEventDispatcher()

Unset the event dispatcher instance on the connection.

Return Value

void