CRM/Contribute/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  */
  33
  34 /**
  35  * Class to represent the actions that can be performed on a group of contacts.
  36  *
  37  * Used by the search forms.
  38  */
  39 class CRM_Contribute_Task {
  40   const DELETE_CONTRIBUTIONS = 1, PRINT_CONTRIBUTIONS = 2, EXPORT_CONTRIBUTIONS = 3, BATCH_CONTRIBUTIONS = 4, EMAIL_CONTACTS = 5, UPDATE_STATUS = 6, PDF_RECEIPT = 7;
  41
  42   /**
  43    * The task array
  44    *
  45    * @var array
  46    */
  47   static $_tasks = NULL;
  48
  49   /**
  50    * The optional task array
  51    *
  52    * @var array
  53    */
  54   static $_optionalTasks = NULL;
  55
  56   /**
  57    * These tasks are the core set of tasks that the user can perform
  58    * on a contact / group of contacts
  59    *
  60    * @return array
  61    *   the set of tasks for a group of contacts
  62    */
  63   public static function tasks() {
  64     if (!(self::$_tasks)) {
  65       self::$_tasks = array(
  66         1 => array(
  67           'title' => ts('Delete contributions'),
  68           'class' => 'CRM_Contribute_Form_Task_Delete',
  69           'result' => FALSE,
  70         ),
  71         2 => array(
  72           'title' => ts('Print selected rows'),
  73           'class' => 'CRM_Contribute_Form_Task_Print',
  74           'result' => FALSE,
  75         ),
  76         3 => array(
  77           'title' => ts('Export contributions'),
  78           'class' => array(
  79             'CRM_Export_Form_Select',
  80             'CRM_Export_Form_Map',
  81           ),
  82           'result' => FALSE,
  83         ),
  84         4 => array(
  85           'title' => ts('Update multiple contributions'),
  86           'class' => array(
  87             'CRM_Contribute_Form_Task_PickProfile',
  88             'CRM_Contribute_Form_Task_Batch',
  89           ),
  90           'result' => TRUE,
  91         ),
  92         5 => array(
  93           'title' => ts('Email - send now'),
  94           'class' => 'CRM_Contribute_Form_Task_Email',
  95           'result' => TRUE,
  96         ),
  97         6 => array(
  98           'title' => ts('Update pending contribution status'),
  99           'class' => 'CRM_Contribute_Form_Task_Status',
 100           'result' => TRUE,
 101         ),
 102         7 => array(
 103           'title' => ts('Receipts - print or email'),
 104           'class' => 'CRM_Contribute_Form_Task_PDF',
 105           'result' => FALSE,
 106         ),
 107         8 => array(
 108           'title' => ts('Thank-you letters - print or email'),
 109           'class' => 'CRM_Contribute_Form_Task_PDFLetter',
 110           'result' => FALSE,
 111         ),
 112         9 => array(
 113           'title' => ts('Invoices - print or email'),
 114           'class' => 'CRM_Contribute_Form_Task_Invoice',
 115           'result' => FALSE,
 116         ),
 117       );
 118
 119       //CRM-4418, check for delete
 120       if (!CRM_Core_Permission::check('delete in CiviContribute')) {
 121         unset(self::$_tasks[1]);
 122       }
 123       //CRM-12920 - check for edit permission
 124       if (!CRM_Core_Permission::check('edit contributions')) {
 125         unset(self::$_tasks[4], self::$_tasks[6]);
 126       }
 127
 128       // remove action "Invoices - print or email"
 129       $invoiceSettings = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::CONTRIBUTE_PREFERENCES_NAME, 'contribution_invoice_settings');
 130       $invoicing = CRM_Utils_Array::value('invoicing', $invoiceSettings);
 131       if (!$invoicing) {
 132         unset(self::$_tasks[9]);
 133       }
 134       CRM_Utils_Hook::searchTasks('contribution', self::$_tasks);
 135       asort(self::$_tasks);
 136     }
 137
 138     return self::$_tasks;
 139   }
 140
 141   /**
 142    * These tasks are the core set of task titles
 143    * on contributors
 144    *
 145    * @return array
 146    *   the set of task titles
 147    */
 148   public static function &taskTitles() {
 149     self::tasks();
 150     $titles = array();
 151     foreach (self::$_tasks as $id => $value) {
 152       $titles[$id] = $value['title'];
 153     }
 154     return $titles;
 155   }
 156
 157   /**
 158    * Show tasks selectively based on the permission level
 159    * of the user
 160    *
 161    * @param int $permission
 162    *
 163    * @param bool $softCreditFiltering
 164    *
 165    * @return array
 166    *   set of tasks that are valid for the user
 167    */
 168   public static function &permissionedTaskTitles($permission, $softCreditFiltering = FALSE) {
 169     $tasks = array();
 170     if (($permission == CRM_Core_Permission::EDIT)
 171       || CRM_Core_Permission::check('edit contributions')
 172     ) {
 173       $tasks = self::taskTitles();
 174     }
 175     else {
 176       $tasks = array(
 177         3 => self::$_tasks[3]['title'],
 178         5 => self::$_tasks[5]['title'],
 179         7 => self::$_tasks[7]['title'],
 180       );
 181
 182       //CRM-4418,
 183       if (CRM_Core_Permission::check('delete in CiviContribute')) {
 184         $tasks[1] = self::$_tasks[1]['title'];
 185       }
 186     }
 187     if ($softCreditFiltering) {
 188       unset($tasks[4], $tasks[7]);
 189     }
 190     return $tasks;
 191   }
 192
 193   /**
 194    * These tasks are the core set of tasks that the user can perform
 195    * on contributors
 196    *
 197    * @param int $value
 198    *
 199    * @return array
 200    *   the set of tasks for a group of contributors
 201    */
 202   public static function getTask($value) {
 203     self::tasks();
 204     if (!$value || !CRM_Utils_Array::value($value, self::$_tasks)) {
 205       // make the print task by default
 206       $value = 2;
 207     }
 208     // this is possible since hooks can inject a task
 209     // CRM-13697
 210     if (!isset(self::$_tasks[$value]['result'])) {
 211       self::$_tasks[$value]['result'] = NULL;
 212     }
 213     return array(
 214       self::$_tasks[$value]['class'],
 215       self::$_tasks[$value]['result'],
 216     );
 217   }
 218
 219 }