_queryParams = &$queryParams;
$this->_single = $single;
$this->_limit = $limit;
$this->_context = $context;
$this->_additionalClause = $additionalClause;
// type of selector
$this->_action = $action;
$this->_query = new CRM_Contact_BAO_Query($this->_queryParams,
CRM_Case_BAO_Query::defaultReturnProperties(CRM_Contact_BAO_Query::MODE_CASE,
FALSE
),
NULL, FALSE, FALSE,
CRM_Contact_BAO_Query::MODE_CASE
);
$this->_query->_distinctComponentClause = " civicrm_case.id ";
$this->_query->_groupByComponentClause = " GROUP BY civicrm_case.id ";
}
/**
* This method returns the links that are given for each search row.
* currently the links added for each row are
*
* - View
* - Edit
*
* @param bool $isDeleted
* @param null $key
*
* @return array
*/
public static function &links($isDeleted = FALSE, $key = NULL) {
$extraParams = ($key) ? "&key={$key}" : NULL;
if ($isDeleted) {
self::$_links = [
CRM_Core_Action::RENEW => [
'name' => ts('Restore'),
'url' => 'civicrm/contact/view/case',
'qs' => 'reset=1&action=renew&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams,
'ref' => 'restore-case',
'title' => ts('Restore Case'),
],
];
}
else {
self::$_links = [
CRM_Core_Action::VIEW => [
'name' => ts('Manage'),
'url' => 'civicrm/contact/view/case',
'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&action=view&context=%%cxt%%&selectedChild=case' . $extraParams,
'ref' => 'manage-case',
'class' => 'no-popup',
'title' => ts('Manage Case'),
],
CRM_Core_Action::DELETE => [
'name' => ts('Delete'),
'url' => 'civicrm/contact/view/case',
'qs' => 'reset=1&action=delete&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams,
'ref' => 'delete-case',
'title' => ts('Delete Case'),
],
CRM_Core_Action::UPDATE => [
'name' => ts('Assign to Another Client'),
'url' => 'civicrm/contact/view/case/editClient',
'qs' => 'reset=1&action=update&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams,
'ref' => 'reassign',
'class' => 'medium-popup',
'title' => ts('Assign to Another Client'),
],
];
}
$actionLinks = [];
foreach (self::$_links as $key => $value) {
$actionLinks['primaryActions'][$key] = $value;
}
return $actionLinks;
}
/**
* Getter for array of the parameters required for creating pager.
*
* @param $action
* @param array $params
*/
public function getPagerParams($action, &$params) {
$params['status'] = ts('Case') . ' %%StatusMessage%%';
$params['csvString'] = NULL;
if ($this->_limit) {
$params['rowCount'] = $this->_limit;
}
else {
$params['rowCount'] = CRM_Utils_Pager::ROWCOUNT;
}
$params['buttonTop'] = 'PagerTopButton';
$params['buttonBottom'] = 'PagerBottomButton';
}
/**
* Returns total number of rows for the query.
*
* @param
*
* @return int
* Total number of rows
*/
public function getTotalCount($action) {
return $this->_query->searchQuery(0, 0, NULL,
TRUE, FALSE,
FALSE, FALSE,
FALSE,
$this->_additionalClause
);
}
/**
* Returns all the rows in the given offset and rowCount.
*
* @param string $action
* The action being performed.
* @param int $offset
* The row number to start from.
* @param int $rowCount
* The number of rows to return.
* @param string $sort
* The sql string that describes the sort order.
* @param string $output
* What should the result set include (web/email/csv).
*
* @return int
* the total number of rows for this action
*/
public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
$result = $this->_query->searchQuery($offset, $rowCount, $sort,
FALSE, FALSE,
FALSE, FALSE,
FALSE,
$this->_additionalClause
);
// process the result of the query
$rows = [];
//CRM-4418 check for view, edit, delete
$permissions = [CRM_Core_Permission::VIEW];
if (CRM_Core_Permission::check('access all cases and activities')
|| CRM_Core_Permission::check('access my cases and activities')
) {
$permissions[] = CRM_Core_Permission::EDIT;
}
if (CRM_Core_Permission::check('delete in CiviCase')) {
$permissions[] = CRM_Core_Permission::DELETE;
}
$mask = CRM_Core_Action::mask($permissions);
$caseStatus = CRM_Core_OptionGroup::values('case_status', FALSE, FALSE, FALSE, " AND v.name = 'Urgent' ");
$scheduledInfo = [];
while ($result->fetch()) {
$row = [];
// the columns we are interested in
foreach (self::$_properties as $property) {
if (isset($result->$property)) {
$row[$property] = $result->$property;
}
}
$isDeleted = FALSE;
if ($result->case_deleted) {
$isDeleted = TRUE;
$row['case_status_id'] = empty($row['case_status_id']) ? "" : $row['case_status_id'] . '
' . ts('(deleted)');
}
$scheduledInfo['case_id'][] = $result->case_id;
$scheduledInfo['contact_id'][] = $result->contact_id;
$scheduledInfo['case_deleted'] = $result->case_deleted;
$row['checkbox'] = CRM_Core_Form::CB_PREFIX . $result->case_id;
$links = self::links($isDeleted, $this->_key);
$row['action'] = CRM_Core_Action::formLink($links['primaryActions'],
$mask, [
'id' => $result->case_id,
'cid' => $result->contact_id,
'cxt' => $this->_context,
],
ts('more'),
FALSE,
'case.selector.actions',
'Case',
$result->case_id
);
$row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($result->contact_sub_type ? $result->contact_sub_type : $result->contact_type
);
//adding case manager to case selector.CRM-4510.
$caseType = CRM_Case_BAO_Case::getCaseType($result->case_id, 'name');
$row['casemanager'] = CRM_Case_BAO_Case::getCaseManagerContact($caseType, $result->case_id);
if (isset($result->case_status_id) &&
array_key_exists($result->case_status_id, $caseStatus)
) {
$row['class'] = "status-urgent";
}
else {
$row['class'] = "status-normal";
}
$rows[$result->case_id] = $row;
}
//retrive the scheduled & recent Activity type and date for selector
if (!empty($scheduledInfo)) {
$schdeduledActivity = CRM_Case_BAO_Case::getNextScheduledActivity($scheduledInfo, 'upcoming');
foreach ($schdeduledActivity as $key => $value) {
$rows[$key]['case_scheduled_activity_date'] = $value['date'];
$rows[$key]['case_scheduled_activity_type'] = $value['type'];
}
$recentActivity = CRM_Case_BAO_Case::getNextScheduledActivity($scheduledInfo, 'recent');
foreach ($recentActivity as $key => $value) {
$rows[$key]['case_recent_activity_date'] = $value['date'];
$rows[$key]['case_recent_activity_type'] = $value['type'];
}
}
return $rows;
}
/**
* @inheritDoc
*/
public function getQILL() {
return $this->_query->qill();
}
/**
* Returns the column headers as an array of tuples:
* (name, sortName (key to the sort array))
*
* @param string $action
* The action being performed.
* @param string $output
* What should the result set include (web/email/csv).
*
* @return array
* the column headers that need to be displayed
*/
public function &getColumnHeaders($action = NULL, $output = NULL) {
if (!isset(self::$_columnHeaders)) {
self::$_columnHeaders = [
[
'name' => ts('Subject'),
'direction' => CRM_Utils_Sort::DONTCARE,
],
[
'name' => ts('Status'),
'sort' => 'case_status',
'direction' => CRM_Utils_Sort::DONTCARE,
],
[
'name' => ts('Case Type'),
'sort' => 'case_type',
'direction' => CRM_Utils_Sort::DONTCARE,
],
[
'name' => ts('My Role'),
'sort' => 'case_role',
'direction' => CRM_Utils_Sort::DONTCARE,
],
[
'name' => ts('Case Manager'),
'direction' => CRM_Utils_Sort::DONTCARE,
],
[
'name' => ts('Most Recent'),
'sort' => 'case_recent_activity_date',
'direction' => CRM_Utils_Sort::DONTCARE,
],
[
'name' => ts('Next Sched.'),
'sort' => 'case_scheduled_activity_date',
'direction' => CRM_Utils_Sort::DONTCARE,
],
['name' => ts('Actions')],
];
if (!$this->_single) {
$pre = [
[
'name' => ts('Client'),
'sort' => 'sort_name',
'direction' => CRM_Utils_Sort::ASCENDING,
],
];
self::$_columnHeaders = array_merge($pre, self::$_columnHeaders);
}
}
return self::$_columnHeaders;
}
/**
* @return mixed
*/
public function alphabetQuery() {
return $this->_query->alphabetQuery();
}
/**
* @return string
*/
public function &getQuery() {
return $this->_query;
}
/**
* Name of export file.
*
* @param string $output
* Type of output.
*
* @return string
* name of the file
*/
public function getExportFileName($output = 'csv') {
return ts('Case Search');
}
/**
* Add the set of "actionLinks" to the case activity
*
* @param int $caseID
* @param int $contactID
* @param int $userID
* @param string $context
* @param \CRM_Core_DAO $dao
*
* @return string
* HTML formatted Link
*/
public static function addCaseActivityLinks($caseID, $contactID, $userID, $context, $dao) {
// FIXME: Why are we not using CRM_Core_Action for these links? This is too much manual work and likely to get out-of-sync with core markup.
$caseActivityId = $dao->id;
$allowView = CRM_Case_BAO_Case::checkPermission($caseActivityId, 'view', $dao->activity_type_id, $userID);
$allowEdit = CRM_Case_BAO_Case::checkPermission($caseActivityId, 'edit', $dao->activity_type_id, $userID);
$allowDelete = CRM_Case_BAO_Case::checkPermission($caseActivityId, 'delete', $dao->activity_type_id, $userID);
$emailActivityTypeIDs = [
'Email' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Email'),
'Inbound Email' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Inbound Email'),
];
$url = CRM_Utils_System::url("civicrm/case/activity",
"reset=1&cid={$contactID}&caseid={$caseID}", FALSE, NULL, FALSE
);
$contextUrl = '';
if ($context == 'fulltext') {
$contextUrl = "&context={$context}";
}
$editUrl = "{$url}&action=update{$contextUrl}";
$deleteUrl = "{$url}&action=delete{$contextUrl}";
$restoreUrl = "{$url}&action=renew{$contextUrl}";
$viewTitle = ts('View activity');
$caseDeleted = CRM_Core_DAO::getFieldValue('CRM_Case_DAO_Case', $caseID, 'is_deleted');
$url = "";
$css = 'class="action-item crm-hover-button"';
if ($allowView) {
$viewUrl = CRM_Utils_System::url('civicrm/case/activity/view', array('cid' => $contactID, 'aid' => $caseActivityId));
$url = '' . ts('View') . '';
}
$additionalUrl = "&id={$caseActivityId}";
if (!$dao->deleted) {
//hide edit link of activity type email.CRM-4530.
if (!in_array($dao->type, $emailActivityTypeIDs)) {
//hide Edit link if activity type is NOT editable (special case activities).CRM-5871
if ($allowEdit) {
$url .= '' . ts('Edit') . ' ';
}
}
if ($allowDelete) {
$url .= ' ' . ts('Delete') . '';
}
}
elseif (!$caseDeleted) {
$url = ' ' . ts('Restore') . '';
}
//check for operations.
if (CRM_Case_BAO_Case::checkPermission($caseActivityId, 'Move To Case', $dao->activity_type_id)) {
$url .= ' ' . ts('Move To Case') . ' ';
}
if (CRM_Case_BAO_Case::checkPermission($caseActivityId, 'Copy To Case', $dao->activity_type_id)) {
$url .= ' ' . ts('Copy To Case') . ' ';
}
// if there are file attachments we will return how many and, if only one, add a link to it
if (!empty($dao->attachment_ids)) {
$url .= implode(' ', CRM_Core_BAO_File::paperIconAttachment('civicrm_activity', $caseActivityId));
}
return $url;
}
}