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