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