crm.fsf.org/20131203/files/sites/all/modules-new/civicrm/CRM/Contribute/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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  * $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, LATEX_TEST = 10;
  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         10 => array(
 120           'title' => ts('Latex Letters for Contributions'),
 121           'class' => 'CRM_Contribute_Form_Task_PDFLatex',
 122           'result' => FALSE,
 123         ),
 124       );
 125
 126       //CRM-4418, check for delete
 127       if (!CRM_Core_Permission::check('delete in CiviContribute')) {
 128         unset(self::$_tasks[1]);
 129       }
 130       //CRM-12920 - check for edit permission
 131       if (!CRM_Core_Permission::check('edit contributions')) {
 132         unset(self::$_tasks[4], self::$_tasks[6]);
 133       }
 134
 135       // remove action "Print or Email Contribution Invoices"
 136       $invoiceSettings = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::CONTRIBUTE_PREFERENCES_NAME, 'contribution_invoice_settings');
 137       $invoicing = CRM_Utils_Array::value('invoicing', $invoiceSettings);
 138       if (!$invoicing) {
 139         unset(self::$_tasks[9]);
 140       }
 141
 142       CRM_Utils_Hook::searchTasks('contribution', self::$_tasks);
 143       asort(self::$_tasks);
 144     }
 145
 146     return self::$_tasks;
 147   }
 148
 149   /**
 150    * These tasks are the core set of task titles
 151    * on contributors
 152    *
 153    * @return array
 154    *   the set of task titles
 155    */
 156   public static function &taskTitles() {
 157     self::tasks();
 158     $titles = array();
 159     foreach (self::$_tasks as $id => $value) {
 160       $titles[$id] = $value['title'];
 161     }
 162     return $titles;
 163   }
 164
 165   /**
 166    * Show tasks selectively based on the permission level
 167    * of the user
 168    *
 169    * @param int $permission
 170    *
 171    * @param bool $softCreditFiltering
 172    *
 173    * @return array
 174    *   set of tasks that are valid for the user
 175    */
 176   public static function &permissionedTaskTitles($permission, $softCreditFiltering = FALSE) {
 177     $tasks = array();
 178     if (($permission == CRM_Core_Permission::EDIT)
 179       || CRM_Core_Permission::check('edit contributions')
 180     ) {
 181       $tasks = self::taskTitles();
 182     }
 183     else {
 184       $tasks = array(
 185         3 => self::$_tasks[3]['title'],
 186         5 => self::$_tasks[5]['title'],
 187         7 => self::$_tasks[7]['title'],
 188       );
 189
 190       //CRM-4418,
 191       if (CRM_Core_Permission::check('delete in CiviContribute')) {
 192         $tasks[1] = self::$_tasks[1]['title'];
 193       }
 194     }
 195     if ($softCreditFiltering) {
 196       unset($tasks[4], $tasks[7]);
 197     }
 198     return $tasks;
 199   }
 200
 201   /**
 202    * These tasks are the core set of tasks that the user can perform
 203    * on contributors
 204    *
 205    * @param int $value
 206    *
 207    * @return array
 208    *   the set of tasks for a group of contributors
 209    */
 210   public static function getTask($value) {
 211     self::tasks();
 212     if (!$value || !CRM_Utils_Array::value($value, self::$_tasks)) {
 213       // make the print task by default
 214       $value = 2;
 215     }
 216     // this is possible since hooks can inject a task
 217     // CRM-13697
 218     if (!isset(self::$_tasks[$value]['result'])) {
 219       self::$_tasks[$value]['result'] = NULL;
 220     }
 221     return array(
 222       self::$_tasks[$value]['class'],
 223       self::$_tasks[$value]['result'],
 224     );
 225   }
 226
 227 }