PrunableBatchRepository.php

TLDR

This file contains the code for the PrunableBatchRepository interface, which extends the BatchRepository interface. It defines a method prune() to remove entries older than a certain date.

Methods

prune(DateTimeInterface $before): int

This method removes all entries in the repository that are older than the provided 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.

<?php

namespace Illuminate\Bus;

use DateTimeInterface;

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