class Facade extends Facade

Properties

static protected Container|null $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|null
spy()

Convert the facade into a Mockery spy.

from  Facade
static MockInterface
partialMock()

Initiate a partial mock on the facade.

from  Facade
static CompositeExpectation|Expectation|HigherOrderMessage
shouldReceive()

Initiate a mock expectation on the facade.

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

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 Container|null
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(Container|null $app)

Set the application instance.

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

Handle dynamic, static calls to the object.

from  Facade
static bool
addBreadcrumb(Breadcrumb $breadcrumb)

No description

static void
bindClient(ClientInterface $client)

No description

static string|null
captureCheckIn(string $slug, CheckInStatus $status, int|float|null $duration = 'null', MonitorConfig|null $monitorConfig = 'null', string|null $checkInId = 'null')

No description

static EventId|null
captureEvent(Event $event, EventHint|null $hint = 'null')

No description

static EventId|null
captureException(Throwable $exception, EventHint|null $hint = 'null')

No description

static EventId|null
captureLastError(EventHint|null $hint = 'null')

No description

static EventId|null
captureMessage(string $message, Severity|null $level = 'null', EventHint|null $hint = 'null')

No description

static void
configureScope(callable $callback)

No description

static ClientInterface|null
getClient()

No description

static IntegrationInterface|null
getIntegration(string $className)

No description

static EventId|null
getLastEventId()

No description

static Span|null
getSpan()

No description

static Transaction|null
getTransaction()

No description

static bool
popScope()

No description

static Scope
pushScope()

No description

static HubInterface
setSpan(Span|null $span)

No description

static Transaction
startTransaction(TransactionContext $context, array<string $, mixed> $customSamplingContext = '[]')

No description

static mixed
withScope(callable $callback)

No description

Details

in Facade at line 61
static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Boot-only. 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

in Facade at line 81
static MockInterface|null spy()

Convert the facade into a Mockery spy.

Tests only. Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface|null

in Facade at line 99
static MockInterface partialMock()

Initiate a partial mock on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface

in Facade at line 115
static CompositeExpectation|Expectation|HigherOrderMessage shouldReceive()

Initiate a mock expectation on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

Return Value

CompositeExpectation|Expectation|HigherOrderMessage

in Facade at line 131
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage expects()

Initiate a mock expectation on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

Return Value

CompositeExpectation|Expectation|ExpectsHigherOrderMessage

in Facade at line 145
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 157
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 167
static protected bool isMock()

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

Return Value

bool

in Facade at line 178
static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

in Facade at line 194
static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Tests only. 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

in Facade at line 206
static bool isFake()

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

Return Value

bool

in Facade at line 217
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 37
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

in Facade at line 233
static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 256
static void clearResolvedInstance(string|null $name = null)

Clear a resolved facade instance.

Boot or tests only. Clears a worker-wide facade cache entry; concurrent coroutines may still hold the previous resolved instance.

Parameters

string|null $name

Return Value

void

in Facade at line 267
static void clearResolvedInstances()

Clear all of the resolved instances.

Boot or tests only. Clears the worker-wide facade cache; concurrent coroutines may still hold previously resolved instances.

Return Value

void

in Facade at line 275
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 335
static Container|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Container|null

in Facade at line 346
static void setFacadeApplication(Container|null $app)

Set the application instance.

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

Parameters

Container|null $app

Return Value

void

in Facade at line 356
static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException

at line 32
static bool addBreadcrumb(Breadcrumb $breadcrumb)

No description

Parameters

Breadcrumb $breadcrumb

Return Value

bool

at line 32
static void bindClient(ClientInterface $client)

No description

Parameters

ClientInterface $client

Return Value

void

at line 32
static string|null captureCheckIn(string $slug, CheckInStatus $status, int|float|null $duration = 'null', MonitorConfig|null $monitorConfig = 'null', string|null $checkInId = 'null')

No description

Parameters

string $slug
CheckInStatus $status
int|float|null $duration
MonitorConfig|null $monitorConfig
string|null $checkInId

Return Value

string|null

at line 32
static EventId|null captureEvent(Event $event, EventHint|null $hint = 'null')

No description

Parameters

Event $event
EventHint|null $hint

Return Value

EventId|null

at line 32
static EventId|null captureException(Throwable $exception, EventHint|null $hint = 'null')

No description

Parameters

Throwable $exception
EventHint|null $hint

Return Value

EventId|null

at line 32
static EventId|null captureLastError(EventHint|null $hint = 'null')

No description

Parameters

EventHint|null $hint

Return Value

EventId|null

at line 32
static EventId|null captureMessage(string $message, Severity|null $level = 'null', EventHint|null $hint = 'null')

No description

Parameters

string $message
Severity|null $level
EventHint|null $hint

Return Value

EventId|null

at line 32
static void configureScope(callable $callback)

No description

Parameters

callable $callback

Return Value

void

at line 32
static ClientInterface|null getClient()

No description

Return Value

ClientInterface|null

at line 32
static IntegrationInterface|null getIntegration(string $className)

No description

Parameters

string $className

Return Value

IntegrationInterface|null

at line 32
static EventId|null getLastEventId()

No description

Return Value

EventId|null

at line 32
static Span|null getSpan()

No description

Return Value

Span|null

at line 32
static Transaction|null getTransaction()

No description

Return Value

Transaction|null

at line 32
static bool popScope()

No description

Return Value

bool

at line 32
static Scope pushScope()

No description

Return Value

Scope

at line 32
static HubInterface setSpan(Span|null $span)

No description

Parameters

Span|null $span

Return Value

HubInterface

at line 32
static Transaction startTransaction(TransactionContext $context, array<string $, mixed> $customSamplingContext = '[]')

No description

Parameters

TransactionContext $context
array<string $
mixed> $customSamplingContext

Return Value

Transaction

at line 32
static mixed withScope(callable $callback)

No description

Parameters

callable $callback

Return Value

mixed