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