ClearableQueue.php

TLDR

This file defines the ClearableQueue interface, which represents a queue that can be cleared of all jobs.

Methods

clear($queue)

This method deletes all of the jobs from the queue.

Parameters:

• $queue (string): The name of the queue to clear.

Returns:

• int: The number of jobs that were deleted from the queue.

<?php

namespace Illuminate\Contracts\Queue;

interface ClearableQueue
{
    /**
     * Delete all of the jobs from the queue.
     *
     * @param  string  $queue
     * @return int
     */
    public function clear($queue);
}