Skip to content

Commit

Permalink
Convert Contact to use core Task class
Browse files Browse the repository at this point in the history
  • Loading branch information
@mattwire
mattwire committed Jan 28, 2018
1 parent 5201c99 commit 002c046
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 158 deletions.
2 changes: 1 addition & 1 deletion CRM/Contact/Form/Task.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ public static function preProcessCommon(&$form, $useTable = FALSE) {
if ($isStandAlone) {
list($form->_task, $title) = CRM_Contact_Task::getTaskAndTitleByClass(get_class($form));
if (!array_key_exists($form->_task, CRM_Contact_Task::permissionedTaskTitles(CRM_Core_Permission::getPermission()))) {
CRM_Core_Error::fatal(ts('You do not have permission to access this page.'));
CRM_Core_Error::statusBounce(ts('You do not have permission to access this page.'));
}
$form->_contactIds = explode(',', CRM_Utils_Request::retrieve('cids', 'CommaSeparatedIntegers', $form, TRUE));
if (empty($form->_contactIds)) {
Expand Down
189 changes: 47 additions & 142 deletions CRM/Contact/Task.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,93 +34,65 @@
/**
* 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,
ADD_TO_CASE = 27;

/**
* The task array
*
* @var array
*/
static $_tasks = NULL;
class CRM_Contact_Task extends CRM_Core_Task {

/**
* The optional task array
*
* @var array
*/
static $_optionalTasks = NULL;
const
// Contact tasks
HOUSEHOLD_CONTACTS = 101,
ORGANIZATION_CONTACTS = 102,
RECORD_CONTACTS = 103,
MAP_CONTACTS = 104,
ADD_EVENT = 105,
MERGE_CONTACTS = 106,
EMAIL_UNHOLD = 107,
RESTORE = 108,
COMMUNICATION_PREFS = 109,
INDIVIDUAL_CONTACTS = 110,
ADD_TO_CASE = 111;

static $objectType = 'contact';

public static function tasks() {
self::initTasks();
return self::$_tasks;
}

public static function initTasks() {
if (!self::$_tasks) {
self::$_tasks = array(
self::GROUP_CONTACTS => array(
self::GROUP_ADD => array(
'title' => ts('Group - add contacts'),
'class' => 'CRM_Contact_Form_Task_AddToGroup',
'url' => 'civicrm/task/add-to-group',
),
self::REMOVE_CONTACTS => array(
self::GROUP_REMOVE => array(
'title' => ts('Group - remove contacts'),
'class' => 'CRM_Contact_Form_Task_RemoveFromGroup',
'url' => 'civicrm/task/remove-from-group',
),
self::TAG_CONTACTS => array(
self::TAG_ADD => array(
'title' => ts('Tag - add to contacts'),
'class' => 'CRM_Contact_Form_Task_AddToTag',
'url' => 'civicrm/task/add-to-tag',
),
self::REMOVE_TAGS => array(
self::TAG_REMOVE => array(
'title' => ts('Tag - remove from contacts'),
'class' => 'CRM_Contact_Form_Task_RemoveFromTag',
'url' => 'civicrm/task/remove-from-tag',
),
self::EXPORT_CONTACTS => array(
self::TASK_EXPORT => 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'))),
self::EMAIL => 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(
self::TASK_DELETE => array(
'title' => ts('Delete contacts'),
'class' => 'CRM_Contact_Form_Task_Delete',
'result' => FALSE,
Expand All @@ -140,7 +112,7 @@ public static function initTasks() {
'class' => 'CRM_Contact_Form_Task_SaveSearch_Update',
'result' => TRUE,
),
self::PRINT_CONTACTS => array(
self::TASK_PRINT => array(
'title' => ts('Print selected rows'),
'class' => 'CRM_Contact_Form_Task_Print',
'result' => FALSE,
Expand All @@ -160,7 +132,7 @@ public static function initTasks() {
'result' => TRUE,
'url' => 'civicrm/task/pick-profile',
),
self::PRINT_FOR_CONTACTS => array(
self::PDF_LETTER => array(
'title' => ts('Print/merge document'),
'class' => 'CRM_Contact_Form_Task_PDF',
'result' => TRUE,
Expand Down Expand Up @@ -191,7 +163,7 @@ public static function initTasks() {
//CRM-16329, if SMS provider is configured show sms action.
$providersCount = CRM_SMS_BAO_Provider::activeProviderCount();
if ($providersCount) {
self::$_tasks[self::SMS_CONTACTS] = array(
self::$_tasks[self::TASK_SMS] = array(
'title' => ts('SMS - schedule/send'),
'class' => 'CRM_Contact_Form_Task_SMS',
'result' => TRUE,
Expand Down Expand Up @@ -238,7 +210,7 @@ public static function initTasks() {

//CRM-4418, check for delete
if (!CRM_Core_Permission::check('delete contacts')) {
unset(self::$_tasks[self::DELETE_CONTACTS]);
unset(self::$_tasks[self::TASK_DELETE]);
}

//show map action only if map provider and geoprovider are set (Google doesn't need geoprovider)
Expand Down Expand Up @@ -284,59 +256,30 @@ public static function initTasks() {
);
}

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]);
parent::tasks();
}

// CRM-6806
if (!CRM_Core_Permission::check('access deleted contacts') ||
!CRM_Core_Permission::check('delete contacts')
) {
unset($titles[self::DELETE_PERMANENTLY]);
}
return $titles;
return self::$_tasks;
}

/**
* 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?.
* @param array $params
* 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();
public static function permissionedTaskTitles($permission, $params = array()) {
if (!isset($params['deletedContacts'])) {
$params['deletedContacts'] = FALSE;
}
self::tasks();
$tasks = array();
if ($deletedContacts) {
if ($params['deletedContacts']) {
if (CRM_Core_Permission::check('access deleted contacts')) {
$tasks[self::RESTORE] = self::$_tasks[self::RESTORE]['title'];
if (CRM_Core_Permission::check('delete contacts')) {
Expand All @@ -349,8 +292,8 @@ public static function &permissionedTaskTitles($permission, $deletedContacts = F
}
else {
$tasks = array(
self::EXPORT_CONTACTS => self::$_tasks[self::EXPORT_CONTACTS]['title'],
self::EMAIL_CONTACTS => self::$_tasks[self::EMAIL_CONTACTS]['title'],
self::TASK_EXPORT => self::$_tasks[self::TASK_EXPORT]['title'],
self::EMAIL => self::$_tasks[self::EMAIL]['title'],
self::LABEL_CONTACTS => self::$_tasks[self::LABEL_CONTACTS]['title'],
);

Expand All @@ -366,19 +309,8 @@ public static function &permissionedTaskTitles($permission, $deletedContacts = F
$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'],
);
$tasks = parent::corePermissionedTaskTitles($tasks, $permission, $params);
return $tasks;
}

Expand All @@ -388,40 +320,13 @@ public static function &optionalTaskTitle() {
* @return array
*/
public static function getTask($value) {
self::initTasks();
self::tasks();

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']) || $task == self::EXPORT_CONTACTS) && (
(is_array($value['class']) && in_array($className, $value['class'])) ||
($value['class'] == $className)
)
) {
return array(
$task,
CRM_Utils_Array::value('title', $value),
);
}
$value = self::TASK_PRINT;
}
return parent::getTask($value);
}

}
15 changes: 0 additions & 15 deletions CRM/Core/Component.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -405,21 +405,6 @@ public static function &contactSubTypeProperties($subType, $op) {
return CRM_Core_DAO::$_nullObject;
}

/**
* FIXME: This function does not appear to do anything. The is_array() check runs on a bunch of objects and (always?) returns false
*/
public static function &taskList() {
$info = self::_info();

$tasks = array();
foreach ($info as $name => $value) {
if (is_array($info[$name]) && isset($info[$name]['task'])) {
$tasks += $info[$name]['task'];
}
}
return $tasks;
}

/**
* Handle table dependencies of components.
*
Expand Down

0 comments on commit 002c046

Please sign in to comment.