drupal-civicrm/sites/all/modules/civicrm/CRM/Contact/Task.php
2018-01-14 13:10:16 +00:00

415 lines
13 KiB
PHP

<?php
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.7 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2017 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| CiviCRM is free software; you can copy, modify, and distribute it |
| under the terms of the GNU Affero General Public License |
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
| |
| CiviCRM is distributed in the hope that it will be useful, but |
| WITHOUT ANY WARRANTY; without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
| See the GNU Affero General Public License for more details. |
| |
| You should have received a copy of the GNU Affero General Public |
| License and the CiviCRM Licensing Exception along |
| with this program; if not, contact CiviCRM LLC |
| at info[AT]civicrm[DOT]org. If you have questions about the |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
/**
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2017
*/
/**
* Class to represent the actions that can be performed on a group of contacts used by the search forms.
*/
class CRM_Contact_Task {
const
GROUP_CONTACTS = 1,
REMOVE_CONTACTS = 2,
TAG_CONTACTS = 3,
REMOVE_TAGS = 4,
EXPORT_CONTACTS = 5,
EMAIL_CONTACTS = 6,
SMS_CONTACTS = 7,
DELETE_CONTACTS = 8,
HOUSEHOLD_CONTACTS = 9,
ORGANIZATION_CONTACTS = 10,
RECORD_CONTACTS = 11,
MAP_CONTACTS = 12,
SAVE_SEARCH = 13,
SAVE_SEARCH_UPDATE = 14,
PRINT_CONTACTS = 15,
LABEL_CONTACTS = 16,
BATCH_UPDATE = 17,
ADD_EVENT = 18,
PRINT_FOR_CONTACTS = 19,
CREATE_MAILING = 20,
MERGE_CONTACTS = 21,
EMAIL_UNHOLD = 22,
RESTORE = 23,
DELETE_PERMANENTLY = 24,
COMMUNICATION_PREFS = 25,
INDIVIDUAL_CONTACTS = 26;
/**
* The task array
*
* @var array
*/
static $_tasks = NULL;
/**
* The optional task array
*
* @var array
*/
static $_optionalTasks = NULL;
public static function initTasks() {
if (!self::$_tasks) {
self::$_tasks = array(
self::GROUP_CONTACTS => array(
'title' => ts('Group - add contacts'),
'class' => 'CRM_Contact_Form_Task_AddToGroup',
'url' => 'civicrm/task/add-to-group',
),
self::REMOVE_CONTACTS => array(
'title' => ts('Group - remove contacts'),
'class' => 'CRM_Contact_Form_Task_RemoveFromGroup',
'url' => 'civicrm/task/remove-from-group',
),
self::TAG_CONTACTS => array(
'title' => ts('Tag - add to contacts'),
'class' => 'CRM_Contact_Form_Task_AddToTag',
'url' => 'civicrm/task/add-to-tag',
),
self::REMOVE_TAGS => array(
'title' => ts('Tag - remove from contacts'),
'class' => 'CRM_Contact_Form_Task_RemoveFromTag',
'url' => 'civicrm/task/remove-from-tag',
),
self::EXPORT_CONTACTS => array(
'title' => ts('Export contacts'),
'class' => array(
'CRM_Export_Form_Select',
'CRM_Export_Form_Map',
),
'result' => FALSE,
),
self::EMAIL_CONTACTS => array(
'title' => ts('Email - send now (to %1 or less)', array(1 => Civi::settings()->get('simple_mail_limit'))),
'class' => 'CRM_Contact_Form_Task_Email',
'result' => TRUE,
'url' => 'civicrm/task/send-email',
),
self::DELETE_CONTACTS => array(
'title' => ts('Delete contacts'),
'class' => 'CRM_Contact_Form_Task_Delete',
'result' => FALSE,
'url' => 'civicrm/task/delete-contact',
),
self::RECORD_CONTACTS => array(
'title' => ts('Add activity'),
'class' => 'CRM_Activity_Form_Activity',
),
self::SAVE_SEARCH => array(
'title' => ts('Group - create smart group'),
'class' => 'CRM_Contact_Form_Task_SaveSearch',
'result' => TRUE,
),
self::SAVE_SEARCH_UPDATE => array(
'title' => ts('Group - update smart group'),
'class' => 'CRM_Contact_Form_Task_SaveSearch_Update',
'result' => TRUE,
),
self::PRINT_CONTACTS => array(
'title' => ts('Print selected rows'),
'class' => 'CRM_Contact_Form_Task_Print',
'result' => FALSE,
),
self::LABEL_CONTACTS => array(
'title' => ts('Mailing labels - print'),
'class' => 'CRM_Contact_Form_Task_Label',
'result' => TRUE,
'url' => 'civicrm/task/make-mailing-label',
),
self::BATCH_UPDATE => array(
'title' => ts('Update multiple contacts'),
'class' => array(
'CRM_Contact_Form_Task_PickProfile',
'CRM_Contact_Form_Task_Batch',
),
'result' => TRUE,
'url' => 'civicrm/task/pick-profile',
),
self::PRINT_FOR_CONTACTS => array(
'title' => ts('Print/merge document'),
'class' => 'CRM_Contact_Form_Task_PDF',
'result' => TRUE,
'url' => 'civicrm/task/print-document',
),
self::EMAIL_UNHOLD => array(
'title' => ts('Email - unhold addresses'),
'class' => 'CRM_Contact_Form_Task_Unhold',
'url' => 'civicrm/task/unhold-email',
),
self::COMMUNICATION_PREFS => array(
'title' => ts('Communication preferences - alter'),
'class' => 'CRM_Contact_Form_Task_AlterPreferences',
'url' => 'civicrm/task/alter-contact-preference',
),
self::RESTORE => array(
'title' => ts('Restore contacts from trash'),
'class' => 'CRM_Contact_Form_Task_Delete',
'result' => FALSE,
),
self::DELETE_PERMANENTLY => array(
'title' => ts('Delete permanently'),
'class' => 'CRM_Contact_Form_Task_Delete',
'result' => FALSE,
),
);
//CRM-16329, if SMS provider is configured show sms action.
$providersCount = CRM_SMS_BAO_Provider::activeProviderCount();
if ($providersCount) {
self::$_tasks[self::SMS_CONTACTS] = array(
'title' => ts('SMS - schedule/send'),
'class' => 'CRM_Contact_Form_Task_SMS',
'result' => TRUE,
);
}
if (CRM_Contact_BAO_ContactType::isActive('Individual')) {
$label = CRM_Contact_BAO_ContactType::getLabel('individual');
self::$_tasks[self::INDIVIDUAL_CONTACTS] = array(
'title' => ts('Add relationship - to %1',
array(1 => $label)
),
'class' => 'CRM_Contact_Form_Task_AddToIndividual',
);
}
if (CRM_Contact_BAO_ContactType::isActive('Household')) {
$label = CRM_Contact_BAO_ContactType::getLabel('household');
self::$_tasks[self::HOUSEHOLD_CONTACTS] = array(
'title' => ts('Add relationship - to %1',
array(1 => $label)
),
'class' => 'CRM_Contact_Form_Task_AddToHousehold',
);
}
if (CRM_Contact_BAO_ContactType::isActive('Organization')) {
$label = CRM_Contact_BAO_ContactType::getLabel('organization');
self::$_tasks[self::ORGANIZATION_CONTACTS] = array(
'title' => ts('Add relationship - to %1',
array(1 => $label)
),
'class' => 'CRM_Contact_Form_Task_AddToOrganization',
);
}
if (CRM_Core_Permission::check('merge duplicate contacts')) {
self::$_tasks[self::MERGE_CONTACTS] = array(
'title' => ts('Merge contacts'),
'class' => 'CRM_Contact_Form_Task_Merge',
'result' => TRUE,
);
}
//CRM-4418, check for delete
if (!CRM_Core_Permission::check('delete contacts')) {
unset(self::$_tasks[self::DELETE_CONTACTS]);
}
//show map action only if map provider and geoprovider are set (Google doesn't need geoprovider)
// should fix this to be more flexible as providers are added ??
$config = CRM_Core_Config::singleton();
if ($config->mapProvider &&
($config->mapProvider == 'Google' ||
($config->mapProvider == 'OpenStreetMaps' ||
$config->geoProvider == 'Google'
)
)
) {
self::$_tasks[self::MAP_CONTACTS] = array(
'title' => ts('Map contacts'),
'class' => 'CRM_Contact_Form_Task_Map',
'result' => FALSE,
);
}
if (CRM_Core_Permission::access('CiviEvent')) {
self::$_tasks[self::ADD_EVENT] = array(
'title' => ts('Register participants for event'),
'class' => 'CRM_Event_Form_Participant',
);
}
if (CRM_Core_Permission::access('CiviMail')
|| (CRM_Mailing_Info::workflowEnabled() && CRM_Core_Permission::check('create mailings'))
) {
self::$_tasks[self::CREATE_MAILING] = array(
'title' => ts('Email - schedule/send via CiviMail'),
'class' => 'CRM_Mailing_Form_Task_AdhocMailing',
'result' => FALSE,
);
}
self::$_tasks += CRM_Core_Component::taskList();
CRM_Utils_Hook::searchTasks('contact', self::$_tasks);
}
}
/**
* These tasks are the core set of tasks that the user can perform
* on a contact / group of contacts
*
* @return array
* the set of tasks for a group of contacts
*/
public static function &taskTitles() {
self::initTasks();
$titles = array();
foreach (self::$_tasks as $id => $value) {
$titles[$id] = $value['title'];
}
// hack unset update saved search
unset($titles[self::SAVE_SEARCH_UPDATE]);
if (!CRM_Utils_Mail::validOutBoundMail()) {
unset($titles[self::EMAIL_CONTACTS]);
unset($titles[self::CREATE_MAILING]);
}
// CRM-6806
if (!CRM_Core_Permission::check('access deleted contacts') ||
!CRM_Core_Permission::check('delete contacts')
) {
unset($titles[self::DELETE_PERMANENTLY]);
}
return $titles;
}
/**
* Show tasks selectively based on the permission level
* of the user
*
* @param int $permission
* @param bool $deletedContacts
* Are these tasks for operating on deleted contacts?.
*
* @return array
* set of tasks that are valid for the user
*/
public static function &permissionedTaskTitles($permission, $deletedContacts = FALSE) {
self::initTasks();
$tasks = array();
if ($deletedContacts) {
if (CRM_Core_Permission::check('access deleted contacts')) {
$tasks[self::RESTORE] = self::$_tasks[self::RESTORE]['title'];
if (CRM_Core_Permission::check('delete contacts')) {
$tasks[self::DELETE_PERMANENTLY] = self::$_tasks[self::DELETE_PERMANENTLY]['title'];
}
}
}
elseif ($permission == CRM_Core_Permission::EDIT) {
$tasks = self::taskTitles();
}
else {
$tasks = array(
self::EXPORT_CONTACTS => self::$_tasks[self::EXPORT_CONTACTS]['title'],
self::EMAIL_CONTACTS => self::$_tasks[self::EMAIL_CONTACTS]['title'],
self::LABEL_CONTACTS => self::$_tasks[self::LABEL_CONTACTS]['title'],
);
if (isset(self::$_tasks[self::MAP_CONTACTS]) &&
!empty(self::$_tasks[self::MAP_CONTACTS]['title'])
) {
$tasks[self::MAP_CONTACTS] = self::$_tasks[self::MAP_CONTACTS]['title'];
}
if (isset(self::$_tasks[self::CREATE_MAILING]) &&
!empty(self::$_tasks[self::CREATE_MAILING]['title'])
) {
$tasks[self::CREATE_MAILING] = self::$_tasks[self::CREATE_MAILING]['title'];
}
}
return $tasks;
}
/**
* These tasks get added based on the context the user is in.
*
* @return array
* the set of optional tasks for a group of contacts
*/
public static function &optionalTaskTitle() {
$tasks = array(
self::SAVE_SEARCH_UPDATE => self::$_tasks[self::SAVE_SEARCH_UPDATE]['title'],
);
return $tasks;
}
/**
* @param $value
*
* @return array
*/
public static function getTask($value) {
self::initTasks();
if (!CRM_Utils_Array::value($value, self::$_tasks)) {
// make it the print task by default
$value = self::PRINT_CONTACTS;
}
return array(
CRM_Utils_Array::value('class', self::$_tasks[$value]),
CRM_Utils_Array::value('result', self::$_tasks[$value]),
);
}
/**
* Function to return the task information on basis of provided task's form name
*
* @param string $className
*
* @return array
*/
public static function getTaskAndTitleByClass($className) {
self::initTasks();
foreach (self::$_tasks as $task => $value) {
if (!empty($value['url']) && (
(is_array($value['class']) && in_array($className, $value['class'])) ||
($value['class'] == $className)
)
) {
return array(
$task,
CRM_Utils_Array::value('title', $value),
);
}
}
}
}