W3cubDocs

/Laravel 11

DatabaseFailedJobProvider

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

Properties

protected ConnectionResolverInterface $resolver

The connection resolver implementation.
protected string $database

The database connection name.
protected string $table

The database table.

Methods

void __construct(ConnectionResolverInterface $resolver, string $database, string $table)

Create a new database 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.
int count(string|null $connection = null, string|null $queue = null)

Count the failed jobs.
Builder getTable()

Get a new query builder instance for the table.

Details

void __construct(ConnectionResolverInterface $resolver, string $database, string $table)

Create a new database failed job provider.

Parameters

ConnectionResolverInterface $resolver
string $database
string $table

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

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

Count the failed jobs.

Parameters

string|null $connection
string|null $queue

Return Value

int

protected Builder getTable()

Get a new query builder instance for the table.

Return Value

Builder

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