1. class
  2. Hypervel
  3. \
  4. Queue
  5. \
  6. Failed
  7. \
  8. FileFailedJobProvider

FileFailedJobProvider

class FileFailedJobProvider implements CountableFailedJobProvider, FailedJobProviderInterface, PrunableFailedJobProvider

Methods

__construct(string $path, int $limit = 100, Closure|null $lockProviderResolver = null)

Create a new file failed job provider.

int|string|null
log(string $connection, string $queue, string $payload, Throwable $exception)

Log a failed job into storage.

array
ids(string|null $queue = null)

Get the IDs of all of the failed jobs.

array
all()

Get a list of all of the failed jobs.

object|null
find(mixed $id)

Get a single failed job.

bool
forget(mixed $id)

Delete a single failed job from storage.

void
flush(int|null $hours = null, string|null $queue = null)

Flush the failed jobs from storage.

int
prune(DateTimeInterface $before)

Prune all of the entries older than the given date.

mixed
lock(Closure $callback)

Execute the given callback while holding a lock.

array
read()

Read the failed jobs file.

void
write(array $jobs)

Write the given array of jobs to the failed jobs file.

int
count(string|null $connection = null, string|null $queue = null)

Count the failed jobs.

Details

at line 21
__construct(string $path, int $limit = 100, Closure|null $lockProviderResolver = null)

Create a new file failed job provider.

Parameters

string $path
int $limit
Closure|null $lockProviderResolver

at line 31
int|string|null log(string $connection, string $queue, string $payload, Throwable $exception)

Log a failed job into storage.

Parameters

string $connection
string $queue
string $payload
Throwable $exception

Return Value

int|string|null

at line 63
array ids(string|null $queue = null)

Get the IDs of all of the failed jobs.

Parameters

string|null $queue

Return Value

array

at line 76
array all()

Get a list of all of the failed jobs.

Return Value

array

at line 84
object|null find(mixed $id)

Get a single failed job.

Parameters

mixed $id

Return Value

object|null

at line 93
bool forget(mixed $id)

Delete a single failed job from storage.

Parameters

mixed $id

Return Value

bool

at line 108
void flush(int|null $hours = null, string|null $queue = null)

Flush the failed jobs from storage.

Parameters

int|null $hours
string|null $queue

Return Value

void

at line 124
int prune(DateTimeInterface $before)

Prune all of the entries older than the given date.

Parameters

DateTimeInterface $before

Return Value

int

at line 148
protected mixed lock(Closure $callback)

Execute the given callback while holding a lock.

Parameters

Closure $callback

Return Value

mixed

at line 165
protected array read()

Read the failed jobs file.

Return Value

array

at line 193
protected void write(array $jobs)

Write the given array of jobs to the failed jobs file.

Parameters

array $jobs

Return Value

void

at line 241
int count(string|null $connection = null, string|null $queue = null)

Count the failed jobs.

Parameters

string|null $connection
string|null $queue

Return Value

int