PendingBatch
class PendingBatch (View source)
Traits
Properties
| protected Container | $container | The IoC container instance. |
|
| string | $name | The batch name. |
|
| Collection | $jobs | The jobs that belong to the batch. |
|
| 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.
Add additional data into the batch's options array.
Dispatch the batch after the response is sent to the browser.
Details
$this|TWhenReturnType
when($value = null, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) truthy.
$this|TUnlessReturnType
unless($value = null, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) falsy.
__construct(Container $container, Collection $jobs)
Create a new pending batch instance.
$this
add(iterable|object|array $jobs)
Add jobs to the batch.
protected void
ensureJobIsBatchable(object|array $job)
Ensure the given job is batchable.
$this
before(callable $callback)
Add a callback to be executed when the batch is stored.
array
beforeCallbacks()
Get the "before" callbacks that have been registered with the pending batch.
$this
progress(callable $callback)
Add a callback to be executed after a job in the batch have executed successfully.
array
progressCallbacks()
Get the "progress" callbacks that have been registered with the pending batch.
$this
then(callable $callback)
Add a callback to be executed after all jobs in the batch have executed successfully.
array
thenCallbacks()
Get the "then" callbacks that have been registered with the pending batch.
$this
catch(callable $callback)
Add a callback to be executed after the first failing job in the batch.
array
catchCallbacks()
Get the "catch" callbacks that have been registered with the pending batch.
$this
finally(callable $callback)
Add a callback to be executed after the batch has finished executing.
array
finallyCallbacks()
Get the "finally" callbacks that have been registered with the pending batch.
$this
allowFailures(Closure|callable|array|bool $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.
bool
allowsFailures()
Determine if the pending batch allows jobs to fail without cancelling the batch.
array
failureCallbacks()
Get the "failure" callbacks that have been registered with the pending batch.
$this
name(string $name)
Set the name for the batch.
$this
onConnection(string $connection)
Specify the queue connection that the batched jobs should run on.
string|null
connection()
Get the connection used by the pending batch.
$this
onQueue(UnitEnum|string|null $queue)
Specify the queue that the batched jobs should run on.
string|null
queue()
Get the queue used by the pending batch.
$this
withOption(string $key, mixed $value)
Add additional data into the batch's options array.
Batch
dispatch()
Dispatch the batch.
Batch
dispatchAfterResponse()
Dispatch the batch after the response is sent to the browser.
protected void
dispatchExistingBatch(Batch $batch)
Dispatch an existing batch.
Batch|null
dispatchUnless(bool|Closure $boolean)
Dispatch the batch unless the given truth test passes.
protected Batch
store(BatchRepository $repository)
Store the batch using the given repository.