class Event extends Facade

Properties

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

Convert the facade into a Mockery spy.

from  Facade
static 
partialMock()

Initiate a partial mock on the facade.

from  Facade
static 
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static 
expects()

Initiate a mock expectation on the facade.

from  Facade
static 
createFreshMockInstance()

Create a fresh mock instance for the given class.

from  Facade
static 
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 
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 
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(mixed $app)

Set the application instance.

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

Handle dynamic, static calls to the object.

from  Facade
static EventFake
fake(array|string $eventsToFake = [])

Replace the bound instance with a fake.

static EventFake
fakeExcept(array|string $eventsToAllow)

Replace the bound instance with a fake that fakes all events except the given events.

static mixed
fakeFor(callable $callable, array $eventsToFake = [])

Replace the bound instance with a fake during the given callable's execution.

static mixed
fakeExceptFor(callable $callable, array $eventsToAllow = [])

Replace the bound instance with a fake during the given callable's execution.

static void
listen(QueuedClosure|array|string $events, object|array|string|null $listener = 'null')

No description

static void
observe(array|string $events, object|array|string $observer)

No description

static bool
hasListeners(string $eventName)

No description

static bool
hasWildcardListeners(string $eventName)

No description

static void
push(string $event, mixed $payload = '[]')

No description

static void
flush(string $event)

No description

static void
subscribe(object|string $subscriber)

No description

static mixed
until(object|string $event, mixed $payload = '[]')

No description

static mixed
dispatch(object|string $event, mixed $payload = '[]', bool $halt = 'false')

No description

static array
getListeners(string $eventName)

No description

static array
getObservers(string $eventName)

No description

static Closure
makeListener(object|array|string $listener, bool $wildcard = 'false')

No description

static Closure
createClassListener(array|string $listener, bool $wildcard = 'false')

No description

static void
forget(string $event)

No description

static void
forgetPushed()

No description

static Dispatcher
setQueueResolver(callable $resolver)

No description

static Dispatcher
setTransactionManagerResolver(callable $resolver)

No description

static mixed
defer(callable $callback, null|string[] $events = 'null')

No description

static array
getRawListeners()

No description

