1. interface
  2. Illuminate
  3. \
  4. Bus
  5. \
  6. PrunableBatchRepository

PrunableBatchRepository

interface PrunableBatchRepository implements BatchRepository (View source)

Methods

Batch[]
get(int $limit, mixed $before)

Retrieve a list of batches.

from  BatchRepository
Batch|null
find(string $batchId)

Retrieve information about an existing batch.

from  BatchRepository
Batch
store(PendingBatch $batch)

Store a new pending batch.

from  BatchRepository
void
incrementTotalJobs(string $batchId, int $amount)

Increment the total number of jobs within the batch.

from  BatchRepository
UpdatedBatchJobCounts
decrementPendingJobs(string $batchId, string $jobId)

Decrement the total number of pending jobs for the batch.

from  BatchRepository
UpdatedBatchJobCounts
incrementFailedJobs(string $batchId, string $jobId)

Increment the total number of failed jobs for the batch.

from  BatchRepository
void
markAsFinished(string $batchId)

Mark the batch that has the given ID as finished.

from  BatchRepository
void
cancel(string $batchId)

Cancel the batch that has the given ID.

from  BatchRepository
void
delete(string $batchId)

Delete the batch that has the given ID.

from  BatchRepository
mixed
transaction(Closure $callback)

Execute the given Closure within a storage specific transaction.

from  BatchRepository
int
prune(DateTimeInterface $before)

Prune all of the entries older than the given date.

Details

in BatchRepository at line 16
Batch[] get(int $limit, mixed $before)

Retrieve a list of batches.

Parameters

int $limit
mixed $before

Return Value

Batch[]

in BatchRepository at line 24
Batch|null find(string $batchId)

Retrieve information about an existing batch.

Parameters

string $batchId

Return Value

Batch|null

in BatchRepository at line 32
Batch store(PendingBatch $batch)

Store a new pending batch.

Parameters

PendingBatch $batch

Return Value

Batch

in BatchRepository at line 41
void incrementTotalJobs(string $batchId, int $amount)

Increment the total number of jobs within the batch.

Parameters

string $batchId
int $amount

Return Value

void

in BatchRepository at line 50
UpdatedBatchJobCounts decrementPendingJobs(string $batchId, string $jobId)

Decrement the total number of pending jobs for the batch.

Parameters

string $batchId
string $jobId

Return Value

UpdatedBatchJobCounts

in BatchRepository at line 59
UpdatedBatchJobCounts incrementFailedJobs(string $batchId, string $jobId)

Increment the total number of failed jobs for the batch.

Parameters

string $batchId
string $jobId

Return Value

UpdatedBatchJobCounts

in BatchRepository at line 67
void markAsFinished(string $batchId)

Mark the batch that has the given ID as finished.

Parameters

string $batchId

Return Value

void

in BatchRepository at line 75
void cancel(string $batchId)

Cancel the batch that has the given ID.

Parameters

string $batchId

Return Value

void

in BatchRepository at line 83
void delete(string $batchId)

Delete the batch that has the given ID.

Parameters

string $batchId

Return Value

void

in BatchRepository at line 91
mixed transaction(Closure $callback)

Execute the given Closure within a storage specific transaction.

Parameters

Closure $callback

Return Value

mixed

at line 15
int prune(DateTimeInterface $before)

Prune all of the entries older than the given date.

Parameters

DateTimeInterface $before

Return Value

int