interface RulesSchedulerTaskHandlerInterface in Rules 7.2

Interface for scheduled task handlers.

Task handlers control the behavior of a task when it's queued or executed. Unless specified otherwise, the RulesSchedulerDefaultTaskHandler task handler is used.

Hierarchy

• interface \RulesSchedulerTaskHandlerInterface

See also

rules_scheduler_run_task()

rules_scheduler_cron()

RulesSchedulerDefaultTaskHandler

File

rules_scheduler/includes/rules_scheduler.handler.inc, line 77

Views integration for the rules scheduler module.

interface RulesSchedulerTaskHandlerInterface {

  /**
   * Processes a queue item.
   *
   * @throws RulesEvaluationException
   *   If there are any problems executing the task.
   *
   * @see rules_scheduler_run_task()
   */
  public function runTask();

  /**
   * Processes a task after it has been queued.
   *
   * @see rules_scheduler_cron()
   */
  public function afterTaskQueued();

  /**
   * Returns the task associated with the task handler.
   *
   * @return array
   *   The task (queue item) array.
   */
  public function getTask();

}

Members

Name	Modifiers	Type	Description	Overrides
RulesSchedulerTaskHandlerInterface::afterTaskQueued	public	function	Processes a task after it has been queued.	1
RulesSchedulerTaskHandlerInterface::getTask	public	function	Returns the task associated with the task handler.	1
RulesSchedulerTaskHandlerInterface::runTask	public	function	Processes a queue item.	1