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_Contact_Task
{
51 HOUSEHOLD_CONTACTS
= 9,
52 ORGANIZATION_CONTACTS
= 10,
56 SAVE_SEARCH_UPDATE
= 14,
61 PRINT_FOR_CONTACTS
= 19,
66 DELETE_PERMANENTLY
= 24,
67 COMMUNICATION_PREFS
= 25;
75 static $_tasks = NULL;
78 * the optional task array
83 static $_optionalTasks = NULL;
85 static function initTasks() {
87 self
::$_tasks = array(
88 self
::GROUP_CONTACTS
=> array(
89 'title' => ts('Add Contacts to Group'),
90 'class' => 'CRM_Contact_Form_Task_AddToGroup',
92 self
::REMOVE_CONTACTS
=> array(
93 'title' => ts('Remove Contacts from Group'),
94 'class' => 'CRM_Contact_Form_Task_RemoveFromGroup',
96 self
::TAG_CONTACTS
=> array(
97 'title' => ts('Tag Contacts (assign tags)'),
98 'class' => 'CRM_Contact_Form_Task_AddToTag',
100 self
::REMOVE_TAGS
=> array(
101 'title' => ts('Untag Contacts (remove tags)'),
102 'class' => 'CRM_Contact_Form_Task_RemoveFromTag',
104 self
::EXPORT_CONTACTS
=> array(
105 'title' => ts('Export Contacts'),
107 'CRM_Export_Form_Select',
108 'CRM_Export_Form_Map',
112 self
::EMAIL_CONTACTS
=> array(
113 'title' => ts('Send Email to Contacts'),
114 'class' => 'CRM_Contact_Form_Task_Email',
117 self
::SMS_CONTACTS
=> array(
118 'title' => ts('Send SMS to Contacts'),
119 'class' => 'CRM_Contact_Form_Task_SMS',
122 self
::DELETE_CONTACTS
=> array(
123 'title' => ts('Delete Contacts'),
124 'class' => 'CRM_Contact_Form_Task_Delete',
127 self
::RECORD_CONTACTS
=> array(
128 'title' => ts('Record Activity for Contacts'),
129 'class' => 'CRM_Activity_Form_Activity',
131 self
::SAVE_SEARCH
=> array(
132 'title' => ts('New Smart Group'),
133 'class' => 'CRM_Contact_Form_Task_SaveSearch',
136 self
::SAVE_SEARCH_UPDATE
=> array(
137 'title' => ts('Update Smart Group'),
138 'class' => 'CRM_Contact_Form_Task_SaveSearch_Update',
141 self
::PRINT_CONTACTS
=> array(
142 'title' => ts('Print Selected Rows'),
143 'class' => 'CRM_Contact_Form_Task_Print',
146 self
::LABEL_CONTACTS
=> array(
147 'title' => ts('Mailing Labels'),
148 'class' => 'CRM_Contact_Form_Task_Label',
151 self
::BATCH_UPDATE
=> array(
152 'title' => ts('Batch Update via Profile'),
154 'CRM_Contact_Form_Task_PickProfile',
155 'CRM_Contact_Form_Task_Batch',
159 self
::PRINT_FOR_CONTACTS
=> array(
160 'title' => ts('Print PDF Letter for Contacts'),
161 'class' => 'CRM_Contact_Form_Task_PDF',
164 self
::EMAIL_UNHOLD
=> array(
165 'title' => ts('Unhold Emails'),
166 'class' => 'CRM_Contact_Form_Task_Unhold',
168 self
::COMMUNICATION_PREFS
=> array(
169 'title' => ts('Alter Contact Communication Preferences'),
170 'class' => 'CRM_Contact_Form_Task_AlterPreferences',
172 self
::RESTORE
=> array(
173 'title' => ts('Restore Contacts'),
174 'class' => 'CRM_Contact_Form_Task_Delete',
177 self
::DELETE_PERMANENTLY
=> array(
178 'title' => ts('Delete Permanently'),
179 'class' => 'CRM_Contact_Form_Task_Delete',
184 if (CRM_Contact_BAO_ContactType
::isActive('Household')) {
185 $label = CRM_Contact_BAO_ContactType
::getLabel('Household');
186 self
::$_tasks[self
::HOUSEHOLD_CONTACTS
] = array(
187 'title' => ts('Add Contacts to %1',
190 'class' => 'CRM_Contact_Form_Task_AddToHousehold',
194 if (CRM_Contact_BAO_ContactType
::isActive('Organization')) {
195 $label = CRM_Contact_BAO_ContactType
::getLabel('Organization');
196 self
::$_tasks[self
::ORGANIZATION_CONTACTS
] = array(
197 'title' => ts('Add Contacts to %1',
200 'class' => 'CRM_Contact_Form_Task_AddToOrganization',
204 if (CRM_Core_Permission
::check('merge duplicate contacts')) {
205 self
::$_tasks[self
::MERGE_CONTACTS
] = array(
206 'title' => ts('Merge Contacts'),
207 'class' => 'CRM_Contact_Form_Task_Merge',
212 //CRM-4418, check for delete
213 if (!CRM_Core_Permission
::check('delete contacts')) {
214 unset(self
::$_tasks[self
::DELETE_CONTACTS
]);
217 //show map action only if map provider and geoprovider are set (Google doesn't need geoprovider)
218 // should fix this to be more flexible as providers are added ??
219 $config = CRM_Core_Config
::singleton();
221 if ($config->mapProvider
&&
222 ($config->mapProvider
== 'Google' ||
223 ($config->mapProvider
== 'OpenStreetMaps' ||
224 $config->geoProvider
== 'Google'
228 self
::$_tasks[self
::MAP_CONTACTS
] = array(
229 'title' => ts('Map Contacts'),
230 'class' => 'CRM_Contact_Form_Task_Map',
235 if (CRM_Core_Permission
::access('CiviEvent')) {
236 self
::$_tasks[self
::ADD_EVENT
] = array(
237 'title' => ts('Add Contacts to Event'),
238 'class' => 'CRM_Event_Form_Participant',
242 if (CRM_Core_Permission
::access('CiviMail')) {
243 self
::$_tasks[self
::CREATE_MAILING
] = array(
244 'title' => ts('Schedule/Send a Mass Mailing'),
246 'CRM_Mailing_Form_Group',
247 'CRM_Mailing_Form_Settings',
248 'CRM_Mailing_Form_Upload',
249 'CRM_Mailing_Form_Test',
250 'CRM_Mailing_Form_Schedule',
255 elseif (CRM_Mailing_Info
::workflowEnabled() &&
256 CRM_Core_Permission
::check('create mailings')
258 self
::$_tasks[self
::CREATE_MAILING
] = array(
259 'title' => ts('Create a Mass Mailing'),
261 'CRM_Mailing_Form_Group',
262 'CRM_Mailing_Form_Settings',
263 'CRM_Mailing_Form_Upload',
264 'CRM_Mailing_Form_Test',
270 self
::$_tasks +
= CRM_Core_Component
::taskList();
272 CRM_Utils_Hook
::searchTasks('contact', self
::$_tasks);
274 asort(self
::$_tasks);
279 * These tasks are the core set of tasks that the user can perform
280 * on a contact / group of contacts
282 * @return array the set of tasks for a group of contacts
286 static function &taskTitles() {
290 foreach (self
::$_tasks as $id => $value) {
291 $titles[$id] = $value['title'];
294 // hack unset update saved search
295 unset($titles[self
::SAVE_SEARCH_UPDATE
]);
297 if (!CRM_Utils_Mail
::validOutBoundMail()) {
298 unset($titles[self
::EMAIL_CONTACTS
]);
299 unset($titles[self
::CREATE_MAILING
]);
303 if (!CRM_Core_Permission
::check('access deleted contacts') ||
304 !CRM_Core_Permission
::check('delete contacts')
306 unset($titles[self
::DELETE_PERMANENTLY
]);
313 * show tasks selectively based on the permission level
316 * @param int $permission
317 * @param bool $deletedContacts are these tasks for operating on deleted contacts?
319 * @return array set of tasks that are valid for the user
322 static function &permissionedTaskTitles($permission, $deletedContacts = FALSE) {
325 if ($deletedContacts) {
326 if (CRM_Core_Permission
::check('access deleted contacts')) {
327 $tasks[self
::RESTORE
] = self
::$_tasks[self
::RESTORE
]['title'];
328 if (CRM_Core_Permission
::check('delete contacts')) {
329 $tasks[self
::DELETE_PERMANENTLY
] = self
::$_tasks[self
::DELETE_PERMANENTLY
]['title'];
333 elseif ($permission == CRM_Core_Permission
::EDIT
) {
334 $tasks = self
::taskTitles();
338 self
::EXPORT_CONTACTS
=> self
::$_tasks[self
::EXPORT_CONTACTS
]['title'],
339 self
::EMAIL_CONTACTS
=> self
::$_tasks[self
::EMAIL_CONTACTS
]['title'],
340 self
::LABEL_CONTACTS
=> self
::$_tasks[self
::LABEL_CONTACTS
]['title'],
343 if (isset(self
::$_tasks[self
::MAP_CONTACTS
]) &&
344 !empty(self
::$_tasks[self
::MAP_CONTACTS
]['title'])
346 $tasks[self
::MAP_CONTACTS
] = self
::$_tasks[self
::MAP_CONTACTS
]['title'];
349 if (isset(self
::$_tasks[self
::CREATE_MAILING
]) &&
350 !empty(self
::$_tasks[self
::CREATE_MAILING
]['title'])
352 $tasks[self
::CREATE_MAILING
] = self
::$_tasks[self
::CREATE_MAILING
]['title'];
359 * These tasks get added based on the context the user is in
361 * @return array the set of optional tasks for a group of contacts
365 static function &optionalTaskTitle() {
367 self
::SAVE_SEARCH_UPDATE
=> self
::$_tasks[self
::SAVE_SEARCH_UPDATE
]['title'],
372 static function getTask($value) {
375 if (!CRM_Utils_Array
::value($value, self
::$_tasks)) {
376 // make it the print task by default
377 $value = self
::PRINT_CONTACTS
;
380 CRM_Utils_Array
::value('class', self
::$_tasks[$value]),
381 CRM_Utils_Array
::value('result', self
::$_tasks[$value]),