abstract class Facade

Constants

protected STATE_CONTEXT_KEY

The context key for the coroutine-local facade roots.

Properties

static protected Container|null $app

The application instance being facaded.

static protected array $resolvedInstance

The resolved object instances.

static protected array<string, true> $scopedAccessors

Accessors whose resolved objects belong to a coroutine scope.

static protected array<string, int> $coroutineAccessors

Accessors with coroutine-local roots, and their current generation.

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|null
spy()

Convert the facade into a Mockery spy.

static MockInterface
partialMock()

Initiate a partial mock on the facade.

static CompositeExpectation|Expectation|HigherOrderMessage
shouldReceive()

Initiate a mock expectation on the facade.

static CompositeExpectation|Expectation|ExpectsHigherOrderMessage
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|null $name = null)

Clear a resolved facade instance.

static void
clearResolvedInstances()

Clear all of the resolved instances.

static Collection
defaultAliases()

Get the application default aliases.

static Container|null
getFacadeApplication()

Get the application instance behind the facade.

static void
setFacadeApplication(Container|null $app)

Set the application instance.

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

Handle dynamic, static calls to the object.

Details

at line 85
static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

The callback is registered on the worker-global container and runs for every subsequent resolution of the facade accessor.

Parameters

Closure $callback

Return Value

void

at line 106
static MockInterface|null spy()

Convert the facade into a Mockery spy.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface|null

at line 125
static MockInterface partialMock()

Initiate a partial mock on the facade.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface

at line 142
static CompositeExpectation|Expectation|HigherOrderMessage shouldReceive()

Initiate a mock expectation on the facade.

Swaps the resolved facade instance for the worker lifetime.

Return Value

CompositeExpectation|Expectation|HigherOrderMessage

at line 159
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage expects()

Initiate a mock expectation on the facade.

Swaps the resolved facade instance for the worker lifetime.

Return Value

CompositeExpectation|Expectation|ExpectsHigherOrderMessage

at line 176
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface

at line 189
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

at line 199
static protected bool isMock()

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

Return Value

bool

at line 210
static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

at line 226
static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Replaces the worker-wide resolved facade instance and container binding; runtime use races across coroutines and changes every subsequent facade call.

Parameters

mixed $instance

Return Value

void

at line 239
static bool isFake()

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

Return Value

bool

at line 250
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 258
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

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

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

at line 312
static void clearResolvedInstance(string|null $name = null)

Clear a resolved facade instance.

Later facade calls everywhere resolve again; only references already held keep the previous instance.

Parameters

string|null $name

Return Value

void

at line 330
static void clearResolvedInstances()

Clear all of the resolved instances.

Later facade calls everywhere resolve again; only references already held keep the previous instances.

Return Value

void

at line 344
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

at line 404
static Container|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Container|null

at line 415
static void setFacadeApplication(Container|null $app)

Set the application instance.

Replaces the worker-wide facade application reference; runtime use races across coroutines and breaks every facade lookup.

Parameters

Container|null $app

Return Value

void

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

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException
Throwable