3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * A task is an item that can be enqueued and later exectued
31 class CRM_Queue_Task
{
33 /** Task was performed successfully */
34 CONST TASK_SUCCESS
= 1;
36 /** Task failed and should not be retried */
40 * @var mixed, serializable
45 * @var array, serializable
50 * @var string, NULL-able
56 * @param $callback mixed, serializable, a callable PHP item; must accept at least one argument (CRM_Queue_TaskContext)
57 * @param $arguments array, serializable, extra arguments to pass to the callback (in order)
58 * @param $title string, a printable string which describes this task
60 function __construct($callback, $arguments, $title = NULL) {
61 $this->callback
= $callback;
62 $this->arguments
= $arguments;
63 $this->title
= $title;
69 * @param $taskContext array with keys:
72 * @return bool, TRUE if task completes successfully
74 function run($taskCtx) {
75 $args = $this->arguments
;
76 array_unshift($args, $taskCtx);
78 if (is_callable($this->callback
)) {
79 $result = call_user_func_array($this->callback
, $args);
83 throw new Exception('Failed to call callback: ' . print_r($this->callback
));