3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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-2019
35 * This class contains the functions for Case Management.
37 class CRM_Case_BAO_Case
extends CRM_Case_DAO_Case
{
40 * Static field for all the case information that we can potentially export.
44 public static $_exportableFields = NULL;
49 public function __construct() {
50 parent
::__construct();
54 * Is CiviCase enabled?
58 public static function enabled() {
59 $config = CRM_Core_Config
::singleton();
60 return in_array('CiviCase', $config->enableComponents
);
64 * Create a case object.
66 * The function extracts all the params it needs to initialize the create a
67 * case object. the params array could contain additional unused name/value
70 * @param array $params
71 * (reference ) an assoc array of name/value pairs.
73 * @return CRM_Case_BAO_Case
75 public static function add(&$params) {
76 $caseDAO = new CRM_Case_DAO_Case();
77 $caseDAO->copyValues($params);
78 $result = $caseDAO->save();
79 // Get other case values (required by XML processor), this adds to $result array
85 * Takes an associative array and creates a case object.
87 * @param array $params
88 * (reference) an assoc array of name/value pairs.
90 * @return CRM_Case_BAO_Case
92 public static function &create(&$params) {
93 // CRM-20958 - These fields are managed by MySQL triggers. Watch out for clients resaving stale timestamps.
94 unset($params['created_date']);
95 unset($params['modified_date']);
96 $caseStatus = CRM_Case_PseudoConstant
::caseStatus('name');
97 // for resolved case the end date should set to now
98 if (!empty($params['status_id']) && $params['status_id'] == array_search('Closed', $caseStatus)) {
99 $params['end_date'] = date("Ymd");
102 $transaction = new CRM_Core_Transaction();
104 if (!empty($params['id'])) {
105 CRM_Utils_Hook
::pre('edit', 'Case', $params['id'], $params);
108 CRM_Utils_Hook
::pre('create', 'Case', NULL, $params);
111 $case = self
::add($params);
113 if (!empty($params['custom']) &&
114 is_array($params['custom'])
116 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_case', $case->id
);
119 if (is_a($case, 'CRM_Core_Error')) {
120 $transaction->rollback();
124 if (!empty($params['id'])) {
125 CRM_Utils_Hook
::post('edit', 'Case', $case->id
, $case);
128 CRM_Utils_Hook
::post('create', 'Case', $case->id
, $case);
130 $transaction->commit();
132 //we are not creating log for case
133 //since case log can be tracked using log for activity.
138 * Process case activity add/delete
139 * takes an associative array and
141 * @param array $params
142 * (reference ) an assoc array of name/value pairs.
145 public static function processCaseActivity(&$params) {
146 $caseActivityDAO = new CRM_Case_DAO_CaseActivity();
147 $caseActivityDAO->activity_id
= $params['activity_id'];
148 $caseActivityDAO->case_id
= $params['case_id'];
150 $caseActivityDAO->find(TRUE);
151 $caseActivityDAO->save();
155 * Get the case subject for Activity.
157 * @param int $activityId
160 * @return string|null
162 public static function getCaseSubject($activityId) {
163 $caseActivity = new CRM_Case_DAO_CaseActivity();
164 $caseActivity->activity_id
= $activityId;
165 if ($caseActivity->find(TRUE)) {
166 return CRM_Core_DAO
::getFieldValue('CRM_Case_BAO_Case', $caseActivity->case_id
, 'subject');
175 * @param string $colName
180 public static function getCaseType($caseId, $colName = 'title') {
182 SELECT civicrm_case_type.{$colName} FROM civicrm_case
183 LEFT JOIN civicrm_case_type ON
184 civicrm_case.case_type_id = civicrm_case_type.id
185 WHERE civicrm_case.id = %1";
187 $queryParams = array(1 => array($caseId, 'Integer'));
189 return CRM_Core_DAO
::singleValueQuery($query, $queryParams);
193 * Delete the record that are associated with this case.
194 * record are deleted from case
197 * Id of the case to delete.
199 * @param bool $moveToTrash
204 public static function deleteCase($caseId, $moveToTrash = FALSE) {
205 CRM_Utils_Hook
::pre('delete', 'Case', $caseId, CRM_Core_DAO
::$_nullArray);
208 $activities = self
::getCaseActivityDates($caseId);
210 foreach ($activities as $value) {
211 CRM_Activity_BAO_Activity
::deleteActivity($value, $moveToTrash);
216 $transaction = new CRM_Core_Transaction();
218 $case = new CRM_Case_DAO_Case();
221 $result = $case->delete();
222 $transaction->commit();
225 $result = $case->is_deleted
= 1;
230 // CRM-7364, disable relationships
231 self
::enableDisableCaseRelationships($caseId, FALSE);
233 CRM_Utils_Hook
::post('delete', 'Case', $caseId, $case);
235 // remove case from recent items.
240 CRM_Utils_Recent
::del($caseRecent);
248 * Enable disable case related relationships.
252 * @param bool $enable
255 public static function enableDisableCaseRelationships($caseId, $enable) {
256 $contactIds = self
::retrieveContactIdsByCaseId($caseId);
257 if (!empty($contactIds)) {
258 foreach ($contactIds as $cid) {
259 $roles = self
::getCaseRoles($cid, $caseId);
260 if (!empty($roles)) {
261 $relationshipIds = implode(',', array_keys($roles));
262 $enable = (int) $enable;
263 $query = "UPDATE civicrm_relationship SET is_active = {$enable}
264 WHERE id IN ( {$relationshipIds} )";
265 CRM_Core_DAO
::executeQuery($query);
272 * Retrieve contact_id by case_id.
277 * @param int $contactID
278 * @param int $startArrayAt This is to support legacy calls to Case.Get API which may rely on the first array index being set to 1
282 public static function retrieveContactIdsByCaseId($caseId, $contactID = NULL, $startArrayAt = 0) {
283 $caseContact = new CRM_Case_DAO_CaseContact();
284 $caseContact->case_id
= $caseId;
285 $caseContact->find();
286 $contactArray = array();
287 $count = $startArrayAt;
288 while ($caseContact->fetch()) {
289 if ($contactID != $caseContact->contact_id
) {
290 $contactArray[$count] = $caseContact->contact_id
;
295 return $contactArray;
299 * Look up a case using an activity ID.
301 * @param int $activityId
303 * @return int, case ID
305 public static function getCaseIdByActivityId($activityId) {
306 $originalId = CRM_Core_DAO
::singleValueQuery(
307 'SELECT original_id FROM civicrm_activity WHERE id = %1',
308 array('1' => array($activityId, 'Integer'))
310 $caseId = CRM_Core_DAO
::singleValueQuery(
311 'SELECT case_id FROM civicrm_case_activity WHERE activity_id in (%1,%2)',
313 '1' => array($activityId, 'Integer'),
314 '2' => array($originalId ?
$originalId : $activityId, 'Integer'),
321 * Retrieve contact names by caseId.
328 public static function getContactNames($caseId) {
329 $contactNames = array();
331 return $contactNames;
335 SELECT contact_a.sort_name name,
336 contact_a.display_name as display_name,
338 contact_a.birth_date as birth_date,
341 FROM civicrm_contact contact_a
342 LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
343 LEFT JOIN civicrm_email ce ON ( ce.contact_id = contact_a.id AND ce.is_primary = 1)
344 LEFT JOIN civicrm_phone cp ON ( cp.contact_id = contact_a.id AND cp.is_primary = 1)
345 WHERE contact_a.is_deleted = 0 AND civicrm_case_contact.case_id = %1
346 ORDER BY civicrm_case_contact.id";
348 $dao = CRM_Core_DAO
::executeQuery($query,
349 array(1 => array($caseId, 'Integer'))
351 while ($dao->fetch()) {
352 $contactNames[$dao->cid
]['contact_id'] = $dao->cid
;
353 $contactNames[$dao->cid
]['sort_name'] = $dao->name
;
354 $contactNames[$dao->cid
]['display_name'] = $dao->display_name
;
355 $contactNames[$dao->cid
]['email'] = $dao->email
;
356 $contactNames[$dao->cid
]['phone'] = $dao->phone
;
357 $contactNames[$dao->cid
]['birth_date'] = $dao->birth_date
;
358 $contactNames[$dao->cid
]['role'] = ts('Client');
361 return $contactNames;
365 * Retrieve case_id by contact_id.
367 * @param int $contactID
368 * @param bool $includeDeleted
369 * Include the deleted cases in result.
370 * @param null $caseType
374 public static function retrieveCaseIdsByContactId($contactID, $includeDeleted = FALSE, $caseType = NULL) {
377 FROM civicrm_case_contact cc
378 INNER JOIN civicrm_case ca ON cc.case_id = ca.id
380 if (isset($caseType)) {
382 "INNER JOIN civicrm_case_type ON civicrm_case_type.id = ca.case_type_id
383 WHERE cc.contact_id = %1 AND civicrm_case_type.name = '{$caseType}'";
385 if (!isset($caseType)) {
386 $query .= "WHERE cc.contact_id = %1";
388 if (!$includeDeleted) {
389 $query .= " AND ca.is_deleted = 0";
392 $params = array(1 => array($contactID, 'Integer'));
393 $dao = CRM_Core_DAO
::executeQuery($query, $params);
395 $caseArray = array();
396 while ($dao->fetch()) {
397 $caseArray[] = $dao->id
;
404 * @param string $type
406 * @param string $condition
410 public static function getCaseActivityCountQuery($type = 'upcoming', $userID, $condition = NULL) {
411 return sprintf(" SELECT COUNT(*) FROM (%s) temp ", self
::getCaseActivityQuery($type, $userID, $condition));
415 * @param string $type
417 * @param string $condition
418 * @param string $limit
419 * @param string $order
423 public static function getCaseActivityQuery($type = 'upcoming', $userID, $condition = NULL, $limit = NULL, $order = NULL) {
424 $selectClauses = array(
425 'civicrm_case.id as case_id',
426 'civicrm_case.subject as case_subject',
427 'civicrm_contact.id as contact_id',
428 'civicrm_contact.sort_name as sort_name',
429 'civicrm_phone.phone as phone',
430 'civicrm_contact.contact_type as contact_type',
431 'civicrm_contact.contact_sub_type as contact_sub_type',
432 't_act.activity_type_id as activity_type_id',
433 'civicrm_case.case_type_id as case_type_id',
434 'civicrm_case.status_id as case_status_id',
435 't_act.status_id as status_id',
436 'civicrm_case.start_date as case_start_date',
437 'case_relation_type.label_b_a as case_role',
438 't_act.activity_date_time as activity_date_time',
439 't_act.id as activity_id',
442 $query = CRM_Contact_BAO_Query
::appendAnyValueToSelect($selectClauses, 'case_id');
446 INNER JOIN civicrm_case_contact ON civicrm_case.id = civicrm_case_contact.case_id
447 INNER JOIN civicrm_contact ON civicrm_case_contact.contact_id = civicrm_contact.id
453 // civicrm_view_case_activity_upcoming and
454 // civicrm_view_case_activity_recent are views that show the next
455 // scheduled and most recent not-scheduled activity on each case,
458 INNER JOIN civicrm_view_case_activity_$type t_act
459 ON t_act.case_id = civicrm_case.id
465 LEFT JOIN civicrm_case_activity ca4
466 ON civicrm_case.id = ca4.case_id
467 LEFT JOIN civicrm_activity t_act
468 ON t_act.id = ca4.activity_id
469 AND t_act.is_current_revision = 1
474 LEFT JOIN civicrm_phone
475 ON civicrm_phone.contact_id = civicrm_contact.id
476 AND civicrm_phone.is_primary = 1
477 LEFT JOIN civicrm_relationship case_relationship
478 ON case_relationship.contact_id_a = civicrm_case_contact.contact_id
479 AND case_relationship.contact_id_b = {$userID}
480 AND case_relationship.is_active
481 AND case_relationship.case_id = civicrm_case.id
482 LEFT JOIN civicrm_relationship_type case_relation_type
483 ON case_relation_type.id = case_relationship.relationship_type_id
484 AND case_relation_type.id = case_relationship.relationship_type_id
488 // CRM-8749 backwards compatibility - callers of this function expect to start $condition with "AND"
489 $query .= " WHERE (1) AND $condition ";
491 $query .= " GROUP BY case_id ";
493 $query .= ($order) ?
: ' ORDER BY activity_date_time ASC';
503 * Retrieve cases related to particular contact or whole contact used in Dashboard and Tab.
505 * @param bool $allCases
506 * @param array $params
507 * @param string $context
508 * @param bool $getCount
513 public static function getCases($allCases = TRUE, $params = array(), $context = 'dashboard', $getCount = FALSE) {
515 $casesList = array();
517 // validate access for own cases.
518 if (!self
::accessCiviCase()) {
519 return $getCount ?
0 : $casesList;
522 // Return cached value instead of re-running query
523 if (isset(Civi
::$statics[__CLASS__
]['totalCount']) && $getCount) {
524 return Civi
::$statics[__CLASS__
]['totalCount'];
527 $type = CRM_Utils_Array
::value('type', $params, 'upcoming');
528 $userID = CRM_Core_Session
::singleton()->get('userID');
530 // validate access for all cases.
531 if ($allCases && !CRM_Core_Permission
::check('access all cases and activities')) {
535 $whereClauses = array('civicrm_case.is_deleted = 0 AND civicrm_contact.is_deleted <> 1');
538 $whereClauses[] .= " case_relationship.contact_id_b = {$userID} AND case_relationship.is_active ";
540 if (empty($params['status_id']) && ($type == 'upcoming' ||
$type == 'any')) {
541 $whereClauses[] = " civicrm_case.status_id != " . CRM_Core_PseudoConstant
::getKey('CRM_Case_BAO_Case', 'case_status_id', 'Closed');
544 foreach (array('case_type_id', 'status_id') as $column) {
545 if (!empty($params[$column])) {
546 $whereClauses[] = sprintf("civicrm_case.%s IN (%s)", $column, $params[$column]);
549 $condition = implode(' AND ', $whereClauses);
551 Civi
::$statics[__CLASS__
]['totalCount'] = $totalCount = CRM_Core_DAO
::singleValueQuery(self
::getCaseActivityCountQuery($type, $userID, $condition));
555 $casesList['total'] = $totalCount;
558 if (!empty($params['rp'])) {
559 $params['offset'] = ($params['page'] - 1) * $params['rp'];
560 $params['rowCount'] = $params['rp'];
561 if (!empty($params['rowCount']) && $params['rowCount'] > 0) {
562 $limit = " LIMIT {$params['offset']}, {$params['rowCount']} ";
567 if (!empty($params['sortBy'])) {
568 if (strstr($params['sortBy'], 'date ')) {
569 $params['sortBy'] = str_replace('date', 'activity_date_time', $params['sortBy']);
571 $order = "ORDER BY " . $params['sortBy'];
574 $query = self
::getCaseActivityQuery($type, $userID, $condition, $limit, $order);
575 $result = CRM_Core_DAO
::executeQuery($query);
577 // we're going to use the usual actions, so doesn't make sense to duplicate definitions
578 $actions = CRM_Case_Selector_Search
::links();
580 // check is the user has view/edit signer permission
581 $permissions = array(CRM_Core_Permission
::VIEW
);
582 if (CRM_Core_Permission
::check('access all cases and activities') ||
583 (!$allCases && CRM_Core_Permission
::check('access my cases and activities'))
585 $permissions[] = CRM_Core_Permission
::EDIT
;
587 if (CRM_Core_Permission
::check('delete in CiviCase')) {
588 $permissions[] = CRM_Core_Permission
::DELETE
;
590 $mask = CRM_Core_Action
::mask($permissions);
592 // Pseudoconstants to populate labels
593 $caseStatuses = CRM_Case_PseudoConstant
::caseStatus('label', FALSE);
594 $caseTypes = CRM_Case_PseudoConstant
::caseType('name');
595 $caseTypeTitles = CRM_Case_PseudoConstant
::caseType('title', FALSE);
596 $activityTypeLabels = CRM_Activity_BAO_Activity
::buildOptions('activity_type_id');
598 foreach ($result->fetchAll() as $case) {
599 $key = $case['case_id'];
600 $casesList[$key] = array();
601 $casesList[$key]['DT_RowId'] = $case['case_id'];
602 $casesList[$key]['DT_RowAttr'] = array('data-entity' => 'case', 'data-id' => $case['case_id']);
603 $casesList[$key]['DT_RowClass'] = "crm-entity";
605 $casesList[$key]['activity_list'] = sprintf('<a title="%s" class="crm-expand-row" href="%s"></a>',
607 CRM_Utils_System
::url('civicrm/case/details', array('caseId' => $case['case_id'], 'cid' => $case['contact_id'], 'type' => $type))
610 $phone = empty($case['phone']) ?
'' : '<br /><span class="description">' . $case['phone'] . '</span>';
611 $casesList[$key]['contact_id'] = sprintf('<a href="%s">%s</a>%s<br /><span class="description">%s: %d</span>',
612 CRM_Utils_System
::url('civicrm/contact/view', array('cid' => $case['contact_id'])),
618 $casesList[$key]['subject'] = $case['case_subject'];
619 $casesList[$key]['case_status'] = CRM_Utils_Array
::value($case['case_status_id'], $caseStatuses);
620 if ($case['case_status_id'] == CRM_Case_PseudoConstant
::getKey('CRM_Case_BAO_Case', 'case_status_id', 'Urgent')) {
621 $casesList[$key]['case_status'] = sprintf('<strong>%s</strong>', strtoupper($casesList[$key]['case_status']));
623 $casesList[$key]['case_type'] = CRM_Utils_Array
::value($case['case_type_id'], $caseTypeTitles);
624 $casesList[$key]['case_role'] = CRM_Utils_Array
::value('case_role', $case, '---');
625 $casesList[$key]['manager'] = self
::getCaseManagerContact($caseTypes[$case['case_type_id']], $case['case_id']);
627 $casesList[$key]['date'] = CRM_Utils_Array
::value($case['activity_type_id'], $activityTypeLabels);
628 if ($actId = CRM_Utils_Array
::value('activity_id', $case)) {
629 if (self
::checkPermission($actId, 'view', $case['activity_type_id'], $userID)) {
630 if ($type == 'recent') {
631 $casesList[$key]['date'] = sprintf('<a class="action-item crm-hover-button" href="%s" title="%s">%s</a>',
632 CRM_Utils_System
::url('civicrm/case/activity/view', array('reset' => 1, 'cid' => $case['contact_id'], 'aid' => $case['activity_id'])),
634 CRM_Utils_Array
::value($case['activity_type_id'], $activityTypeLabels)
638 $status = CRM_Utils_Date
::overdue($case['activity_date_time']) ?
'status-overdue' : 'status-scheduled';
639 $casesList[$key]['date'] = sprintf('<a class="crm-popup %s" href="%s" title="%s">%s</a> ',
641 CRM_Utils_System
::url('civicrm/case/activity/view', array('reset' => 1, 'cid' => $case['contact_id'], 'aid' => $case['activity_id'])),
643 CRM_Utils_Array
::value($case['activity_type_id'], $activityTypeLabels)
647 if (isset($case['activity_type_id']) && self
::checkPermission($actId, 'edit', $case['activity_type_id'], $userID)) {
648 $casesList[$key]['date'] .= sprintf('<a class="action-item crm-hover-button" href="%s" title="%s"><i class="crm-i fa-pencil"></i></a>',
649 CRM_Utils_System
::url('civicrm/case/activity', array('reset' => 1, 'cid' => $case['contact_id'], 'caseid' => $case['case_id'], 'action' => 'update', 'id' => $actId)),
654 $casesList[$key]['date'] .= "<br/>" . CRM_Utils_Date
::customFormat($case['activity_date_time']);
655 $casesList[$key]['links'] = CRM_Core_Action
::formLink($actions['primaryActions'], $mask,
657 'id' => $case['case_id'],
658 'cid' => $case['contact_id'],
663 'case.actions.primary',
673 * Get the summary of cases counts by type and status.
675 * @param bool $allCases
678 public static function getCasesSummary($allCases = TRUE) {
679 $caseSummary = array();
681 //validate access for civicase.
682 if (!self
::accessCiviCase()) {
686 $userID = CRM_Core_Session
::singleton()->get('userID');
688 //validate access for all cases.
689 if ($allCases && !CRM_Core_Permission
::check('access all cases and activities')) {
693 $caseTypes = CRM_Case_PseudoConstant
::caseType();
694 $caseStatuses = CRM_Case_PseudoConstant
::caseStatus();
695 $caseTypes = array_flip($caseTypes);
697 // get statuses as headers for the table
698 $url = CRM_Utils_System
::url('civicrm/case/search', "reset=1&force=1&all=1&status=");
699 foreach ($caseStatuses as $key => $name) {
700 $caseSummary['headers'][$key]['status'] = $name;
701 $caseSummary['headers'][$key]['url'] = $url . $key;
704 // build rows with actual data
706 $myGroupByClause = $mySelectClause = $myCaseFromClause = $myCaseWhereClause = '';
712 $myGroupByClause = ' GROUP BY civicrm_case.id';
717 $myCaseWhereClause = " AND case_relationship.contact_id_b = {$userID} AND case_relationship.is_active ";
718 $myGroupByClause = " GROUP BY CONCAT(case_relationship.case_id,'-',case_relationship.contact_id_b)";
720 $myGroupByClause .= ", case_status.label, status_id, case_type_id";
722 // FIXME: This query could be a lot more efficient if it used COUNT() instead of returning all rows and then counting them with php
724 SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS case_type,
725 case_type_id, case_relationship.contact_id_b
727 INNER JOIN civicrm_case_contact cc on cc.case_id = civicrm_case.id
728 LEFT JOIN civicrm_case_type ON civicrm_case.case_type_id = civicrm_case_type.id
729 LEFT JOIN civicrm_option_group option_group_case_status ON ( option_group_case_status.name = 'case_status' )
730 LEFT JOIN civicrm_option_value case_status ON ( civicrm_case.status_id = case_status.value
731 AND option_group_case_status.id = case_status.option_group_id )
732 LEFT JOIN civicrm_relationship case_relationship ON ( case_relationship.case_id = civicrm_case.id
733 AND case_relationship.contact_id_b = {$userID} AND case_relationship.is_active )
734 WHERE is_deleted = 0 AND cc.contact_id IN (SELECT id FROM civicrm_contact WHERE is_deleted <> 1)
735 {$myCaseWhereClause} {$myGroupByClause}";
737 $res = CRM_Core_DAO
::executeQuery($query);
738 while ($res->fetch()) {
739 if (!empty($rows[$res->case_type
]) && !empty($rows[$res->case_type
][$res->case_status
])) {
740 $rows[$res->case_type
][$res->case_status
]['count'] = $rows[$res->case_type
][$res->case_status
]['count'] +
1;
743 $rows[$res->case_type
][$res->case_status
] = array(
745 'url' => CRM_Utils_System
::url('civicrm/case/search',
746 "reset=1&force=1&status={$res->status_id}&type={$res->case_type_id}&case_owner={$case_owner}"
751 $caseSummary['rows'] = array_merge($caseTypes, $rows);
759 * @param int $contactID
763 * @param int $relationshipID
764 * @param bool $activeOnly
767 * case role / relationships
770 public static function getCaseRoles($contactID, $caseID, $relationshipID = NULL, $activeOnly = TRUE) {
772 SELECT rel.id as civicrm_relationship_id,
773 con.sort_name as sort_name,
774 civicrm_email.email as email,
775 civicrm_phone.phone as phone,
776 con.id as civicrm_contact_id,
777 IF(rel.contact_id_a = %1, civicrm_relationship_type.label_a_b, civicrm_relationship_type.label_b_a) as relation,
778 civicrm_relationship_type.id as relation_type,
779 IF(rel.contact_id_a = %1, "a_b", "b_a") as relationship_direction
780 FROM civicrm_relationship rel
781 INNER JOIN civicrm_relationship_type ON rel.relationship_type_id = civicrm_relationship_type.id
782 INNER JOIN civicrm_contact con ON ((con.id <> %1 AND con.id IN (rel.contact_id_a, rel.contact_id_b)) OR (con.id = %1 AND rel.contact_id_b = rel.contact_id_a AND rel.contact_id_a = %1 AND rel.is_active))
783 LEFT JOIN civicrm_phone ON (civicrm_phone.contact_id = con.id AND civicrm_phone.is_primary = 1)
784 LEFT JOIN civicrm_email ON (civicrm_email.contact_id = con.id AND civicrm_email.is_primary = 1)
785 WHERE (rel.contact_id_a = %1 OR rel.contact_id_b = %1) AND rel.case_id = %2
786 AND con.is_deleted = 0';
789 $query .= ' AND rel.is_active = 1 AND (rel.end_date IS NULL OR rel.end_date > NOW())';
793 1 => array($contactID, 'Positive'),
794 2 => array($caseID, 'Positive'),
797 if ($relationshipID) {
798 $query .= ' AND rel.id = %3 ';
799 $params[3] = array($relationshipID, 'Integer');
801 $dao = CRM_Core_DAO
::executeQuery($query, $params);
804 while ($dao->fetch()) {
805 $rid = $dao->civicrm_relationship_id
;
806 $values[$rid]['cid'] = $dao->civicrm_contact_id
;
807 $values[$rid]['relation'] = $dao->relation
;
808 $values[$rid]['name'] = $dao->sort_name
;
809 $values[$rid]['email'] = $dao->email
;
810 $values[$rid]['phone'] = $dao->phone
;
811 $values[$rid]['relation_type'] = $dao->relation_type
;
812 $values[$rid]['rel_id'] = $dao->civicrm_relationship_id
;
813 $values[$rid]['client_id'] = $contactID;
814 $values[$rid]['relationship_direction'] = $dao->relationship_direction
;
821 * Get Case Activities.
825 * @param array $params
827 * @param int $contactID
830 * @param null $context
832 * @param null $type (deprecated)
835 * Array of case activities
838 public static function getCaseActivity($caseID, &$params, $contactID, $context = NULL, $userID = NULL, $type = NULL) {
839 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
840 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
841 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
842 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
844 // CRM-5081 - formatting the dates to omit seconds.
845 // Note the 00 in the date format string is needed otherwise later on it thinks scheduled ones are overdue.
847 SELECT SQL_CALC_FOUND_ROWS COUNT(ca.id) AS ismultiple,
849 ca.activity_type_id AS type,
850 ca.activity_type_id AS activity_type_id,
851 tcc.sort_name AS target_contact_name,
852 tcc.id AS target_contact_id,
853 scc.sort_name AS source_contact_name,
854 scc.id AS source_contact_id,
855 acc.sort_name AS assignee_contact_name,
856 acc.id AS assignee_contact_id,
858 IF(ca.activity_date_time < NOW() AND ca.status_id=ov.value,
859 ca.activity_date_time,
860 DATE_ADD(NOW(), INTERVAL 1 YEAR)
861 ), '%Y%m%d%H%i00') AS overdue_date,
862 DATE_FORMAT(ca.activity_date_time, '%Y%m%d%H%i00') AS display_date,
863 ca.status_id AS status,
864 ca.subject AS subject,
865 ca.is_deleted AS deleted,
866 ca.priority_id AS priority,
868 GROUP_CONCAT(ef.file_id) AS attachment_ids ";
871 FROM civicrm_case_activity cca
872 INNER JOIN civicrm_activity ca
873 ON ca.id = cca.activity_id
874 INNER JOIN civicrm_activity_contact cas
875 ON cas.activity_id = ca.id
876 AND cas.record_type_id = {$sourceID}
877 INNER JOIN civicrm_contact scc
878 ON scc.id = cas.contact_id
879 LEFT JOIN civicrm_activity_contact caa
880 ON caa.activity_id = ca.id
881 AND caa.record_type_id = {$assigneeID}
882 LEFT JOIN civicrm_contact acc
883 ON acc.id = caa.contact_id
884 LEFT JOIN civicrm_activity_contact cat
885 ON cat.activity_id = ca.id
886 AND cat.record_type_id = {$targetID}
887 LEFT JOIN civicrm_contact tcc
888 ON tcc.id = cat.contact_id
889 INNER JOIN civicrm_option_group cog
890 ON cog.name = 'activity_type'
891 INNER JOIN civicrm_option_value cov
892 ON cov.option_group_id = cog.id
893 AND cov.value = ca.activity_type_id
894 AND cov.is_active = 1
895 LEFT JOIN civicrm_entity_file ef
896 ON ef.entity_table = 'civicrm_activity'
897 AND ef.entity_id = ca.id
898 LEFT OUTER JOIN civicrm_option_group og
899 ON og.name = 'activity_status'
900 LEFT OUTER JOIN civicrm_option_value ov
901 ON ov.option_group_id=og.id
902 AND ov.name = 'Scheduled'";
905 WHERE cca.case_id= %1
906 AND ca.is_current_revision = 1';
908 if (!empty($params['source_contact_id'])) {
910 AND cas.contact_id = " . CRM_Utils_Type
::escape($params['source_contact_id'], 'Integer');
913 if (!empty($params['status_id'])) {
915 AND ca.status_id = " . CRM_Utils_Type
::escape($params['status_id'], 'Integer');
918 if (!empty($params['activity_deleted'])) {
920 AND ca.is_deleted = 1";
924 AND ca.is_deleted = 0";
927 if (!empty($params['activity_type_id'])) {
929 AND ca.activity_type_id = " . CRM_Utils_Type
::escape($params['activity_type_id'], 'Integer');
932 if (!empty($params['activity_date_low'])) {
933 $fromActivityDate = CRM_Utils_Type
::escape(CRM_Utils_Date
::processDate($params['activity_date_low']), 'Date');
935 if (!empty($fromActivityDate)) {
937 AND ca.activity_date_time >= '{$fromActivityDate}'";
940 if (!empty($params['activity_date_high'])) {
941 $toActivityDate = CRM_Utils_Type
::escape(CRM_Utils_Date
::processDate($params['activity_date_high']), 'Date');
942 $toActivityDate = $toActivityDate ?
$toActivityDate +
235959 : NULL;
944 if (!empty($toActivityDate)) {
946 AND ca.activity_date_time <= '{$toActivityDate}'";
950 GROUP BY ca.id, tcc.id, scc.id, acc.id, ov.value";
952 $sortBy = CRM_Utils_Array
::value('sortBy', $params);
954 // CRM-5081 - added id to act like creation date
956 ORDER BY overdue_date ASC, display_date DESC, weight DESC";
959 $sortBy = CRM_Utils_Type
::escape($sortBy, 'String');
960 $orderBy = " ORDER BY $sortBy ";
963 $page = CRM_Utils_Array
::value('page', $params);
964 $rp = CRM_Utils_Array
::value('rp', $params);
972 $start = (($page - 1) * $rp);
973 $limit = " LIMIT $start, $rp";
975 $query = $select . $from . $where . $groupBy . $orderBy . $limit;
976 $queryParams = array(1 => array($caseID, 'Integer'));
978 $dao = CRM_Core_DAO
::executeQuery($query, $queryParams);
979 $caseCount = CRM_Core_DAO
::singleValueQuery('SELECT FOUND_ROWS()');
981 $activityTypes = CRM_Case_PseudoConstant
::caseActivityType(FALSE, TRUE);
983 $compStatusValues = array_keys(
984 CRM_Activity_BAO_Activity
::getStatusesByType(CRM_Activity_BAO_Activity
::COMPLETED
) +
985 CRM_Activity_BAO_Activity
::getStatusesByType(CRM_Activity_BAO_Activity
::CANCELLED
)
989 $userID = CRM_Core_Session
::getLoggedInContactID();
992 $caseActivities = [];
994 while ($dao->fetch()) {
995 $caseActivityId = $dao->id
;
997 //Do we have permission to access given case activity record.
998 if (!self
::checkPermission($caseActivityId, 'view', $dao->activity_type_id
, $userID)) {
1002 $caseActivities[$caseActivityId]['DT_RowId'] = $caseActivityId;
1003 //Add classes to the row, via DataTables syntax
1004 $caseActivities[$caseActivityId]['DT_RowClass'] = "crm-entity status-id-$dao->status";
1006 if (CRM_Utils_Array
::crmInArray($dao->status
, $compStatusValues)) {
1007 $caseActivities[$caseActivityId]['DT_RowClass'] .= " status-completed";
1010 if (CRM_Utils_Date
::overdue($dao->display_date
)) {
1011 $caseActivities[$caseActivityId]['DT_RowClass'] .= " status-overdue";
1014 $caseActivities[$caseActivityId]['DT_RowClass'] .= " status-scheduled";
1018 if (!empty($dao->priority
)) {
1019 if ($dao->priority
== CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'priority_id', 'Urgent')) {
1020 $caseActivities[$caseActivityId]['DT_RowClass'] .= " priority-urgent ";
1022 elseif ($dao->priority
== CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'priority_id', 'Low')) {
1023 $caseActivities[$caseActivityId]['DT_RowClass'] .= " priority-low ";
1027 //Add data to the row for inline editing, via DataTable syntax
1028 $caseActivities[$caseActivityId]['DT_RowAttr'] = array();
1029 $caseActivities[$caseActivityId]['DT_RowAttr']['data-entity'] = 'activity';
1030 $caseActivities[$caseActivityId]['DT_RowAttr']['data-id'] = $caseActivityId;
1032 //Activity Date and Time
1033 $caseActivities[$caseActivityId]['activity_date_time'] = CRM_Utils_Date
::customFormat($dao->display_date
);
1036 $caseActivities[$caseActivityId]['subject'] = $dao->subject
;
1039 $caseActivities[$caseActivityId]['type'] = (!empty($activityTypes[$dao->type
]['icon']) ?
'<span class="crm-i ' . $activityTypes[$dao->type
]['icon'] . '"></span> ' : '')
1040 . $activityTypes[$dao->type
]['label'];
1042 // Activity Target (With Contact) (There can be more than one)
1043 $targetContact = self
::formatContactLink($dao->target_contact_id
, $dao->target_contact_name
);
1044 if (empty($caseActivities[$caseActivityId]['target_contact_name'])) {
1045 $caseActivities[$caseActivityId]['target_contact_name'] = $targetContact;
1048 if (strpos($caseActivities[$caseActivityId]['target_contact_name'], $targetContact) === FALSE) {
1049 $caseActivities[$caseActivityId]['target_contact_name'] .= '; ' . $targetContact;
1053 // Activity Source Contact (Reporter) (There can only be one)
1054 $sourceContact = self
::formatContactLink($dao->source_contact_id
, $dao->source_contact_name
);
1055 $caseActivities[$caseActivityId]['source_contact_name'] = $sourceContact;
1057 // Activity Assignee (There can be more than one)
1058 $assigneeContact = self
::formatContactLink($dao->assignee_contact_id
, $dao->assignee_contact_name
);
1059 if (empty($caseActivities[$caseActivityId]['assignee_contact_name'])) {
1060 $caseActivities[$caseActivityId]['assignee_contact_name'] = $assigneeContact;
1063 if (strpos($caseActivities[$caseActivityId]['assignee_contact_name'], $assigneeContact) === FALSE) {
1064 $caseActivities[$caseActivityId]['assignee_contact_name'] .= '; ' . $assigneeContact;
1068 // Activity Status Label for Case activities list
1069 $caseActivities[$caseActivityId]['status_id'] = CRM_Core_PseudoConstant
::getLabel('CRM_Activity_BAO_Activity', 'activity_status_id', $dao->status
);
1071 if ($dao->deleted
) {
1072 $deleted = '<br /> ' . ts('(deleted)');
1074 $caseActivities[$caseActivityId]['status_id'] = CRM_Core_PseudoConstant
::getLabel('CRM_Activity_BAO_Activity', 'activity_status_id', $dao->status
) . $deleted;
1075 // if there are file attachments we will return how many
1076 if (!empty($dao->attachment_ids
)) {
1077 $attachmentIDs = array_unique(explode(',', $dao->attachment_ids
));
1078 $caseActivity['no_attachments'] = count($attachmentIDs);
1081 $caseActivities[$caseActivityId]['links'] = self
::addCaseActivityLinks($caseID, $contactID, $userID, $context, $dao);
1084 $caseActivitiesDT = array();
1085 $caseActivitiesDT['data'] = array_values($caseActivities);
1086 $caseActivitiesDT['recordsTotal'] = $caseCount;
1087 $caseActivitiesDT['recordsFiltered'] = $caseCount;
1089 return $caseActivitiesDT;
1093 * FIXME: This is a transitional function to facilitate a refactor of this to use CRM_Core_Action and actionLinks
1094 * Add the set of "actionLinks" to the case activity
1096 * @param int $caseID
1097 * @param int $contactID
1098 * @param int $userID
1099 * @param string $context
1100 * @param \CRM_Core_DAO $dao
1103 * HTML formatted Link
1105 private static function addCaseActivityLinks($caseID, $contactID, $userID, $context, $dao) {
1106 // 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.
1107 $caseActivityId = $dao->id
;
1108 $allowView = self
::checkPermission($caseActivityId, 'view', $dao->activity_type_id
, $userID);
1109 $allowEdit = self
::checkPermission($caseActivityId, 'edit', $dao->activity_type_id
, $userID);
1110 $allowDelete = self
::checkPermission($caseActivityId, 'delete', $dao->activity_type_id
, $userID);
1111 $emailActivityTypeIDs = [
1112 'Email' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Email'),
1113 'Inbound Email' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Inbound Email'),
1115 $url = CRM_Utils_System
::url("civicrm/case/activity",
1116 "reset=1&cid={$contactID}&caseid={$caseID}", FALSE, NULL, FALSE
1119 if ($context == 'fulltext') {
1120 $contextUrl = "&context={$context}";
1122 $editUrl = "{$url}&action=update{$contextUrl}";
1123 $deleteUrl = "{$url}&action=delete{$contextUrl}";
1124 $restoreUrl = "{$url}&action=renew{$contextUrl}";
1125 $viewTitle = ts('View activity');
1126 $caseDeleted = CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_Case', $caseID, 'is_deleted');
1129 $css = 'class="action-item crm-hover-button"';
1131 $viewUrl = CRM_Utils_System
::url('civicrm/case/activity/view', array('cid' => $contactID, 'aid' => $caseActivityId));
1132 $url = '<a ' . str_replace('action-item', 'action-item medium-pop-up', $css) . 'href="' . $viewUrl . '" title="' . $viewTitle . '">' . ts('View') . '</a>';
1134 $additionalUrl = "&id={$caseActivityId}";
1135 if (!$dao->deleted
) {
1136 //hide edit link of activity type email.CRM-4530.
1137 if (!in_array($dao->type
, $emailActivityTypeIDs)) {
1138 //hide Edit link if activity type is NOT editable (special case activities).CRM-5871
1140 $url .= '<a ' . $css . ' href="' . $editUrl . $additionalUrl . '">' . ts('Edit') . '</a> ';
1144 $url .= ' <a ' . str_replace('action-item', 'action-item small-popup', $css) . ' href="' . $deleteUrl . $additionalUrl . '">' . ts('Delete') . '</a>';
1147 elseif (!$caseDeleted) {
1148 $url = ' <a ' . $css . ' href="' . $restoreUrl . $additionalUrl . '">' . ts('Restore') . '</a>';
1151 //check for operations.
1152 if (self
::checkPermission($caseActivityId, 'Move To Case', $dao->activity_type_id
)) {
1153 $url .= ' <a ' . $css . ' href="#" onClick="Javascript:fileOnCase( \'move\',' . $caseActivityId . ', ' . $caseID . ', this ); return false;">' . ts('Move To Case') . '</a> ';
1155 if (self
::checkPermission($caseActivityId, 'Copy To Case', $dao->activity_type_id
)) {
1156 $url .= ' <a ' . $css . ' href="#" onClick="Javascript:fileOnCase( \'copy\',' . $caseActivityId . ',' . $caseID . ', this ); return false;">' . ts('Copy To Case') . '</a> ';
1158 // if there are file attachments we will return how many and, if only one, add a link to it
1159 if (!empty($dao->attachment_ids
)) {
1160 $url .= implode(' ', CRM_Core_BAO_File
::paperIconAttachment('civicrm_activity', $caseActivityId));
1167 * Helper function to generate a formatted contact link/name for display in the Case activities tab
1170 * @param $contactName
1174 private static function formatContactLink($contactId, $contactName) {
1175 if (empty($contactId)) {
1179 $hasViewContact = CRM_Contact_BAO_Contact_Permission
::allow($contactId);
1181 if ($hasViewContact) {
1182 $contactViewUrl = CRM_Utils_System
::url("civicrm/contact/view", "reset=1&cid={$contactId}");
1183 return "<a href=\"{$contactViewUrl}\">" . $contactName . "</a>";
1186 return $contactName;
1191 * Get Case Related Contacts.
1193 * @param int $caseID
1195 * @param bool $includeDetails
1196 * If true include details of contacts.
1199 * array of return properties
1202 public static function getRelatedContacts($caseID, $includeDetails = TRUE) {
1203 $caseRoles = array();
1204 if ($includeDetails) {
1205 $caseInfo = civicrm_api3('Case', 'getsingle', array(
1207 // Most efficient way of retrieving definition is to also include case type id and name so the api doesn't have to look it up separately
1208 'return' => array('case_type_id', 'case_type_id.name', 'case_type_id.definition'),
1210 if (!empty($caseInfo['case_type_id.definition']['caseRoles'])) {
1211 $caseRoles = CRM_Utils_Array
::rekey($caseInfo['case_type_id.definition']['caseRoles'], 'name');
1216 SELECT cc.display_name as name, cc.sort_name as sort_name, cc.id, cr.relationship_type_id, crt.label_b_a as role, crt.name_b_a, ce.email, cp.phone
1217 FROM civicrm_relationship cr
1218 LEFT JOIN civicrm_relationship_type crt
1219 ON crt.id = cr.relationship_type_id
1220 LEFT JOIN civicrm_contact cc
1221 ON cc.id = cr.contact_id_b
1222 LEFT JOIN civicrm_email ce
1223 ON ce.contact_id = cc.id
1224 AND ce.is_primary= 1
1225 LEFT JOIN civicrm_phone cp
1226 ON cp.contact_id = cc.id
1227 AND cp.is_primary= 1
1228 WHERE cr.case_id = %1 AND cr.is_active AND cc.is_deleted <> 1';
1230 $params = array(1 => array($caseID, 'Integer'));
1231 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1233 while ($dao->fetch()) {
1234 if (!$includeDetails) {
1235 $values[$dao->id
] = 1;
1239 'contact_id' => $dao->id
,
1240 'display_name' => $dao->name
,
1241 'sort_name' => $dao->sort_name
,
1242 'relationship_type_id' => $dao->relationship_type_id
,
1243 'role' => $dao->role
,
1244 'email' => $dao->email
,
1245 'phone' => $dao->phone
,
1247 // Add more info about the role (creator, manager)
1248 $role = CRM_Utils_Array
::value($dao->name_b_a
, $caseRoles);
1250 unset($role['name']);
1253 $values[] = $details;
1261 * Send e-mail copy of activity
1263 * @param int $clientId
1264 * @param int $activityId
1266 * @param array $contacts
1267 * Array of related contact.
1269 * @param null $attachments
1270 * @param int $caseId
1272 * @return bool |array
1274 public static function sendActivityCopy($clientId, $activityId, $contacts, $attachments = NULL, $caseId) {
1279 $tplParams = $activityInfo = array();
1280 $activityTypeId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $activityId, 'activity_type_id');
1281 // If it's a case activity
1283 $nonCaseActivityTypes = CRM_Core_PseudoConstant
::activityType();
1284 if (!empty($nonCaseActivityTypes[$activityTypeId])) {
1285 $anyActivity = TRUE;
1288 $anyActivity = FALSE;
1290 $tplParams['isCaseActivity'] = 1;
1291 $tplParams['client_id'] = $clientId;
1294 $anyActivity = TRUE;
1297 $xmlProcessorProcess = new CRM_Case_XMLProcessor_Process();
1298 $isRedact = $xmlProcessorProcess->getRedactActivityEmail();
1300 $xmlProcessorReport = new CRM_Case_XMLProcessor_Report();
1302 $activityInfo = $xmlProcessorReport->getActivityInfo($clientId, $activityId, $anyActivity, $isRedact);
1304 $activityInfo['fields'][] = array('label' => 'Case ID', 'type' => 'String', 'value' => $caseId);
1306 $tplParams['activityTypeName'] = CRM_Core_PseudoConstant
::getLabel('CRM_Activity_DAO_Activity', 'activity_type_id', $activityTypeId);
1307 $tplParams['activity'] = $activityInfo;
1308 foreach ($tplParams['activity']['fields'] as $k => $val) {
1309 if (CRM_Utils_Array
::value('label', $val) == ts('Subject')) {
1310 $activitySubject = $val['value'];
1314 $session = CRM_Core_Session
::singleton();
1315 // CRM-8926 If user is not logged in, use the activity creator as userID
1316 if (!($userID = $session->get('userID'))) {
1317 $userID = CRM_Activity_BAO_Activity
::getSourceContactID($activityId);
1320 //also create activities simultaneously of this copy.
1321 $activityParams = array();
1323 $activityParams['source_record_id'] = $activityId;
1324 $activityParams['source_contact_id'] = $userID;
1325 $activityParams['activity_type_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_DAO_Activity', 'activity_type_id', 'Email');
1326 $activityParams['activity_date_time'] = date('YmdHis');
1327 $activityParams['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_DAO_Activity', 'activity_status_id', 'Completed');
1328 $activityParams['medium_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_DAO_Activity', 'encounter_medium', 'email');
1329 $activityParams['case_id'] = $caseId;
1330 $activityParams['is_auto'] = 0;
1331 $activityParams['target_id'] = $clientId;
1333 $tplParams['activitySubject'] = $activitySubject;
1335 // if it’s a case activity, add hashed id to the template (CRM-5916)
1337 $tplParams['idHash'] = substr(sha1(CIVICRM_SITE_KEY
. $caseId), 0, 7);
1341 // CRM-20308 get receiptFrom defaults see https://issues.civicrm.org/jira/browse/CRM-20308
1342 $receiptFrom = self
::getReceiptFrom($activityId);
1344 $recordedActivityParams = array();
1346 foreach ($contacts as $mail => $info) {
1347 $tplParams['contact'] = $info;
1348 self
::buildPermissionLinks($tplParams, $activityParams);
1350 $displayName = CRM_Utils_Array
::value('display_name', $info);
1352 list($result[CRM_Utils_Array
::value('contact_id', $info)], $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate(
1354 'groupName' => 'msg_tpl_workflow_case',
1355 'valueName' => 'case_activity',
1356 'contactId' => CRM_Utils_Array
::value('contact_id', $info),
1357 'tplParams' => $tplParams,
1358 'from' => $receiptFrom,
1359 'toName' => $displayName,
1361 'attachments' => $attachments,
1365 $activityParams['subject'] = ts('%1 - copy sent to %2', [1 => $activitySubject, 2 => $displayName]);
1366 $activityParams['details'] = $message;
1368 if (!empty($result[$info['contact_id']])) {
1370 * Really only need to record one activity with all the targets combined.
1371 * Originally the template was going to possibly have different content, e.g. depending on permissions,
1372 * but it's always the same content at the moment.
1374 if (empty($recordedActivityParams)) {
1375 $recordedActivityParams = $activityParams;
1378 $recordedActivityParams['subject'] .= "; $displayName";
1380 $recordedActivityParams['target_contact_id'][] = $info['contact_id'];
1383 unset($result[CRM_Utils_Array
::value('contact_id', $info)]);
1387 if (!empty($recordedActivityParams)) {
1388 $activity = CRM_Activity_BAO_Activity
::create($recordedActivityParams);
1390 //create case_activity record if its case activity.
1392 $caseParams = array(
1393 'activity_id' => $activity->id
,
1394 'case_id' => $caseId,
1396 self
::processCaseActivity($caseParams);
1404 * Retrieve count of activities having a particular type, and
1405 * associated with a particular case.
1407 * @param int $caseId
1409 * @param int $activityTypeId
1410 * ID of the activity type.
1414 public static function getCaseActivityCount($caseId, $activityTypeId) {
1415 $queryParam = array(
1416 1 => array($caseId, 'Integer'),
1417 2 => array($activityTypeId, 'Integer'),
1419 $query = "SELECT count(ca.id) as countact
1420 FROM civicrm_activity ca
1421 INNER JOIN civicrm_case_activity cca ON ca.id = cca.activity_id
1422 WHERE ca.activity_type_id = %2
1423 AND cca.case_id = %1
1424 AND ca.is_deleted = 0";
1426 $dao = CRM_Core_DAO
::executeQuery($query, $queryParam);
1427 if ($dao->fetch()) {
1428 return $dao->countact
;
1435 * Create an activity for a case via email.
1440 * @return array|void
1441 * $activity object of newly creted activity via email
1443 public static function recordActivityViaEmail($file) {
1444 if (!file_exists($file) ||
1447 return CRM_Core_Error
::fatal(ts('File %1 does not exist or is not readable',
1452 $result = CRM_Utils_Mail_Incoming
::parse($file);
1453 if ($result['is_error']) {
1457 foreach ($result['to'] as $to) {
1460 $emailPattern = '/^([A-Z0-9._%+-]+)\+([\d]+)@[A-Z0-9.-]+\.[A-Z]{2,4}$/i';
1461 $replacement = preg_replace($emailPattern, '$2', $to['email']);
1463 if ($replacement !== $to['email']) {
1464 $caseId = $replacement;
1465 //if caseId is invalid, return as error file
1466 if (!CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_Case', $caseId, 'id')) {
1467 return CRM_Core_Error
::createAPIError(ts('Invalid case ID ( %1 ) in TO: field.',
1476 // TODO: May want to replace this with a call to getRelatedAndGlobalContacts() when this feature is revisited.
1477 // (Or for efficiency call the global one outside the loop and then union with this each time.)
1478 $contactDetails = self
::getRelatedContacts($caseId, FALSE);
1480 if (!empty($contactDetails[$result['from']['id']])) {
1482 $params['subject'] = $result['subject'];
1483 $params['activity_date_time'] = $result['date'];
1484 $params['details'] = $result['body'];
1485 $params['source_contact_id'] = $result['from']['id'];
1486 $params['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed');
1488 $details = CRM_Case_PseudoConstant
::caseActivityType();
1490 preg_match('/^\W+([a-zA-Z0-9_ ]+)(\W+)?\n/i',
1491 $result['body'], $matches
1494 if (!empty($matches) && isset($matches[1])) {
1495 $activityType = trim($matches[1]);
1496 if (isset($details[$activityType])) {
1497 $params['activity_type_id'] = $details[$activityType]['id'];
1500 if (!isset($params['activity_type_id'])) {
1501 $params['activity_type_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Inbound Email');
1505 $activity = CRM_Activity_BAO_Activity
::create($params);
1507 $caseParams = array(
1508 'activity_id' => $activity->id
,
1509 'case_id' => $caseId,
1511 self
::processCaseActivity($caseParams);
1514 return CRM_Core_Error
::createAPIError(ts('FROM email contact %1 doesn\'t have a relationship to the referenced case.',
1515 array(1 => $result['from']['email'])
1522 * Retrieve the scheduled activity type and date.
1524 * @param array $cases
1525 * Array of contact and case id.
1527 * @param string $type
1530 * Array of scheduled activity type and date
1534 public static function getNextScheduledActivity($cases, $type = 'upcoming') {
1535 $session = CRM_Core_Session
::singleton();
1536 $userID = $session->get('userID');
1538 $caseID = implode(',', $cases['case_id']);
1539 $contactID = implode(',', $cases['contact_id']);
1541 $condition = " civicrm_case_contact.contact_id IN( {$contactID} )
1542 AND civicrm_case.id IN( {$caseID})
1543 AND civicrm_case.is_deleted = {$cases['case_deleted']}";
1545 $query = self
::getCaseActivityQuery($type, $userID, $condition);
1546 $activityTypes = CRM_Activity_BAO_Activity
::buildOptions('activity_type_id');
1548 $res = CRM_Core_DAO
::executeQuery($query);
1550 $activityInfo = array();
1551 while ($res->fetch()) {
1552 if ($type == 'upcoming') {
1553 $activityInfo[$res->case_id
]['date'] = $res->activity_date_time
;
1554 $activityInfo[$res->case_id
]['type'] = CRM_Utils_Array
::value($res->activity_type_id
, $activityTypes);
1557 $activityInfo[$res->case_id
]['date'] = $res->activity_date_time
;
1558 $activityInfo[$res->case_id
]['type'] = CRM_Utils_Array
::value($res->activity_type_id
, $activityTypes);
1562 return $activityInfo;
1566 * Combine all the exportable fields from the lower levels object.
1569 * array of exportable Fields
1571 public static function &exportableFields() {
1572 if (!self
::$_exportableFields) {
1573 if (!self
::$_exportableFields) {
1574 self
::$_exportableFields = array();
1577 $fields = CRM_Case_DAO_Case
::export();
1578 $fields['case_role'] = array('title' => ts('Role in Case'));
1579 $fields['case_type'] = array(
1580 'title' => ts('Case Type'),
1581 'name' => 'case_type',
1583 $fields['case_status'] = array(
1584 'title' => ts('Case Status'),
1585 'name' => 'case_status',
1588 // add custom data for cases
1589 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Case'));
1591 self
::$_exportableFields = $fields;
1593 return self
::$_exportableFields;
1597 * Restore the record that are associated with this case.
1599 * @param int $caseId
1600 * Id of the case to restore.
1604 public static function restoreCase($caseId) {
1605 //restore activities
1606 $activities = self
::getCaseActivityDates($caseId);
1608 foreach ($activities as $value) {
1609 CRM_Activity_BAO_Activity
::restoreActivity($value);
1613 $case = new CRM_Case_DAO_Case();
1614 $case->id
= $caseId;
1615 $case->is_deleted
= 0;
1618 //CRM-7364, enable relationships
1619 self
::enableDisableCaseRelationships($caseId, TRUE);
1626 * @param null $showLinks
1627 * @param bool $returnOnlyCount
1628 * @param int $offset
1629 * @param int $rowCount
1633 public static function getGlobalContacts(&$groupInfo, $sort = NULL, $showLinks = NULL, $returnOnlyCount = FALSE, $offset = 0, $rowCount = 25) {
1634 $globalContacts = array();
1636 $settingsProcessor = new CRM_Case_XMLProcessor_Settings();
1637 $settings = $settingsProcessor->run();
1638 if (!empty($settings)) {
1639 $groupInfo['name'] = $settings['groupname'];
1640 if ($groupInfo['name']) {
1641 $searchParams = array('name' => $groupInfo['name']);
1643 CRM_Contact_BAO_Group
::retrieve($searchParams, $results);
1645 $groupInfo['id'] = $results['id'];
1646 $groupInfo['title'] = $results['title'];
1647 $params = array(array('group', '=', $groupInfo['id'], 0, 0));
1648 $return = array('contact_id' => 1, 'sort_name' => 1, 'display_name' => 1, 'email' => 1, 'phone' => 1);
1649 list($globalContacts) = CRM_Contact_BAO_Query
::apiQuery($params, $return, NULL, $sort, $offset, $rowCount, TRUE, $returnOnlyCount);
1651 if ($returnOnlyCount) {
1652 return $globalContacts;
1656 foreach ($globalContacts as $idx => $contact) {
1657 $globalContacts[$idx]['sort_name'] = '<a href="' . CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$contact['contact_id']}") . '">' . $contact['sort_name'] . '</a>';
1663 return $globalContacts;
1667 * Convenience function to get both case contacts and global in one array.
1668 * @param int $caseId
1672 public static function getRelatedAndGlobalContacts($caseId) {
1673 $relatedContacts = self
::getRelatedContacts($caseId);
1675 $groupInfo = array();
1676 $globalContacts = self
::getGlobalContacts($groupInfo);
1678 //unset values which are not required.
1679 foreach ($globalContacts as $k => & $v) {
1680 unset($v['email_id']);
1681 unset($v['group_contact_id']);
1682 unset($v['status']);
1684 $v['role'] = $groupInfo['title'];
1686 //include multiple listings for the same contact/different roles.
1687 $relatedGlobalContacts = array_merge($relatedContacts, $globalContacts);
1688 return $relatedGlobalContacts;
1692 * Get Case ActivitiesDueDates with given criteria.
1694 * @param int $caseID
1696 * @param array $criteriaParams
1698 * @param bool $latestDate
1699 * If set newest or oldest date is selected.
1702 * case activities due dates
1705 public static function getCaseActivityDates($caseID, $criteriaParams = array(), $latestDate = FALSE) {
1707 $selectDate = " ca.activity_date_time";
1708 $where = $groupBy = ' ';
1715 if (!empty($criteriaParams['activity_type_id'])) {
1716 $where .= " AND ca.activity_type_id = " . CRM_Utils_Type
::escape($criteriaParams['activity_type_id'], 'Integer');
1717 $where .= " AND ca.is_current_revision = 1";
1718 $groupBy .= " GROUP BY ca.activity_type_id, ca.id";
1721 if (!empty($criteriaParams['newest'])) {
1722 $selectDate = " max(ca.activity_date_time) ";
1725 $selectDate = " min(ca.activity_date_time) ";
1729 $query = "SELECT ca.id, {$selectDate} as activity_date
1730 FROM civicrm_activity ca
1731 LEFT JOIN civicrm_case_activity cca ON cca.activity_id = ca.id LEFT JOIN civicrm_case cc ON cc.id = cca.case_id
1732 WHERE cc.id = %1 {$where} {$groupBy}";
1734 $params = array(1 => array($caseID, 'Integer'));
1735 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1737 while ($dao->fetch()) {
1738 $values[$dao->id
]['id'] = $dao->id
;
1739 $values[$dao->id
]['activity_date'] = $dao->activity_date
;
1745 * Create activities when Case or Other roles assigned/modified/deleted.
1747 * @param int $caseId
1748 * @param int $relationshipId
1750 * @param int $relContactId
1751 * Case role assignee contactId.
1752 * @param int $contactId
1754 public static function createCaseRoleActivity($caseId, $relationshipId, $relContactId = NULL, $contactId = NULL) {
1755 if (!$caseId ||
!$relationshipId ||
empty($relationshipId)) {
1759 $queryParam = array();
1760 if (is_array($relationshipId)) {
1761 $relationshipId = implode(',', $relationshipId);
1762 $relationshipClause = " civicrm_relationship.id IN ($relationshipId)";
1765 $relationshipClause = " civicrm_relationship.id = %1";
1766 $queryParam[1] = array($relationshipId, 'Positive');
1770 SELECT cc.display_name as clientName,
1771 cca.display_name as assigneeContactName,
1772 civicrm_relationship.case_id as caseId,
1773 civicrm_relationship_type.label_a_b as relation_a_b,
1774 civicrm_relationship_type.label_b_a as relation_b_a,
1775 civicrm_relationship.contact_id_b as rel_contact_id,
1776 civicrm_relationship.contact_id_a as assign_contact_id
1777 FROM civicrm_relationship_type, civicrm_relationship
1778 LEFT JOIN civicrm_contact cc ON cc.id = civicrm_relationship.contact_id_b
1779 LEFT JOIN civicrm_contact cca ON cca.id = civicrm_relationship.contact_id_a
1780 WHERE civicrm_relationship.relationship_type_id = civicrm_relationship_type.id AND {$relationshipClause}";
1782 $dao = CRM_Core_DAO
::executeQuery($query, $queryParam);
1784 while ($dao->fetch()) {
1785 // The assignee is not the client.
1786 if ($dao->rel_contact_id
!= $contactId) {
1787 $caseRelationship = $dao->relation_a_b
;
1788 $assigneContactName = $dao->clientName
;
1789 $assigneContactIds[$dao->rel_contact_id
] = $dao->rel_contact_id
;
1792 $caseRelationship = $dao->relation_b_a
;
1793 $assigneContactName = $dao->assigneeContactName
;
1794 $assigneContactIds[$dao->assign_contact_id
] = $dao->assign_contact_id
;
1798 $session = CRM_Core_Session
::singleton();
1799 $activityParams = array(
1800 'source_contact_id' => $session->get('userID'),
1801 'subject' => $caseRelationship . ' : ' . $assigneContactName,
1802 'activity_date_time' => date('YmdHis'),
1803 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'),
1806 //if $relContactId is passed, role is added or modified.
1807 if (!empty($relContactId)) {
1808 $activityParams['assignee_contact_id'] = $assigneContactIds;
1809 $activityTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Assign Case Role');
1812 $activityTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Remove Case Role');
1815 $activityParams['activity_type_id'] = $activityTypeID;
1817 $activity = CRM_Activity_BAO_Activity
::create($activityParams);
1819 //create case_activity record.
1820 $caseParams = array(
1821 'activity_id' => $activity->id
,
1822 'case_id' => $caseId,
1825 CRM_Case_BAO_Case
::processCaseActivity($caseParams);
1830 * contact which is assigned a case role of case manager.
1832 * @param int $caseType
1834 * @param int $caseId
1838 * html hyperlink of manager contact view page
1841 public static function getCaseManagerContact($caseType, $caseId) {
1842 if (!$caseType ||
!$caseId) {
1846 $caseManagerName = '---';
1847 $xmlProcessor = new CRM_Case_XMLProcessor_Process();
1849 $managerRoleId = $xmlProcessor->getCaseManagerRoleId($caseType);
1851 if (!empty($managerRoleId)) {
1852 $managerRoleQuery = "
1853 SELECT civicrm_contact.id as casemanager_id,
1854 civicrm_contact.sort_name as casemanager
1855 FROM civicrm_contact
1856 LEFT JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = civicrm_contact.id AND civicrm_relationship.relationship_type_id = %1) AND civicrm_relationship.is_active
1857 LEFT JOIN civicrm_case ON civicrm_case.id = civicrm_relationship.case_id
1858 WHERE civicrm_case.id = %2 AND is_active = 1";
1860 $managerRoleParams = array(
1861 1 => array($managerRoleId, 'Integer'),
1862 2 => array($caseId, 'Integer'),
1865 $dao = CRM_Core_DAO
::executeQuery($managerRoleQuery, $managerRoleParams);
1866 if ($dao->fetch()) {
1867 $caseManagerName = sprintf('<a href="%s">%s</a>',
1868 CRM_Utils_System
::url('civicrm/contact/view', array('cid' => $dao->casemanager_id
)),
1874 return $caseManagerName;
1878 * @param int $contactId
1879 * @param bool $excludeDeleted
1883 public static function caseCount($contactId = NULL, $excludeDeleted = TRUE) {
1884 $params = array('check_permissions' => TRUE);
1885 if ($excludeDeleted) {
1886 $params['is_deleted'] = 0;
1889 $params['contact_id'] = $contactId;
1892 return civicrm_api3('Case', 'getcount', $params);
1894 catch (CiviCRM_API3_Exception
$e) {
1895 // Lack of permissions will throw an exception
1901 * Retrieve related case ids for given case.
1903 * @param int $caseId
1904 * @param bool $excludeDeleted
1905 * Do not include deleted cases.
1909 public static function getRelatedCaseIds($caseId, $excludeDeleted = TRUE) {
1910 //FIXME : do check for permissions.
1916 $linkActType = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Link Cases');
1917 if (!$linkActType) {
1921 $whereClause = "mainCase.id = %2";
1922 if ($excludeDeleted) {
1923 $whereClause .= " AND ( relAct.is_deleted = 0 OR relAct.is_deleted IS NULL )";
1927 SELECT relCaseAct.case_id
1928 FROM civicrm_case mainCase
1929 INNER JOIN civicrm_case_activity mainCaseAct ON (mainCaseAct.case_id = mainCase.id)
1930 INNER JOIN civicrm_activity mainAct ON (mainCaseAct.activity_id = mainAct.id AND mainAct.activity_type_id = %1)
1931 INNER JOIN civicrm_case_activity relCaseAct ON (relCaseAct.activity_id = mainAct.id AND mainCaseAct.id != relCaseAct.id)
1932 INNER JOIN civicrm_activity relAct ON (relCaseAct.activity_id = relAct.id AND relAct.activity_type_id = %1)
1933 WHERE $whereClause";
1935 $dao = CRM_Core_DAO
::executeQuery($query, array(
1936 1 => array($linkActType, 'Integer'),
1937 2 => array($caseId, 'Integer'),
1939 $relatedCaseIds = array();
1940 while ($dao->fetch()) {
1941 $relatedCaseIds[$dao->case_id
] = $dao->case_id
;
1944 return array_values($relatedCaseIds);
1948 * Retrieve related case details for given case.
1950 * @param int $caseId
1951 * @param bool $excludeDeleted
1952 * Do not include deleted cases.
1956 public static function getRelatedCases($caseId, $excludeDeleted = TRUE) {
1957 $relatedCaseIds = self
::getRelatedCaseIds($caseId, $excludeDeleted);
1958 $relatedCases = array();
1960 if (!$relatedCaseIds) {
1964 $whereClause = 'relCase.id IN ( ' . implode(',', $relatedCaseIds) . ' )';
1965 if ($excludeDeleted) {
1966 $whereClause .= " AND ( relCase.is_deleted = 0 OR relCase.is_deleted IS NULL )";
1969 //filter for permissioned cases.
1970 $filterCases = array();
1971 $doFilterCases = FALSE;
1972 if (!CRM_Core_Permission
::check('access all cases and activities')) {
1973 $doFilterCases = TRUE;
1974 $filterCases = CRM_Case_BAO_Case
::getCases(FALSE);
1977 //2. fetch the details of related cases.
1979 SELECT relCase.id as id,
1980 civicrm_case_type.title as case_type,
1981 client.display_name as client_name,
1982 client.id as client_id,
1984 FROM civicrm_case relCase
1985 INNER JOIN civicrm_case_contact relCaseContact ON ( relCase.id = relCaseContact.case_id )
1986 INNER JOIN civicrm_contact client ON ( client.id = relCaseContact.contact_id )
1987 LEFT JOIN civicrm_case_type ON relCase.case_type_id = civicrm_case_type.id
1988 WHERE {$whereClause}";
1990 $dao = CRM_Core_DAO
::executeQuery($query);
1991 $contactViewUrl = CRM_Utils_System
::url("civicrm/contact/view", "reset=1&cid=");
1992 $hasViewContact = CRM_Core_Permission
::giveMeAllACLs();
1993 $statuses = CRM_Case_BAO_Case
::buildOptions('status_id');
1995 while ($dao->fetch()) {
1997 if (!$doFilterCases ||
array_key_exists($dao->id
, $filterCases)) {
1998 $caseViewStr = "reset=1&id={$dao->id}&cid={$dao->client_id}&action=view&context=case&selectedChild=case";
1999 $caseViewUrl = CRM_Utils_System
::url("civicrm/contact/view/case", $caseViewStr);
2000 $caseView = "<a class='action-item no-popup crm-hover-button' href='{$caseViewUrl}'>" . ts('View Case') . "</a>";
2002 $clientView = $dao->client_name
;
2003 if ($hasViewContact) {
2004 $clientView = "<a href='{$contactViewUrl}{$dao->client_id}'>$dao->client_name</a>";
2007 $relatedCases[$dao->id
] = array(
2008 'case_id' => $dao->id
,
2009 'case_type' => $dao->case_type
,
2010 'client_name' => $clientView,
2011 'case_status' => $statuses[$dao->status_id
],
2012 'links' => $caseView,
2016 return $relatedCases;
2020 * Merge two duplicate contacts' cases - follow CRM-5758 rules.
2022 * @see CRM_Dedupe_Merger::cpTables()
2024 * TODO: use the 3rd $sqls param to append sql statements rather than executing them here
2026 * @param int $mainContactId
2027 * @param int $otherContactId
2029 public static function mergeContacts($mainContactId, $otherContactId) {
2030 self
::mergeCases($mainContactId, NULL, $otherContactId);
2034 * Function perform two task.
2035 * 1. Merge two duplicate contacts cases - follow CRM-5758 rules.
2036 * 2. Merge two cases of same contact - follow CRM-5598 rules.
2038 * @param int $mainContactId
2039 * Contact id of main contact record.
2040 * @param int $mainCaseId
2041 * Case id of main case record.
2042 * @param int $otherContactId
2043 * Contact id of record which is going to merge.
2044 * @param int $otherCaseId
2045 * Case id of record which is going to merge.
2047 * @param bool $changeClient
2051 public static function mergeCases(
2052 $mainContactId, $mainCaseId = NULL, $otherContactId = NULL,
2053 $otherCaseId = NULL, $changeClient = FALSE) {
2054 $moveToTrash = TRUE;
2056 $duplicateContacts = FALSE;
2057 if ($mainContactId && $otherContactId &&
2058 $mainContactId != $otherContactId
2060 $duplicateContacts = TRUE;
2063 $duplicateCases = FALSE;
2064 if ($mainCaseId && $otherCaseId &&
2065 $mainCaseId != $otherCaseId
2067 $duplicateCases = TRUE;
2070 $mainCaseIds = array();
2071 if (!$duplicateContacts && !$duplicateCases) {
2072 return $mainCaseIds;
2075 $activityTypes = CRM_Activity_BAO_Activity
::buildOptions('activity_type_id', 'validate');
2076 $completedActivityStatus = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed');
2077 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2078 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2079 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
2080 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2082 $processCaseIds = array($otherCaseId);
2083 if ($duplicateContacts && !$duplicateCases) {
2084 if ($changeClient) {
2085 $processCaseIds = array($mainCaseId);
2088 //get all case ids for other contact.
2089 $processCaseIds = self
::retrieveCaseIdsByContactId($otherContactId, TRUE);
2091 if (!is_array($processCaseIds)) {
2096 $session = CRM_Core_Session
::singleton();
2097 $currentUserId = $session->get('userID');
2099 CRM_Utils_Hook
::pre_case_merge($mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient);
2101 // copy all cases and connect to main contact id.
2102 foreach ($processCaseIds as $otherCaseId) {
2103 if ($duplicateContacts) {
2104 $mainCase = CRM_Core_DAO
::copyGeneric('CRM_Case_DAO_Case', array('id' => $otherCaseId));
2105 $mainCaseId = $mainCase->id
;
2110 // CRM-11662 Copy Case custom data
2111 $extends = array('case');
2112 $groupTree = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, NULL, $extends);
2114 foreach ($groupTree as $groupID => $group) {
2115 $table[$groupTree[$groupID]['table_name']] = array('entity_id');
2116 foreach ($group['fields'] as $fieldID => $field) {
2117 $table[$groupTree[$groupID]['table_name']][] = $groupTree[$groupID]['fields'][$fieldID]['column_name'];
2121 foreach ($table as $tableName => $tableColumns) {
2122 $insert = 'INSERT INTO ' . $tableName . ' (' . implode(', ', $tableColumns) . ') ';
2123 $tableColumns[0] = $mainCaseId;
2124 $select = 'SELECT ' . implode(', ', $tableColumns);
2125 $from = ' FROM ' . $tableName;
2126 $where = " WHERE {$tableName}.entity_id = {$otherCaseId}";
2127 $query = $insert . $select . $from . $where;
2128 $dao = CRM_Core_DAO
::executeQuery($query);
2132 $mainCaseIds[] = $mainCaseId;
2133 //insert record for case contact.
2134 $otherCaseContact = new CRM_Case_DAO_CaseContact();
2135 $otherCaseContact->case_id
= $otherCaseId;
2136 $otherCaseContact->find();
2137 while ($otherCaseContact->fetch()) {
2138 $mainCaseContact = new CRM_Case_DAO_CaseContact();
2139 $mainCaseContact->case_id
= $mainCaseId;
2140 $mainCaseContact->contact_id
= $otherCaseContact->contact_id
;
2141 if ($mainCaseContact->contact_id
== $otherContactId) {
2142 $mainCaseContact->contact_id
= $mainContactId;
2144 //avoid duplicate object.
2145 if (!$mainCaseContact->find(TRUE)) {
2146 $mainCaseContact->save();
2150 elseif (!$otherContactId) {
2151 $otherContactId = $mainContactId;
2154 if (!$mainCaseId ||
!$otherCaseId ||
2155 !$mainContactId ||
!$otherContactId
2160 // get all activities for other case.
2161 $otherCaseActivities = array();
2162 CRM_Core_DAO
::commonRetrieveAll('CRM_Case_DAO_CaseActivity', 'case_id', $otherCaseId, $otherCaseActivities);
2164 //for duplicate cases do not process singleton activities.
2165 $otherActivityIds = $singletonActivityIds = array();
2166 foreach ($otherCaseActivities as $caseActivityId => $otherIds) {
2167 $otherActId = CRM_Utils_Array
::value('activity_id', $otherIds);
2168 if (!$otherActId ||
in_array($otherActId, $otherActivityIds)) {
2171 $otherActivityIds[] = $otherActId;
2173 if ($duplicateCases) {
2174 if ($openCaseType = array_search('Open Case', $activityTypes)) {
2177 FROM civicrm_activity
2178 WHERE activity_type_id = $openCaseType
2179 AND id IN ( " . implode(',', array_values($otherActivityIds)) . ');';
2180 $dao = CRM_Core_DAO
::executeQuery($sql);
2181 while ($dao->fetch()) {
2182 $singletonActivityIds[] = $dao->id
;
2187 // migrate all activities and connect to main contact.
2188 $copiedActivityIds = $activityMappingIds = array();
2189 sort($otherActivityIds);
2190 foreach ($otherActivityIds as $otherActivityId) {
2192 //for duplicate cases -
2193 //do not migrate singleton activities.
2194 if (!$otherActivityId ||
in_array($otherActivityId, $singletonActivityIds)) {
2198 //migrate activity record.
2199 $otherActivity = new CRM_Activity_DAO_Activity();
2200 $otherActivity->id
= $otherActivityId;
2201 if (!$otherActivity->find(TRUE)) {
2205 $mainActVals = array();
2206 $mainActivity = new CRM_Activity_DAO_Activity();
2207 CRM_Core_DAO
::storeValues($otherActivity, $mainActVals);
2208 $mainActivity->copyValues($mainActVals);
2209 $mainActivity->id
= NULL;
2210 $mainActivity->activity_date_time
= CRM_Utils_Date
::isoToMysql($otherActivity->activity_date_time
);
2211 $mainActivity->source_record_id
= CRM_Utils_Array
::value($mainActivity->source_record_id
,
2215 $mainActivity->original_id
= CRM_Utils_Array
::value($mainActivity->original_id
,
2219 $mainActivity->parent_id
= CRM_Utils_Array
::value($mainActivity->parent_id
,
2222 $mainActivity->save();
2223 $mainActivityId = $mainActivity->id
;
2224 if (!$mainActivityId) {
2228 $activityMappingIds[$otherActivityId] = $mainActivityId;
2229 // insert log of all activities
2230 CRM_Activity_BAO_Activity
::logActivityAction($mainActivity);
2232 $copiedActivityIds[] = $otherActivityId;
2234 //create case activity record.
2235 $mainCaseActivity = new CRM_Case_DAO_CaseActivity();
2236 $mainCaseActivity->case_id
= $mainCaseId;
2237 $mainCaseActivity->activity_id
= $mainActivityId;
2238 $mainCaseActivity->save();
2240 //migrate source activity.
2241 $otherSourceActivity = new CRM_Activity_DAO_ActivityContact();
2242 $otherSourceActivity->activity_id
= $otherActivityId;
2243 $otherSourceActivity->record_type_id
= $sourceID;
2244 $otherSourceActivity->find();
2245 while ($otherSourceActivity->fetch()) {
2246 $mainActivitySource = new CRM_Activity_DAO_ActivityContact();
2247 $mainActivitySource->record_type_id
= $sourceID;
2248 $mainActivitySource->activity_id
= $mainActivityId;
2249 $mainActivitySource->contact_id
= $otherSourceActivity->contact_id
;
2250 if ($mainActivitySource->contact_id
== $otherContactId) {
2251 $mainActivitySource->contact_id
= $mainContactId;
2253 //avoid duplicate object.
2254 if (!$mainActivitySource->find(TRUE)) {
2255 $mainActivitySource->save();
2259 //migrate target activities.
2260 $otherTargetActivity = new CRM_Activity_DAO_ActivityContact();
2261 $otherTargetActivity->activity_id
= $otherActivityId;
2262 $otherTargetActivity->record_type_id
= $targetID;
2263 $otherTargetActivity->find();
2264 while ($otherTargetActivity->fetch()) {
2265 $mainActivityTarget = new CRM_Activity_DAO_ActivityContact();
2266 $mainActivityTarget->record_type_id
= $targetID;
2267 $mainActivityTarget->activity_id
= $mainActivityId;
2268 $mainActivityTarget->contact_id
= $otherTargetActivity->contact_id
;
2269 if ($mainActivityTarget->contact_id
== $otherContactId) {
2270 $mainActivityTarget->contact_id
= $mainContactId;
2272 //avoid duplicate object.
2273 if (!$mainActivityTarget->find(TRUE)) {
2274 $mainActivityTarget->save();
2278 //migrate assignee activities.
2279 $otherAssigneeActivity = new CRM_Activity_DAO_ActivityContact();
2280 $otherAssigneeActivity->activity_id
= $otherActivityId;
2281 $otherAssigneeActivity->record_type_id
= $assigneeID;
2282 $otherAssigneeActivity->find();
2283 while ($otherAssigneeActivity->fetch()) {
2284 $mainAssigneeActivity = new CRM_Activity_DAO_ActivityContact();
2285 $mainAssigneeActivity->activity_id
= $mainActivityId;
2286 $mainAssigneeActivity->record_type_id
= $assigneeID;
2287 $mainAssigneeActivity->contact_id
= $otherAssigneeActivity->contact_id
;
2288 if ($mainAssigneeActivity->contact_id
== $otherContactId) {
2289 $mainAssigneeActivity->contact_id
= $mainContactId;
2291 //avoid duplicate object.
2292 if (!$mainAssigneeActivity->find(TRUE)) {
2293 $mainAssigneeActivity->save();
2297 // copy custom fields and attachments
2299 'activityID' => $otherActivityId,
2300 'mainActivityId' => $mainActivityId,
2302 CRM_Activity_BAO_Activity
::copyExtendedActivityData($aparams);
2305 //copy case relationship.
2306 if ($duplicateContacts) {
2307 //migrate relationship records.
2308 $otherRelationship = new CRM_Contact_DAO_Relationship();
2309 $otherRelationship->case_id
= $otherCaseId;
2310 $otherRelationship->find();
2311 $otherRelationshipIds = array();
2312 while ($otherRelationship->fetch()) {
2313 $otherRelVals = array();
2314 $updateOtherRel = FALSE;
2315 CRM_Core_DAO
::storeValues($otherRelationship, $otherRelVals);
2317 $mainRelationship = new CRM_Contact_DAO_Relationship();
2318 $mainRelationship->copyValues($otherRelVals);
2319 $mainRelationship->id
= NULL;
2320 $mainRelationship->case_id
= $mainCaseId;
2321 if ($mainRelationship->contact_id_a
== $otherContactId) {
2322 $updateOtherRel = TRUE;
2323 $mainRelationship->contact_id_a
= $mainContactId;
2326 //case creator change only when we merge user contact.
2327 if ($mainRelationship->contact_id_b
== $otherContactId) {
2328 //do not change creator for change client.
2329 if (!$changeClient) {
2330 $updateOtherRel = TRUE;
2331 $mainRelationship->contact_id_b
= ($currentUserId) ?
$currentUserId : $mainContactId;
2334 $mainRelationship->end_date
= CRM_Utils_Date
::isoToMysql($otherRelationship->end_date
);
2335 $mainRelationship->start_date
= CRM_Utils_Date
::isoToMysql($otherRelationship->start_date
);
2337 //avoid duplicate object.
2338 if (!$mainRelationship->find(TRUE)) {
2339 $mainRelationship->save();
2342 //get the other relationship ids to update end date.
2343 if ($updateOtherRel) {
2344 $otherRelationshipIds[$otherRelationship->id
] = $otherRelationship->id
;
2348 //update other relationships end dates
2349 if (!empty($otherRelationshipIds)) {
2350 $sql = 'UPDATE civicrm_relationship
2351 SET end_date = CURDATE()
2352 WHERE id IN ( ' . implode(',', $otherRelationshipIds) . ')';
2353 CRM_Core_DAO
::executeQuery($sql);
2357 //move other case to trash.
2358 $mergeCase = self
::deleteCase($otherCaseId, $moveToTrash);
2363 $mergeActSubject = $mergeActSubjectDetails = $mergeActType = '';
2364 if ($changeClient) {
2365 $mainContactDisplayName = CRM_Contact_BAO_Contact
::displayName($mainContactId);
2366 $otherContactDisplayName = CRM_Contact_BAO_Contact
::displayName($otherContactId);
2368 $mergeActType = array_search('Reassigned Case', $activityTypes);
2369 $mergeActSubject = ts("Case %1 reassigned client from %2 to %3. New Case ID is %4.",
2372 2 => $otherContactDisplayName,
2373 3 => $mainContactDisplayName,
2378 elseif ($duplicateContacts) {
2379 $mergeActType = array_search('Merge Case', $activityTypes);
2380 $mergeActSubject = ts("Case %1 copied from contact id %2 to contact id %3 via merge. New Case ID is %4.",
2383 2 => $otherContactId,
2384 3 => $mainContactId,
2390 $mergeActType = array_search('Merge Case', $activityTypes);
2391 $mergeActSubject = ts("Case %1 merged into case %2", array(1 => $otherCaseId, 2 => $mainCaseId));
2392 if (!empty($copiedActivityIds)) {
2394 SELECT id, subject, activity_date_time, activity_type_id
2395 FROM civicrm_activity
2396 WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
2397 $dao = CRM_Core_DAO
::executeQuery($sql);
2398 while ($dao->fetch()) {
2399 $mergeActSubjectDetails .= "{$dao->activity_date_time} :: {$activityTypes[$dao->activity_type_id]}";
2400 if ($dao->subject
) {
2401 $mergeActSubjectDetails .= " :: {$dao->subject}";
2403 $mergeActSubjectDetails .= "<br />";
2408 // Create merge activity record. Source for merge activity is the logged in user's contact ID ($currentUserId).
2409 $activityParams = array(
2410 'subject' => $mergeActSubject,
2411 'details' => $mergeActSubjectDetails,
2412 'status_id' => $completedActivityStatus,
2413 'activity_type_id' => $mergeActType,
2414 'source_contact_id' => $currentUserId,
2415 'activity_date_time' => date('YmdHis'),
2418 $mergeActivity = CRM_Activity_BAO_Activity
::create($activityParams);
2419 $mergeActivityId = $mergeActivity->id
;
2420 if (!$mergeActivityId) {
2424 //connect merge activity to case.
2425 $mergeCaseAct = array(
2426 'case_id' => $mainCaseId,
2427 'activity_id' => $mergeActivityId,
2430 self
::processCaseActivity($mergeCaseAct);
2433 CRM_Utils_Hook
::post_case_merge($mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient);
2435 return $mainCaseIds;
2439 * Validate contact permission for
2440 * edit/view on activity record and build links.
2442 * @param array $tplParams
2443 * Params to be sent to template for sending email.
2444 * @param array $activityParams
2445 * Info of the activity.
2447 public static function buildPermissionLinks(&$tplParams, $activityParams) {
2448 $activityTypeId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $activityParams['source_record_id'],
2449 'activity_type_id', 'id'
2452 if (!empty($tplParams['isCaseActivity'])) {
2453 $tplParams['editActURL'] = CRM_Utils_System
::url('civicrm/case/activity',
2454 "reset=1&cid={$activityParams['target_id']}&caseid={$activityParams['case_id']}&action=update&id={$activityParams['source_record_id']}", TRUE
2457 $tplParams['viewActURL'] = CRM_Utils_System
::url('civicrm/case/activity/view',
2458 "reset=1&aid={$activityParams['source_record_id']}&cid={$activityParams['target_id']}&caseID={$activityParams['case_id']}", TRUE
2461 $tplParams['manageCaseURL'] = CRM_Utils_System
::url('civicrm/contact/view/case',
2462 "reset=1&id={$activityParams['case_id']}&cid={$activityParams['target_id']}&action=view&context=home", TRUE
2466 $tplParams['editActURL'] = CRM_Utils_System
::url('civicrm/contact/view/activity',
2467 "atype=$activityTypeId&action=update&reset=1&id={$activityParams['source_record_id']}&cid={$tplParams['contact']['contact_id']}&context=activity", TRUE
2470 $tplParams['viewActURL'] = CRM_Utils_System
::url('civicrm/contact/view/activity',
2471 "atype=$activityTypeId&action=view&reset=1&id={$activityParams['source_record_id']}&cid={$tplParams['contact']['contact_id']}&context=activity", TRUE
2477 * Validate contact permission for
2478 * given operation on activity record.
2480 * @param int $activityId
2481 * Activity record id.
2482 * @param string $operation
2484 * @param int $actTypeId
2486 * @param int $contactId
2487 * Contact id/if not pass consider logged in.
2488 * @param bool $checkComponent
2489 * Do we need to check component enabled.
2493 public static function checkPermission($activityId, $operation, $actTypeId = NULL, $contactId = NULL, $checkComponent = TRUE) {
2495 if (!$actTypeId && $activityId) {
2496 $actTypeId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $activityId, 'activity_type_id');
2499 if (!$activityId ||
!$operation ||
!$actTypeId) {
2503 //do check for civicase component enabled.
2504 if ($checkComponent && !self
::enabled()) {
2508 //do check for cases.
2509 $caseActOperations = array(
2516 if (in_array($operation, $caseActOperations)) {
2518 if (!isset($caseCount)) {
2520 $caseCount = civicrm_api3('Case', 'getcount', array(
2521 'check_permissions' => TRUE,
2522 'status_id' => array('!=' => 'Closed'),
2524 'end_date' => array('IS NULL' => 1),
2527 catch (CiviCRM_API3_Exception
$e) {
2528 // Lack of permissions will throw an exception
2532 if ($operation == 'File On Case') {
2533 $allow = !empty($caseCount);
2536 $allow = ($caseCount > 1);
2540 $actionOperations = array('view', 'edit', 'delete');
2541 if (in_array($operation, $actionOperations)) {
2543 //do cache when user has non/supper permission.
2544 static $allowOperations;
2546 if (!is_array($allowOperations) ||
2547 !array_key_exists($operation, $allowOperations)
2551 $session = CRM_Core_Session
::singleton();
2552 $contactId = $session->get('userID');
2555 //check for permissions.
2556 $permissions = array(
2558 'access my cases and activities',
2559 'access all cases and activities',
2562 'access my cases and activities',
2563 'access all cases and activities',
2565 'delete' => array('delete activities'),
2568 //check for core permission.
2569 $hasPermissions = array();
2570 $checkPermissions = CRM_Utils_Array
::value($operation, $permissions);
2571 if (is_array($checkPermissions)) {
2572 foreach ($checkPermissions as $per) {
2573 if (CRM_Core_Permission
::check($per)) {
2574 $hasPermissions[$operation][] = $per;
2580 if (!empty($hasPermissions)) {
2581 //need to check activity object specific.
2582 if (in_array($operation, array(
2587 //do we have supper permission.
2588 if (in_array('access all cases and activities', $hasPermissions[$operation])) {
2589 $allowOperations[$operation] = $allow = TRUE;
2592 //user has only access to my cases and activity.
2593 //here object specific permmions come in picture.
2595 //edit - contact must be source or assignee
2596 //view - contact must be source/assignee/target
2597 $isTarget = $isAssignee = $isSource = FALSE;
2598 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2599 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2600 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
2601 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2603 $target = new CRM_Activity_DAO_ActivityContact();
2604 $target->record_type_id
= $targetID;
2605 $target->activity_id
= $activityId;
2606 $target->contact_id
= $contactId;
2607 if ($target->find(TRUE)) {
2611 $assignee = new CRM_Activity_DAO_ActivityContact();
2612 $assignee->activity_id
= $activityId;
2613 $assignee->record_type_id
= $assigneeID;
2614 $assignee->contact_id
= $contactId;
2615 if ($assignee->find(TRUE)) {
2619 $source = new CRM_Activity_DAO_ActivityContact();
2620 $source->activity_id
= $activityId;
2621 $source->record_type_id
= $sourceID;
2622 $source->contact_id
= $contactId;
2623 if ($source->find(TRUE)) {
2627 if ($operation == 'edit') {
2628 if ($isAssignee ||
$isSource) {
2632 if ($operation == 'view') {
2633 if ($isTarget ||
$isAssignee ||
$isSource) {
2639 elseif (is_array($hasPermissions[$operation])) {
2640 $allowOperations[$operation] = $allow = TRUE;
2644 //contact do not have permission.
2645 $allowOperations[$operation] = FALSE;
2650 //here contact might have supper/non permission.
2651 $allow = $allowOperations[$operation];
2655 //do further only when operation is granted.
2657 $actTypeName = CRM_Core_PseudoConstant
::getName('CRM_Activity_BAO_Activity', 'activity_type_id', $actTypeId);
2659 //do not allow multiple copy / edit action.
2660 $singletonNames = array(
2670 //do not allow to delete these activities, CRM-4543
2671 $doNotDeleteNames = array('Open Case', 'Change Case Type', 'Change Case Status', 'Change Case Start Date');
2673 //allow edit operation.
2674 $allowEditNames = array('Open Case');
2676 if (CRM_Activity_BAO_Activity
::checkEditInboundEmailsPermissions()) {
2677 $allowEditNames[] = 'Inbound Email';
2680 // do not allow File on Case
2681 $doNotFileNames = array(
2684 'Change Case Status',
2685 'Change Case Start Date',
2692 if (in_array($actTypeName, $singletonNames)) {
2694 if ($operation == 'File On Case') {
2695 $allow = (in_array($actTypeName, $doNotFileNames)) ?
FALSE : TRUE;
2697 if (in_array($operation, $actionOperations)) {
2699 if ($operation == 'edit') {
2700 $allow = (in_array($actTypeName, $allowEditNames)) ?
TRUE : FALSE;
2702 elseif ($operation == 'delete') {
2703 $allow = (in_array($actTypeName, $doNotDeleteNames)) ?
FALSE : TRUE;
2707 if ($allow && ($operation == 'delete') &&
2708 in_array($actTypeName, $doNotDeleteNames)
2713 if ($allow && ($operation == 'File On Case') &&
2714 in_array($actTypeName, $doNotFileNames)
2719 //check settings file for masking actions
2720 //on the basis the activity types
2721 //hide Edit link if activity type is NOT editable
2722 //(special case activities).CRM-5871
2723 if ($allow && in_array($operation, $actionOperations)) {
2724 static $actionFilter = array();
2725 if (!array_key_exists($operation, $actionFilter)) {
2726 $xmlProcessor = new CRM_Case_XMLProcessor_Process();
2727 $actionFilter[$operation] = $xmlProcessor->get('Settings', 'ActivityTypes', FALSE, $operation);
2729 if (array_key_exists($operation, $actionFilter[$operation]) &&
2730 in_array($actTypeId, $actionFilter[$operation][$operation])
2741 * Since we drop 'access CiviCase', allow access
2742 * if user has 'access my cases and activities'
2743 * or 'access all cases and activities'
2745 public static function accessCiviCase() {
2746 if (!self
::enabled()) {
2750 if (CRM_Core_Permission
::check('access my cases and activities') ||
2751 CRM_Core_Permission
::check('access all cases and activities')
2760 * Verify user has permission to access a case.
2762 * @param int $caseId
2763 * @param bool $denyClosed
2764 * Set TRUE if one wants closed cases to be treated as inaccessible.
2768 public static function accessCase($caseId, $denyClosed = TRUE) {
2769 if (!$caseId ||
!self
::enabled()) {
2773 $params = array('id' => $caseId, 'check_permissions' => TRUE);
2774 if ($denyClosed && !CRM_Core_Permission
::check('access all cases and activities')) {
2775 $params['status_id'] = array('!=' => 'Closed');
2778 return (bool) civicrm_api3('Case', 'getcount', $params);
2780 catch (CiviCRM_API3_Exception
$e) {
2781 // Lack of permissions will throw an exception
2787 * Check whether activity is a case Activity.
2789 * @param int $activityID
2794 public static function isCaseActivity($activityID) {
2795 $isCaseActivity = FALSE;
2797 $params = array(1 => array($activityID, 'Integer'));
2798 $query = "SELECT id FROM civicrm_case_activity WHERE activity_id = %1";
2799 if (CRM_Core_DAO
::singleValueQuery($query, $params)) {
2800 $isCaseActivity = TRUE;
2804 return $isCaseActivity;
2808 * Get all the case type ids currently in use.
2812 public static function getUsedCaseType() {
2813 static $caseTypeIds;
2815 if (!is_array($caseTypeIds)) {
2816 $query = "SELECT DISTINCT( civicrm_case.case_type_id ) FROM civicrm_case";
2818 $dao = CRM_Core_DAO
::executeQuery($query);
2819 $caseTypeIds = array();
2820 while ($dao->fetch()) {
2821 $typeId = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
2824 $caseTypeIds[] = $typeId[1];
2828 return $caseTypeIds;
2832 * Get all the case status ids currently in use.
2836 public static function getUsedCaseStatuses() {
2837 static $caseStatusIds;
2839 if (!is_array($caseStatusIds)) {
2840 $query = "SELECT DISTINCT( civicrm_case.status_id ) FROM civicrm_case";
2842 $dao = CRM_Core_DAO
::executeQuery($query);
2843 $caseStatusIds = array();
2844 while ($dao->fetch()) {
2845 $caseStatusIds[] = $dao->status_id
;
2849 return $caseStatusIds;
2853 * Get all the encounter medium ids currently in use.
2857 public static function getUsedEncounterMediums() {
2860 if (!is_array($mediumIds)) {
2861 $query = "SELECT DISTINCT( civicrm_activity.medium_id ) FROM civicrm_activity";
2863 $dao = CRM_Core_DAO
::executeQuery($query);
2864 $mediumIds = array();
2865 while ($dao->fetch()) {
2866 $mediumIds[] = $dao->medium_id
;
2874 * Check case configuration.
2876 * @param int $contactId
2880 public static function isCaseConfigured($contactId = NULL) {
2881 $configured = array_fill_keys(array('configured', 'allowToAddNewCase', 'redirectToCaseAdmin'), FALSE);
2883 //lets check for case configured.
2884 $allCasesCount = CRM_Case_BAO_Case
::caseCount(NULL, FALSE);
2885 $configured['configured'] = ($allCasesCount) ?
TRUE : FALSE;
2886 if (!$configured['configured']) {
2887 //do check for case type and case status.
2888 $caseTypes = CRM_Case_PseudoConstant
::caseType('title', FALSE);
2889 if (!empty($caseTypes)) {
2890 $configured['configured'] = TRUE;
2891 if (!$configured['configured']) {
2892 $caseStatuses = CRM_Case_PseudoConstant
::caseStatus('label', FALSE);
2893 if (!empty($caseStatuses)) {
2894 $configured['configured'] = TRUE;
2899 if ($configured['configured']) {
2900 //do check for active case type and case status.
2901 $caseTypes = CRM_Case_PseudoConstant
::caseType();
2902 if (!empty($caseTypes)) {
2903 $caseStatuses = CRM_Case_PseudoConstant
::caseStatus();
2904 if (!empty($caseStatuses)) {
2905 $configured['allowToAddNewCase'] = TRUE;
2909 //do we need to redirect user to case admin.
2910 if (!$configured['allowToAddNewCase'] && $contactId) {
2911 //check for current contact case count.
2912 $currentContatCasesCount = CRM_Case_BAO_Case
::caseCount($contactId);
2913 //redirect user to case admin page.
2914 if (!$currentContatCasesCount) {
2915 $configured['redirectToCaseAdmin'] = TRUE;
2924 * Used during case component enablement and during ugprade.
2928 public static function createCaseViews() {
2929 $errorScope = CRM_Core_TemporaryErrorScope
::ignoreException();
2930 $dao = new CRM_Core_DAO();
2932 $sql = self
::createCaseViewsQuery('upcoming');
2934 if (PEAR
::getStaticProperty('DB_DataObject', 'lastError')) {
2938 // Above error doesn't get caught?
2939 $doublecheck = $dao->singleValueQuery("SELECT count(id) FROM civicrm_view_case_activity_upcoming");
2940 if (is_null($doublecheck)) {
2944 $sql = self
::createCaseViewsQuery('recent');
2946 if (PEAR
::getStaticProperty('DB_DataObject', 'lastError')) {
2950 // Above error doesn't get caught?
2951 $doublecheck = $dao->singleValueQuery("SELECT count(id) FROM civicrm_view_case_activity_recent");
2952 if (is_null($doublecheck)) {
2960 * Helper function, also used by the upgrade in case of error
2962 * @param string $section
2966 public static function createCaseViewsQuery($section = 'upcoming') {
2968 $scheduled_id = CRM_Core_Pseudoconstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Scheduled');
2971 $sql = "CREATE OR REPLACE VIEW `civicrm_view_case_activity_upcoming`
2972 AS SELECT ca.case_id, a.id, a.activity_date_time, a.status_id, a.activity_type_id
2973 FROM civicrm_case_activity ca
2974 INNER JOIN civicrm_activity a ON ca.activity_id=a.id
2976 (SELECT b.id FROM civicrm_case_activity bca
2977 INNER JOIN civicrm_activity b ON bca.activity_id=b.id
2978 WHERE b.activity_date_time <= DATE_ADD( NOW(), INTERVAL 14 DAY )
2979 AND b.is_current_revision = 1 AND b.is_deleted=0 AND b.status_id = $scheduled_id
2980 AND bca.case_id = ca.case_id ORDER BY b.activity_date_time ASC LIMIT 1)";
2984 $sql = "CREATE OR REPLACE VIEW `civicrm_view_case_activity_recent`
2985 AS SELECT ca.case_id, a.id, a.activity_date_time, a.status_id, a.activity_type_id
2986 FROM civicrm_case_activity ca
2987 INNER JOIN civicrm_activity a ON ca.activity_id=a.id
2989 (SELECT b.id FROM civicrm_case_activity bca
2990 INNER JOIN civicrm_activity b ON bca.activity_id=b.id
2991 WHERE b.activity_date_time >= DATE_SUB( NOW(), INTERVAL 14 DAY )
2992 AND b.is_current_revision = 1 AND b.is_deleted=0 AND b.status_id <> $scheduled_id
2993 AND bca.case_id = ca.case_id ORDER BY b.activity_date_time DESC LIMIT 1)";
3000 * Add/copy relationships, when new client is added for a case
3002 * @param int $caseId
3004 * @param int $contactId
3005 * Contact id / new client id.
3007 public static function addCaseRelationships($caseId, $contactId) {
3008 // get the case role / relationships for the case
3009 $caseRelationships = new CRM_Contact_DAO_Relationship();
3010 $caseRelationships->case_id
= $caseId;
3011 $caseRelationships->find();
3012 $relationshipTypes = array();
3014 // make sure we don't add duplicate relationships of same relationship type.
3015 while ($caseRelationships->fetch() && !in_array($caseRelationships->relationship_type_id
, $relationshipTypes)) {
3017 CRM_Core_DAO
::storeValues($caseRelationships, $values);
3019 // add relationship for new client.
3020 $newRelationship = new CRM_Contact_DAO_Relationship();
3021 $newRelationship->copyValues($values);
3022 $newRelationship->id
= NULL;
3023 $newRelationship->case_id
= $caseId;
3024 $newRelationship->contact_id_a
= $contactId;
3025 $newRelationship->end_date
= CRM_Utils_Date
::isoToMysql($caseRelationships->end_date
);
3026 $newRelationship->start_date
= CRM_Utils_Date
::isoToMysql($caseRelationships->start_date
);
3028 // another check to avoid duplicate relationship, in cases where client is removed and re-added again.
3029 if (!$newRelationship->find(TRUE)) {
3030 $newRelationship->save();
3033 // store relationship type of newly created relationship
3034 $relationshipTypes[] = $caseRelationships->relationship_type_id
;
3039 * Get the list of clients for a case.
3041 * @param int $caseId
3044 * associated array with client ids
3046 public static function getCaseClients($caseId) {
3048 $caseContact = new CRM_Case_DAO_CaseContact();
3049 $caseContact->case_id
= $caseId;
3050 $caseContact->orderBy('id');
3051 $caseContact->find();
3053 while ($caseContact->fetch()) {
3054 $clients[] = $caseContact->contact_id
;
3061 * @param int $caseId
3062 * @param string $direction
3064 * @param int $relTypeId
3065 * @throws \CRM_Core_Exception
3066 * @throws \CiviCRM_API3_Exception
3068 public static function endCaseRole($caseId, $direction, $cid, $relTypeId) {
3070 if ($direction !== 'a' && $direction !== 'b') {
3071 throw new CRM_Core_Exception('Invalid relationship direction');
3074 // This case might have multiple clients, so we lookup by relationship instead of by id to get them all
3075 $sql = "SELECT id FROM civicrm_relationship WHERE case_id = %1 AND contact_id_{$direction} = %2 AND relationship_type_id = %3";
3076 $dao = CRM_Core_DAO
::executeQuery($sql, array(
3077 1 => array($caseId, 'Positive'),
3078 2 => array($cid, 'Positive'),
3079 3 => array($relTypeId, 'Positive'),
3081 while ($dao->fetch()) {
3082 civicrm_api3('relationship', 'create', array(
3085 'end_date' => 'now',
3091 * Get options for a given case field.
3092 * @see CRM_Core_DAO::buildOptions
3094 * @param string $fieldName
3095 * @param string $context
3096 * @see CRM_Core_DAO::buildOptionsContext
3097 * @param array $props
3098 * Whatever is known about this dao object.
3100 * @return array|bool
3102 public static function buildOptions($fieldName, $context = NULL, $props = array()) {
3103 $className = __CLASS__
;
3105 switch ($fieldName) {
3106 // This field is not part of this object but the api supports it
3108 $className = 'CRM_Activity_BAO_Activity';
3111 // Filter status id by case type id
3113 if (!empty($props['case_type_id'])) {
3114 $idField = is_numeric($props['case_type_id']) ?
'id' : 'name';
3115 $caseType = civicrm_api3('CaseType', 'getsingle', array($idField => $props['case_type_id'], 'return' => 'definition'));
3116 if (!empty($caseType['definition']['statuses'])) {
3117 $params['condition'] = 'v.name IN ("' . implode('","', $caseType['definition']['statuses']) . '")';
3122 return CRM_Core_PseudoConstant
::get($className, $fieldName, $params, $context);
3128 public function addSelectWhereClause() {
3129 // We always return an array with these keys, even if they are empty,
3130 // because this tells the query builder that we have considered these fields for acls
3133 // Only case admins can view deleted cases
3134 'is_deleted' => CRM_Core_Permission
::check('administer CiviCase') ?
array() : array("= 0"),
3136 // Ensure the user has permission to view the case client
3137 $contactClause = CRM_Utils_SQL
::mergeSubquery('Contact');
3138 if ($contactClause) {
3139 $contactClause = implode(' AND contact_id ', $contactClause);
3140 $clauses['id'][] = "IN (SELECT case_id FROM civicrm_case_contact WHERE contact_id $contactClause)";
3142 // The api gatekeeper ensures the user has at least "access my cases and activities"
3143 // so if they do not have permission to see all cases we'll assume they can only access their own
3144 if (!CRM_Core_Permission
::check('access all cases and activities')) {
3145 $user = (int) CRM_Core_Session
::getLoggedInContactID();
3146 $clauses['id'][] = "IN (
3147 SELECT r.case_id FROM civicrm_relationship r, civicrm_case_contact cc WHERE r.is_active = 1 AND cc.case_id = r.case_id AND (
3148 (r.contact_id_a = cc.contact_id AND r.contact_id_b = $user) OR (r.contact_id_b = cc.contact_id AND r.contact_id_a = $user)
3152 CRM_Utils_Hook
::selectWhereClause($this, $clauses);
3157 * CRM-20308: Method to get the contact id to use as from contact for email copy
3158 * 1. Activity Added by Contact's email address
3159 * 2. System Default From Address
3160 * 3. Default Organization Contact email address
3163 * @param int $activityID
3165 * @return mixed $emailFromContactId
3166 * @see https://issues.civicrm.org/jira/browse/CRM-20308
3168 public static function getReceiptFrom($activityID) {
3169 $name = $address = NULL;
3171 if (!empty($activityID) && (Civi
::settings()->get('allow_mail_from_logged_in_contact'))) {
3172 // This breaks SPF/DMARC if email is sent from an email address that the server is not authorised to send from.
3173 // so we can disable this behaviour with the "allow_mail_from_logged_in_contact" setting.
3174 // There is always a 'Added by' contact for a activity,
3175 // so we can safely use ActivityContact.Getvalue API
3176 $sourceContactId = civicrm_api3('ActivityContact', 'getvalue', array(
3177 'activity_id' => $activityID,
3178 'record_type_id' => 'Activity Source',
3179 'return' => 'contact_id',
3181 list($name, $address) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($sourceContactId);
3184 // If 'From' email address not found for Source Activity Contact then
3185 // fetch the email from domain or logged in user.
3186 if (empty($address)) {
3187 list($name, $address) = CRM_Core_BAO_Domain
::getDefaultReceiptFrom();
3190 return "$name <$address>";
3196 public static function getEntityRefFilters() {
3199 'key' => 'case_id.case_type_id',
3200 'value' => ts('Case Type'),
3204 'key' => 'case_id.status_id',
3205 'value' => ts('Case Status'),
3209 foreach (CRM_Contact_BAO_Contact
::getEntityRefFilters() as $filter) {
3210 $filter +
= ['entity' => 'Contact'];
3211 $filter['key'] = 'contact_id.' . $filter['key'];
3212 $filters[] = $filter;