PrunableFailedJobProvider.php

TLDR

This file is an interface for a prunable failed job provider in Illuminate\Queue\Failed namespace. It defines a single method called "prune" that is used to prune (delete) all the entries older than a given date.

Methods

prune

This method is used to prune (delete) all the entries older than the given date. It takes a DateTimeInterface object as a parameter representing the date before which the entries should be pruned. It returns an integer representing the number of entries that were pruned.

Classes

There are no classes in this file.

<?php

namespace Illuminate\Queue\Failed;

use DateTimeInterface;

interface PrunableFailedJobProvider
{
    /**
     * Prune all of the entries older than the given date.
     *
     * @param  \DateTimeInterface  $before
     * @return int
     */
    public function prune(DateTimeInterface $before);
}