class BusFake implements Dispatcher (View source)

Properties

protected Dispatcher $dispatcher The original Bus dispatcher implementation.
protected array $jobsToFake The job types that should be intercepted instead of dispatched.
protected array $commands The commands that have been dispatched.

Methods

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

Create a new bus fake instance.

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

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

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

Assert if a job was pushed a number of times.

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

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

dispatched(string $command, callable|null $callback = null)

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

bool
hasDispatched(string $command)

Determine if there are any stored commands for a given class.

mixed
dispatch(mixed $command)

Dispatch a command to its appropriate handler.

mixed
dispatchNow(mixed $command, mixed $handler = null)

Dispatch a command to its appropriate handler in the current process.

bool
shouldFakeJob(mixed $command)

Determine if an command should be faked or actually dispatched.

$this
pipeThrough(array $pipes)

Set the pipes commands should be piped through before dispatching.

bool
hasCommandHandler(mixed $command)

Determine if the given command has a handler.

bool|mixed
getCommandHandler(mixed $command)

Retrieve the handler for a command.

$this
map(array $map)

Map a command to a handler.

Details

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

Create a new bus fake instance.

Parameters

Dispatcher $dispatcher
array|string $jobsToFake

Return Value

void

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

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

Parameters

string $command
callable|int|null $callback

Return Value

void

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

Assert if a job was pushed a number of times.

Parameters

string $command
int $times

Return Value

void

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

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

Parameters

string $command
callable|null $callback

Return Value

void

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

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

Parameters

string $command
callable|null $callback

Return Value

Collection

bool hasDispatched(string $command)

Determine if there are any stored commands for a given class.

Parameters

string $command

Return Value

bool

mixed dispatch(mixed $command)

Dispatch a command to its appropriate handler.

Parameters

mixed $command

Return Value

mixed

mixed dispatchNow(mixed $command, mixed $handler = null)

Dispatch a command to its appropriate handler in the current process.

Parameters

mixed $command
mixed $handler

Return Value

mixed

protected bool shouldFakeJob(mixed $command)

Determine if an command should be faked or actually dispatched.

Parameters

mixed $command

Return Value

bool

$this pipeThrough(array $pipes)

Set the pipes commands should be piped through before dispatching.

Parameters

array $pipes

Return Value

$this

bool hasCommandHandler(mixed $command)

Determine if the given command has a handler.

Parameters

mixed $command

Return Value

bool

bool|mixed getCommandHandler(mixed $command)

Retrieve the handler for a command.

Parameters

mixed $command

Return Value

bool|mixed

$this map(array $map)

Map a command to a handler.

Parameters

array $map

Return Value

$this