BusFake
class BusFake implements Fake, QueueingDispatcher
Traits
Properties
| protected array | $jobsToFake | The job types that should be intercepted instead of dispatched. |
|
| protected array | $jobsToDispatch | The job types that should be dispatched instead of faked. |
|
| protected BatchRepository | $batchRepository | The fake repository to track batched jobs. |
|
| protected array | $commands | The commands that have been dispatched. |
|
| protected array | $commandsSync | The commands that have been dispatched synchronously. |
|
| protected array | $commandsAfterResponse | The commands that have been dispatched after the response has been sent. |
|
| protected array | $batches | The batches that have been dispatched. |
|
| protected bool | $serializeAndRestore | Indicates if commands should be serialized and restored when pushed to the Bus. |
Methods
Get the class name of the first parameter of the given Closure.
Get the class names of the first parameter of the given Closure, including union types.
Get the class names / types of the parameters of the given Closure.
Get the class names / types of the return type of the given Closure.
Create a new bus fake instance.
Specify the jobs that should be dispatched instead of faked.
Assert if a job was dispatched based on a truth-test callback.
Assert if a job was pushed a number of times.
Determine if a job was dispatched based on a truth-test callback.
Assert that no jobs were dispatched.
Assert if a job was explicitly dispatched synchronously based on a truth-test callback.
Assert if a job was pushed synchronously a number of times.
Determine if a job was dispatched based on a truth-test callback.
Assert if a job was dispatched after the response was sent based on a truth-test callback.
Assert if a job was pushed after the response was sent a number of times.
Determine if a job was dispatched based on a truth-test callback.
Assert if a chain of jobs was dispatched.
Assert no chained jobs was dispatched.
Reset the chain properties to their default values on the job.
Assert if a job was dispatched with an empty chain based on a truth-test callback.
Assert if a job was dispatched with chained jobs based on a truth-test callback.
Assert if a batch was dispatched based on a truth-test callback.
Assert the number of batches that have been dispatched.
Assert that no batched jobs were dispatched.
Assert that no jobs were dispatched, chained, or batched.
Get all of the jobs matching a truth-test callback.
Get all of the jobs dispatched synchronously matching a truth-test callback.
Get all of the jobs dispatched after the response was sent matching a truth-test callback.
Get all of the pending batches matching a truth-test callback.
Determine if there are any stored commands for a given class.
Determine if there are any stored commands for a given class.
Determine if there are any stored commands for a given class.
Dispatch a command to its appropriate handler.
Dispatch a command to its appropriate handler in the current process.
Dispatch a command to its appropriate handler in the current process.
Dispatch a command to its appropriate handler behind a queue.
Dispatch a command to its appropriate handler after the current process.
Dispatch multiple commands in bulk to their appropriate handlers on the queue.
Create a new chain of queueable jobs.
Create a new batch of queueable jobs.
Dispatch an empty job batch for testing.
Determine if a command should be faked or actually dispatched.
Determine if a command should be dispatched or not.
Specify if commands should be serialized and restored when dispatched or batched.
Serialize and unserialize the command to simulate the queueing process.
Return the command representation that should be stored.
Set the pipes commands should be piped through before dispatching.
Determine if the given command has a handler.
Retrieve the handler for a command.
Map a command to a handler.
Get the batches that have been dispatched.
Details
in
ReflectsClosures at line 25
protected string
firstClosureParameterType(Closure $closure)
Get the class name of the first parameter of the given Closure.
in
ReflectsClosures at line 48
protected array
firstClosureParameterTypes(Closure $closure)
Get the class names of the first parameter of the given Closure, including union types.
in
ReflectsClosures at line 74
protected array
closureParameterTypes(Closure $closure)
Get the class names / types of the parameters of the given Closure.
in
ReflectsClosures at line 94
protected array
closureReturnTypes(Closure $closure)
Get the class names / types of the return type of the given Closure.
at line 70
__construct(QueueingDispatcher $dispatcher, array|string $jobsToFake = [], BatchRepository|null $batchRepository = null)
Create a new bus fake instance.
at line 82
BusFake
except(array|string $jobsToDispatch)
Specify the jobs that should be dispatched instead of faked.
at line 92
void
assertDispatched(Closure|string $command, callable|int|null $callback = null)
Assert if a job was dispatched based on a truth-test callback.
at line 114
void
assertDispatchedOnce(Closure|string $command)
Assert if a job was pushed exactly once.
at line 122
void
assertDispatchedTimes(Closure|string $command, int $times = 1)
Assert if a job was pushed a number of times.
at line 148
void
assertNotDispatched(Closure|string $command, callable|null $callback = null)
Determine if a job was dispatched based on a truth-test callback.
at line 165
void
assertNothingDispatched()
Assert that no jobs were dispatched.
at line 177
void
assertDispatchedSync(Closure|string $command, callable|int|null $callback = null)
Assert if a job was explicitly dispatched synchronously based on a truth-test callback.
at line 197
void
assertDispatchedSyncTimes(Closure|string $command, int $times = 1)
Assert if a job was pushed synchronously a number of times.
at line 221
void
assertNotDispatchedSync(Closure|string $command, callable|null $callback = null)
Determine if a job was dispatched based on a truth-test callback.
at line 237
void
assertDispatchedAfterResponse(Closure|string $command, callable|int|null $callback = null)
Assert if a job was dispatched after the response was sent based on a truth-test callback.
at line 257
void
assertDispatchedAfterResponseTimes(Closure|string $command, int $times = 1)
Assert if a job was pushed after the response was sent a number of times.
at line 281
void
assertNotDispatchedAfterResponse(Closure|string $command, callable|null $callback = null)
Determine if a job was dispatched based on a truth-test callback.
at line 297
void
assertChained(array $expectedChain)
Assert if a chain of jobs was dispatched.
at line 334
void
assertNothingChained()
Assert no chained jobs was dispatched.
at line 342
protected mixed
resetChainPropertiesToDefaults(mixed $job)
Reset the chain properties to their default values on the job.
at line 355
void
assertDispatchedWithoutChain(Closure|string $command, callable|null $callback = null)
Assert if a job was dispatched with an empty chain based on a truth-test callback.
at line 372
protected void
assertDispatchedWithChainOfObjects(string $command, array $expectedChain, callable|null $callback)
Assert if a job was dispatched with chained jobs based on a truth-test callback.
at line 422
ChainedBatchTruthTest
chainedBatch(Closure $callback)
Create a new assertion about a chained batch.
at line 430
void
assertBatched(callable|array $callback)
Assert if a batch was dispatched based on a truth-test callback.
at line 443
void
assertBatchCount(int $count)
Assert the number of batches that have been dispatched.
at line 454
void
assertNothingBatched()
Assert that no batched jobs were dispatched.
at line 467
void
assertNothingPlaced()
Assert that no jobs were dispatched, chained, or batched.
at line 476
Collection
dispatched(string $command, callable|null $callback = null)
Get all of the jobs matching a truth-test callback.
at line 490
Collection
dispatchedSync(string $command, callable|null $callback = null)
Get all of the jobs dispatched synchronously matching a truth-test callback.
at line 504
Collection
dispatchedAfterResponse(string $command, callable|null $callback = null)
Get all of the jobs dispatched after the response was sent matching a truth-test callback.
at line 518
Collection
batched(callable $callback)
Get all of the pending batches matching a truth-test callback.
at line 530
bool
hasDispatched(string $command)
Determine if there are any stored commands for a given class.
at line 538
bool
hasDispatchedSync(string $command)
Determine if there are any stored commands for a given class.
at line 546
bool
hasDispatchedAfterResponse(string $command)
Determine if there are any stored commands for a given class.
at line 554
mixed
dispatch(mixed $command)
Dispatch a command to its appropriate handler.
at line 569
mixed
dispatchSync(mixed $command, mixed $handler = null)
Dispatch a command to its appropriate handler in the current process.
Queueable jobs will be dispatched to the "sync" queue.
at line 582
mixed
dispatchNow(mixed $command, mixed $handler = null)
Dispatch a command to its appropriate handler in the current process.
at line 595
mixed
dispatchToQueue(mixed $command)
Dispatch a command to its appropriate handler behind a queue.
at line 608
void
dispatchAfterResponse(mixed $command, mixed $handler = null)
Dispatch a command to its appropriate handler after the current process.
at line 620
void
bulk(iterable $jobs)
Dispatch multiple commands in bulk to their appropriate handlers on the queue.
at line 630
mixed
chain(mixed $jobs = null)
Create a new chain of queueable jobs.
at line 641
Batch|null
findBatch(string $batchId)
Attempt to find the batch with the given ID.
at line 649
PendingBatch
batch(mixed $jobs)
Create a new batch of queueable jobs.
at line 657
Batch
dispatchFakeBatch(string $name = '')
Dispatch an empty job batch for testing.
at line 665
Batch
recordPendingBatch(PendingBatch $pendingBatch)
Record the fake pending batch dispatch.
at line 681
protected bool
shouldFakeJob(mixed $command)
Determine if a command should be faked or actually dispatched.
at line 702
protected bool
shouldDispatchCommand(mixed $command)
Determine if a command should be dispatched or not.
at line 715
BusFake
serializeAndRestore(bool $serializeAndRestore = true)
Specify if commands should be serialized and restored when dispatched or batched.
at line 725
protected mixed
serializeAndRestoreCommand(mixed $command)
Serialize and unserialize the command to simulate the queueing process.
at line 733
protected mixed
getCommandRepresentation(mixed $command)
Return the command representation that should be stored.
at line 741
Dispatcher
pipeThrough(array $pipes)
Set the pipes commands should be piped through before dispatching.
at line 751
bool
hasCommandHandler(mixed $command)
Determine if the given command has a handler.
at line 759
mixed
getCommandHandler(mixed $command)
Retrieve the handler for a command.
at line 767
Dispatcher
map(array $map)
Map a command to a handler.
at line 777
array
dispatchedBatches()
Get the batches that have been dispatched.