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 used by the search forms.
37 class CRM_Contact_Task
{
47 HOUSEHOLD_CONTACTS
= 9,
48 ORGANIZATION_CONTACTS
= 10,
52 SAVE_SEARCH_UPDATE
= 14,
57 PRINT_FOR_CONTACTS
= 19,
62 DELETE_PERMANENTLY
= 24,
63 COMMUNICATION_PREFS
= 25,
64 INDIVIDUAL_CONTACTS
= 26;
71 static $_tasks = NULL;
74 * The optional task array
78 static $_optionalTasks = NULL;
80 public static function initTasks() {
82 self
::$_tasks = array(
83 self
::GROUP_CONTACTS
=> array(
84 'title' => ts('Group - add contacts'),
85 'class' => 'CRM_Contact_Form_Task_AddToGroup',
86 'url' => 'civicrm/task/add-to-group',
88 self
::REMOVE_CONTACTS
=> array(
89 'title' => ts('Group - remove contacts'),
90 'class' => 'CRM_Contact_Form_Task_RemoveFromGroup',
91 'url' => 'civicrm/task/remove-from-group',
93 self
::TAG_CONTACTS
=> array(
94 'title' => ts('Tag - add to contacts'),
95 'class' => 'CRM_Contact_Form_Task_AddToTag',
96 'url' => 'civicrm/task/add-to-tag',
98 self
::REMOVE_TAGS
=> array(
99 'title' => ts('Tag - remove from contacts'),
100 'class' => 'CRM_Contact_Form_Task_RemoveFromTag',
101 'url' => 'civicrm/task/remove-from-tag',
103 self
::EXPORT_CONTACTS
=> array(
104 'title' => ts('Export contacts'),
106 'CRM_Export_Form_Select',
107 'CRM_Export_Form_Map',
111 self
::EMAIL_CONTACTS
=> array(
112 'title' => ts('Email - send now (to 50 or less)'),
113 'class' => 'CRM_Contact_Form_Task_Email',
115 'url' => 'civicrm/task/send-email',
117 self
::DELETE_CONTACTS
=> array(
118 'title' => ts('Delete contacts'),
119 'class' => 'CRM_Contact_Form_Task_Delete',
121 'url' => 'civicrm/task/delete-contact',
123 self
::RECORD_CONTACTS
=> array(
124 'title' => ts('Add activity'),
125 'class' => 'CRM_Activity_Form_Activity',
127 self
::SAVE_SEARCH
=> array(
128 'title' => ts('Group - create smart group'),
129 'class' => 'CRM_Contact_Form_Task_SaveSearch',
132 self
::SAVE_SEARCH_UPDATE
=> array(
133 'title' => ts('Group - update smart group'),
134 'class' => 'CRM_Contact_Form_Task_SaveSearch_Update',
137 self
::PRINT_CONTACTS
=> array(
138 'title' => ts('Print selected rows'),
139 'class' => 'CRM_Contact_Form_Task_Print',
142 self
::LABEL_CONTACTS
=> array(
143 'title' => ts('Mailing labels - print'),
144 'class' => 'CRM_Contact_Form_Task_Label',
146 'url' => 'civicrm/task/make-mailing-label',
148 self
::BATCH_UPDATE
=> array(
149 'title' => ts('Update multiple contacts'),
151 'CRM_Contact_Form_Task_PickProfile',
152 'CRM_Contact_Form_Task_Batch',
155 'url' => 'civicrm/task/pick-profile',
157 self
::PRINT_FOR_CONTACTS
=> array(
158 'title' => ts('Print/merge document'),
159 'class' => 'CRM_Contact_Form_Task_PDF',
161 'url' => 'civicrm/task/print-document',
163 self
::EMAIL_UNHOLD
=> array(
164 'title' => ts('Email - unhold addresses'),
165 'class' => 'CRM_Contact_Form_Task_Unhold',
166 'url' => 'civicrm/task/unhold-email',
168 self
::COMMUNICATION_PREFS
=> array(
169 'title' => ts('Communication preferences - alter'),
170 'class' => 'CRM_Contact_Form_Task_AlterPreferences',
171 'url' => 'civicrm/task/alter-contact-preference',
173 self
::RESTORE
=> array(
174 'title' => ts('Restore contacts from trash'),
175 'class' => 'CRM_Contact_Form_Task_Delete',
178 self
::DELETE_PERMANENTLY
=> array(
179 'title' => ts('Delete permanently'),
180 'class' => 'CRM_Contact_Form_Task_Delete',
185 //CRM-16329, if SMS provider is configured show sms action.
186 $providersCount = CRM_SMS_BAO_Provider
::activeProviderCount();
187 if ($providersCount) {
188 self
::$_tasks[self
::SMS_CONTACTS
] = array(
189 'title' => ts('SMS - schedule/send'),
190 'class' => 'CRM_Contact_Form_Task_SMS',
195 if (CRM_Contact_BAO_ContactType
::isActive('Individual')) {
196 $label = CRM_Contact_BAO_ContactType
::getLabel('individual');
197 self
::$_tasks[self
::INDIVIDUAL_CONTACTS
] = array(
198 'title' => ts('Add relationship - to %1',
201 'class' => 'CRM_Contact_Form_Task_AddToIndividual',
205 if (CRM_Contact_BAO_ContactType
::isActive('Household')) {
206 $label = CRM_Contact_BAO_ContactType
::getLabel('household');
207 self
::$_tasks[self
::HOUSEHOLD_CONTACTS
] = array(
208 'title' => ts('Add relationship - to %1',
211 'class' => 'CRM_Contact_Form_Task_AddToHousehold',
215 if (CRM_Contact_BAO_ContactType
::isActive('Organization')) {
216 $label = CRM_Contact_BAO_ContactType
::getLabel('organization');
217 self
::$_tasks[self
::ORGANIZATION_CONTACTS
] = array(
218 'title' => ts('Add relationship - to %1',
221 'class' => 'CRM_Contact_Form_Task_AddToOrganization',
225 if (CRM_Core_Permission
::check('merge duplicate contacts')) {
226 self
::$_tasks[self
::MERGE_CONTACTS
] = array(
227 'title' => ts('Merge contacts'),
228 'class' => 'CRM_Contact_Form_Task_Merge',
233 //CRM-4418, check for delete
234 if (!CRM_Core_Permission
::check('delete contacts')) {
235 unset(self
::$_tasks[self
::DELETE_CONTACTS
]);
238 //show map action only if map provider and geoprovider are set (Google doesn't need geoprovider)
239 // should fix this to be more flexible as providers are added ??
240 $config = CRM_Core_Config
::singleton();
242 if ($config->mapProvider
&&
243 ($config->mapProvider
== 'Google' ||
244 ($config->mapProvider
== 'OpenStreetMaps' ||
245 $config->geoProvider
== 'Google'
249 self
::$_tasks[self
::MAP_CONTACTS
] = array(
250 'title' => ts('Map contacts'),
251 'class' => 'CRM_Contact_Form_Task_Map',
256 if (CRM_Core_Permission
::access('CiviEvent')) {
257 self
::$_tasks[self
::ADD_EVENT
] = array(
258 'title' => ts('Register participants for event'),
259 'class' => 'CRM_Event_Form_Participant',
263 if (CRM_Core_Permission
::access('CiviMail')
264 ||
(CRM_Mailing_Info
::workflowEnabled() && CRM_Core_Permission
::check('create mailings'))
266 self
::$_tasks[self
::CREATE_MAILING
] = array(
267 'title' => ts('Email - schedule/send via CiviMail'),
268 'class' => 'CRM_Mailing_Form_Task_AdhocMailing',
273 self
::$_tasks +
= CRM_Core_Component
::taskList();
275 CRM_Utils_Hook
::searchTasks('contact', self
::$_tasks);
281 * These tasks are the core set of tasks that the user can perform
282 * on a contact / group of contacts
285 * the set of tasks for a group of contacts
287 public static function &taskTitles() {
291 foreach (self
::$_tasks as $id => $value) {
292 $titles[$id] = $value['title'];
295 // hack unset update saved search
296 unset($titles[self
::SAVE_SEARCH_UPDATE
]);
298 if (!CRM_Utils_Mail
::validOutBoundMail()) {
299 unset($titles[self
::EMAIL_CONTACTS
]);
300 unset($titles[self
::CREATE_MAILING
]);
304 if (!CRM_Core_Permission
::check('access deleted contacts') ||
305 !CRM_Core_Permission
::check('delete contacts')
307 unset($titles[self
::DELETE_PERMANENTLY
]);
313 * Show tasks selectively based on the permission level
316 * @param int $permission
317 * @param bool $deletedContacts
318 * Are these tasks for operating on deleted contacts?.
321 * set of tasks that are valid for the user
323 public static function &permissionedTaskTitles($permission, $deletedContacts = FALSE) {
326 if ($deletedContacts) {
327 if (CRM_Core_Permission
::check('access deleted contacts')) {
328 $tasks[self
::RESTORE
] = self
::$_tasks[self
::RESTORE
]['title'];
329 if (CRM_Core_Permission
::check('delete contacts')) {
330 $tasks[self
::DELETE_PERMANENTLY
] = self
::$_tasks[self
::DELETE_PERMANENTLY
]['title'];
334 elseif ($permission == CRM_Core_Permission
::EDIT
) {
335 $tasks = self
::taskTitles();
339 self
::EXPORT_CONTACTS
=> self
::$_tasks[self
::EXPORT_CONTACTS
]['title'],
340 self
::EMAIL_CONTACTS
=> self
::$_tasks[self
::EMAIL_CONTACTS
]['title'],
341 self
::LABEL_CONTACTS
=> self
::$_tasks[self
::LABEL_CONTACTS
]['title'],
344 if (isset(self
::$_tasks[self
::MAP_CONTACTS
]) &&
345 !empty(self
::$_tasks[self
::MAP_CONTACTS
]['title'])
347 $tasks[self
::MAP_CONTACTS
] = self
::$_tasks[self
::MAP_CONTACTS
]['title'];
350 if (isset(self
::$_tasks[self
::CREATE_MAILING
]) &&
351 !empty(self
::$_tasks[self
::CREATE_MAILING
]['title'])
353 $tasks[self
::CREATE_MAILING
] = self
::$_tasks[self
::CREATE_MAILING
]['title'];
360 * These tasks get added based on the context the user is in.
363 * the set of optional tasks for a group of contacts
365 public static function &optionalTaskTitle() {
367 self
::SAVE_SEARCH_UPDATE
=> self
::$_tasks[self
::SAVE_SEARCH_UPDATE
]['title'],
377 public static function getTask($value) {
380 if (!CRM_Utils_Array
::value($value, self
::$_tasks)) {
381 // make it the print task by default
382 $value = self
::PRINT_CONTACTS
;
385 CRM_Utils_Array
::value('class', self
::$_tasks[$value]),
386 CRM_Utils_Array
::value('result', self
::$_tasks[$value]),
391 * Function to return the task information on basis of provided task's form name
393 * @param string $className
397 public static function getTaskAndTitleByClass($className) {
400 foreach (self
::$_tasks as $task => $value) {
401 if (!empty($value['url']) && (
402 (is_array($value['class']) && in_array($className, $value['class'])) ||
403 ($value['class'] == $className)
408 CRM_Utils_Array
::value('title', $value),