Redis

class Redis extends Facade (View source)

Properties

static protected Application	$app	The application instance being facaded.	from Facade
static protected array	$resolvedInstance	The resolved object instances.	from Facade
static protected bool	$cached	Indicates if the resolved instance should be cached.	from Facade

Methods

static void

resolved(Closure $callback)

Run a Closure when the facade has been resolved.

from Facade

static MockInterface

spy()

Convert the facade into a Mockery spy.

from Facade

static MockInterface

partialMock()

Initiate a partial mock on the facade.

from Facade

static Expectation

shouldReceive()

Initiate a mock expectation on the facade.

from Facade

static Expectation

expects()

Initiate a mock expectation on the facade.

from Facade

static MockInterface

createFreshMockInstance()

Create a fresh mock instance for the given class.

from Facade

static MockInterface

createMock()

Create a fresh mock instance for the given class.

from Facade

static bool

isMock()

Determines whether a mock is set as the instance of the facade.

from Facade

static string|null

getMockableClass()

Get the mockable class for the bound instance.

from Facade

static void

swap(mixed $instance)

Hotswap the underlying instance behind the facade.

from Facade

static bool

isFake()

Determines whether a "fake" has been set as the facade instance.

from Facade

static mixed

getFacadeRoot()

Get the root object behind the facade.

from Facade

static string

getFacadeAccessor()

Get the registered name of the component.

static mixed

resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

from Facade

static void

clearResolvedInstance(string $name)

Clear a resolved facade instance.

from Facade

static void

clearResolvedInstances()

Clear all of the resolved instances.

from Facade

static Collection

defaultAliases()

Get the application default aliases.

from Facade

static Application

getFacadeApplication()

Get the application instance behind the facade.

from Facade

static void

setFacadeApplication(Application $app)

Set the application instance.

from Facade

static mixed

__callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

from Facade

static Connection

connection(string|null $name = null)

No description

static Connection

resolve(string|null $name = null)

No description

static array

connections()

No description

static void

enableEvents()

No description

static void

disableEvents()

No description

static void

setDriver(string $driver)

No description

static void

purge(string|null $name = null)

No description

static RedisManager

extend(string $driver, Closure $callback)

No description

static void

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

No description

static ConcurrencyLimiterBuilder

funnel(string $name)

No description

static DurationLimiterBuilder

throttle(string $name)

No description

static mixed

client()

No description

static void

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

No description

static void

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

No description

static mixed

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

No description

static void

listen(Closure $callback)

No description

static string|null

getName()

No description

static Connection

setName(string $name)

No description

static Dispatcher

getEventDispatcher()

No description

static void

setEventDispatcher(Dispatcher $events)

No description

static void

unsetEventDispatcher()

No description

static void

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

No description

static void

mixin(object $mixin, bool $replace = true)

No description

static bool

hasMacro(string $name)

No description

static void

flushMacros()

No description

static mixed

macroCall(string $method, array $parameters)

No description

Details

static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Parameters

Closure

$callback

Return Value

void

static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

static Expectation expects()

Initiate a mock expectation on the facade.

Return Value

Expectation

static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected bool isMock()

Determines whether a mock is set as the instance of the facade.

Return Value

bool

static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Parameters

mixed

$instance

Return Value

void

static protected bool isFake()

Determines whether a "fake" has been set as the facade instance.

Return Value

bool

static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string

$name

Return Value

mixed

static void clearResolvedInstance(string $name)

Clear a resolved facade instance.

Parameters

string

$name

Return Value

void

static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

static Application getFacadeApplication()

Get the application instance behind the facade.

Return Value

Application

static void setFacadeApplication(Application $app)

Set the application instance.

Parameters

Application

$app

Return Value

void

static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string	$method
array	$args

Return Value

mixed

Exceptions

RuntimeException

static Connection connection(string|null $name = null)

No description

Parameters

string|null

$name

Return Value

Connection

static Connection resolve(string|null $name = null)

No description

Parameters

string|null

$name

Return Value

Connection

static array connections()

No description

Return Value

array

static void enableEvents()

No description

Return Value

void

static void disableEvents()

No description

Return Value

void

static void setDriver(string $driver)

No description

Parameters

string

$driver

Return Value

void

static void purge(string|null $name = null)

No description

Parameters

string|null

$name

Return Value

void

static RedisManager extend(string $driver, Closure $callback)

No description

Parameters

string	$driver
Closure	$callback

Return Value

RedisManager

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

No description

Parameters

array\|string	$channels
Closure	$callback
string	$method

Return Value

void

static ConcurrencyLimiterBuilder funnel(string $name)

No description

Parameters

string

$name

Return Value

ConcurrencyLimiterBuilder

static DurationLimiterBuilder throttle(string $name)

No description

Parameters

string

$name

Return Value

DurationLimiterBuilder

static mixed client()

No description

Return Value

mixed

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

No description

Parameters

array\|string	$channels
Closure	$callback

Return Value

void

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

No description

Parameters

array\|string	$channels
Closure	$callback

Return Value

void

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

No description

Parameters

string	$method
array	$parameters

Return Value

mixed

static void listen(Closure $callback)

No description

Parameters

Closure

$callback

Return Value

void

static string|null getName()

No description

Return Value

string|null

static Connection setName(string $name)

No description

Parameters

string

$name

Return Value

Connection

static Dispatcher getEventDispatcher()

No description

Return Value

Dispatcher

static void setEventDispatcher(Dispatcher $events)

No description

Parameters

Dispatcher

$events

Return Value

void

static void unsetEventDispatcher()

No description

Return Value

void

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

No description

Parameters

string	$name
object\|callable	$macro

Return Value

void

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

No description

Parameters

object	$mixin
bool	$replace

Return Value

void

static bool hasMacro(string $name)

No description

Parameters

string

$name

Return Value

bool

static void flushMacros()

No description

Return Value

void

static mixed macroCall(string $method, array $parameters)

No description

Parameters

string	$method
array	$parameters

Return Value

mixed

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Support/Facades/Redis.html