class EventFake implements Dispatcher, Fake (View source)

Traits

Properties

Dispatcher $dispatcher

The original event dispatcher.

protected array $eventsToFake

The event types that should be intercepted instead of dispatched.

protected array $eventsToDispatch

The event types that should be dispatched instead of intercepted.

protected array $events

All of the events that have been intercepted keyed by type.

Methods

mixed
forwardCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object.

mixed
forwardDecoratedCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object, returning $this if the forwarded call returned itself.

static void
throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

string
firstClosureParameterType(Closure $closure)

Get the class name of the first parameter of the given Closure.

array
firstClosureParameterTypes(Closure $closure)

Get the class names of the first parameter of the given Closure, including union types.

array
closureParameterTypes(Closure $closure)

Get the class names / types of the parameters of the given Closure.

void
__construct(Dispatcher $dispatcher, array|string $eventsToFake = [])

Create a new event fake instance.

$this
except(array|string $eventsToDispatch)

Specify the events that should be dispatched instead of faked.

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

Assert if an event has a listener attached to it.

void
assertDispatched(string|Closure $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 an event was dispatched a number of times.

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

Determine if an event was dispatched based on a truth-test callback.

void
assertNothingDispatched()

Assert that no events were dispatched.

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(Closure|string|array $events, Closure|string|array|null $listener = null)

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.

bool
shouldFakeEvent(string $eventName, mixed $payload)

Determine if an event should be faked or actually dispatched.

void
fakeEvent(string|object $event, string $name, array $arguments)

Push the event onto the fake events array immediately or after the next database transaction.

bool
shouldDispatchEvent(string $eventName, mixed $payload)

Determine whether an event should be dispatched or not.

void
forget(string $event)

Remove a set of listeners from the dispatcher.

void
forgetPushed()

Forget all of the queued listeners.

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

Dispatch an event and call the listeners.

array
dispatchedEvents()

Get the events that have been dispatched.

mixed
__call(string $method, array $parameters)

Handle dynamic method calls to the dispatcher.

Details

protected mixed forwardCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object.

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

protected mixed forwardDecoratedCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object, returning $this if the forwarded call returned itself.

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

Parameters

string $method

Return Value

void

Exceptions

BadMethodCallException

protected string firstClosureParameterType(Closure $closure)

Get the class name of the first parameter of the given Closure.

Parameters

Closure $closure

Return Value

string

Exceptions

ReflectionException
RuntimeException

protected array firstClosureParameterTypes(Closure $closure)

Get the class names of the first parameter of the given Closure, including union types.

Parameters

Closure $closure

Return Value

array

Exceptions

ReflectionException
RuntimeException

protected array closureParameterTypes(Closure $closure)

Get the class names / types of the parameters of the given Closure.

Parameters

Closure $closure

Return Value

array

Exceptions

ReflectionException

void __construct(Dispatcher $dispatcher, array|string $eventsToFake = [])

Create a new event fake instance.

Parameters

Dispatcher $dispatcher
array|string $eventsToFake

Return Value

void

$this except(array|string $eventsToDispatch)

Specify the events that should be dispatched instead of faked.

Parameters

array|string $eventsToDispatch

Return Value

$this

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

Assert if an event has a listener attached to it.

Parameters

string $expectedEvent
string|array $expectedListener

Return Value

void

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

Assert if an event was dispatched based on a truth-test callback.

Parameters

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

Return Value

void

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

Assert if an event was dispatched a number of times.

Parameters

string $event
int $times

Return Value

void

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

Determine if an event was dispatched based on a truth-test callback.

Parameters

string|Closure $event
callable|null $callback

Return Value

void

void assertNothingDispatched()

Assert that no events were dispatched.

Return Value

void

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

Get all of the events matching a truth-test callback.

Parameters

string $event
callable|null $callback

Return Value

Collection

bool hasDispatched(string $event)

Determine if the given event has been dispatched.

Parameters

string $event

Return Value

bool

void listen(Closure|string|array $events, Closure|string|array|null $listener = null)

Register an event listener with the dispatcher.

Parameters

Closure|string|array $events
Closure|string|array|null $listener

Return Value

void

bool hasListeners(string $eventName)

Determine if a given event has listeners.

Parameters

string $eventName

Return Value

bool

void push(string $event, array $payload = [])

Register an event and payload to be dispatched later.

Parameters

string $event
array $payload

Return Value

void

void subscribe(object|string $subscriber)

Register an event subscriber with the dispatcher.

Parameters

object|string $subscriber

Return Value

void

void flush(string $event)

Flush a set of pushed events.

Parameters

string $event

Return Value

void

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

Fire an event and call the listeners.

Parameters

string|object $event
mixed $payload
bool $halt

Return Value

array|null

protected bool shouldFakeEvent(string $eventName, mixed $payload)

Determine if an event should be faked or actually dispatched.

Parameters

string $eventName
mixed $payload

Return Value

bool

protected void fakeEvent(string|object $event, string $name, array $arguments)

Push the event onto the fake events array immediately or after the next database transaction.

Parameters

string|object $event
string $name
array $arguments

Return Value

void

protected bool shouldDispatchEvent(string $eventName, mixed $payload)

Determine whether an event should be dispatched or not.

Parameters

string $eventName
mixed $payload

Return Value

bool

void forget(string $event)

Remove a set of listeners from the dispatcher.

Parameters

string $event

Return Value

void

void forgetPushed()

Forget all of the queued listeners.

Return Value

void

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

Dispatch an event and call the listeners.

Parameters

string|object $event
mixed $payload

Return Value

mixed

array dispatchedEvents()

Get the events that have been dispatched.

Return Value

array

mixed __call(string $method, array $parameters)

Handle dynamic method calls to the dispatcher.

Parameters

string $method
array $parameters

Return Value

mixed