CRM/Queue/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * A task is an item that can be enqueued and later exectued
  30  */
  31 class CRM_Queue_Task {
  32
  33   /**
  34    * Task was performed successfully.
  35    */
  36   const TASK_SUCCESS = 1;
  37
  38   /**
  39    * Task failed and should not be retried.
  40    */
  41   const TASK_FAIL = 2;
  42
  43   /**
  44    * @var mixed, serializable
  45    */
  46   public $callback;
  47
  48   /**
  49    * @var array, serializable
  50    */
  51   public $arguments;
  52
  53   /**
  54    * @var string, NULL-able
  55    */
  56   public $title;
  57
  58   /**
  59    * @param mixed $callback
  60    *   Serializable, a callable PHP item; must accept at least one argument
  61    *   (CRM_Queue_TaskContext).
  62    * @param array $arguments
  63    *   Serializable, extra arguments to pass to the callback (in order).
  64    * @param string $title
  65    *   A printable string which describes this task.
  66    */
  67   public function __construct($callback, $arguments, $title = NULL) {
  68     $this->callback = $callback;
  69     $this->arguments = $arguments;
  70     $this->title = $title;
  71   }
  72
  73   /**
  74    * Perform the task.
  75    *
  76    * @param array $taskCtx
  77    *   Array with keys:
  78    *   - log: object 'Log'
  79    *
  80    * @throws Exception
  81    * @return bool, TRUE if task completes successfully
  82    */
  83   public function run($taskCtx) {
  84     $args = $this->arguments;
  85     array_unshift($args, $taskCtx);
  86
  87     if (is_callable($this->callback)) {
  88       $result = call_user_func_array($this->callback, $args);
  89       return $result;
  90     }
  91     else {
  92       throw new Exception('Failed to call callback: ' . print_r($this->callback));
  93     }
  94   }
  95
  96 }