CRM/Contribute/Task.php

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