1. class
  2. Hypervel
  3. \
  4. Support
  5. \
  6. Facades
  7. \
  8. Event

Event

class Event extends 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.

 from  Facade
static protected array $resolvedInstance

The resolved object instances.

 from  Facade
static protected array<string, true> $scopedAccessors

Accessors whose resolved objects belong to a coroutine scope.

 from  Facade
static protected array<string, int> $coroutineAccessors

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

 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 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 Closure
createClassListener(array|string $listener, bool $wildcard = 'false')

No description

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

No description

void
static()

($halt is true ? mixed : null|array<int, mixed>) dispatch(object|string $event, mixed $payload = '[]', bool $halt = 'false')

static void
flush(string $event)

No description

static void
flushMacros()

No description

static void
flushState()

No description

static void
forget(string $event)

No description

static void
forgetPushed()

No description

static array
getListeners(string $eventName)

No description

static array
getObservers(string $eventName)

No description

static void
array()

<array-key, array<int, null|array|callable|string>> getRawListeners()

static bool
hasListeners(string $eventName)

No description

static bool
hasMacro(string $name)

No description

static bool
hasWildcardListeners(string $eventName)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static string|null
resolveConnectionFromQueueRoute(object $queueable, UnitEnum $queue = 'null')

No description

static string|null
resolveQueueFromQueueRoute(object $queueable)

No description

static Dispatcher
setQueueResolver(callable $resolver)

No description

static Dispatcher
setTransactionManagerResolver(callable $resolver)

No description

static void
subscribe(object|string $subscriber)

No description

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

No description

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

No description

static void
assertDispatchedOnce(string $event)

No description

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

No description

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

No description

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

No description

static void
assertNothingDispatched()

No description

static Collection
dispatched(string $event, null|array<string $, mixed>|callable $callback = 'null')

No description

static array
dispatchedEvents()

No description

static EventFake
except(array|string $eventsToDispatch)

No description

static bool
hasDispatched(string $event)

No description

Details

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

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

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

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

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

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

in Facade at line 189
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 199
static protected bool isMock()

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

Return Value

bool

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

Get the mockable class for the bound instance.

Return Value

string|null

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

in Facade at line 239
static bool isFake()

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

Return Value

bool

in Facade at line 250
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 136
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

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

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

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

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

in Facade at line 344
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

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

Get the application instance behind the facade.

Return Value

Container|null

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

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

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

Replace the bound instance with a fake.

Swaps the resolved facade instance for the worker lifetime.

Parameters

array|string $eventsToFake

Return Value

EventFake

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

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

Swaps the resolved facade instance for the worker lifetime.

Parameters

array|string $eventsToAllow

Return Value

EventFake

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

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

Swaps the resolved facade instance worker-wide until the callable returns.

Parameters

callable $callable
array $eventsToFake

Return Value

mixed

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

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

Swaps the resolved facade instance worker-wide until the callable returns.

Parameters

callable $callable
array $eventsToAllow

Return Value

mixed

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

No description

Parameters

array|string $listener
bool $wildcard

Return Value

Closure

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

No description

Parameters

callable $callback
null|string[] $events

Return Value

mixed

at line 52
void static()

($halt is true ? mixed : null|array<int, mixed>) dispatch(object|string $event, mixed $payload = '[]', bool $halt = 'false')

Return Value

void

at line 52
static void flush(string $event)

No description

Parameters

string $event

Return Value

void

at line 52
static void flushMacros()

No description

Return Value

void

at line 52
static void flushState()

No description

Return Value

void

at line 52
static void forget(string $event)

No description

Parameters

string $event

Return Value

void

at line 52
static void forgetPushed()

No description

Return Value

void

at line 52
static array getListeners(string $eventName)

No description

Parameters

string $eventName

Return Value

array

at line 52
static array getObservers(string $eventName)

No description

Parameters

string $eventName

Return Value

array

at line 52
static void array()

<array-key, array<int, null|array|callable|string>> getRawListeners()

Return Value

void

at line 52
static bool hasListeners(string $eventName)

No description

Parameters

string $eventName

Return Value

bool

at line 52
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

at line 52
static bool hasWildcardListeners(string $eventName)

No description

Parameters

string $eventName

Return Value

bool

at line 52
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 52
static void macro(string $name, callable|object $macro)

No description

Parameters

string $name
callable|object $macro

Return Value

void

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

No description

Parameters

array|object|string $listener
bool $wildcard

Return Value

Closure

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

No description

Parameters

object $mixin
bool $replace

Return Value

void

at line 52
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 52
static void push(string $event, mixed $payload = '[]')

No description

Parameters

string $event
mixed $payload

Return Value

void

at line 52
static string|null resolveConnectionFromQueueRoute(object $queueable, UnitEnum $queue = 'null')

No description

Parameters

object $queueable
UnitEnum $queue

Return Value

string|null

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

No description

Parameters

object $queueable

Return Value

string|null

at line 52
static Dispatcher setQueueResolver(callable $resolver)

No description

Parameters

callable $resolver

Return Value

Dispatcher

at line 52
static Dispatcher setTransactionManagerResolver(callable $resolver)

No description

Parameters

callable $resolver

Return Value

Dispatcher

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

No description

Parameters

object|string $subscriber

Return Value

void

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

No description

Parameters

object|string $event
mixed $payload

Return Value

mixed

at line 52
static void assertDispatched(Closure|string $event, null|array<string $, mixed>|callable|int $callback = 'null')

No description

Parameters

Closure|string $event
null|array<string $
mixed>|callable|int $callback

Return Value

void

at line 52
static void assertDispatchedOnce(string $event)

No description

Parameters

string $event

Return Value

void

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

No description

Parameters

string $event
int $times

Return Value

void

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

No description

Parameters

string $expectedEvent
array|string $expectedListener

Return Value

void

at line 52
static void assertNotDispatched(Closure|string $event, null|array<string $, mixed>|callable $callback = 'null')

No description

Parameters

Closure|string $event
null|array<string $
mixed>|callable $callback

Return Value

void

at line 52
static void assertNothingDispatched()

No description

Return Value

void

at line 52
static Collection dispatched(string $event, null|array<string $, mixed>|callable $callback = 'null')

No description

Parameters

string $event
null|array<string $
mixed>|callable $callback

Return Value

Collection

at line 52
static array dispatchedEvents()

No description

Return Value

array

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

No description

Parameters

array|string $eventsToDispatch

Return Value

EventFake

at line 52
static bool hasDispatched(string $event)

No description

Parameters

string $event

Return Value

bool