3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
37 * class to represent the actions that can be performed on a group of contacts
38 * used by the search forms
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;
50 static $_tasks = NULL;
53 * The optional task array
58 static $_optionalTasks = NULL;
61 * These tasks are the core set of tasks that the user can perform
62 * on a contact / group of contacts
64 * @return array the set of tasks for a group of contacts
68 static function &tasks() {
69 if (!(self
::$_tasks)) {
70 self
::$_tasks = array(
72 'title' => ts('Delete Contributions'),
73 'class' => 'CRM_Contribute_Form_Task_Delete',
77 'title' => ts('Print Selected Rows'),
78 'class' => 'CRM_Contribute_Form_Task_Print',
82 'title' => ts('Export Contributions'),
84 'CRM_Export_Form_Select',
85 'CRM_Export_Form_Map',
90 'title' => ts('Batch Update Contributions Via Profile'),
92 'CRM_Contribute_Form_Task_PickProfile',
93 'CRM_Contribute_Form_Task_Batch',
98 'title' => ts('Send Email to Contacts'),
99 'class' => 'CRM_Contribute_Form_Task_Email',
103 'title' => ts('Update Pending Contribution Status'),
104 'class' => 'CRM_Contribute_Form_Task_Status',
108 'title' => ts('Print or Email Contribution Receipts'),
109 'class' => 'CRM_Contribute_Form_Task_PDF',
113 'title' => ts('Thank-you Letters for Contributions'),
114 'class' => 'CRM_Contribute_Form_Task_PDFLetter',
118 'title' => ts('Print or Email Contribution Invoices'),
119 'class' => 'CRM_Contribute_Form_Task_Invoice',
124 //CRM-4418, check for delete
125 if (!CRM_Core_Permission
::check('delete in CiviContribute')) {
126 unset(self
::$_tasks[1]);
128 //CRM-12920 - check for edit permission
129 if( !CRM_Core_Permission
::check('edit contributions') ){
130 unset(self
::$_tasks[4],self
::$_tasks[6]);
133 // remove action "Print or Email Contribution Invoices"
134 $invoiceSettings = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::CONTRIBUTE_PREFERENCES_NAME
, 'contribution_invoice_settings');
135 $invoicing = CRM_Utils_Array
::value('invoicing', $invoiceSettings);
137 unset(self
::$_tasks[9]);
139 CRM_Utils_Hook
::searchTasks('contribution', self
::$_tasks);
140 asort(self
::$_tasks);
143 return self
::$_tasks;
147 * These tasks are the core set of task titles
150 * @return array the set of task titles
154 static function &taskTitles() {
157 foreach (self
::$_tasks as $id => $value) {
158 $titles[$id] = $value['title'];
164 * Show tasks selectively based on the permission level
167 * @param int $permission
169 * @param bool $softCreditFiltering
171 * @return array set of tasks that are valid for the user
174 static function &permissionedTaskTitles($permission, $softCreditFiltering = FALSE) {
176 if (($permission == CRM_Core_Permission
::EDIT
)
177 || CRM_Core_Permission
::check('edit contributions')
179 $tasks = self
::taskTitles();
183 3 => self
::$_tasks[3]['title'],
184 5 => self
::$_tasks[5]['title'],
185 7 => self
::$_tasks[7]['title'],
189 if (CRM_Core_Permission
::check('delete in CiviContribute')) {
190 $tasks[1] = self
::$_tasks[1]['title'];
193 if ($softCreditFiltering) {
194 unset($tasks[4], $tasks[7]);
200 * These tasks are the core set of tasks that the user can perform
205 * @return array the set of tasks for a group of contributors
209 static function getTask($value) {
211 if (!$value ||
!CRM_Utils_Array
::value($value, self
::$_tasks)) {
212 // make the print task by default
215 // this is possible since hooks can inject a task
217 if (!isset(self
::$_tasks[$value]['result'])) {
218 self
::$_tasks[$value]['result'] = NULL;
221 self
::$_tasks[$value]['class'],
222 self
::$_tasks[$value]['result'],