CRM/Campaign/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   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  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2015
  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    */
  50   static $_tasks = NULL;
  51
  52   /**
  53    * The optional task array
  54    *
  55    * @var array
  56    */
  57   static $_optionalTasks = NULL;
  58
  59   /**
  60    * These tasks are the core set of tasks that the user can perform
  61    * on a voter / group of voters
  62    *
  63    * @return array
  64    *   the set of tasks for a group of voters.
  65    */
  66   public static function &tasks() {
  67     if (!(self::$_tasks)) {
  68       self::$_tasks = array(
  69         1 => array(
  70           'title' => ts('Record Respondents Interview'),
  71           'class' => array(
  72             'CRM_Campaign_Form_Task_Interview',
  73             'CRM_Campaign_Form_Task_Release',
  74           ),
  75           'result' => FALSE,
  76         ),
  77         2 => array(
  78           '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(
  87           'title' => ts('Release Respondents'),
  88           'class' => 'CRM_Campaign_Form_Task_Release',
  89           'result' => FALSE,
  90         ),
  91         4 => array(
  92           'title' => ts('Print Respondents'),
  93           'class' => 'CRM_Campaign_Form_Task_Print',
  94           'result' => FALSE,
  95         ),
  96       );
  97     }
  98
  99     CRM_Utils_Hook::searchTasks('campaign', self::$_tasks);
 100
 101     asort(self::$_tasks);
 102
 103     return self::$_tasks;
 104   }
 105
 106   /**
 107    * These tasks are the core set of task titles
 108    * on voters.
 109    *
 110    * @return array
 111    *   the set of task titles
 112    */
 113   public static function &taskTitles() {
 114     self::tasks();
 115     $titles = array();
 116     foreach (self::$_tasks as $id => $value) {
 117       $titles[$id] = $value['title'];
 118     }
 119
 120     return $titles;
 121   }
 122
 123   /**
 124    * Show tasks selectively based on the permission level
 125    * of the user
 126    *
 127    * @param int $permission
 128    *
 129    * @return array
 130    *   set of tasks that are valid for the user
 131    */
 132   public static function &permissionedTaskTitles($permission) {
 133     $tasks = self::taskTitles();
 134
 135     return $tasks;
 136   }
 137
 138   /**
 139    * These tasks are the core set of tasks that the user can perform
 140    * on voters.
 141    *
 142    * @param int $value
 143    *
 144    * @return array
 145    *   the set of tasks for a group of voters.
 146    */
 147   public 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 }