PendingBatch
class PendingBatch
Traits
Properties
| string | $name | The batch name. |
|
| array | $options | The batch options. |
|
| static protected array<class-string, bool> | $batchableClasses | Jobs that have been verified to contain the Batchable trait. |
Methods
Apply the callback if the given "value" is (or resolves to) truthy.
Apply the callback if the given "value" is (or resolves to) falsy.
Add jobs to the batch.
Ensure the given job is batchable.
Add a callback to be executed when the batch is stored.
Get the "before" callbacks that have been registered with the pending batch.
Add a callback to be executed after a job in the batch have executed successfully.
Get the "progress" callbacks that have been registered with the pending batch.
Add a callback to be executed after all jobs in the batch have executed successfully.
Get the "then" callbacks that have been registered with the pending batch.
Add a callback to be executed after the first failing job in the batch.
Get the "catch" callbacks that have been registered with the pending batch.
Add a callback to be executed after the batch has finished executing.
Get the "finally" callbacks that have been registered with the pending batch.
Indicate that the batch should not be canceled when a job within the batch fails.
Determine if the pending batch allows jobs to fail without cancelling the batch.
Get the "failure" callbacks that have been registered with the pending batch.
Set the name for the batch.
Specify the queue connection that the batched jobs should run on.
Get the connection used by the pending batch.
Specify the queue that the batched jobs should run on.
Get the queue used by the pending batch.
Dispatch batched jobs through the transactional outbox by default.
Dispatch batched jobs without the transactional outbox by default.
Stage batched jobs on the given database connection by default.
Add additional data into the batch's options array.
Dispatch the batch after the response is sent to the browser.
Flush all static state.
Details
in
Conditionable at line 23
mixed
when(mixed $value = null, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) truthy.
in
Conditionable at line 56
mixed
unless(mixed $value = null, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) falsy.
at line 48
__construct(Container $container, Collection $jobs)
Create a new pending batch instance.
at line 62
PendingBatch
add(iterable|object $jobs)
Add jobs to the batch.
at line 80
protected void
ensureJobIsBatchable(object|array $job)
Ensure the given job is batchable.
at line 102
PendingBatch
before(callable $callback)
Add a callback to be executed when the batch is stored.
at line 112
array
beforeCallbacks()
Get the "before" callbacks that have been registered with the pending batch.
at line 122
PendingBatch
progress(callable $callback)
Add a callback to be executed after a job in the batch have executed successfully.
at line 132
array
progressCallbacks()
Get the "progress" callbacks that have been registered with the pending batch.
at line 142
PendingBatch
then(callable $callback)
Add a callback to be executed after all jobs in the batch have executed successfully.
at line 152
array
thenCallbacks()
Get the "then" callbacks that have been registered with the pending batch.
at line 162
PendingBatch
catch(callable $callback)
Add a callback to be executed after the first failing job in the batch.
at line 172
array
catchCallbacks()
Get the "catch" callbacks that have been registered with the pending batch.
at line 182
PendingBatch
finally(callable $callback)
Add a callback to be executed after the batch has finished executing.
at line 192
array
finallyCallbacks()
Get the "finally" callbacks that have been registered with the pending batch.
at line 205
PendingBatch
allowFailures(mixed $param = true)
Indicate that the batch should not be canceled when a job within the batch fails.
Optionally, add callbacks to be executed upon each job failure.
at line 225
bool
allowsFailures()
Determine if the pending batch allows jobs to fail without cancelling the batch.
at line 235
array
failureCallbacks()
Get the "failure" callbacks that have been registered with the pending batch.
at line 255
PendingBatch
name(string $name)
Set the name for the batch.
at line 267
PendingBatch
onConnection(UnitEnum|string $connection)
Specify the queue connection that the batched jobs should run on.
at line 279
string|null
connection()
Get the connection used by the pending batch.
at line 289
PendingBatch
onQueue(UnitEnum|string|null $queue)
Specify the queue that the batched jobs should run on.
at line 301
string|null
queue()
Get the queue used by the pending batch.
at line 311
PendingBatch
viaOutbox()
Dispatch batched jobs through the transactional outbox by default.
at line 323
PendingBatch
withoutOutbox()
Dispatch batched jobs without the transactional outbox by default.
at line 337
PendingBatch
onOutboxDatabase(UnitEnum|string $connection)
Stage batched jobs on the given database connection by default.
at line 356
PendingBatch
withOption(string $key, mixed $value)
Add additional data into the batch's options array.
at line 368
Batch
dispatch()
Dispatch the batch.
at line 399
Batch
dispatchAfterResponse()
Dispatch the batch after the response is sent to the browser.
at line 415
protected void
dispatchExistingBatch(Batch $batch)
Dispatch an existing batch.
at line 438
Batch|null
dispatchIf(bool|Closure $boolean)
Dispatch the batch if the given truth test passes.
at line 446
Batch|null
dispatchUnless(bool|Closure $boolean)
Dispatch the batch unless the given truth test passes.
at line 454
protected Batch
store(BatchRepository $repository)
Store the batch using the given repository.
at line 487
static void
flushState()
Flush all static state.