1. class
  2. Illuminate
  3. \
  4. Support
  5. \
  6. Facades
  7. \
  8. Facade

Facade

abstract class Facade (View source)

Properties

static protected Application|null $app

The application instance being facaded.
static protected array $resolvedInstance

The resolved object instances.
static protected bool $cached

Indicates if the resolved instance should be cached.

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 Expectation
expects()

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 bool
isFake()

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

static mixed
getFacadeRoot()

Get the root object behind the facade.

static string
getFacadeAccessor()

Get the registered name of the component.

static mixed
resolveFacadeInstance(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 Collection
defaultAliases()

Get the application default aliases.

static Application|null
getFacadeApplication()

Get the application instance behind the facade.

static void
setFacadeApplication(Application|null $app)

Set the application instance.

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

Handle dynamic, static calls to the object.

Details

at line 47
static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Parameters

Closure $callback

Return Value

void

at line 65
static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

at line 81
static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

at line 97
static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

at line 113
static Expectation expects()

Initiate a mock expectation on the facade.

Return Value

Expectation

at line 129
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

at line 143
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

at line 155
static protected bool isMock()

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

Return Value

bool

at line 168
static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

at line 181
static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Parameters

mixed $instance

Return Value

void

at line 195
static bool isFake()

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

Return Value

bool

at line 208
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 220
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

Exceptions

RuntimeException

at line 231
static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

at line 252
static void clearResolvedInstance(string $name)

Clear a resolved facade instance.

Parameters

string $name

Return Value

void

at line 262
static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

at line 272
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

at line 328
static Application|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Application|null

at line 339
static void setFacadeApplication(Application|null $app)

Set the application instance.

Parameters

Application|null $app

Return Value

void

at line 353
static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException