CRM/Grant/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  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * class to represent the actions that can be performed on a group of contacts
  38  * used by the search forms
  39  *
  40  */
  41 class CRM_Grant_Task extends CRM_Core_Task {
  42
  43   /**
  44    * Grant Tasks
  45    */
  46   const UPDATE_GRANTS = 701;
  47
  48   /**
  49    * @var string
  50    */
  51   public static $objectType = 'grant';
  52
  53   /**
  54    * These tasks are the core set of tasks that the user can perform
  55    * on a contact / group of contacts
  56    *
  57    * @return array
  58    *   the set of tasks for a group of contacts
  59    */
  60   public static function tasks() {
  61     if (!(self::$_tasks)) {
  62       self::$_tasks = [
  63         self::TASK_DELETE => [
  64           'title' => ts('Delete grants'),
  65           'class' => 'CRM_Grant_Form_Task_Delete',
  66           'result' => FALSE,
  67         ],
  68         self::TASK_PRINT => [
  69           'title' => ts('Print selected rows'),
  70           'class' => 'CRM_Grant_Form_Task_Print',
  71           'result' => FALSE,
  72         ],
  73         self::TASK_EXPORT => [
  74           'title' => ts('Export grants'),
  75           'class' => [
  76             'CRM_Export_Form_Select',
  77             'CRM_Export_Form_Map',
  78           ],
  79           'result' => FALSE,
  80         ],
  81         self::UPDATE_GRANTS => [
  82           'title' => ts('Update grants'),
  83           'class' => 'CRM_Grant_Form_Task_Update',
  84           'result' => FALSE,
  85         ],
  86       ];
  87
  88       if (!CRM_Core_Permission::check('delete in CiviGrant')) {
  89         unset(self::$_tasks[self::TASK_DELETE]);
  90       }
  91
  92       parent::tasks();
  93     }
  94
  95     return self::$_tasks;
  96   }
  97
  98   /**
  99    * Show tasks selectively based on the permission level
 100    * of the user
 101    *
 102    * @param int $permission
 103    * @param array $params
 104    *
 105    * @return array
 106    *   set of tasks that are valid for the user
 107    */
 108   public static function permissionedTaskTitles($permission, $params = []) {
 109     if (($permission == CRM_Core_Permission::EDIT)
 110       || CRM_Core_Permission::check('edit grants')
 111     ) {
 112       $tasks = self::taskTitles();
 113     }
 114     else {
 115       $tasks = [
 116         self::TASK_EXPORT => self::$_tasks[self::TASK_EXPORT]['title'],
 117       ];
 118       //CRM-4418,
 119       if (CRM_Core_Permission::check('delete in CiviGrant')) {
 120         $tasks[self::TASK_DELETE] = self::$_tasks[self::TASK_DELETE]['title'];
 121       }
 122     }
 123
 124     $tasks = parent::corePermissionedTaskTitles($tasks, $permission, $params);
 125     return $tasks;
 126   }
 127
 128   /**
 129    * These tasks are the core set of tasks that the user can perform
 130    *
 131    * @param int $value
 132    *
 133    * @return array
 134    *   the set of tasks for a group of contacts
 135    */
 136   public static function getTask($value) {
 137     self::tasks();
 138
 139     if (!CRM_Utils_Array::value($value, self::$_tasks)) {
 140       // make it the print task by default
 141       $value = self::TASK_PRINT;
 142     }
 143     return parent::getTask($value);
 144   }
 145
 146 }