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',
119 //CRM-4418, check for delete
120 if (!CRM_Core_Permission
::check('delete in CiviContribute')) {
121 unset(self
::$_tasks[1]);
124 CRM_Utils_Hook
::searchTasks('contribution', self
::$_tasks);
125 asort(self
::$_tasks);
128 return self
::$_tasks;
132 * These tasks are the core set of task titles
135 * @return array the set of task titles
139 static function &taskTitles() {
142 foreach (self
::$_tasks as $id => $value) {
143 $titles[$id] = $value['title'];
149 * show tasks selectively based on the permission level
152 * @param int $permission
154 * @param bool $softCreditFiltering
156 * @return array set of tasks that are valid for the user
159 static function &permissionedTaskTitles($permission, $softCreditFiltering = FALSE) {
161 if (($permission == CRM_Core_Permission
::EDIT
)
162 || CRM_Core_Permission
::check('edit contributions')
164 $tasks = self
::taskTitles();
168 3 => self
::$_tasks[3]['title'],
169 5 => self
::$_tasks[5]['title'],
170 7 => self
::$_tasks[7]['title'],
174 if (CRM_Core_Permission
::check('delete in CiviContribute')) {
175 $tasks[1] = self
::$_tasks[1]['title'];
178 if ($softCreditFiltering) {
179 unset($tasks[4], $tasks[7]);
185 * These tasks are the core set of tasks that the user can perform
190 * @return array the set of tasks for a group of contributors
194 static function getTask($value) {
196 if (!$value ||
!CRM_Utils_Array
::value($value, self
::$_tasks)) {
197 // make the print task by default
200 // this is possible since hooks can inject a task
202 if (!isset(self
::$_tasks[$value]['result'])) {
203 self
::$_tasks[$value]['result'] = NULL;
206 self
::$_tasks[$value]['class'],
207 self
::$_tasks[$value]['result'],