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