3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * Class to represent the actions that can be performed on a group of contacts.
21 * Used by the search forms.
23 class CRM_Contribute_Task
extends CRM_Core_Task
{
37 public static $objectType = 'contribution';
40 * These tasks are the core set of tasks that the user can perform
41 * on a contact / group of contacts
44 * the set of tasks for a group of contacts
46 public static function tasks() {
47 if (!(self
::$_tasks)) {
49 self
::TASK_DELETE
=> [
50 'title' => ts('Delete contributions'),
51 'class' => 'CRM_Contribute_Form_Task_Delete',
55 'title' => ts('Print selected rows'),
56 'class' => 'CRM_Contribute_Form_Task_Print',
59 self
::TASK_EXPORT
=> [
60 'title' => ts('Export contributions'),
62 'CRM_Export_Form_Select',
63 'CRM_Export_Form_Map',
67 self
::BATCH_UPDATE
=> [
68 'title' => ts('Update multiple contributions'),
70 'CRM_Contribute_Form_Task_PickProfile',
71 'CRM_Contribute_Form_Task_Batch',
76 'title' => ts('Email - send now (to %1 or less)', [
78 ->get('simple_mail_limit'),
80 'class' => 'CRM_Contribute_Form_Task_Email',
83 self
::UPDATE_STATUS
=> [
84 'title' => ts('Update pending contribution status'),
85 'class' => 'CRM_Contribute_Form_Task_Status',
88 self
::PDF_RECEIPT
=> [
89 'title' => ts('Receipts - print or email'),
90 'class' => 'CRM_Contribute_Form_Task_PDF',
93 self
::PDF_THANKYOU
=> [
94 'title' => ts('Thank-you letters - print or email'),
95 'class' => 'CRM_Contribute_Form_Task_PDFLetter',
98 self
::PDF_INVOICE
=> [
99 'title' => ts('Invoices - print or email'),
100 'class' => 'CRM_Contribute_Form_Task_Invoice',
105 //CRM-4418, check for delete
106 if (!CRM_Core_Permission
::check('delete in CiviContribute')) {
107 unset(self
::$_tasks[self
::TASK_DELETE
]);
109 //CRM-12920 - check for edit permission
110 if (!CRM_Core_Permission
::check('edit contributions')) {
111 unset(self
::$_tasks[self
::BATCH_UPDATE
], self
::$_tasks[self
::UPDATE_STATUS
]);
114 // remove action "Invoices - print or email"
115 $invoicing = CRM_Invoicing_Utils
::isInvoicingEnabled();
117 unset(self
::$_tasks[self
::PDF_INVOICE
]);
123 return self
::$_tasks;
127 * Show tasks selectively based on the permission level
130 * @param int $permission
132 * @param array $params
133 * bool softCreditFiltering: derived from CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled
136 * set of tasks that are valid for the user
138 public static function permissionedTaskTitles($permission, $params = []) {
139 if (!isset($params['softCreditFiltering'])) {
140 $params['softCreditFiltering'] = FALSE;
142 if (($permission == CRM_Core_Permission
::EDIT
)
143 || CRM_Core_Permission
::check('edit contributions')
145 $tasks = self
::taskTitles();
149 self
::TASK_EXPORT
=> self
::$_tasks[self
::TASK_EXPORT
]['title'],
150 self
::TASK_EMAIL
=> self
::$_tasks[self
::TASK_EMAIL
]['title'],
151 self
::PDF_RECEIPT
=> self
::$_tasks[self
::PDF_RECEIPT
]['title'],
155 if (CRM_Core_Permission
::check('delete in CiviContribute')) {
156 $tasks[self
::TASK_DELETE
] = self
::$_tasks[self
::TASK_DELETE
]['title'];
159 if ($params['softCreditFiltering']) {
160 unset($tasks[self
::BATCH_UPDATE
], $tasks[self
::PDF_RECEIPT
]);
163 $tasks = parent
::corePermissionedTaskTitles($tasks, $permission, $params);
168 * These tasks are the core set of tasks that the user can perform
174 * the set of tasks for a group of contributors
176 public static function getTask($value) {
178 if (!$value ||
empty(self
::$_tasks[$value])) {
179 // make the print task by default
180 $value = self
::TASK_PRINT
;
182 return parent
::getTask($value);