Documentation

Queue
in package

Table of Contents

Methods

cancelTaskById()  : void
Cancel a task by ID.
process()  : array<string|int, mixed>
Process the next 5 tasks in the queue.
requeueTaskById()  : void
Requeue a task by ID.
schedule()  : bool
Schedule a task.

Methods

cancelTaskById()

Cancel a task by ID.

public static cancelTaskById(int $taskId) : void
Parameters
$taskId : int

process()

Process the next 5 tasks in the queue.

public static process(Container $container) : array<string|int, mixed>
Parameters
$container : Container

Dependency injection container

Return values
array<string|int, mixed>

Processed tasks

requeueTaskById()

Requeue a task by ID.

public static requeueTaskById(int $taskId) : void
Parameters
$taskId : int

schedule()

Schedule a task.

public static schedule(Task $task) : bool
Parameters
$task : Task
Return values
bool

Whether the task was scheduled successfully or not


        
On this page

Search results