3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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-2017
35 * Class to represent the actions that can be performed on a group of contacts.
37 * Used by the search forms.
39 class CRM_Contribute_Task
{
40 const DELETE_CONTRIBUTIONS
= 1, PRINT_CONTRIBUTIONS
= 2, EXPORT_CONTRIBUTIONS
= 3, BATCH_CONTRIBUTIONS
= 4, EMAIL_CONTACTS
= 5, UPDATE_STATUS
= 6, PDF_RECEIPT
= 7;
47 static $_tasks = NULL;
50 * The optional task array
54 static $_optionalTasks = NULL;
57 * These tasks are the core set of tasks that the user can perform
58 * on a contact / group of contacts
61 * the set of tasks for a group of contacts
63 public static function tasks() {
64 if (!(self
::$_tasks)) {
65 self
::$_tasks = array(
67 'title' => ts('Delete contributions'),
68 'class' => 'CRM_Contribute_Form_Task_Delete',
72 'title' => ts('Print selected rows'),
73 'class' => 'CRM_Contribute_Form_Task_Print',
77 'title' => ts('Export contributions'),
79 'CRM_Export_Form_Select',
80 'CRM_Export_Form_Map',
85 'title' => ts('Update multiple contributions'),
87 'CRM_Contribute_Form_Task_PickProfile',
88 'CRM_Contribute_Form_Task_Batch',
93 'title' => ts('Email - send now (to %1 or less)', array(
95 ->get('simple_mail_limit'),
97 'class' => 'CRM_Contribute_Form_Task_Email',
101 'title' => ts('Update pending contribution status'),
102 'class' => 'CRM_Contribute_Form_Task_Status',
106 'title' => ts('Receipts - print or email'),
107 'class' => 'CRM_Contribute_Form_Task_PDF',
111 'title' => ts('Thank-you letters - print or email'),
112 'class' => 'CRM_Contribute_Form_Task_PDFLetter',
116 'title' => ts('Invoices - print or email'),
117 'class' => 'CRM_Contribute_Form_Task_Invoice',
122 //CRM-4418, check for delete
123 if (!CRM_Core_Permission
::check('delete in CiviContribute')) {
124 unset(self
::$_tasks[1]);
126 //CRM-12920 - check for edit permission
127 if (!CRM_Core_Permission
::check('edit contributions')) {
128 unset(self
::$_tasks[4], self
::$_tasks[6]);
131 // remove action "Invoices - print or email"
132 $invoiceSettings = Civi
::settings()->get('contribution_invoice_settings');
133 $invoicing = CRM_Utils_Array
::value('invoicing', $invoiceSettings);
135 unset(self
::$_tasks[9]);
138 CRM_Utils_Hook
::searchTasks('contribution', self
::$_tasks);
139 asort(self
::$_tasks);
142 return self
::$_tasks;
146 * These tasks are the core set of task titles
150 * the set of task titles
152 public static function &taskTitles() {
155 foreach (self
::$_tasks as $id => $value) {
156 $titles[$id] = $value['title'];
162 * Show tasks selectively based on the permission level
165 * @param int $permission
167 * @param bool $softCreditFiltering
170 * set of tasks that are valid for the user
172 public static function &permissionedTaskTitles($permission, $softCreditFiltering = FALSE) {
174 if (($permission == CRM_Core_Permission
::EDIT
)
175 || CRM_Core_Permission
::check('edit contributions')
177 $tasks = self
::taskTitles();
181 3 => self
::$_tasks[3]['title'],
182 5 => self
::$_tasks[5]['title'],
183 7 => self
::$_tasks[7]['title'],
187 if (CRM_Core_Permission
::check('delete in CiviContribute')) {
188 $tasks[1] = self
::$_tasks[1]['title'];
191 if ($softCreditFiltering) {
192 unset($tasks[4], $tasks[7]);
198 * These tasks are the core set of tasks that the user can perform
204 * the set of tasks for a group of contributors
206 public static function getTask($value) {
208 if (!$value ||
!CRM_Utils_Array
::value($value, self
::$_tasks)) {
209 // make the print task by default
212 // this is possible since hooks can inject a task
214 if (!isset(self
::$_tasks[$value]['result'])) {
215 self
::$_tasks[$value]['result'] = NULL;
218 self
::$_tasks[$value]['class'],
219 self
::$_tasks[$value]['result'],