PredisConnection
class PredisConnection extends Connection implements Connection mixin Client (View source)
Traits
Properties
| static protected array | $macros | The registered string macros. |
from Macroable |
| protected Client | $client | The Predis client. |
|
| protected string|null | $name | The Redis connection name. |
from Connection |
| protected Dispatcher | $events | The event dispatcher instance. |
from Connection |
Methods
Mix another object into the class.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Subscribe to a set of given channels for messages.
Funnel a callback for a maximum number of simultaneous executions.
Throttle a callback for a maximum number of executions over a given duration.
Subscribe to a set of given channels for messages.
Subscribe to a set of given channels with wildcards.
Run a command against the Redis database.
Create a new Predis connection.
Flush the selected Redis database.
Details
static void
macro(string $name, object|callable $macro)
Register a custom macro.
static void
mixin(object $mixin, bool $replace = true)
Mix another object into the class.
static bool
hasMacro(string $name)
Checks if macro is registered.
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed
__call(string $method, array $parameters)
Dynamically handle calls to the class.
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.
protected void
event(mixed $event)
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.
void
__construct(Client $client)
Create a new Predis connection.
void
flushdb()
Flush the selected Redis database.