EventFake
class EventFake implements Dispatcher (View source)
Properties
| protected Dispatcher | $dispatcher | The original event dispatcher. |
|
| protected array | $eventsToFake | The event types that should be intercepted instead of dispatched. |
|
| protected array | $events | All of the events that have been intercepted keyed by type. |
Methods
Create a new event fake instance.
Assert if an event was dispatched based on a truth-test callback.
Assert if a event was dispatched a number of times.
Determine if an event was dispatched based on a truth-test callback.
Get all of the events matching a truth-test callback.
Determine if the given event has been dispatched.
Determine if a given event has listeners.
Register an event and payload to be dispatched later.
Register an event subscriber with the dispatcher.
Flush a set of pushed events.
Fire an event and call the listeners.
Determine if an event should be faked or actually dispatched.
Remove a set of listeners from the dispatcher.
Forget all of the queued listeners.
Dispatch an event and call the listeners.
Details
void
__construct(Dispatcher $dispatcher, array|string $eventsToFake = [])
Create a new event fake instance.
void
assertDispatched(string $event, callable|int|null $callback = null)
Assert if an event was dispatched based on a truth-test callback.
void
assertDispatchedTimes(string $event, int $times = 1)
Assert if a event was dispatched a number of times.
void
assertNotDispatched(string $event, callable|null $callback = null)
Determine if an event was dispatched based on a truth-test callback.
Collection
dispatched(string $event, callable|null $callback = null)
Get all of the events matching a truth-test callback.
bool
hasDispatched(string $event)
Determine if the given event has been dispatched.
void
listen(string|array $events, Closure|string $listener)
Register an event listener with the dispatcher.
bool
hasListeners(string $eventName)
Determine if a given event has listeners.
void
push(string $event, array $payload = [])
Register an event and payload to be dispatched later.
void
subscribe(object|string $subscriber)
Register an event subscriber with the dispatcher.
void
flush(string $event)
Flush a set of pushed events.
array|null
dispatch(string|object $event, mixed $payload = [], bool $halt = false)
Fire an event and call the listeners.
protected bool
shouldFakeEvent(string $eventName, mixed $payload)
Determine if an event should be faked or actually dispatched.
void
forget(string $event)
Remove a set of listeners from the dispatcher.
void
forgetPushed()
Forget all of the queued listeners.
array|null
until(string|object $event, mixed $payload = [])
Dispatch an event and call the listeners.