Batchable
trait Batchable
Traits
Properties
| bool|null | $viaOutbox | Whether to stage the job through the transactional outbox. |
from InteractsWithQueueOutbox |
| string|null | $outboxDatabase | The database connection that owns the staged job. |
from InteractsWithQueueOutbox |
| string|null | $batchId | The batch ID (if applicable). |
Methods
Dispatch the job through the transactional outbox.
Dispatch the job without the transactional outbox.
Stage the job on the given database connection.
Determine if the batch is still active and processing.
Set the batch ID on the job.
Indicate that the job should use a fake batch.
Details
in
InteractsWithQueueOutbox at line 29
InteractsWithQueueOutbox
viaOutbox()
Dispatch the job through the transactional outbox.
in
InteractsWithQueueOutbox at line 39
InteractsWithQueueOutbox
withoutOutbox()
Dispatch the job without the transactional outbox.
in
InteractsWithQueueOutbox at line 50
InteractsWithQueueOutbox
onOutboxDatabase(UnitEnum|string $connection)
Stage the job on the given database connection.
at line 29
Batch|null
batch()
Get the batch instance for the job, if applicable.
at line 45
bool
batching()
Determine if the batch is still active and processing.
at line 57
Batchable
withBatchId(string $batchId)
Set the batch ID on the job.
at line 69
array
withFakeBatch(string $id = '', string $name = '', int $totalJobs = 0, int $pendingJobs = 0, int $failedJobs = 0, array $failedJobIds = [], array $options = [], CarbonImmutable|null $createdAt = null, CarbonImmutable|null $cancelledAt = null, CarbonImmutable|null $finishedAt = null)
Indicate that the job should use a fake batch.