W3cubDocs

/Laravel 11

FileFailedJobProvider

class FileFailedJobProvider implements CountableFailedJobProvider, FailedJobProviderInterface, PrunableFailedJobProvider (View source)

Properties

protected string $path

The file path where the failed job file should be stored.
protected int $limit

The maximum number of failed jobs to retain.
protected Closure $lockProviderResolver

The lock provider resolver.

Methods

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

Create a new file failed job provider.
string|int|null log(string $connection, string $queue, string $payload, Throwable $exception)

Log a failed job into storage.
array ids(string $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)

Flush all of 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

void __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

Return Value

void

string|int|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

string|int|null

array ids(string $queue = null)

Get the IDs of all of the failed jobs.

Parameters

string $queue

Return Value

array

array all()

Get a list of all of the failed jobs.

Return Value

array

object|null find(mixed $id)

Get a single failed job.

Parameters

mixed $id

Return Value

object|null

bool forget(mixed $id)

Delete a single failed job from storage.

Parameters

mixed $id

Return Value

bool

void flush(int|null $hours = null)

Flush all of the failed jobs from storage.

Parameters

int|null $hours

Return Value

void

int prune(DateTimeInterface $before)

Prune all of the entries older than the given date.

Parameters

DateTimeInterface $before

Return Value

int

protected mixed lock(Closure $callback)

Execute the given callback while holding a lock.

Parameters

Closure $callback

Return Value

mixed

protected array read()

Read the failed jobs file.

Return Value

array

protected void write(array $jobs)

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

Parameters

array $jobs

Return Value

void

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

Count the failed jobs.

Parameters

string|null $connection
string|null $queue

Return Value

int

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Queue/Failed/FileFailedJobProvider.html