CRM/Campaign/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  32  */
  33
  34 /**
  35  * class to represent the actions that can be performed on a group of voters.
  36  *
  37  * Used by the search forms.
  38  */
  39 class CRM_Campaign_Task extends CRM_Core_Task {
  40
  41   const
  42     // Campaign tasks
  43     INTERVIEW = 601,
  44     RESERVE = 602,
  45     RELEASE = 603;
  46
  47   static $objectType = 'campaign';
  48
  49   /**
  50    * These tasks are the core set of tasks that the user can perform
  51    * on a voter / group of voters
  52    *
  53    * @return array
  54    *   the set of tasks for a group of voters.
  55    */
  56   public static function tasks() {
  57     if (!(self::$_tasks)) {
  58       self::$_tasks = array(
  59         self::INTERVIEW => array(
  60           'title' => ts('Record Respondents Interview'),
  61           'class' => array(
  62             'CRM_Campaign_Form_Task_Interview',
  63             'CRM_Campaign_Form_Task_Release',
  64           ),
  65           'result' => FALSE,
  66         ),
  67         self::RESERVE => array(
  68           'title' => ts('Reserve Respondents'),
  69           'class' => array(
  70             'CRM_Campaign_Form_Task_Reserve',
  71             'CRM_Campaign_Form_Task_Interview',
  72             'CRM_Campaign_Form_Task_Release',
  73           ),
  74           'result' => FALSE,
  75         ),
  76         self::RELEASE => array(
  77           'title' => ts('Release Respondents'),
  78           'class' => 'CRM_Campaign_Form_Task_Release',
  79           'result' => FALSE,
  80         ),
  81         self::TASK_PRINT => array(
  82           'title' => ts('Print Respondents'),
  83           'class' => 'CRM_Campaign_Form_Task_Print',
  84           'result' => FALSE,
  85         ),
  86       );
  87
  88       parent::tasks();
  89     }
  90
  91     return self::$_tasks;
  92   }
  93
  94   /**
  95    * Show tasks selectively based on the permission level
  96    * of the user
  97    *
  98    * @param int $permission
  99    * @param array $params
 100    *
 101    * @return array
 102    *   set of tasks that are valid for the user
 103    */
 104   public static function permissionedTaskTitles($permission, $params = array()) {
 105     $tasks = self::taskTitles();
 106
 107     $tasks = parent::corePermissionedTaskTitles($tasks, $permission, $params);
 108     return $tasks;
 109   }
 110
 111   /**
 112    * These tasks are the core set of tasks that the user can perform
 113    * on voters.
 114    *
 115    * @param int $value
 116    *
 117    * @return array
 118    *   the set of tasks for a group of voters.
 119    */
 120   public static function getTask($value) {
 121     self::tasks();
 122     if (!$value || !CRM_Utils_Array::value($value, self::$_tasks)) {
 123       // Set the interview task as default
 124       $value = self::INTERVIEW;
 125     }
 126
 127     return array(
 128       self::$_tasks[$value]['class'],
 129       self::$_tasks[$value]['result'],
 130     );
 131   }
 132
 133 }