CRM/Contribute/Task.php

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