BusFake
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. | |
| protected array | $commandsAfterResponse | The commands that have been dispatched after the response has been sent. |
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. | |
| void | assertDispatchedAfterResponse(string $command, callable|int|null $callback = null) Assert if a job was dispatched after the response was sent based on a truth-test callback. | |
| void | assertDispatchedAfterResponseTimes(string $command, int $times = 1) Assert if a job was pushed after the response was sent a number of times. | |
| void | assertNotDispatchedAfterResponse(string $command, callable|null $callback = null) Determine if a job was dispatched based on a truth-test callback. | |
| Collection | dispatched(string $command, callable|null $callback = null) Get all of the jobs matching a truth-test callback. | |
| Collection | dispatchedAfterResponse(string $command, callable|null $callback = null) Get all of the jobs dispatched after the response was sent matching a truth-test callback. | |
| bool | hasDispatched(string $command) Determine if there are any stored commands for a given class. | |
| bool | hasDispatchedAfterResponse(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. | |
| mixed | dispatchAfterResponse(mixed $command) Dispatch a command to its appropriate handler. | |
| 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.
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.
void assertDispatchedAfterResponse(string $command, callable|int|null $callback = null)
Assert if a job was dispatched after the response was sent based on a truth-test callback.
void assertDispatchedAfterResponseTimes(string $command, int $times = 1)
Assert if a job was pushed after the response was sent a number of times.
void assertNotDispatchedAfterResponse(string $command, callable|null $callback = null)
Determine if a job was dispatched based on a truth-test callback.
Collection dispatched(string $command, callable|null $callback = null)
Get all of the jobs matching a truth-test callback.
Collection dispatchedAfterResponse(string $command, callable|null $callback = null)
Get all of the jobs dispatched after the response was sent matching a truth-test callback.
bool hasDispatched(string $command)
Determine if there are any stored commands for a given class.
bool hasDispatchedAfterResponse(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.
mixed dispatchAfterResponse(mixed $command)
Dispatch a command to its appropriate handler.
protected 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.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/6.x/Illuminate/Support/Testing/Fakes/BusFake.html