Function __global->dispatch_task_notification

Definitions

sources/tasks.php

  • Dispatch a task notification.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$task_title SHORT_TEXT No No required parameter N/A N/A The title of the task that executed
$requester MEMBER No No required parameter N/A N/A The member who executed the task
$result ~?array No No required parameter N/A N/A The results of the task (null: task completed without output) (false: task failed)
$task_row ?array No No Null N/A N/A The task row (null: this task was not executed from the queue)

Preview

Code (PHP)

/**
 * Dispatch a task notification.
 *
 * @param  SHORT_TEXT $task_title The title of the task that executed
 * @param  MEMBER $requester The member who executed the task
 * @param  ~?array $result The results of the task (null: task completed without output) (false: task failed)
 * @param  ?array $task_row The task row (null: this task was not executed from the queue)
 */
function dispatch_task_notification(string $task_title, int $requester, $result, ?array $task_row = null)