final class adhoc_service

internal  
 

High-level service for creating and managing adhoc tasks.

Methods

__construct(task_support $task_support)

Constructor.

adhoc_task
create(string $classname, array $data = [], int|null $userid = null)

Create a new adhoc task instance for a given class.

bool
queue(adhoc_task $task, bool $avoidDuplicates = false)

Queue a new adhoc task.

void
reschedule_or_queue(adhoc_task $task)

Reschedule or queue.

array
list(string $classname, bool $failedOnly = false)

Get queued tasks for a class.

Details

at line 34
__construct(task_support $task_support)

Constructor.

Parameters

task_support $task_support

at line 47
adhoc_task create(string $classname, array $data = [], int|null $userid = null)

Create a new adhoc task instance for a given class.

Parameters

string $classname

Fully-qualified adhoc task class name

array $data

Custom task data

int|null $userid

Owner user ID

Return Value

adhoc_task

at line 65
bool queue(adhoc_task $task, bool $avoidDuplicates = false)

Queue a new adhoc task.

Parameters

adhoc_task $task
bool $avoidDuplicates

Skip if a duplicate is already queued

Return Value

bool

at line 75
void reschedule_or_queue(adhoc_task $task)

Reschedule or queue.

Parameters

adhoc_task $task

Return Value

void

at line 85
array list(string $classname, bool $failedOnly = false)

Get queued tasks for a class.

Parameters

string $classname
bool $failedOnly

Return Value

array