CRM/Campaign/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2013
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * class to represent the actions that can be performed on a
  38  * group of voters.
  39  * used by the search forms
  40  *
  41  */
  42 class CRM_Campaign_Task {
  43   CONST INTERVIEW = 1, RESERVE = 2, RELEASE = 3, PRINT_VOTERS = 4;
  44
  45   /**
  46    * the task array
  47    *
  48    * @var array
  49    * @static
  50    */
  51   static $_tasks = NULL;
  52
  53   /**
  54    * the optional task array
  55    *
  56    * @var array
  57    * @static
  58    */
  59   static $_optionalTasks = NULL;
  60
  61   /**
  62    * These tasks are the core set of tasks that the user can perform
  63    * on a voter / group of voters
  64    *
  65    * @return array the set of tasks for a group of voters.
  66    * @static
  67    * @access public
  68    */
  69   static function &tasks() {
  70     if (!(self::$_tasks)) {
  71       self::$_tasks = array(1 => array('title' => ts('Record Respondents Interview'),
  72           'class' => array(
  73             'CRM_Campaign_Form_Task_Interview',
  74             'CRM_Campaign_Form_Task_Release',
  75           ),
  76           'result' => FALSE,
  77         ),
  78         2 => array('title' => ts('Reserve Respondents'),
  79           'class' => array(
  80             'CRM_Campaign_Form_Task_Reserve',
  81             'CRM_Campaign_Form_Task_Interview',
  82             'CRM_Campaign_Form_Task_Release',
  83           ),
  84           'result' => FALSE,
  85         ),
  86         3 => array('title' => ts('Release Respondents'),
  87           'class' => 'CRM_Campaign_Form_Task_Release',
  88           'result' => FALSE,
  89         ),
  90         4 => array('title' => ts('Print Respondents'),
  91           'class' => 'CRM_Campaign_Form_Task_Print',
  92           'result' => FALSE,
  93         ),
  94       );
  95     }
  96
  97     CRM_Utils_Hook::searchTasks('campaign', self::$_tasks);
  98
  99     asort(self::$_tasks);
 100
 101     return self::$_tasks;
 102   }
 103
 104   /**
 105    * These tasks are the core set of task titles
 106    * on voters.
 107    *
 108    * @return array the set of task titles
 109    * @static
 110    * @access public
 111    */
 112   static function &taskTitles() {
 113     self::tasks();
 114     $titles = array();
 115     foreach (self::$_tasks as $id => $value) {
 116       $titles[$id] = $value['title'];
 117     }
 118
 119     return $titles;
 120   }
 121
 122   /**
 123    * show tasks selectively based on the permission level
 124    * of the user
 125    *
 126    * @param int $permission
 127    *
 128    * @return array set of tasks that are valid for the user
 129    * @access public
 130    */
 131   static function &permissionedTaskTitles($permission) {
 132     $tasks = self::taskTitles();
 133
 134     return $tasks;
 135   }
 136
 137   /**
 138    * These tasks are the core set of tasks that the user can perform
 139    * on voters.
 140    *
 141    * @param int $value
 142    *
 143    * @return array the set of tasks for a group of voters.
 144    * @static
 145    * @access public
 146    */
 147   static function getTask($value) {
 148     self::tasks();
 149     if (!$value || !CRM_Utils_Array::value($value, self::$_tasks)) {
 150       // make the interview task by default
 151       $value = 1;
 152     }
 153
 154     return array(
 155       self::$_tasks[$value]['class'],
 156       self::$_tasks[$value]['result'],
 157     );
 158   }
 159 }
 160