Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
0f03f337 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
0f03f337 | 31 | * @copyright CiviCRM LLC (c) 2004-2017 |
6a488035 TO |
32 | */ |
33 | ||
34 | /** | |
347e061b | 35 | * Class to represent the actions that can be performed on a group of contacts. |
6a488035 | 36 | * |
347e061b | 37 | * Used by the search forms. |
6a488035 TO |
38 | */ |
39 | class CRM_Contribute_Task { | |
7da04cde | 40 | const DELETE_CONTRIBUTIONS = 1, PRINT_CONTRIBUTIONS = 2, EXPORT_CONTRIBUTIONS = 3, BATCH_CONTRIBUTIONS = 4, EMAIL_CONTACTS = 5, UPDATE_STATUS = 6, PDF_RECEIPT = 7; |
6a488035 TO |
41 | |
42 | /** | |
100fef9d | 43 | * The task array |
6a488035 TO |
44 | * |
45 | * @var array | |
6a488035 TO |
46 | */ |
47 | static $_tasks = NULL; | |
48 | ||
49 | /** | |
100fef9d | 50 | * The optional task array |
6a488035 TO |
51 | * |
52 | * @var array | |
6a488035 TO |
53 | */ |
54 | static $_optionalTasks = NULL; | |
55 | ||
56 | /** | |
57 | * These tasks are the core set of tasks that the user can perform | |
58 | * on a contact / group of contacts | |
59 | * | |
a6c01b45 CW |
60 | * @return array |
61 | * the set of tasks for a group of contacts | |
6a488035 | 62 | */ |
42e8b05c | 63 | public static function tasks() { |
6a488035 TO |
64 | if (!(self::$_tasks)) { |
65 | self::$_tasks = array( | |
23546577 | 66 | 1 => array( |
7f82e636 | 67 | 'title' => ts('Delete contributions'), |
6a488035 TO |
68 | 'class' => 'CRM_Contribute_Form_Task_Delete', |
69 | 'result' => FALSE, | |
70 | ), | |
23546577 | 71 | 2 => array( |
7f82e636 | 72 | 'title' => ts('Print selected rows'), |
6a488035 TO |
73 | 'class' => 'CRM_Contribute_Form_Task_Print', |
74 | 'result' => FALSE, | |
75 | ), | |
23546577 | 76 | 3 => array( |
7f82e636 | 77 | 'title' => ts('Export contributions'), |
6a488035 TO |
78 | 'class' => array( |
79 | 'CRM_Export_Form_Select', | |
80 | 'CRM_Export_Form_Map', | |
81 | ), | |
82 | 'result' => FALSE, | |
83 | ), | |
23546577 | 84 | 4 => array( |
b581842f | 85 | 'title' => ts('Update multiple contributions'), |
6a488035 TO |
86 | 'class' => array( |
87 | 'CRM_Contribute_Form_Task_PickProfile', | |
88 | 'CRM_Contribute_Form_Task_Batch', | |
89 | ), | |
90 | 'result' => TRUE, | |
91 | ), | |
23546577 | 92 | 5 => array( |
21d01648 MW |
93 | 'title' => ts('Email - send now (to %1 or less)', array( |
94 | 1 => Civi::settings() | |
95 | ->get('simple_mail_limit'), | |
96 | )), | |
6a488035 TO |
97 | 'class' => 'CRM_Contribute_Form_Task_Email', |
98 | 'result' => TRUE, | |
99 | ), | |
23546577 | 100 | 6 => array( |
7f82e636 | 101 | 'title' => ts('Update pending contribution status'), |
6a488035 TO |
102 | 'class' => 'CRM_Contribute_Form_Task_Status', |
103 | 'result' => TRUE, | |
104 | ), | |
23546577 | 105 | 7 => array( |
79e4c2ad | 106 | 'title' => ts('Receipts - print or email'), |
6a488035 TO |
107 | 'class' => 'CRM_Contribute_Form_Task_PDF', |
108 | 'result' => FALSE, | |
109 | ), | |
23546577 | 110 | 8 => array( |
79e4c2ad | 111 | 'title' => ts('Thank-you letters - print or email'), |
6a488035 TO |
112 | 'class' => 'CRM_Contribute_Form_Task_PDFLetter', |
113 | 'result' => FALSE, | |
114 | ), | |
9849720e | 115 | 9 => array( |
79e4c2ad | 116 | 'title' => ts('Invoices - print or email'), |
9849720e RK |
117 | 'class' => 'CRM_Contribute_Form_Task_Invoice', |
118 | 'result' => FALSE, | |
119 | ), | |
6a488035 TO |
120 | ); |
121 | ||
122 | //CRM-4418, check for delete | |
123 | if (!CRM_Core_Permission::check('delete in CiviContribute')) { | |
124 | unset(self::$_tasks[1]); | |
125 | } | |
447c72b5 | 126 | //CRM-12920 - check for edit permission |
481a74f4 | 127 | if (!CRM_Core_Permission::check('edit contributions')) { |
874c9be7 | 128 | unset(self::$_tasks[4], self::$_tasks[6]); |
447c72b5 | 129 | } |
6a488035 | 130 | |
79e4c2ad | 131 | // remove action "Invoices - print or email" |
aaffa79f | 132 | $invoiceSettings = Civi::settings()->get('contribution_invoice_settings'); |
e0d683cf PB |
133 | $invoicing = CRM_Utils_Array::value('invoicing', $invoiceSettings); |
134 | if (!$invoicing) { | |
135 | unset(self::$_tasks[9]); | |
136 | } | |
4d73a5a7 | 137 | |
6a488035 TO |
138 | CRM_Utils_Hook::searchTasks('contribution', self::$_tasks); |
139 | asort(self::$_tasks); | |
140 | } | |
141 | ||
142 | return self::$_tasks; | |
143 | } | |
144 | ||
145 | /** | |
146 | * These tasks are the core set of task titles | |
147 | * on contributors | |
148 | * | |
a6c01b45 CW |
149 | * @return array |
150 | * the set of task titles | |
6a488035 | 151 | */ |
00be9182 | 152 | public static function &taskTitles() { |
6a488035 TO |
153 | self::tasks(); |
154 | $titles = array(); | |
155 | foreach (self::$_tasks as $id => $value) { | |
e341bbee | 156 | $titles[$id] = $value['title']; |
6a488035 TO |
157 | } |
158 | return $titles; | |
159 | } | |
160 | ||
161 | /** | |
100fef9d | 162 | * Show tasks selectively based on the permission level |
6a488035 TO |
163 | * of the user |
164 | * | |
165 | * @param int $permission | |
166 | * | |
dd244018 EM |
167 | * @param bool $softCreditFiltering |
168 | * | |
a6c01b45 CW |
169 | * @return array |
170 | * set of tasks that are valid for the user | |
6a488035 | 171 | */ |
00be9182 | 172 | public static function &permissionedTaskTitles($permission, $softCreditFiltering = FALSE) { |
6a488035 TO |
173 | $tasks = array(); |
174 | if (($permission == CRM_Core_Permission::EDIT) | |
175 | || CRM_Core_Permission::check('edit contributions') | |
176 | ) { | |
177 | $tasks = self::taskTitles(); | |
178 | } | |
179 | else { | |
180 | $tasks = array( | |
181 | 3 => self::$_tasks[3]['title'], | |
182 | 5 => self::$_tasks[5]['title'], | |
183 | 7 => self::$_tasks[7]['title'], | |
184 | ); | |
185 | ||
186 | //CRM-4418, | |
187 | if (CRM_Core_Permission::check('delete in CiviContribute')) { | |
188 | $tasks[1] = self::$_tasks[1]['title']; | |
189 | } | |
190 | } | |
c410490a DS |
191 | if ($softCreditFiltering) { |
192 | unset($tasks[4], $tasks[7]); | |
193 | } | |
6a488035 TO |
194 | return $tasks; |
195 | } | |
196 | ||
197 | /** | |
198 | * These tasks are the core set of tasks that the user can perform | |
199 | * on contributors | |
200 | * | |
201 | * @param int $value | |
202 | * | |
a6c01b45 CW |
203 | * @return array |
204 | * the set of tasks for a group of contributors | |
6a488035 | 205 | */ |
00be9182 | 206 | public static function getTask($value) { |
6a488035 TO |
207 | self::tasks(); |
208 | if (!$value || !CRM_Utils_Array::value($value, self::$_tasks)) { | |
209 | // make the print task by default | |
210 | $value = 2; | |
211 | } | |
3c247800 DL |
212 | // this is possible since hooks can inject a task |
213 | // CRM-13697 | |
214 | if (!isset(self::$_tasks[$value]['result'])) { | |
215 | self::$_tasks[$value]['result'] = NULL; | |
216 | } | |
6a488035 TO |
217 | return array( |
218 | self::$_tasks[$value]['class'], | |
219 | self::$_tasks[$value]['result'], | |
220 | ); | |
221 | } | |
96025800 | 222 | |
6a488035 | 223 | } |