Facade

abstract class Facade (View source)

Properties

static protected Application $app The application instance being facaded.
static protected array $resolvedInstance The resolved object instances.

Methods

static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.
static MockInterface spy()

Convert the facade into a Mockery spy.
static MockInterface partialMock()

Initiate a partial mock on the facade.
static Expectation shouldReceive()

Initiate a mock expectation on the facade.
static MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.
static MockInterface createMock()

Create a fresh mock instance for the given class.
static bool isMock()

Determines whether a mock is set as the instance of the facade.
static string|null getMockableClass()

Get the mockable class for the bound instance.
static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.
static mixed getFacadeRoot()

Get the root object behind the facade.
static string getFacadeAccessor()

Get the registered name of the component.
static mixed resolveFacadeInstance(object|string $name)

Resolve the facade root instance from the container.
static void clearResolvedInstance(string $name)

Clear a resolved facade instance.
static void clearResolvedInstances()

Clear all of the resolved instances.
static Application getFacadeApplication()

Get the application instance behind the facade.
static void setFacadeApplication(Application $app)

Set the application instance.
static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

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 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 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

Exceptions

RuntimeException

static protected mixed resolveFacadeInstance(object|string $name)

Resolve the facade root instance from the container.

Parameters

object|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 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

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