static void
macro(string $name, callable|object $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 string|null
resolveConnectionFromQueueRoute(object $queueable)

No description

static string|null
resolveQueueFromQueueRoute(object $queueable)

No description

static EventFake
except(array|string $eventsToDispatch)

No description

static void
assertListening(string $expectedEvent, array|string $expectedListener)

No description

static void
assertDispatched(Closure|string $event, callable|int|null $callback = 'null')

No description

static void
assertDispatchedOnce(string $event)

No description

static void
assertDispatchedTimes(string $event, int $times = '1')

No description

static void
assertNotDispatched(Closure|string $event, callable|null $callback = 'null')

No description

static void
assertNothingDispatched()

No description

static Collection
dispatched(string $event, callable|null $callback = 'null')

No description

static bool
hasDispatched(string $event)

No description

static array
dispatchedEvents()

No description

Details

in Facade at line 55
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 71
static spy()

Convert the facade into a Mockery spy.

in Facade at line 89
static partialMock()

Initiate a partial mock on the facade.

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

in Facade at line 105
static shouldReceive()

Initiate a mock expectation on the facade.

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

in Facade at line 121
static expects()

Initiate a mock expectation on the facade.

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

in Facade at line 135
static protected createFreshMockInstance()

Create a fresh mock instance for the given class.

in Facade at line 147
static protected createMock()

Create a fresh mock instance for the given class.

in Facade at line 157
static protected bool isMock()

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

Return Value

bool

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

Get the mockable class for the bound instance.

Return Value

string|null

in Facade at line 184
static 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

in Facade at line 196
static bool isFake()

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

Return Value

bool

in Facade at line 207
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 119
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

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

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 246
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 257
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 265
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 324
static getFacadeApplication()

Get the application instance behind the facade.

in Facade at line 337
static void setFacadeApplication(mixed $app)

Set the application instance.

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

Parameters

mixed $app

Return Value

void

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

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Exceptions

RuntimeException

at line 55
static EventFake fake(array|string $eventsToFake = [])

Replace the bound instance with a fake.

Parameters

array|string $eventsToFake

Return Value

EventFake

at line 72
static EventFake fakeExcept(array|string $eventsToAllow)

Replace the bound instance with a fake that fakes all events except the given events.

Parameters

array|string $eventsToAllow

Return Value

EventFake

at line 84
static mixed fakeFor(callable $callable, array $eventsToFake = [])

Replace the bound instance with a fake during the given callable's execution.

Parameters

callable $callable
array $eventsToFake

Return Value

mixed

at line 103
static mixed fakeExceptFor(callable $callable, array $eventsToAllow = [])

Replace the bound instance with a fake during the given callable's execution.

Parameters

callable $callable
array $eventsToAllow

Return Value

mixed

at line 50
static void listen(QueuedClosure|array|string $events, object|array|string|null $listener = 'null')

No description

Parameters

QueuedClosure|array|string $events
object|array|string|null $listener

Return Value

void

at line 50
static void observe(array|string $events, object|array|string $observer)

No description

Parameters

array|string $events
object|array|string $observer

Return Value

void

at line 50
static bool hasListeners(string $eventName)

No description

Parameters

string $eventName

Return Value

bool

at line 50
static bool hasWildcardListeners(string $eventName)

No description

Parameters

string $eventName

Return Value

bool

at line 50
static void push(string $event, mixed $payload = '[]')

No description

Parameters

string $event
mixed $payload

Return Value

void

at line 50
static void flush(string $event)

No description

Parameters

string $event

Return Value

void

at line 50
static void subscribe(object|string $subscriber)

No description

Parameters

object|string $subscriber

Return Value

void

at line 50
static mixed until(object|string $event, mixed $payload = '[]')

No description

Parameters

object|string $event
mixed $payload

Return Value

mixed

at line 50
static mixed dispatch(object|string $event, mixed $payload = '[]', bool $halt = 'false')

No description

Parameters

object|string $event
mixed $payload
bool $halt

Return Value

mixed

at line 50
static array getListeners(string $eventName)

No description

Parameters

string $eventName

Return Value

array

at line 50
static array getObservers(string $eventName)

No description

Parameters

string $eventName

Return Value

array

at line 50
static Closure makeListener(object|array|string $listener, bool $wildcard = 'false')

No description

Parameters

object|array|string $listener
bool $wildcard

Return Value

Closure

at line 50
static Closure createClassListener(array|string $listener, bool $wildcard = 'false')

No description

Parameters

array|string $listener
bool $wildcard

Return Value

Closure

at line 50
static void forget(string $event)

No description

Parameters

string $event

Return Value

void

at line 50
static void forgetPushed()

No description

Return Value

void

at line 50
static Dispatcher setQueueResolver(callable $resolver)

No description

Parameters

callable $resolver

Return Value

Dispatcher

at line 50
static Dispatcher setTransactionManagerResolver(callable $resolver)

No description

Parameters

callable $resolver

Return Value

Dispatcher

at line 50
static mixed defer(callable $callback, null|string[] $events = 'null')

No description

Parameters

callable $callback
null|string[] $events

Return Value

mixed

at line 50
static array getRawListeners()

No description

Return Value

array

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

No description

Parameters

string $name
callable|object $macro

Return Value

void

at line 50
static void mixin(object $mixin, bool $replace = 'true')

No description

Parameters

object $mixin
bool $replace

Return Value

void

at line 50
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

at line 50
static void flushMacros()

No description

Return Value

void

at line 50
static string|null resolveConnectionFromQueueRoute(object $queueable)

No description

Parameters

object $queueable

Return Value

string|null

at line 50
static string|null resolveQueueFromQueueRoute(object $queueable)

No description

Parameters

object $queueable

Return Value

string|null

at line 50
static EventFake except(array|string $eventsToDispatch)

No description

Parameters

array|string $eventsToDispatch

Return Value

EventFake

at line 50
static void assertListening(string $expectedEvent, array|string $expectedListener)

No description

Parameters

string $expectedEvent
array|string $expectedListener

Return Value

void

at line 50
static void assertDispatched(Closure|string $event, callable|int|null $callback = 'null')

No description

Parameters

Closure|string $event
callable|int|null $callback

Return Value

void

at line 50
static void assertDispatchedOnce(string $event)

No description

Parameters

string $event

Return Value

void

at line 50
static void assertDispatchedTimes(string $event, int $times = '1')

No description

Parameters

string $event
int $times

Return Value

void

at line 50
static void assertNotDispatched(Closure|string $event, callable|null $callback = 'null')

No description

Parameters

Closure|string $event
callable|null $callback

Return Value

void

at line 50
static void assertNothingDispatched()

No description

Return Value

void

at line 50
static Collection dispatched(string $event, callable|null $callback = 'null')

No description

Parameters

string $event
callable|null $callback

Return Value

Collection

at line 50
static bool hasDispatched(string $event)

No description

Parameters

string $event

Return Value

bool

at line 50
static array dispatchedEvents()

No description

Return Value

array