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