CRM_Queue_Task

class CRM_Queue_Task

A task is an item that can be enqueued and later executed

Constants

TASK_SUCCESS

Task was performed successfully.
TASK_FAIL

Task failed and should not be retried.

Properties

mixed, $callback
array, $arguments
string, $title

Methods

__construct(mixed $callback, array $arguments, string $title = NULL)

No description

bool,
run(array $taskCtx)

Perform the task.

Details

at line 67
__construct(mixed $callback, array $arguments, string $title = NULL)

Parameters

mixed $callback Serializable, a callable PHP item; must accept at least one argument (CRM_Queue_TaskContext).
array $arguments Serializable, extra arguments to pass to the callback (in order).
string $title A printable string which describes this task.

at line 83
bool, run(array $taskCtx)

Perform the task.

Parameters

array $taskCtx Array with keys: - log: object 'Log'

Return Value

bool, TRUE if task completes successfully

Exceptions

Exception