3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
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 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 return $caseDAO->save();
82 * Given the list of params in the params array, fetch the object
83 * and store the values in the values array.
85 * @param array $params
86 * Input parameters to find object.
87 * @param array $values
88 * Output values of the object.
90 * The array that holds all the db ids.
92 * @return CRM_Case_BAO_Case|null
93 * The found object or null
95 public static function &getValues(&$params, &$values, &$ids) {
96 $case = new CRM_Case_BAO_Case();
98 $case->copyValues($params);
100 if ($case->find(TRUE)) {
101 $ids['case'] = $case->id
;
102 CRM_Core_DAO
::storeValues($case, $values);
109 * Takes an associative array and creates a case object.
111 * @param array $params
112 * (reference) an assoc array of name/value pairs.
114 * @return CRM_Case_BAO_Case
116 public static function &create(&$params) {
117 $transaction = new CRM_Core_Transaction();
119 if (!empty($params['id'])) {
120 CRM_Utils_Hook
::pre('edit', 'Case', $params['id'], $params);
123 CRM_Utils_Hook
::pre('create', 'Case', NULL, $params);
126 $case = self
::add($params);
128 if (!empty($params['custom']) &&
129 is_array($params['custom'])
131 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_case', $case->id
);
134 if (is_a($case, 'CRM_Core_Error')) {
135 $transaction->rollback();
139 if (!empty($params['id'])) {
140 CRM_Utils_Hook
::post('edit', 'Case', $case->id
, $case);
143 CRM_Utils_Hook
::post('create', 'Case', $case->id
, $case);
145 $transaction->commit();
147 //we are not creating log for case
148 //since case log can be tracked using log for activity.
153 * Create case contact record.
155 * @param array $params
156 * case_id, contact_id
160 public static function addCaseToContact($params) {
161 $caseContact = new CRM_Case_DAO_CaseContact();
162 $caseContact->case_id
= $params['case_id'];
163 $caseContact->contact_id
= $params['contact_id'];
164 $caseContact->find(TRUE);
165 $caseContact->save();
167 // add to recently viewed
168 $caseType = CRM_Case_BAO_Case
::getCaseType($caseContact->case_id
);
169 $url = CRM_Utils_System
::url('civicrm/contact/view/case',
170 "action=view&reset=1&id={$caseContact->case_id}&cid={$caseContact->contact_id}&context=home"
173 $title = CRM_Contact_BAO_Contact
::displayName($caseContact->contact_id
) . ' - ' . $caseType;
175 $recentOther = array();
176 if (CRM_Core_Permission
::checkActionPermission('CiviCase', CRM_Core_Action
::DELETE
)) {
177 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/contact/view/case',
178 "action=delete&reset=1&id={$caseContact->case_id}&cid={$caseContact->contact_id}&context=home"
182 // add the recently created case
183 CRM_Utils_Recent
::add($title,
185 $caseContact->case_id
,
187 $params['contact_id'],
196 * Delete case contact record.
200 public static function deleteCaseContact($caseID) {
201 $caseContact = new CRM_Case_DAO_CaseContact();
202 $caseContact->case_id
= $caseID;
203 $caseContact->delete();
205 // delete the recently created Case
210 CRM_Utils_Recent
::del($caseRecent);
214 * Convert associative array names to values and vice-versa.
216 * This function is used by both the web form layer and the api. Note that
217 * the api needs the name => value conversion, also the view layer typically
218 * requires value => name conversion
220 * @param array $defaults
221 * @param string $property
222 * @param array $lookup
223 * @param bool $reverse
227 public static function lookupValue(&$defaults, $property, &$lookup, $reverse) {
228 $id = $property . '_id';
230 $src = $reverse ?
$property : $id;
231 $dst = $reverse ?
$id : $property;
233 if (!array_key_exists($src, $defaults)) {
237 $look = $reverse ?
array_flip($lookup) : $lookup;
239 if (is_array($look)) {
240 if (!array_key_exists($defaults[$src], $look)) {
244 $defaults[$dst] = $look[$defaults[$src]];
249 * Retrieve DB object based on input parameters.
251 * It also stores all the retrieved values in the default array.
253 * @param array $params
254 * (reference ) an assoc array of name/value pairs.
255 * @param array $defaults
256 * (reference ) an assoc array to hold the name / value pairs.
257 * in a hierarchical manner
259 * (reference) the array that holds all the db ids.
261 * @return CRM_Case_BAO_Case
263 public static function retrieve(&$params, &$defaults, &$ids) {
264 $case = CRM_Case_BAO_Case
::getValues($params, $defaults, $ids);
269 * Process case activity add/delete
270 * takes an associative array and
272 * @param array $params
273 * (reference ) an assoc array of name/value pairs.
276 public static function processCaseActivity(&$params) {
277 $caseActivityDAO = new CRM_Case_DAO_CaseActivity();
278 $caseActivityDAO->activity_id
= $params['activity_id'];
279 $caseActivityDAO->case_id
= $params['case_id'];
281 $caseActivityDAO->find(TRUE);
282 $caseActivityDAO->save();
286 * Get the case subject for Activity.
288 * @param int $activityId
291 * @return string|null
293 public static function getCaseSubject($activityId) {
294 $caseActivity = new CRM_Case_DAO_CaseActivity();
295 $caseActivity->activity_id
= $activityId;
296 if ($caseActivity->find(TRUE)) {
297 return CRM_Core_DAO
::getFieldValue('CRM_Case_BAO_Case', $caseActivity->case_id
, 'subject');
306 * @param string $colName
311 public static function getCaseType($caseId, $colName = 'title') {
313 SELECT civicrm_case_type.{$colName} FROM civicrm_case
314 LEFT JOIN civicrm_case_type ON
315 civicrm_case.case_type_id = civicrm_case_type.id
316 WHERE civicrm_case.id = %1";
318 $queryParams = array(1 => array($caseId, 'Integer'));
320 return CRM_Core_DAO
::singleValueQuery($query, $queryParams);
324 * Delete the record that are associated with this case.
325 * record are deleted from case
328 * Id of the case to delete.
330 * @param bool $moveToTrash
335 public static function deleteCase($caseId, $moveToTrash = FALSE) {
336 CRM_Utils_Hook
::pre('delete', 'Case', $caseId, CRM_Core_DAO
::$_nullArray);
339 $activities = self
::getCaseActivityDates($caseId);
341 foreach ($activities as $value) {
342 CRM_Activity_BAO_Activity
::deleteActivity($value, $moveToTrash);
347 $transaction = new CRM_Core_Transaction();
349 $case = new CRM_Case_DAO_Case();
352 $result = $case->delete();
353 $transaction->commit();
356 $result = $case->is_deleted
= 1;
361 // CRM-7364, disable relationships
362 self
::enableDisableCaseRelationships($caseId, FALSE);
364 CRM_Utils_Hook
::post('delete', 'Case', $caseId, $case);
366 // remove case from recent items.
371 CRM_Utils_Recent
::del($caseRecent);
379 * Enable disable case related relationships.
383 * @param bool $enable
386 public static function enableDisableCaseRelationships($caseId, $enable) {
387 $contactIds = self
::retrieveContactIdsByCaseId($caseId);
388 if (!empty($contactIds)) {
389 foreach ($contactIds as $cid) {
390 $roles = self
::getCaseRoles($cid, $caseId);
391 if (!empty($roles)) {
392 $relationshipIds = implode(',', array_keys($roles));
393 $enable = (int) $enable;
394 $query = "UPDATE civicrm_relationship SET is_active = {$enable}
395 WHERE id IN ( {$relationshipIds} )";
396 CRM_Core_DAO
::executeQuery($query);
403 * Delete the activities related to case.
405 * @param int $activityId
406 * Id of the activity.
408 public static function deleteCaseActivity($activityId) {
409 $case = new CRM_Case_DAO_CaseActivity();
410 $case->activity_id
= $activityId;
415 * Retrieve contact_id by case_id.
420 * @param int $contactID
424 public static function retrieveContactIdsByCaseId($caseId, $contactID = NULL) {
425 $caseContact = new CRM_Case_DAO_CaseContact();
426 $caseContact->case_id
= $caseId;
427 $caseContact->find();
428 $contactArray = array();
430 while ($caseContact->fetch()) {
431 if ($contactID != $caseContact->contact_id
) {
432 $contactArray[$count] = $caseContact->contact_id
;
437 return $contactArray;
441 * Look up a case using an activity ID.
443 * @param int $activityId
445 * @return int, case ID
447 public static function getCaseIdByActivityId($activityId) {
448 $originalId = CRM_Core_DAO
::singleValueQuery(
449 'SELECT original_id FROM civicrm_activity WHERE id = %1',
450 array('1' => array($activityId, 'Integer'))
452 $caseId = CRM_Core_DAO
::singleValueQuery(
453 'SELECT case_id FROM civicrm_case_activity WHERE activity_id in (%1,%2)',
455 '1' => array($activityId, 'Integer'),
456 '2' => array($originalId ?
$originalId : $activityId, 'Integer'),
463 * Retrieve contact names by caseId.
470 public static function getContactNames($caseId) {
471 $contactNames = array();
473 return $contactNames;
477 SELECT contact_a.sort_name name,
478 contact_a.display_name as display_name,
480 contact_a.birth_date as birth_date,
483 FROM civicrm_contact contact_a
484 LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
485 LEFT JOIN civicrm_email ce ON ( ce.contact_id = contact_a.id AND ce.is_primary = 1)
486 LEFT JOIN civicrm_phone cp ON ( cp.contact_id = contact_a.id AND cp.is_primary = 1)
487 WHERE civicrm_case_contact.case_id = %1";
489 $dao = CRM_Core_DAO
::executeQuery($query,
490 array(1 => array($caseId, 'Integer'))
492 while ($dao->fetch()) {
493 $contactNames[$dao->cid
]['contact_id'] = $dao->cid
;
494 $contactNames[$dao->cid
]['sort_name'] = $dao->name
;
495 $contactNames[$dao->cid
]['display_name'] = $dao->display_name
;
496 $contactNames[$dao->cid
]['email'] = $dao->email
;
497 $contactNames[$dao->cid
]['phone'] = $dao->phone
;
498 $contactNames[$dao->cid
]['birth_date'] = $dao->birth_date
;
499 $contactNames[$dao->cid
]['role'] = ts('Client');
502 return $contactNames;
506 * Retrieve case_id by contact_id.
508 * @param int $contactID
509 * @param bool $includeDeleted
510 * Include the deleted cases in result.
511 * @param null $caseType
515 public static function retrieveCaseIdsByContactId($contactID, $includeDeleted = FALSE, $caseType = NULL) {
518 FROM civicrm_case_contact cc
519 INNER JOIN civicrm_case ca ON cc.case_id = ca.id
521 if (isset($caseType)) {
523 "INNER JOIN civicrm_case_type ON civicrm_case_type.id = ca.case_type_id
524 WHERE cc.contact_id = %1 AND civicrm_case_type.name = '{$caseType}'";
526 if (!isset($caseType)) {
527 $query .= "WHERE cc.contact_id = %1";
529 if (!$includeDeleted) {
530 $query .= " AND ca.is_deleted = 0";
533 $params = array(1 => array($contactID, 'Integer'));
534 $dao = CRM_Core_DAO
::executeQuery($query, $params);
536 $caseArray = array();
537 while ($dao->fetch()) {
538 $caseArray[] = $dao->id
;
546 * @param string $type
548 * @param null $condition
549 * @param int $isDeleted
553 public static function getCaseActivityQuery($type = 'upcoming', $userID = NULL, $condition = NULL, $isDeleted = 0) {
555 $session = CRM_Core_Session
::singleton();
556 $userID = $session->get('userID');
559 $actStatus = array_flip(CRM_Core_PseudoConstant
::activityStatus('name'));
560 $scheduledStatusId = $actStatus['Scheduled'];
563 civicrm_case.id as case_id,
564 civicrm_case.subject as case_subject,
565 civicrm_contact.id as contact_id,
566 civicrm_contact.sort_name as sort_name,
567 civicrm_phone.phone as phone,
568 civicrm_contact.contact_type as contact_type,
569 civicrm_contact.contact_sub_type as contact_sub_type,
570 t_act.activity_type_id,
571 c_type.title as case_type,
572 civicrm_case.case_type_id as case_type_id,
573 cov_status.label as case_status,
574 cov_status.label as case_status_name,
576 civicrm_case.start_date as case_start_date,
577 case_relation_type.label_b_a as case_role, ";
579 if ($type == 'upcoming') {
581 t_act.desired_date as case_scheduled_activity_date,
582 t_act.id as case_scheduled_activity_id,
583 t_act.act_type_name as case_scheduled_activity_type_name,
584 t_act.act_type AS case_scheduled_activity_type ";
586 elseif ($type == 'recent') {
588 t_act.desired_date as case_recent_activity_date,
589 t_act.id as case_recent_activity_id,
590 t_act.act_type_name as case_recent_activity_type_name,
591 t_act.act_type AS case_recent_activity_type ";
593 elseif ($type == 'any') {
595 t_act.desired_date as case_activity_date,
596 t_act.id as case_activity_id,
597 t_act.act_type_name as case_activity_type_name,
598 t_act.act_type AS case_activity_type ";
601 $query .= " FROM civicrm_case
602 INNER JOIN civicrm_case_contact ON civicrm_case.id = civicrm_case_contact.case_id
603 INNER JOIN civicrm_contact ON civicrm_case_contact.contact_id = civicrm_contact.id ";
605 if ($type == 'upcoming') {
606 // This gets the earliest activity per case that's scheduled within 14 days from now.
607 // Note we have an inner select to get the min activity id in order to remove duplicates in case there are two with the same datetime.
608 // In this case we don't really care which one, so min(id) works.
609 // optimized in CRM-11837
610 $query .= " INNER JOIN
612 SELECT case_id, act.id, activity_date_time AS desired_date, activity_type_id, status_id, aov.name AS act_type_name, aov.label AS act_type
617 FROM civicrm_view_case_activity_upcoming
618 ORDER BY activity_date_time ASC, id ASC
622 LEFT JOIN civicrm_option_group aog ON aog.name='activity_type'
623 LEFT JOIN civicrm_option_value aov ON ( aov.option_group_id = aog.id AND aov.value = act.activity_type_id )
627 elseif ($type == 'recent') {
628 // Similarly, the most recent activity in the past 14 days, and exclude scheduled.
629 //improve query performance - CRM-10598
630 $query .= " INNER JOIN
632 SELECT case_id, act.id, activity_date_time AS desired_date, activity_type_id, status_id, aov.name AS act_type_name, aov.label AS act_type
637 FROM civicrm_view_case_activity_recent
638 ORDER BY activity_date_time DESC, id ASC
642 LEFT JOIN civicrm_option_group aog ON aog.name='activity_type'
643 LEFT JOIN civicrm_option_value aov ON ( aov.option_group_id = aog.id AND aov.value = act.activity_type_id )
646 elseif ($type == 'any') {
647 $query .= " LEFT JOIN
649 SELECT ca4.case_id, act4.id AS id, act4.activity_date_time AS desired_date, act4.activity_type_id, act4.status_id, aov.name AS act_type_name, aov.label AS act_type
650 FROM civicrm_activity act4
651 LEFT JOIN civicrm_case_activity ca4
652 ON ca4.activity_id = act4.id
653 AND act4.is_current_revision = 1
654 LEFT JOIN civicrm_option_group aog
655 ON aog.name='activity_type'
656 LEFT JOIN civicrm_option_value aov
657 ON aov.option_group_id = aog.id
658 AND aov.value = act4.activity_type_id
663 ON t_act.case_id = civicrm_case.id
664 LEFT JOIN civicrm_phone ON (civicrm_phone.contact_id = civicrm_contact.id AND civicrm_phone.is_primary=1)
665 LEFT JOIN civicrm_relationship case_relationship
666 ON ( case_relationship.contact_id_a = civicrm_case_contact.contact_id AND case_relationship.contact_id_b = {$userID}
667 AND case_relationship.case_id = civicrm_case.id )
669 LEFT JOIN civicrm_relationship_type case_relation_type
670 ON ( case_relation_type.id = case_relationship.relationship_type_id
671 AND case_relation_type.id = case_relationship.relationship_type_id )
673 LEFT JOIN civicrm_case_type c_type
674 ON civicrm_case.case_type_id = c_type.id
676 LEFT JOIN civicrm_option_group cog_status
677 ON cog_status.name = 'case_status'
679 LEFT JOIN civicrm_option_value cov_status
680 ON ( civicrm_case.status_id = cov_status.value
681 AND cog_status.id = cov_status.option_group_id )
685 // CRM-8749 backwards compatibility - callers of this function expect to start $condition with "AND"
686 $query .= " WHERE (1) $condition ";
689 if ($type == 'upcoming') {
690 $query .= " ORDER BY case_scheduled_activity_date ASC ";
692 elseif ($type == 'recent') {
693 $query .= " ORDER BY case_recent_activity_date ASC ";
695 elseif ($type == 'any') {
696 $query .= " ORDER BY case_activity_date ASC ";
703 * Retrieve cases related to particular contact or whole contact used in Dashboard and Tab.
705 * @param bool $allCases
709 * @param string $type
710 * /upcoming,recent,all/.
712 * @param string $context
717 public static function getCases($allCases = TRUE, $userID = NULL, $type = 'upcoming', $context = 'dashboard') {
719 $casesList = array();
721 //validate access for own cases.
722 if (!self
::accessCiviCase()) {
727 $session = CRM_Core_Session
::singleton();
728 $userID = $session->get('userID');
731 //validate access for all cases.
732 if ($allCases && !CRM_Core_Permission
::check('access all cases and activities')) {
736 $condition = " AND civicrm_case.is_deleted = 0 AND civicrm_contact.is_deleted <> 1";
739 $condition .= " AND case_relationship.contact_id_b = {$userID} ";
741 if ($type == 'upcoming' ||
$type == 'any') {
742 $closedId = CRM_Core_OptionGroup
::getValue('case_status', 'Closed', 'name');
744 AND civicrm_case.status_id != $closedId";
747 $query = self
::getCaseActivityQuery($type, $userID, $condition);
749 $queryParams = array();
750 $result = CRM_Core_DAO
::executeQuery($query,
754 $caseStatus = CRM_Core_OptionGroup
::values('case_status', FALSE, FALSE, FALSE, " AND v.name = 'Urgent' ");
756 $resultFields = array(
773 if ($type == 'upcoming') {
774 $resultFields[] = 'case_scheduled_activity_date';
775 $resultFields[] = 'case_scheduled_activity_type_name';
776 $resultFields[] = 'case_scheduled_activity_type';
777 $resultFields[] = 'case_scheduled_activity_id';
779 elseif ($type == 'recent') {
780 $resultFields[] = 'case_recent_activity_date';
781 $resultFields[] = 'case_recent_activity_type_name';
782 $resultFields[] = 'case_recent_activity_type';
783 $resultFields[] = 'case_recent_activity_id';
785 elseif ($type == 'any') {
786 $resultFields[] = 'case_activity_date';
787 $resultFields[] = 'case_activity_type_name';
788 $resultFields[] = 'case_activity_type';
789 $resultFields[] = 'case_activity_id';
792 // we're going to use the usual actions, so doesn't make sense to duplicate definitions
793 $actions = CRM_Case_Selector_Search
::links();
795 // check is the user has view/edit signer permission
796 $permissions = array(CRM_Core_Permission
::VIEW
);
797 if (CRM_Core_Permission
::check('access all cases and activities') ||
798 (!$allCases && CRM_Core_Permission
::check('access my cases and activities'))
800 $permissions[] = CRM_Core_Permission
::EDIT
;
802 if (CRM_Core_Permission
::check('delete in CiviCase')) {
803 $permissions[] = CRM_Core_Permission
::DELETE
;
805 $mask = CRM_Core_Action
::mask($permissions);
807 while ($result->fetch()) {
808 foreach ($resultFields as $donCare => $field) {
809 $casesList[$result->case_id
][$field] = $result->$field;
810 if ($field == 'contact_type') {
811 $casesList[$result->case_id
]['contact_type_icon'] = CRM_Contact_BAO_Contact_Utils
::getImage($result->contact_sub_type ?
$result->contact_sub_type
: $result->contact_type
813 $casesList[$result->case_id
]['action'] = CRM_Core_Action
::formLink($actions['primaryActions'], $mask,
815 'id' => $result->case_id
,
816 'cid' => $result->contact_id
,
821 'case.actions.primary',
825 $casesList[$result->case_id
]['moreActions'] = CRM_Core_Action
::formLink($actions['moreActions'],
828 'id' => $result->case_id
,
829 'cid' => $result->contact_id
,
839 elseif ($field == 'case_status') {
840 if (in_array($result->$field, $caseStatus)) {
841 $casesList[$result->case_id
]['class'] = "status-urgent";
844 $casesList[$result->case_id
]['class'] = "status-normal";
849 $caseTypes = CRM_Case_PseudoConstant
::caseType('name');
850 $caseManagerContact = self
::getCaseManagerContact($caseTypes[$result->case_type_id
], $result->case_id
);
851 if (!empty($caseManagerContact)) {
852 $casesList[$result->case_id
]['casemanager_id'] = CRM_Utils_Array
::value('casemanager_id', $caseManagerContact);
853 $casesList[$result->case_id
]['casemanager'] = CRM_Utils_Array
::value('casemanager', $caseManagerContact);
856 //do check user permissions for edit/view activity.
857 if (($actId = CRM_Utils_Array
::value('case_scheduled_activity_id', $casesList[$result->case_id
])) ||
858 ($actId = CRM_Utils_Array
::value('case_recent_activity_id', $casesList[$result->case_id
]))
860 $casesList[$result->case_id
]["case_{$type}_activity_editable"] = self
::checkPermission($actId,
862 $casesList[$result->case_id
]['activity_type_id'], $userID
864 $casesList[$result->case_id
]["case_{$type}_activity_viewable"] = self
::checkPermission($actId,
866 $casesList[$result->case_id
]['activity_type_id'], $userID
875 * Get the summary of cases counts by type and status.
877 * @param bool $allCases
881 public static function getCasesSummary($allCases = TRUE, $userID) {
882 $caseSummary = array();
884 //validate access for civicase.
885 if (!self
::accessCiviCase()) {
889 //validate access for all cases.
890 if ($allCases && !CRM_Core_Permission
::check('access all cases and activities')) {
894 $caseTypes = CRM_Case_PseudoConstant
::caseType();
895 $caseStatuses = CRM_Case_PseudoConstant
::caseStatus();
896 $caseTypes = array_flip($caseTypes);
898 // get statuses as headers for the table
899 $url = CRM_Utils_System
::url('civicrm/case/search', "reset=1&force=1&all=1&status=");
900 foreach ($caseStatuses as $key => $name) {
901 $caseSummary['headers'][$key]['status'] = $name;
902 $caseSummary['headers'][$key]['url'] = $url . $key;
905 // build rows with actual data
907 $myGroupByClause = $mySelectClause = $myCaseFromClause = $myCaseWhereClause = '';
913 $myGroupByClause = ' GROUP BY civicrm_case.id';
918 $myCaseWhereClause = " AND case_relationship.contact_id_b = {$userID}";
919 $myGroupByClause = " GROUP BY CONCAT(case_relationship.case_id,'-',case_relationship.contact_id_b)";
922 // FIXME: This query could be a lot more efficient if it used COUNT() instead of returning all rows and then counting them with php
924 SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS case_type,
925 case_type_id, case_relationship.contact_id_b
927 INNER JOIN civicrm_case_contact cc on cc.case_id = civicrm_case.id
928 LEFT JOIN civicrm_case_type ON civicrm_case.case_type_id = civicrm_case_type.id
929 LEFT JOIN civicrm_option_group option_group_case_status ON ( option_group_case_status.name = 'case_status' )
930 LEFT JOIN civicrm_option_value case_status ON ( civicrm_case.status_id = case_status.value
931 AND option_group_case_status.id = case_status.option_group_id )
932 LEFT JOIN civicrm_relationship case_relationship ON ( case_relationship.case_id = civicrm_case.id
933 AND case_relationship.contact_id_b = {$userID})
934 WHERE is_deleted = 0 AND cc.contact_id IN (SELECT id FROM civicrm_contact WHERE is_deleted <> 1)
935 {$myCaseWhereClause} {$myGroupByClause}";
937 $res = CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
938 while ($res->fetch()) {
939 if (!empty($rows[$res->case_type
]) && !empty($rows[$res->case_type
][$res->case_status
])) {
940 $rows[$res->case_type
][$res->case_status
]['count'] = $rows[$res->case_type
][$res->case_status
]['count'] +
1;
943 $rows[$res->case_type
][$res->case_status
] = array(
945 'url' => CRM_Utils_System
::url('civicrm/case/search',
946 "reset=1&force=1&status={$res->status_id}&type={$res->case_type_id}&case_owner={$case_owner}"
951 $caseSummary['rows'] = array_merge($caseTypes, $rows);
959 * @param int $contactID
963 * @param int $relationshipID
966 * case role / relationships
969 public static function getCaseRoles($contactID, $caseID, $relationshipID = NULL) {
971 SELECT rel.id as civicrm_relationship_id,
972 con.sort_name as sort_name,
973 civicrm_email.email as email,
974 civicrm_phone.phone as phone,
975 con.id as civicrm_contact_id,
976 IF(rel.contact_id_a = %1, civicrm_relationship_type.label_a_b, civicrm_relationship_type.label_b_a) as relation,
977 civicrm_relationship_type.id as relation_type,
978 IF(rel.contact_id_a = %1, "a_b", "b_a") as relationship_direction
979 FROM civicrm_relationship rel
980 INNER JOIN civicrm_relationship_type ON rel.relationship_type_id = civicrm_relationship_type.id
981 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))
982 LEFT JOIN civicrm_phone ON (civicrm_phone.contact_id = con.id AND civicrm_phone.is_primary = 1)
983 LEFT JOIN civicrm_email ON (civicrm_email.contact_id = con.id AND civicrm_email.is_primary = 1)
984 WHERE (rel.contact_id_a = %1 OR rel.contact_id_b = %1) AND rel.case_id = %2
985 AND rel.is_active = 1 AND (rel.end_date IS NULL OR rel.end_date > NOW())';
988 1 => array($contactID, 'Positive'),
989 2 => array($caseID, 'Positive'),
992 if ($relationshipID) {
993 $query .= ' AND civicrm_relationship.id = %3 ';
994 $params[3] = array($relationshipID, 'Integer');
996 $dao = CRM_Core_DAO
::executeQuery($query, $params);
999 while ($dao->fetch()) {
1000 $rid = $dao->civicrm_relationship_id
;
1001 $values[$rid]['cid'] = $dao->civicrm_contact_id
;
1002 $values[$rid]['relation'] = $dao->relation
;
1003 $values[$rid]['name'] = $dao->sort_name
;
1004 $values[$rid]['email'] = $dao->email
;
1005 $values[$rid]['phone'] = $dao->phone
;
1006 $values[$rid]['relation_type'] = $dao->relation_type
;
1007 $values[$rid]['rel_id'] = $dao->civicrm_relationship_id
;
1008 $values[$rid]['client_id'] = $contactID;
1009 $values[$rid]['relationship_direction'] = $dao->relationship_direction
;
1017 * Get Case Activities.
1019 * @param int $caseID
1021 * @param array $params
1023 * @param int $contactID
1026 * @param null $context
1027 * @param int $userID
1031 * Array of case activities
1034 public static function getCaseActivity($caseID, &$params, $contactID, $context = NULL, $userID = NULL, $type = NULL) {
1037 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1038 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
1039 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
1040 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
1042 // CRM-5081 - formatting the dates to omit seconds.
1043 // Note the 00 in the date format string is needed otherwise later on it thinks scheduled ones are overdue.
1045 SELECT COUNT(ca.id) AS ismultiple,
1047 ca.activity_type_id AS type,
1048 ca.activity_type_id AS activity_type_id,
1049 tcc.sort_name AS target_contact_name,
1050 tcc.id AS target_contact_id,
1051 scc.sort_name AS source_contact_name,
1052 scc.id AS source_contact_id,
1053 acc.sort_name AS assignee_contact_name,
1054 acc.id AS assignee_contact_id,
1056 IF(ca.activity_date_time < NOW() AND ca.status_id=ov.value,
1057 ca.activity_date_time,
1058 DATE_ADD(NOW(), INTERVAL 1 YEAR)
1059 ), '%Y%m%d%H%i00') AS overdue_date,
1060 DATE_FORMAT(ca.activity_date_time, '%Y%m%d%H%i00') AS display_date,
1061 ca.status_id AS status,
1062 ca.subject AS subject,
1063 ca.is_deleted AS deleted,
1064 ca.priority_id AS priority,
1065 ca.weight AS weight,
1066 GROUP_CONCAT(ef.file_id) AS attachment_ids ";
1069 FROM civicrm_case_activity cca
1070 INNER JOIN civicrm_activity ca
1071 ON ca.id = cca.activity_id
1072 INNER JOIN civicrm_activity_contact cas
1073 ON cas.activity_id = ca.id
1074 AND cas.record_type_id = {$sourceID}
1075 INNER JOIN civicrm_contact scc
1076 ON scc.id = cas.contact_id
1077 LEFT JOIN civicrm_activity_contact caa
1078 ON caa.activity_id = ca.id
1079 AND caa.record_type_id = {$assigneeID}
1080 LEFT JOIN civicrm_contact acc
1081 ON acc.id = caa.contact_id
1082 LEFT JOIN civicrm_activity_contact cat
1083 ON cat.activity_id = ca.id
1084 AND cat.record_type_id = {$targetID}
1085 LEFT JOIN civicrm_contact tcc
1086 ON tcc.id = cat.contact_id
1087 INNER JOIN civicrm_option_group cog
1088 ON cog.name = 'activity_type'
1089 INNER JOIN civicrm_option_value cov
1090 ON cov.option_group_id = cog.id
1091 AND cov.value = ca.activity_type_id
1092 AND cov.is_active = 1
1093 LEFT JOIN civicrm_entity_file ef
1094 ON ef.entity_table = 'civicrm_activity'
1095 AND ef.entity_id = ca.id
1096 LEFT OUTER JOIN civicrm_option_group og
1097 ON og.name = 'activity_status'
1098 LEFT OUTER JOIN civicrm_option_value ov
1099 ON ov.option_group_id=og.id
1100 AND ov.name = 'Scheduled'";
1103 WHERE cca.case_id= %1
1104 AND ca.is_current_revision = 1';
1106 if (!empty($params['source_contact_id'])) {
1108 AND cas.contact_id = " . CRM_Utils_Type
::escape($params['source_contact_id'], 'Integer');
1111 if (!empty($params['status_id'])) {
1113 AND ca.status_id = " . CRM_Utils_Type
::escape($params['status_id'], 'Integer');
1116 if (!empty($params['activity_deleted'])) {
1118 AND ca.is_deleted = 1";
1122 AND ca.is_deleted = 0";
1125 if (!empty($params['activity_type_id'])) {
1127 AND ca.activity_type_id = " . CRM_Utils_Type
::escape($params['activity_type_id'], 'Integer');
1130 if (!empty($params['activity_date_low'])) {
1131 $fromActivityDate = CRM_Utils_Type
::escape(CRM_Utils_Date
::processDate($params['activity_date_low']), 'Date');
1133 if (!empty($fromActivityDate)) {
1135 AND ca.activity_date_time >= '{$fromActivityDate}'";
1138 if (!empty($params['activity_date_high'])) {
1139 $toActivityDate = CRM_Utils_Type
::escape(CRM_Utils_Date
::processDate($params['activity_date_high']), 'Date');
1140 $toActivityDate = $toActivityDate ?
$toActivityDate +
235959 : NULL;
1142 if (!empty($toActivityDate)) {
1144 AND ca.activity_date_time <= '{$toActivityDate}'";
1150 $sortBy = CRM_Utils_Array
::value('sortBy', $params);
1152 // CRM-5081 - added id to act like creation date
1154 ORDER BY overdue_date ASC, display_date DESC, weight DESC";
1157 $sortBy = CRM_Utils_Type
::escape($sortBy, 'String');
1158 $orderBy = " ORDER BY $sortBy ";
1161 $page = CRM_Utils_Array
::value('page', $params);
1162 $rp = CRM_Utils_Array
::value('rp', $params);
1170 $start = (($page - 1) * $rp);
1171 $limit = " LIMIT $start, $rp";
1173 $query = $select . $from . $where . $groupBy . $orderBy . $limit;
1174 $queryParams = array(1 => array($caseID, 'Integer'));
1176 $dao = CRM_Core_DAO
::executeQuery($query, $queryParams);
1178 $activityTypes = CRM_Case_PseudoConstant
::caseActivityType(FALSE, TRUE);
1179 $activityStatuses = CRM_Core_PseudoConstant
::activityStatus();
1181 $url = CRM_Utils_System
::url("civicrm/case/activity",
1182 "reset=1&cid={$contactID}&caseid={$caseID}", FALSE, NULL, FALSE
1186 if ($context == 'fulltext') {
1187 $contextUrl = "&context={$context}";
1189 $editUrl = "{$url}&action=update{$contextUrl}";
1190 $deleteUrl = "{$url}&action=delete{$contextUrl}";
1191 $restoreUrl = "{$url}&action=renew{$contextUrl}";
1192 $viewTitle = ts('View activity');
1193 $statusTitle = ts('Edit Status');
1195 $emailActivityTypeIDs = array(
1196 'Email' => CRM_Core_OptionGroup
::getValue('activity_type',
1200 'Inbound Email' => CRM_Core_OptionGroup
::getValue('activity_type',
1206 $emailActivityTypeIDs = array(
1207 'Email' => CRM_Core_OptionGroup
::getValue('activity_type',
1211 'Inbound Email' => CRM_Core_OptionGroup
::getValue('activity_type',
1217 $caseDeleted = CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_Case', $caseID, 'is_deleted');
1219 // define statuses which are handled like Completed status (others are assumed to be handled like Scheduled status)
1220 $compStatusValues = array();
1221 $compStatusNames = array('Completed', 'Left Message', 'Cancelled', 'Unreachable', 'Not Required');
1222 foreach ($compStatusNames as $name) {
1223 $compStatusValues[] = CRM_Core_OptionGroup
::getValue('activity_status', $name, 'name');
1226 $contactViewUrl = CRM_Utils_System
::url("civicrm/contact/view", "reset=1&cid=", FALSE, NULL, FALSE);
1227 $hasViewContact = CRM_Core_Permission
::giveMeAllACLs();
1228 $clientIds = self
::retrieveContactIdsByCaseId($caseID);
1231 $session = CRM_Core_Session
::singleton();
1232 $userID = $session->get('userID');
1235 $caseActivities = array();
1238 while ($dao->fetch()) {
1240 $caseActivity = array();
1241 $caseActivityId = $dao->id
;
1243 $allowView = self
::checkPermission($caseActivityId, 'view', $dao->activity_type_id
, $userID);
1244 $allowEdit = self
::checkPermission($caseActivityId, 'edit', $dao->activity_type_id
, $userID);
1245 $allowDelete = self
::checkPermission($caseActivityId, 'delete', $dao->activity_type_id
, $userID);
1247 //do not have sufficient permission
1248 //to access given case activity record.
1249 if (!$allowView && !$allowEdit && !$allowDelete) {
1253 //Add classes to the row, via DataTables syntax
1254 $caseActivity['DT_RowClass'] = "crm-entity";
1256 if (CRM_Utils_Array
::crmInArray($dao->status
, $compStatusValues)) {
1257 $caseActivity['DT_RowClass'] .= " status-completed";
1260 if (CRM_Utils_Date
::overdue($dao->display_date
)) {
1261 $caseActivity['DT_RowClass'] .= " status-overdue";
1264 $caseActivity['DT_RowClass'] .= " status-scheduled";
1268 if (!empty($dao->priority
)) {
1269 if ($dao->priority
== CRM_Core_OptionGroup
::getValue('priority', 'Urgent', 'name')) {
1270 $caseActivity['DT_RowClass'] .= " priority-urgent ";
1272 elseif ($dao->priority
== CRM_Core_OptionGroup
::getValue('priority', 'Low', 'name')) {
1273 $caseActivity['DT_RowClass'] .= " priority-low ";
1277 //Add data to the row for inline editing, via DataTable syntax
1278 $caseActivity['DT_RowData'] = array();
1279 $caseActivity['DT_RowData']['entity'] = 'activity';
1280 $caseActivity['DT_RowData']['id'] = $caseActivityId;
1282 //Activity Date and Time
1283 $caseActivity['activity_date_time'] = CRM_Utils_Date
::customFormat($dao->display_date
);
1286 $caseActivity['subject'] = $dao->subject
;
1289 $caseActivity['type'] = $activityTypes[$dao->type
]['label'];
1291 //Activity Target (With)
1292 $targetContact = '';
1293 if (isset($dao->target_contact_id
)) {
1294 $targetContact = $dao->target_contact_name
;
1295 if ($hasViewContact) {
1296 $targetContact = '<a href="' . $contactViewUrl . $dao->target_contact_id
. '">' . $dao->target_contact_name
. '</a>';
1299 $caseActivity['target_contact_name'] = $targetContact;
1301 //Activity Source Contact (Reporter)
1302 $sourceContact = $dao->source_contact_name
;
1303 if ($hasViewContact) {
1304 $sourceContact = '<a href="' . $contactViewUrl . $dao->source_contact_id
. '">' . $dao->source_contact_name
. '</a>';
1306 $caseActivity['source_contact_name'] = $sourceContact;
1308 //Activity Assignee. CRM-4485.
1309 $assigneeContact = '';
1310 if (isset($dao->assignee_contact_id
)) {
1311 $assigneeContact = $dao->assignee_contact_name
;
1312 if ($hasViewContact) {
1313 $assigneeContact = '<a href="' . $contactViewUrl . $dao->assignee_contact_id
. '">' . $dao->assignee_contact_name
. '</a>';
1316 $caseActivity['assignee_contact_name'] = $assigneeContact;
1319 $caseActivity['status_id'] = $activityStatuses[$dao->status
];
1321 // 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.
1323 $css = 'class="action-item crm-hover-button"';
1325 $viewUrl = CRM_Utils_System
::url('civicrm/case/activity/view', array('cid' => $contactID, 'aid' => $caseActivityId));
1326 $url = '<a ' . str_replace('action-item', 'action-item medium-pop-up', $css) . 'href="' . $viewUrl . '" title="' . $viewTitle . '">' . ts('View') . '</a>';
1328 $additionalUrl = "&id={$caseActivityId}";
1329 if (!$dao->deleted
) {
1330 //hide edit link of activity type email.CRM-4530.
1331 if (!in_array($dao->type
, $emailActivityTypeIDs)) {
1332 //hide Edit link if activity type is NOT editable (special case activities).CRM-5871
1334 $url .= '<a ' . $css . ' href="' . $editUrl . $additionalUrl . '">' . ts('Edit') . '</a> ';
1338 $url .= ' <a ' . str_replace('action-item', 'action-item small-popup', $css) . ' href="' . $deleteUrl . $additionalUrl . '">' . ts('Delete') . '</a>';
1341 elseif (!$caseDeleted) {
1342 $url = ' <a ' . $css . ' href="' . $restoreUrl . $additionalUrl . '">' . ts('Restore') . '</a>';
1343 $caseActivity['status_id'] = $caseActivity['status_id'] . '<br /> (deleted)';
1346 //check for operations.
1347 if (self
::checkPermission($caseActivityId, 'Move To Case', $dao->activity_type_id
)) {
1348 $url .= ' <a ' . $css . ' href="#" onClick="Javascript:fileOnCase( \'move\',' . $caseActivityId . ', ' . $caseID . ', this ); return false;">' . ts('Move To Case') . '</a> ';
1350 if (self
::checkPermission($caseActivityId, 'Copy To Case', $dao->activity_type_id
)) {
1351 $url .= ' <a ' . $css . ' href="#" onClick="Javascript:fileOnCase( \'copy\',' . $caseActivityId . ',' . $caseID . ', this ); return false;">' . ts('Copy To Case') . '</a> ';
1353 // if there are file attachments we will return how many and, if only one, add a link to it
1354 if (!empty($dao->attachment_ids
)) {
1355 $attachmentIDs = explode(',', $dao->attachment_ids
);
1356 $caseActivity['no_attachments'] = count($attachmentIDs);
1357 if ($caseActivity['no_attachments'] == 1) {
1358 // if there is only one it's easy to do a link - otherwise just flag it
1359 $attachmentViewUrl = CRM_Utils_System
::url(
1361 "reset=1&eid=" . $caseActivityId . "&id=" . $dao->attachment_ids
,
1366 $url .= " <a href='$attachmentViewUrl' ><span class='icon paper-icon'></span></a>";
1370 $caseActivity['links'] = $url;
1372 array_push($caseActivities, $caseActivity);
1376 $caseActivitiesDT = array();
1377 $caseActivitiesDT['data'] = $caseActivities;
1378 $caseActivitiesDT['recordsTotal'] = $caseCount;
1379 $caseActivitiesDT['recordsFiltered'] = $caseCount;
1381 return $caseActivitiesDT;
1385 * Get Case Related Contacts.
1387 * @param int $caseID
1389 * @param bool $skipDetails
1390 * If true include details of contacts.
1393 * array of return properties
1396 public static function getRelatedContacts($caseID, $skipDetails = FALSE) {
1399 SELECT cc.display_name as name, cc.sort_name as sort_name, cc.id, crt.label_b_a as role, ce.email
1400 FROM civicrm_relationship cr
1401 LEFT JOIN civicrm_relationship_type crt
1402 ON crt.id = cr.relationship_type_id
1403 LEFT JOIN civicrm_contact cc
1404 ON cc.id = cr.contact_id_b
1405 LEFT JOIN civicrm_email ce
1406 ON ce.contact_id = cc.id
1407 AND ce.is_primary= 1
1408 WHERE cr.case_id = %1
1411 $params = array(1 => array($caseID, 'Integer'));
1412 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1414 while ($dao->fetch()) {
1416 $values[$dao->id
] = 1;
1420 'contact_id' => $dao->id
,
1421 'display_name' => $dao->name
,
1422 'sort_name' => $dao->sort_name
,
1423 'role' => $dao->role
,
1424 'email' => $dao->email
,
1434 * Send e-mail copy of activity
1436 * @param int $clientId
1437 * @param int $activityId
1439 * @param array $contacts
1440 * Array of related contact.
1442 * @param null $attachments
1443 * @param int $caseId
1445 * @return bool |array
1447 public static function sendActivityCopy($clientId, $activityId, $contacts, $attachments = NULL, $caseId) {
1452 $tplParams = $activityInfo = array();
1453 //if its a case activity
1455 $activityTypeId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $activityId, 'activity_type_id');
1456 $nonCaseActivityTypes = CRM_Core_PseudoConstant
::activityType();
1457 if (!empty($nonCaseActivityTypes[$activityTypeId])) {
1458 $anyActivity = TRUE;
1461 $anyActivity = FALSE;
1463 $tplParams['isCaseActivity'] = 1;
1464 $tplParams['client_id'] = $clientId;
1467 $anyActivity = TRUE;
1470 $xmlProcessorProcess = new CRM_Case_XMLProcessor_Process();
1471 $isRedact = $xmlProcessorProcess->getRedactActivityEmail();
1473 $xmlProcessorReport = new CRM_Case_XMLProcessor_Report();
1475 $activityInfo = $xmlProcessorReport->getActivityInfo($clientId, $activityId, $anyActivity, $isRedact);
1477 $activityInfo['fields'][] = array('label' => 'Case ID', 'type' => 'String', 'value' => $caseId);
1479 $tplParams['activity'] = $activityInfo;
1480 foreach ($tplParams['activity']['fields'] as $k => $val) {
1481 if (CRM_Utils_Array
::value('label', $val) == ts('Subject')) {
1482 $activitySubject = $val['value'];
1486 $session = CRM_Core_Session
::singleton();
1487 // CRM-8926 If user is not logged in, use the activity creator as userID
1488 if (!($userID = $session->get('userID'))) {
1489 $userID = CRM_Activity_BAO_Activity
::getSourceContactID($activityId);
1492 //also create activities simultaneously of this copy.
1493 $activityParams = array();
1495 $activityParams['source_record_id'] = $activityId;
1496 $activityParams['source_contact_id'] = $userID;
1497 $activityParams['activity_type_id'] = CRM_Core_OptionGroup
::getValue('activity_type', 'Email', 'name');
1498 $activityParams['activity_date_time'] = date('YmdHis');
1499 $activityParams['status_id'] = CRM_Core_OptionGroup
::getValue('activity_status', 'Completed', 'name');
1500 $activityParams['medium_id'] = CRM_Core_OptionGroup
::getValue('encounter_medium', 'email', 'name');
1501 $activityParams['case_id'] = $caseId;
1502 $activityParams['is_auto'] = 0;
1503 $activityParams['target_id'] = $clientId;
1505 $tplParams['activitySubject'] = $activitySubject;
1507 // if it’s a case activity, add hashed id to the template (CRM-5916)
1509 $tplParams['idHash'] = substr(sha1(CIVICRM_SITE_KEY
. $caseId), 0, 7);
1513 list($name, $address) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($userID);
1515 $receiptFrom = "$name <$address>";
1517 $recordedActivityParams = array();
1519 foreach ($contacts as $mail => $info) {
1520 $tplParams['contact'] = $info;
1521 self
::buildPermissionLinks($tplParams, $activityParams);
1523 $displayName = CRM_Utils_Array
::value('display_name', $info);
1525 list($result[CRM_Utils_Array
::value('contact_id', $info)], $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate(
1527 'groupName' => 'msg_tpl_workflow_case',
1528 'valueName' => 'case_activity',
1529 'contactId' => CRM_Utils_Array
::value('contact_id', $info),
1530 'tplParams' => $tplParams,
1531 'from' => $receiptFrom,
1532 'toName' => $displayName,
1534 'attachments' => $attachments,
1538 $activityParams['subject'] = $activitySubject . ' - copy sent to ' . $displayName;
1539 $activityParams['details'] = $message;
1541 if (!empty($result[$info['contact_id']])) {
1543 * Really only need to record one activity with all the targets combined.
1544 * Originally the template was going to possibly have different content, e.g. depending on permissions,
1545 * but it's always the same content at the moment.
1547 if (empty($recordedActivityParams)) {
1548 $recordedActivityParams = $activityParams;
1551 $recordedActivityParams['subject'] .= "; $displayName";
1553 $recordedActivityParams['target_contact_id'][] = $info['contact_id'];
1556 unset($result[CRM_Utils_Array
::value('contact_id', $info)]);
1560 if (!empty($recordedActivityParams)) {
1561 $activity = CRM_Activity_BAO_Activity
::create($recordedActivityParams);
1563 //create case_activity record if its case activity.
1565 $caseParams = array(
1566 'activity_id' => $activity->id
,
1567 'case_id' => $caseId,
1569 self
::processCaseActivity($caseParams);
1577 * Retrieve count of activities having a particular type, and
1578 * associated with a particular case.
1580 * @param int $caseId
1582 * @param int $activityTypeId
1583 * ID of the activity type.
1587 public static function getCaseActivityCount($caseId, $activityTypeId) {
1588 $queryParam = array(
1589 1 => array($caseId, 'Integer'),
1590 2 => array($activityTypeId, 'Integer'),
1592 $query = "SELECT count(ca.id) as countact
1593 FROM civicrm_activity ca
1594 INNER JOIN civicrm_case_activity cca ON ca.id = cca.activity_id
1595 WHERE ca.activity_type_id = %2
1596 AND cca.case_id = %1
1597 AND ca.is_deleted = 0";
1599 $dao = CRM_Core_DAO
::executeQuery($query, $queryParam);
1600 if ($dao->fetch()) {
1601 return $dao->countact
;
1608 * Create an activity for a case via email.
1613 * @return array|void
1614 * $activity object of newly creted activity via email
1616 public static function recordActivityViaEmail($file) {
1617 if (!file_exists($file) ||
1620 return CRM_Core_Error
::fatal(ts('File %1 does not exist or is not readable',
1625 $result = CRM_Utils_Mail_Incoming
::parse($file);
1626 if ($result['is_error']) {
1630 foreach ($result['to'] as $to) {
1633 $emailPattern = '/^([A-Z0-9._%+-]+)\+([\d]+)@[A-Z0-9.-]+\.[A-Z]{2,4}$/i';
1634 $replacement = preg_replace($emailPattern, '$2', $to['email']);
1636 if ($replacement !== $to['email']) {
1637 $caseId = $replacement;
1638 //if caseId is invalid, return as error file
1639 if (!CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_Case', $caseId, 'id')) {
1640 return CRM_Core_Error
::createAPIError(ts('Invalid case ID ( %1 ) in TO: field.',
1649 // TODO: May want to replace this with a call to getRelatedAndGlobalContacts() when this feature is revisited.
1650 // (Or for efficiency call the global one outside the loop and then union with this each time.)
1651 $contactDetails = self
::getRelatedContacts($caseId, TRUE);
1653 if (!empty($contactDetails[$result['from']['id']])) {
1655 $params['subject'] = $result['subject'];
1656 $params['activity_date_time'] = $result['date'];
1657 $params['details'] = $result['body'];
1658 $params['source_contact_id'] = $result['from']['id'];
1659 $params['status_id'] = CRM_Core_OptionGroup
::getValue('activity_status',
1664 $details = CRM_Case_PseudoConstant
::caseActivityType();
1666 preg_match('/^\W+([a-zA-Z0-9_ ]+)(\W+)?\n/i',
1667 $result['body'], $matches
1670 if (!empty($matches) && isset($matches[1])) {
1671 $activityType = trim($matches[1]);
1672 if (isset($details[$activityType])) {
1673 $params['activity_type_id'] = $details[$activityType]['id'];
1676 if (!isset($params['activity_type_id'])) {
1677 $params['activity_type_id'] = CRM_Core_OptionGroup
::getValue('activity_type', 'Inbound Email', 'name');
1681 $activity = CRM_Activity_BAO_Activity
::create($params);
1683 $caseParams = array(
1684 'activity_id' => $activity->id
,
1685 'case_id' => $caseId,
1687 self
::processCaseActivity($caseParams);
1690 return CRM_Core_Error
::createAPIError(ts('FROM email contact %1 doesn\'t have a relationship to the referenced case.',
1691 array(1 => $result['from']['email'])
1698 * Retrieve the scheduled activity type and date.
1700 * @param array $cases
1701 * Array of contact and case id.
1703 * @param string $type
1706 * Array of scheduled activity type and date
1710 public static function getNextScheduledActivity($cases, $type = 'upcoming') {
1711 $session = CRM_Core_Session
::singleton();
1712 $userID = $session->get('userID');
1714 $caseID = implode(',', $cases['case_id']);
1715 $contactID = implode(',', $cases['contact_id']);
1718 AND civicrm_case_contact.contact_id IN( {$contactID} )
1719 AND civicrm_case.id IN( {$caseID})
1720 AND civicrm_case.is_deleted = {$cases['case_deleted']}";
1722 $query = self
::getCaseActivityQuery($type, $userID, $condition, $cases['case_deleted']);
1724 $res = CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
1726 $activityInfo = array();
1727 while ($res->fetch()) {
1728 if ($type == 'upcoming') {
1729 $activityInfo[$res->case_id
]['date'] = $res->case_scheduled_activity_date
;
1730 $activityInfo[$res->case_id
]['type'] = $res->case_scheduled_activity_type
;
1733 $activityInfo[$res->case_id
]['date'] = $res->case_recent_activity_date
;
1734 $activityInfo[$res->case_id
]['type'] = $res->case_recent_activity_type
;
1738 return $activityInfo;
1742 * Combine all the exportable fields from the lower levels object.
1745 * array of exportable Fields
1747 public static function &exportableFields() {
1748 if (!self
::$_exportableFields) {
1749 if (!self
::$_exportableFields) {
1750 self
::$_exportableFields = array();
1753 $fields = CRM_Case_DAO_Case
::export();
1754 $fields['case_role'] = array('title' => ts('Role in Case'));
1755 $fields['case_type'] = array(
1756 'title' => ts('Case Type'),
1757 'name' => 'case_type',
1759 $fields['case_status'] = array(
1760 'title' => ts('Case Status'),
1761 'name' => 'case_status',
1764 self
::$_exportableFields = $fields;
1766 return self
::$_exportableFields;
1770 * Restore the record that are associated with this case.
1772 * @param int $caseId
1773 * Id of the case to restore.
1777 public static function restoreCase($caseId) {
1778 //restore activities
1779 $activities = self
::getCaseActivityDates($caseId);
1781 foreach ($activities as $value) {
1782 CRM_Activity_BAO_Activity
::restoreActivity($value);
1786 $case = new CRM_Case_DAO_Case();
1787 $case->id
= $caseId;
1788 $case->is_deleted
= 0;
1791 //CRM-7364, enable relationships
1792 self
::enableDisableCaseRelationships($caseId, TRUE);
1799 * @param null $showLinks
1800 * @param bool $returnOnlyCount
1801 * @param int $offset
1802 * @param int $rowCount
1806 public static function getGlobalContacts(&$groupInfo, $sort = NULL, $showLinks = NULL, $returnOnlyCount = FALSE, $offset = 0, $rowCount = 25) {
1807 $globalContacts = array();
1809 $settingsProcessor = new CRM_Case_XMLProcessor_Settings();
1810 $settings = $settingsProcessor->run();
1811 if (!empty($settings)) {
1812 $groupInfo['name'] = $settings['groupname'];
1813 if ($groupInfo['name']) {
1814 $searchParams = array('name' => $groupInfo['name']);
1816 CRM_Contact_BAO_Group
::retrieve($searchParams, $results);
1818 $groupInfo['id'] = $results['id'];
1819 $groupInfo['title'] = $results['title'];
1820 $params = array(array('group', '=', $groupInfo['id'], 0, 0));
1821 $return = array('contact_id' => 1, 'sort_name' => 1, 'display_name' => 1, 'email' => 1, 'phone' => 1);
1822 list($globalContacts) = CRM_Contact_BAO_Query
::apiQuery($params, $return, NULL, $sort, $offset, $rowCount, TRUE, $returnOnlyCount);
1824 if ($returnOnlyCount) {
1825 return $globalContacts;
1829 foreach ($globalContacts as $idx => $contact) {
1830 $globalContacts[$idx]['sort_name'] = '<a href="' . CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$contact['contact_id']}") . '">' . $contact['sort_name'] . '</a>';
1836 return $globalContacts;
1840 * Convenience function to get both case contacts and global in one array.
1841 * @param int $caseId
1845 public static function getRelatedAndGlobalContacts($caseId) {
1846 $relatedContacts = self
::getRelatedContacts($caseId);
1848 $groupInfo = array();
1849 $globalContacts = self
::getGlobalContacts($groupInfo);
1851 //unset values which are not required.
1852 foreach ($globalContacts as $k => & $v) {
1853 unset($v['email_id']);
1854 unset($v['group_contact_id']);
1855 unset($v['status']);
1857 $v['role'] = $groupInfo['title'];
1859 //include multiple listings for the same contact/different roles.
1860 $relatedGlobalContacts = array_merge($relatedContacts, $globalContacts);
1861 return $relatedGlobalContacts;
1865 * Get Case ActivitiesDueDates with given criteria.
1867 * @param int $caseID
1869 * @param array $criteriaParams
1871 * @param bool $latestDate
1872 * If set newest or oldest date is selected.
1875 * case activities due dates
1878 public static function getCaseActivityDates($caseID, $criteriaParams = array(), $latestDate = FALSE) {
1880 $selectDate = " ca.activity_date_time";
1881 $where = $groupBy = ' ';
1888 if (!empty($criteriaParams['activity_type_id'])) {
1889 $where .= " AND ca.activity_type_id = " . CRM_Utils_Type
::escape($criteriaParams['activity_type_id'], 'Integer');
1890 $where .= " AND ca.is_current_revision = 1";
1891 $groupBy .= " GROUP BY ca.activity_type_id";
1894 if (!empty($criteriaParams['newest'])) {
1895 $selectDate = " max(ca.activity_date_time) ";
1898 $selectDate = " min(ca.activity_date_time) ";
1902 $query = "SELECT ca.id, {$selectDate} as activity_date
1903 FROM civicrm_activity ca
1904 LEFT JOIN civicrm_case_activity cca ON cca.activity_id = ca.id LEFT JOIN civicrm_case cc ON cc.id = cca.case_id
1905 WHERE cc.id = %1 {$where} {$groupBy}";
1907 $params = array(1 => array($caseID, 'Integer'));
1908 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1910 while ($dao->fetch()) {
1911 $values[$dao->id
]['id'] = $dao->id
;
1912 $values[$dao->id
]['activity_date'] = $dao->activity_date
;
1919 * Create activities when Case or Other roles assigned/modified/deleted.
1921 * @param int $caseId
1922 * @param int $relationshipId
1924 * @param int $relContactId
1925 * Case role assignee contactId.
1926 * @param int $contactId
1928 public static function createCaseRoleActivity($caseId, $relationshipId, $relContactId = NULL, $contactId = NULL) {
1929 if (!$caseId ||
!$relationshipId ||
empty($relationshipId)) {
1933 $queryParam = array();
1934 if (is_array($relationshipId)) {
1935 $relationshipId = implode(',', $relationshipId);
1936 $relationshipClause = " civicrm_relationship.id IN ($relationshipId)";
1939 $relationshipClause = " civicrm_relationship.id = %1";
1940 $queryParam[1] = array($relationshipId, 'Positive');
1944 SELECT cc.display_name as clientName,
1945 cca.display_name as assigneeContactName,
1946 civicrm_relationship.case_id as caseId,
1947 civicrm_relationship_type.label_a_b as relation_a_b,
1948 civicrm_relationship_type.label_b_a as relation_b_a,
1949 civicrm_relationship.contact_id_b as rel_contact_id,
1950 civicrm_relationship.contact_id_a as assign_contact_id
1951 FROM civicrm_relationship_type, civicrm_relationship
1952 LEFT JOIN civicrm_contact cc ON cc.id = civicrm_relationship.contact_id_b
1953 LEFT JOIN civicrm_contact cca ON cca.id = civicrm_relationship.contact_id_a
1954 WHERE civicrm_relationship.relationship_type_id = civicrm_relationship_type.id AND {$relationshipClause}";
1956 $dao = CRM_Core_DAO
::executeQuery($query, $queryParam);
1958 while ($dao->fetch()) {
1959 //to get valid assignee contact(s).
1960 if (isset($dao->caseId
) ||
$dao->rel_contact_id
!= $contactId) {
1961 $caseRelationship = $dao->relation_a_b
;
1962 $assigneContactName = $dao->clientName
;
1963 $assigneContactIds[$dao->rel_contact_id
] = $dao->rel_contact_id
;
1966 $caseRelationship = $dao->relation_b_a
;
1967 $assigneContactName = $dao->assigneeContactName
;
1968 $assigneContactIds[$dao->assign_contact_id
] = $dao->assign_contact_id
;
1972 $session = CRM_Core_Session
::singleton();
1973 $activityParams = array(
1974 'source_contact_id' => $session->get('userID'),
1975 'subject' => $caseRelationship . ' : ' . $assigneContactName,
1976 'activity_date_time' => date('YmdHis'),
1977 'status_id' => CRM_Core_OptionGroup
::getValue('activity_status', 'Completed', 'name'),
1980 //if $relContactId is passed, role is added or modified.
1981 if (!empty($relContactId)) {
1982 $activityParams['assignee_contact_id'] = $assigneContactIds;
1984 $activityTypeID = CRM_Core_OptionGroup
::getValue('activity_type',
1990 $activityTypeID = CRM_Core_OptionGroup
::getValue('activity_type',
1996 $activityParams['activity_type_id'] = $activityTypeID;
1998 $activity = CRM_Activity_BAO_Activity
::create($activityParams);
2000 //create case_activity record.
2001 $caseParams = array(
2002 'activity_id' => $activity->id
,
2003 'case_id' => $caseId,
2006 CRM_Case_BAO_Case
::processCaseActivity($caseParams);
2011 * contact which is assigned a case role of case manager.
2013 * @param int $caseType
2015 * @param int $caseId
2019 * array of contact on success otherwise empty
2022 public static function getCaseManagerContact($caseType, $caseId) {
2023 if (!$caseType ||
!$caseId) {
2027 $caseManagerContact = array();
2028 $xmlProcessor = new CRM_Case_XMLProcessor_Process();
2030 $managerRoleId = $xmlProcessor->getCaseManagerRoleId($caseType);
2032 if (!empty($managerRoleId)) {
2033 $managerRoleQuery = "
2034 SELECT civicrm_contact.id as casemanager_id,
2035 civicrm_contact.sort_name as casemanager
2036 FROM civicrm_contact
2037 LEFT JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = civicrm_contact.id AND civicrm_relationship.relationship_type_id = %1)
2038 LEFT JOIN civicrm_case ON civicrm_case.id = civicrm_relationship.case_id
2039 WHERE civicrm_case.id = %2";
2041 $managerRoleParams = array(
2042 1 => array($managerRoleId, 'Integer'),
2043 2 => array($caseId, 'Integer'),
2046 $dao = CRM_Core_DAO
::executeQuery($managerRoleQuery, $managerRoleParams);
2047 if ($dao->fetch()) {
2048 $caseManagerContact['casemanager_id'] = $dao->casemanager_id
;
2049 $caseManagerContact['casemanager'] = $dao->casemanager
;
2053 return $caseManagerContact;
2057 * Get all cases with no end dates.
2059 * @param array $params
2060 * @param array $excludeCaseIds
2061 * @param bool $excludeDeleted
2063 * @param bool $includeClosed
2066 * Case and related data keyed on case id
2068 public static function getUnclosedCases($params = array(), $excludeCaseIds = array(), $excludeDeleted = TRUE, $includeClosed = FALSE) {
2069 //params from ajax call.
2070 $where = array($includeClosed ?
'(1)' : '(ca.end_date is null)');
2071 if ($caseType = CRM_Utils_Array
::value('case_type', $params)) {
2072 $where[] = "( civicrm_case_type.title LIKE '%$caseType%' )";
2074 if ($sortName = CRM_Utils_Array
::value('sort_name', $params)) {
2075 $config = CRM_Core_Config
::singleton();
2076 $search = ($config->includeWildCardInName
) ?
"%$sortName%" : "$sortName%";
2077 $where[] = "( sort_name LIKE '$search' )";
2079 if ($cid = CRM_Utils_Array
::value('contact_id', $params)) {
2080 $where[] = " c.id = $cid ";
2082 if (is_array($excludeCaseIds) &&
2083 !CRM_Utils_System
::isNull($excludeCaseIds)
2085 $where[] = ' ( ca.id NOT IN ( ' . implode(',', $excludeCaseIds) . ' ) ) ';
2087 if ($excludeDeleted) {
2088 $where[] = ' ( ca.is_deleted = 0 OR ca.is_deleted IS NULL ) ';
2091 //filter for permissioned cases.
2092 $filterCases = array();
2093 $doFilterCases = FALSE;
2094 if (!CRM_Core_Permission
::check('access all cases and activities')) {
2095 $doFilterCases = TRUE;
2096 $session = CRM_Core_Session
::singleton();
2097 $filterCases = CRM_Case_BAO_Case
::getCases(FALSE, $session->get('userID'));
2099 $whereClause = implode(' AND ', $where);
2102 if ($limit = CRM_Utils_Array
::value('limit', $params)) {
2103 $limitClause = "LIMIT 0, $limit";
2107 SELECT c.id as contact_id,
2110 ca.subject as case_subject,
2111 civicrm_case_type.title as case_type,
2112 ca.start_date as start_date,
2113 ca.end_date as end_date,
2115 FROM civicrm_case ca INNER JOIN civicrm_case_contact cc ON ca.id=cc.case_id
2116 INNER JOIN civicrm_contact c ON cc.contact_id=c.id
2117 INNER JOIN civicrm_case_type ON ca.case_type_id = civicrm_case_type.id
2118 WHERE {$whereClause}
2119 ORDER BY c.sort_name, ca.end_date
2122 $dao = CRM_Core_DAO
::executeQuery($query);
2123 $statuses = CRM_Case_BAO_Case
::buildOptions('status_id', 'create');
2125 $unclosedCases = array();
2126 while ($dao->fetch()) {
2127 if ($doFilterCases && !array_key_exists($dao->id
, $filterCases)) {
2130 $unclosedCases[$dao->id
] = array(
2131 'sort_name' => $dao->sort_name
,
2132 'case_type' => $dao->case_type
,
2133 'contact_id' => $dao->contact_id
,
2134 'start_date' => $dao->start_date
,
2135 'end_date' => $dao->end_date
,
2136 'case_subject' => $dao->case_subject
,
2137 'case_status' => $statuses[$dao->status_id
],
2142 return $unclosedCases;
2146 * @param int $contactId
2147 * @param bool $excludeDeleted
2149 * @return null|string
2151 public static function caseCount($contactId = NULL, $excludeDeleted = TRUE) {
2152 $whereConditions = array();
2153 if ($excludeDeleted) {
2154 $whereConditions[] = "( civicrm_case.is_deleted = 0 OR civicrm_case.is_deleted IS NULL )";
2157 $whereConditions[] = "civicrm_case_contact.contact_id = {$contactId}";
2159 if (!CRM_Core_Permission
::check('access all cases and activities')) {
2160 static $accessibleCaseIds;
2161 if (!is_array($accessibleCaseIds)) {
2162 $session = CRM_Core_Session
::singleton();
2163 $accessibleCaseIds = array_keys(self
::getCases(FALSE, $session->get('userID'), 'any'));
2165 //no need of further processing.
2166 if (empty($accessibleCaseIds)) {
2169 $whereConditions[] = "( civicrm_case.id in (" . implode(',', $accessibleCaseIds) . ") )";
2173 if (!empty($whereConditions)) {
2174 $whereClause = "WHERE " . implode(' AND ', $whereConditions);
2178 SELECT count( civicrm_case.id )
2180 LEFT JOIN civicrm_case_contact ON ( civicrm_case.id = civicrm_case_contact.case_id )
2183 return CRM_Core_DAO
::singleValueQuery($query);
2187 * Retrieve cases related to particular contact.
2189 * @param int $contactId
2191 * @param bool $excludeDeleted
2192 * Do not include deleted cases.
2196 public static function getContactCases($contactId, $excludeDeleted = TRUE) {
2202 $whereClause = "civicrm_case_contact.contact_id = %1";
2203 if ($excludeDeleted) {
2204 $whereClause .= " AND ( civicrm_case.is_deleted = 0 OR civicrm_case.is_deleted IS NULL )";
2208 SELECT civicrm_case.id, civicrm_case_type.title as case_type, civicrm_case.start_date
2210 INNER JOIN civicrm_case_contact ON ( civicrm_case.id = civicrm_case_contact.case_id )
2211 LEFT JOIN civicrm_case_type ON civicrm_case.case_type_id = civicrm_case_type.id
2212 WHERE {$whereClause}";
2214 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array($contactId, 'Integer')));
2215 while ($dao->fetch()) {
2216 $cases[$dao->id
] = array(
2217 'case_id' => $dao->id
,
2218 'case_type' => $dao->case_type
,
2219 'case_start_date' => $dao->start_date
,
2228 * Retrieve related cases for give case.
2230 * @param int $mainCaseId
2232 * @param int $contactId
2234 * @param bool $excludeDeleted
2235 * Do not include deleted cases.
2239 public static function getRelatedCases($mainCaseId, $contactId, $excludeDeleted = TRUE) {
2240 //FIXME : do check for permissions.
2242 $relatedCases = array();
2243 if (!$mainCaseId ||
!$contactId) {
2244 return $relatedCases;
2247 $linkActType = array_search('Link Cases',
2248 CRM_Core_PseudoConstant
::activityType(TRUE, TRUE, FALSE, 'name')
2250 if (!$linkActType) {
2251 return $relatedCases;
2254 $whereClause = "mainCase.id = %2";
2255 if ($excludeDeleted) {
2256 $whereClause .= " AND ( relAct.is_deleted = 0 OR relAct.is_deleted IS NULL )";
2259 //1. first fetch related case ids.
2261 SELECT relCaseAct.case_id
2262 FROM civicrm_case mainCase
2263 INNER JOIN civicrm_case_activity mainCaseAct ON (mainCaseAct.case_id = mainCase.id)
2264 INNER JOIN civicrm_activity mainAct ON (mainCaseAct.activity_id = mainAct.id AND mainAct.activity_type_id = %1)
2265 INNER JOIN civicrm_case_activity relCaseAct ON (relCaseAct.activity_id = mainAct.id AND mainCaseAct.id != relCaseAct.id)
2266 INNER JOIN civicrm_activity relAct ON (relCaseAct.activity_id = relAct.id AND relAct.activity_type_id = %1)
2267 WHERE $whereClause";
2269 $dao = CRM_Core_DAO
::executeQuery($query, array(
2270 1 => array($linkActType, 'Integer'),
2271 2 => array($mainCaseId, 'Integer'),
2273 $relatedCaseIds = array();
2274 while ($dao->fetch()) {
2275 $relatedCaseIds[$dao->case_id
] = $dao->case_id
;
2279 // there are no related cases.
2280 if (empty($relatedCaseIds)) {
2281 return $relatedCases;
2284 $whereClause = 'relCase.id IN ( ' . implode(',', $relatedCaseIds) . ' )';
2285 if ($excludeDeleted) {
2286 $whereClause .= " AND ( relCase.is_deleted = 0 OR relCase.is_deleted IS NULL )";
2289 //filter for permissioned cases.
2290 $filterCases = array();
2291 $doFilterCases = FALSE;
2292 if (!CRM_Core_Permission
::check('access all cases and activities')) {
2293 $doFilterCases = TRUE;
2294 $session = CRM_Core_Session
::singleton();
2295 $filterCases = CRM_Case_BAO_Case
::getCases(FALSE, $session->get('userID'));
2298 //2. fetch the details of related cases.
2300 SELECT relCase.id as id,
2301 civicrm_case_type.title as case_type,
2302 client.display_name as client_name,
2303 client.id as client_id
2304 FROM civicrm_case relCase
2305 INNER JOIN civicrm_case_contact relCaseContact ON ( relCase.id = relCaseContact.case_id )
2306 INNER JOIN civicrm_contact client ON ( client.id = relCaseContact.contact_id )
2307 LEFT JOIN civicrm_case_type ON relCase.case_type_id = civicrm_case_type.id
2308 WHERE {$whereClause}";
2310 $dao = CRM_Core_DAO
::executeQuery($query);
2311 $contactViewUrl = CRM_Utils_System
::url("civicrm/contact/view", "reset=1&cid=");
2312 $hasViewContact = CRM_Core_Permission
::giveMeAllACLs();
2314 while ($dao->fetch()) {
2316 if (!$doFilterCases ||
array_key_exists($dao->id
, $filterCases)) {
2317 $caseViewStr = "reset=1&id={$dao->id}&cid={$dao->client_id}&action=view&context=case&selectedChild=case";
2318 $caseViewUrl = CRM_Utils_System
::url("civicrm/contact/view/case", $caseViewStr);
2319 $caseView = "<a class='action-item no-popup crm-hover-button' href='{$caseViewUrl}'>" . ts('View Case') . "</a>";
2321 $clientView = $dao->client_name
;
2322 if ($hasViewContact) {
2323 $clientView = "<a href='{$contactViewUrl}{$dao->client_id}'>$dao->client_name</a>";
2326 $relatedCases[$dao->id
] = array(
2327 'case_id' => $dao->id
,
2328 'case_type' => $dao->case_type
,
2329 'client_name' => $clientView,
2330 'links' => $caseView,
2335 return $relatedCases;
2339 * Merge two duplicate contacts' cases - follow CRM-5758 rules.
2341 * @see CRM_Dedupe_Merger::cpTables()
2343 * TODO: use the 3rd $sqls param to append sql statements rather than executing them here
2345 * @param int $mainContactId
2346 * @param int $otherContactId
2348 public static function mergeContacts($mainContactId, $otherContactId) {
2349 self
::mergeCases($mainContactId, NULL, $otherContactId);
2353 * Function perform two task.
2354 * 1. Merge two duplicate contacts cases - follow CRM-5758 rules.
2355 * 2. Merge two cases of same contact - follow CRM-5598 rules.
2357 * @param int $mainContactId
2358 * Contact id of main contact record.
2359 * @param int $mainCaseId
2360 * Case id of main case record.
2361 * @param int $otherContactId
2362 * Contact id of record which is going to merge.
2363 * @param int $otherCaseId
2364 * Case id of record which is going to merge.
2366 * @param bool $changeClient
2370 public static function mergeCases(
2371 $mainContactId, $mainCaseId = NULL, $otherContactId = NULL,
2372 $otherCaseId = NULL, $changeClient = FALSE) {
2373 $moveToTrash = TRUE;
2375 $duplicateContacts = FALSE;
2376 if ($mainContactId && $otherContactId &&
2377 $mainContactId != $otherContactId
2379 $duplicateContacts = TRUE;
2382 $duplicateCases = FALSE;
2383 if ($mainCaseId && $otherCaseId &&
2384 $mainCaseId != $otherCaseId
2386 $duplicateCases = TRUE;
2389 $mainCaseIds = array();
2390 if (!$duplicateContacts && !$duplicateCases) {
2391 return $mainCaseIds;
2394 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, TRUE, FALSE, 'name');
2395 $activityStatuses = CRM_Core_PseudoConstant
::activityStatus('name');
2396 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2397 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2398 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
2399 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2401 $processCaseIds = array($otherCaseId);
2402 if ($duplicateContacts && !$duplicateCases) {
2403 if ($changeClient) {
2404 $processCaseIds = array($mainCaseId);
2407 //get all case ids for other contact.
2408 $processCaseIds = self
::retrieveCaseIdsByContactId($otherContactId, TRUE);
2410 if (!is_array($processCaseIds)) {
2415 $session = CRM_Core_Session
::singleton();
2416 $currentUserId = $session->get('userID');
2418 CRM_Utils_Hook
::pre_case_merge($mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient);
2420 // copy all cases and connect to main contact id.
2421 foreach ($processCaseIds as $otherCaseId) {
2422 if ($duplicateContacts) {
2423 $mainCase = CRM_Core_DAO
::copyGeneric('CRM_Case_DAO_Case', array('id' => $otherCaseId));
2424 $mainCaseId = $mainCase->id
;
2429 // CRM-11662 Copy Case custom data
2430 $extends = array('case');
2431 $groupTree = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, NULL, $extends);
2433 foreach ($groupTree as $groupID => $group) {
2434 $table[$groupTree[$groupID]['table_name']] = array('entity_id');
2435 foreach ($group['fields'] as $fieldID => $field) {
2436 $table[$groupTree[$groupID]['table_name']][] = $groupTree[$groupID]['fields'][$fieldID]['column_name'];
2440 foreach ($table as $tableName => $tableColumns) {
2441 $insert = 'INSERT INTO ' . $tableName . ' (' . implode(', ', $tableColumns) . ') ';
2442 $tableColumns[0] = $mainCaseId;
2443 $select = 'SELECT ' . implode(', ', $tableColumns);
2444 $from = ' FROM ' . $tableName;
2445 $where = " WHERE {$tableName}.entity_id = {$otherCaseId}";
2446 $query = $insert . $select . $from . $where;
2447 $dao = CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
2453 $mainCaseIds[] = $mainCaseId;
2454 //insert record for case contact.
2455 $otherCaseContact = new CRM_Case_DAO_CaseContact();
2456 $otherCaseContact->case_id
= $otherCaseId;
2457 $otherCaseContact->find();
2458 while ($otherCaseContact->fetch()) {
2459 $mainCaseContact = new CRM_Case_DAO_CaseContact();
2460 $mainCaseContact->case_id
= $mainCaseId;
2461 $mainCaseContact->contact_id
= $otherCaseContact->contact_id
;
2462 if ($mainCaseContact->contact_id
== $otherContactId) {
2463 $mainCaseContact->contact_id
= $mainContactId;
2465 //avoid duplicate object.
2466 if (!$mainCaseContact->find(TRUE)) {
2467 $mainCaseContact->save();
2469 $mainCaseContact->free();
2471 $otherCaseContact->free();
2473 elseif (!$otherContactId) {
2474 $otherContactId = $mainContactId;
2477 if (!$mainCaseId ||
!$otherCaseId ||
2478 !$mainContactId ||
!$otherContactId
2483 // get all activities for other case.
2484 $otherCaseActivities = array();
2485 CRM_Core_DAO
::commonRetrieveAll('CRM_Case_DAO_CaseActivity', 'case_id', $otherCaseId, $otherCaseActivities);
2487 //for duplicate cases do not process singleton activities.
2488 $otherActivityIds = $singletonActivityIds = array();
2489 foreach ($otherCaseActivities as $caseActivityId => $otherIds) {
2490 $otherActId = CRM_Utils_Array
::value('activity_id', $otherIds);
2491 if (!$otherActId ||
in_array($otherActId, $otherActivityIds)) {
2494 $otherActivityIds[] = $otherActId;
2496 if ($duplicateCases) {
2497 if ($openCaseType = array_search('Open Case', $activityTypes)) {
2500 FROM civicrm_activity
2501 WHERE activity_type_id = $openCaseType
2502 AND id IN ( " . implode(',', array_values($otherActivityIds)) . ');';
2503 $dao = CRM_Core_DAO
::executeQuery($sql);
2504 while ($dao->fetch()) {
2505 $singletonActivityIds[] = $dao->id
;
2511 // migrate all activities and connect to main contact.
2512 $copiedActivityIds = $activityMappingIds = array();
2513 sort($otherActivityIds);
2514 foreach ($otherActivityIds as $otherActivityId) {
2516 //for duplicate cases -
2517 //do not migrate singleton activities.
2518 if (!$otherActivityId ||
in_array($otherActivityId, $singletonActivityIds)) {
2522 //migrate activity record.
2523 $otherActivity = new CRM_Activity_DAO_Activity();
2524 $otherActivity->id
= $otherActivityId;
2525 if (!$otherActivity->find(TRUE)) {
2529 $mainActVals = array();
2530 $mainActivity = new CRM_Activity_DAO_Activity();
2531 CRM_Core_DAO
::storeValues($otherActivity, $mainActVals);
2532 $mainActivity->copyValues($mainActVals);
2533 $mainActivity->id
= NULL;
2534 $mainActivity->activity_date_time
= CRM_Utils_Date
::isoToMysql($otherActivity->activity_date_time
);
2535 $mainActivity->source_record_id
= CRM_Utils_Array
::value($mainActivity->source_record_id
,
2539 $mainActivity->original_id
= CRM_Utils_Array
::value($mainActivity->original_id
,
2543 $mainActivity->parent_id
= CRM_Utils_Array
::value($mainActivity->parent_id
,
2546 $mainActivity->save();
2547 $mainActivityId = $mainActivity->id
;
2548 if (!$mainActivityId) {
2552 $activityMappingIds[$otherActivityId] = $mainActivityId;
2553 // insert log of all activities
2554 CRM_Activity_BAO_Activity
::logActivityAction($mainActivity);
2556 $otherActivity->free();
2557 $mainActivity->free();
2558 $copiedActivityIds[] = $otherActivityId;
2560 //create case activity record.
2561 $mainCaseActivity = new CRM_Case_DAO_CaseActivity();
2562 $mainCaseActivity->case_id
= $mainCaseId;
2563 $mainCaseActivity->activity_id
= $mainActivityId;
2564 $mainCaseActivity->save();
2565 $mainCaseActivity->free();
2567 //migrate source activity.
2568 $otherSourceActivity = new CRM_Activity_DAO_ActivityContact();
2569 $otherSourceActivity->activity_id
= $otherActivityId;
2570 $otherSourceActivity->record_type_id
= $sourceID;
2571 $otherSourceActivity->find();
2572 while ($otherSourceActivity->fetch()) {
2573 $mainActivitySource = new CRM_Activity_DAO_ActivityContact();
2574 $mainActivitySource->record_type_id
= $sourceID;
2575 $mainActivitySource->activity_id
= $mainActivityId;
2576 $mainActivitySource->contact_id
= $otherSourceActivity->contact_id
;
2577 if ($mainActivitySource->contact_id
== $otherContactId) {
2578 $mainActivitySource->contact_id
= $mainContactId;
2580 //avoid duplicate object.
2581 if (!$mainActivitySource->find(TRUE)) {
2582 $mainActivitySource->save();
2584 $mainActivitySource->free();
2586 $otherSourceActivity->free();
2588 //migrate target activities.
2589 $otherTargetActivity = new CRM_Activity_DAO_ActivityContact();
2590 $otherTargetActivity->activity_id
= $otherActivityId;
2591 $otherTargetActivity->record_type_id
= $targetID;
2592 $otherTargetActivity->find();
2593 while ($otherTargetActivity->fetch()) {
2594 $mainActivityTarget = new CRM_Activity_DAO_ActivityContact();
2595 $mainActivityTarget->record_type_id
= $targetID;
2596 $mainActivityTarget->activity_id
= $mainActivityId;
2597 $mainActivityTarget->contact_id
= $otherTargetActivity->contact_id
;
2598 if ($mainActivityTarget->contact_id
== $otherContactId) {
2599 $mainActivityTarget->contact_id
= $mainContactId;
2601 //avoid duplicate object.
2602 if (!$mainActivityTarget->find(TRUE)) {
2603 $mainActivityTarget->save();
2605 $mainActivityTarget->free();
2607 $otherTargetActivity->free();
2609 //migrate assignee activities.
2610 $otherAssigneeActivity = new CRM_Activity_DAO_ActivityContact();
2611 $otherAssigneeActivity->activity_id
= $otherActivityId;
2612 $otherAssigneeActivity->record_type_id
= $assigneeID;
2613 $otherAssigneeActivity->find();
2614 while ($otherAssigneeActivity->fetch()) {
2615 $mainAssigneeActivity = new CRM_Activity_DAO_ActivityContact();
2616 $mainAssigneeActivity->activity_id
= $mainActivityId;
2617 $mainAssigneeActivity->record_type_id
= $assigneeID;
2618 $mainAssigneeActivity->contact_id
= $otherAssigneeActivity->contact_id
;
2619 if ($mainAssigneeActivity->contact_id
== $otherContactId) {
2620 $mainAssigneeActivity->contact_id
= $mainContactId;
2622 //avoid duplicate object.
2623 if (!$mainAssigneeActivity->find(TRUE)) {
2624 $mainAssigneeActivity->save();
2626 $mainAssigneeActivity->free();
2628 $otherAssigneeActivity->free();
2630 // copy custom fields and attachments
2632 'activityID' => $otherActivityId,
2633 'mainActivityId' => $mainActivityId,
2635 CRM_Activity_BAO_Activity
::copyExtendedActivityData($aparams);
2638 //copy case relationship.
2639 if ($duplicateContacts) {
2640 //migrate relationship records.
2641 $otherRelationship = new CRM_Contact_DAO_Relationship();
2642 $otherRelationship->case_id
= $otherCaseId;
2643 $otherRelationship->find();
2644 $otherRelationshipIds = array();
2645 while ($otherRelationship->fetch()) {
2646 $otherRelVals = array();
2647 $updateOtherRel = FALSE;
2648 CRM_Core_DAO
::storeValues($otherRelationship, $otherRelVals);
2650 $mainRelationship = new CRM_Contact_DAO_Relationship();
2651 $mainRelationship->copyValues($otherRelVals);
2652 $mainRelationship->id
= NULL;
2653 $mainRelationship->case_id
= $mainCaseId;
2654 if ($mainRelationship->contact_id_a
== $otherContactId) {
2655 $updateOtherRel = TRUE;
2656 $mainRelationship->contact_id_a
= $mainContactId;
2659 //case creator change only when we merge user contact.
2660 if ($mainRelationship->contact_id_b
== $otherContactId) {
2661 //do not change creator for change client.
2662 if (!$changeClient) {
2663 $updateOtherRel = TRUE;
2664 $mainRelationship->contact_id_b
= ($currentUserId) ?
$currentUserId : $mainContactId;
2667 $mainRelationship->end_date
= CRM_Utils_Date
::isoToMysql($otherRelationship->end_date
);
2668 $mainRelationship->start_date
= CRM_Utils_Date
::isoToMysql($otherRelationship->start_date
);
2670 //avoid duplicate object.
2671 if (!$mainRelationship->find(TRUE)) {
2672 $mainRelationship->save();
2674 $mainRelationship->free();
2676 //get the other relationship ids to update end date.
2677 if ($updateOtherRel) {
2678 $otherRelationshipIds[$otherRelationship->id
] = $otherRelationship->id
;
2681 $otherRelationship->free();
2683 //update other relationships end dates
2684 if (!empty($otherRelationshipIds)) {
2685 $sql = 'UPDATE civicrm_relationship
2686 SET end_date = CURDATE()
2687 WHERE id IN ( ' . implode(',', $otherRelationshipIds) . ')';
2688 CRM_Core_DAO
::executeQuery($sql);
2692 //move other case to trash.
2693 $mergeCase = self
::deleteCase($otherCaseId, $moveToTrash);
2698 $mergeActSubject = $mergeActSubjectDetails = $mergeActType = '';
2699 if ($changeClient) {
2700 $mainContactDisplayName = CRM_Contact_BAO_Contact
::displayName($mainContactId);
2701 $otherContactDisplayName = CRM_Contact_BAO_Contact
::displayName($otherContactId);
2703 $mergeActType = array_search('Reassigned Case', $activityTypes);
2704 $mergeActSubject = ts("Case %1 reassigned client from %2 to %3. New Case ID is %4.",
2707 2 => $otherContactDisplayName,
2708 3 => $mainContactDisplayName,
2713 elseif ($duplicateContacts) {
2714 $mergeActType = array_search('Merge Case', $activityTypes);
2715 $mergeActSubject = ts("Case %1 copied from contact id %2 to contact id %3 via merge. New Case ID is %4.",
2718 2 => $otherContactId,
2719 3 => $mainContactId,
2725 $mergeActType = array_search('Merge Case', $activityTypes);
2726 $mergeActSubject = ts("Case %1 merged into case %2", array(1 => $otherCaseId, 2 => $mainCaseId));
2727 if (!empty($copiedActivityIds)) {
2729 SELECT id, subject, activity_date_time, activity_type_id
2730 FROM civicrm_activity
2731 WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
2732 $dao = CRM_Core_DAO
::executeQuery($sql);
2733 while ($dao->fetch()) {
2734 $mergeActSubjectDetails .= "{$dao->activity_date_time} :: {$activityTypes[$dao->activity_type_id]}";
2735 if ($dao->subject
) {
2736 $mergeActSubjectDetails .= " :: {$dao->subject}";
2738 $mergeActSubjectDetails .= "<br />";
2743 //Create merge activity record. Source for merge activity is the logged in user's contact ID ($currentUserId).
2744 $activityParams = array(
2745 'subject' => $mergeActSubject,
2746 'details' => $mergeActSubjectDetails,
2747 'status_id' => array_search('Completed', $activityStatuses),
2748 'activity_type_id' => $mergeActType,
2749 'source_contact_id' => $currentUserId,
2750 'activity_date_time' => date('YmdHis'),
2753 $mergeActivity = CRM_Activity_BAO_Activity
::create($activityParams);
2754 $mergeActivityId = $mergeActivity->id
;
2755 if (!$mergeActivityId) {
2758 $mergeActivity->free();
2760 //connect merge activity to case.
2761 $mergeCaseAct = array(
2762 'case_id' => $mainCaseId,
2763 'activity_id' => $mergeActivityId,
2766 self
::processCaseActivity($mergeCaseAct);
2769 CRM_Utils_Hook
::post_case_merge($mainContactId, $mainCaseId, $otherContactId, $otherCaseId, $changeClient);
2771 return $mainCaseIds;
2775 * Validate contact permission for
2776 * edit/view on activity record and build links.
2778 * @param array $tplParams
2779 * Params to be sent to template for sending email.
2780 * @param array $activityParams
2781 * Info of the activity.
2783 public static function buildPermissionLinks(&$tplParams, $activityParams) {
2784 $activityTypeId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $activityParams['source_record_id'],
2785 'activity_type_id', 'id'
2788 if (!empty($tplParams['isCaseActivity'])) {
2789 $tplParams['editActURL'] = CRM_Utils_System
::url('civicrm/case/activity',
2790 "reset=1&cid={$activityParams['target_id']}&caseid={$activityParams['case_id']}&action=update&id={$activityParams['source_record_id']}", TRUE
2793 $tplParams['viewActURL'] = CRM_Utils_System
::url('civicrm/case/activity/view',
2794 "reset=1&aid={$activityParams['source_record_id']}&cid={$activityParams['target_id']}&caseID={$activityParams['case_id']}", TRUE
2797 $tplParams['manageCaseURL'] = CRM_Utils_System
::url('civicrm/contact/view/case',
2798 "reset=1&id={$activityParams['case_id']}&cid={$activityParams['target_id']}&action=view&context=home", TRUE
2802 $tplParams['editActURL'] = CRM_Utils_System
::url('civicrm/contact/view/activity',
2803 "atype=$activityTypeId&action=update&reset=1&id={$activityParams['source_record_id']}&cid={$tplParams['contact']['contact_id']}&context=activity", TRUE
2806 $tplParams['viewActURL'] = CRM_Utils_System
::url('civicrm/contact/view/activity',
2807 "atype=$activityTypeId&action=view&reset=1&id={$activityParams['source_record_id']}&cid={$tplParams['contact']['contact_id']}&context=activity", TRUE
2813 * Validate contact permission for
2814 * given operation on activity record.
2816 * @param int $activityId
2817 * Activity record id.
2818 * @param string $operation
2820 * @param int $actTypeId
2822 * @param int $contactId
2823 * Contact id/if not pass consider logged in.
2824 * @param bool $checkComponent
2825 * Do we need to check component enabled.
2829 public static function checkPermission($activityId, $operation, $actTypeId = NULL, $contactId = NULL, $checkComponent = TRUE) {
2831 if (!$actTypeId && $activityId) {
2832 $actTypeId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity', $activityId, 'activity_type_id');
2835 if (!$activityId ||
!$operation ||
!$actTypeId) {
2839 //do check for civicase component enabled.
2840 if ($checkComponent && !self
::enabled()) {
2844 //do check for cases.
2845 $caseActOperations = array(
2852 if (in_array($operation, $caseActOperations)) {
2853 static $unclosedCases;
2854 if (!is_array($unclosedCases)) {
2855 $unclosedCases = self
::getUnclosedCases();
2857 if ($operation == 'File On Case') {
2858 $allow = (empty($unclosedCases)) ?
FALSE : TRUE;
2861 $allow = (count($unclosedCases) > 1) ?
TRUE : FALSE;
2865 $actionOperations = array('view', 'edit', 'delete');
2866 if (in_array($operation, $actionOperations)) {
2868 //do cache when user has non/supper permission.
2869 static $allowOperations;
2871 if (!is_array($allowOperations) ||
2872 !array_key_exists($operation, $allowOperations)
2876 $session = CRM_Core_Session
::singleton();
2877 $contactId = $session->get('userID');
2880 //check for permissions.
2881 $permissions = array(
2883 'access my cases and activities',
2884 'access all cases and activities',
2887 'access my cases and activities',
2888 'access all cases and activities',
2890 'delete' => array('delete activities'),
2893 //check for core permission.
2894 $hasPermissions = array();
2895 $checkPermissions = CRM_Utils_Array
::value($operation, $permissions);
2896 if (is_array($checkPermissions)) {
2897 foreach ($checkPermissions as $per) {
2898 if (CRM_Core_Permission
::check($per)) {
2899 $hasPermissions[$operation][] = $per;
2905 if (!empty($hasPermissions)) {
2906 //need to check activity object specific.
2907 if (in_array($operation, array(
2912 //do we have supper permission.
2913 if (in_array('access all cases and activities', $hasPermissions[$operation])) {
2914 $allowOperations[$operation] = $allow = TRUE;
2917 //user has only access to my cases and activity.
2918 //here object specific permmions come in picture.
2920 //edit - contact must be source or assignee
2921 //view - contact must be source/assignee/target
2922 $isTarget = $isAssignee = $isSource = FALSE;
2923 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2924 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2925 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
2926 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2928 $target = new CRM_Activity_DAO_ActivityContact();
2929 $target->record_type_id
= $targetID;
2930 $target->activity_id
= $activityId;
2931 $target->contact_id
= $contactId;
2932 if ($target->find(TRUE)) {
2936 $assignee = new CRM_Activity_DAO_ActivityContact();
2937 $assignee->activity_id
= $activityId;
2938 $assignee->record_type_id
= $assigneeID;
2939 $assignee->contact_id
= $contactId;
2940 if ($assignee->find(TRUE)) {
2944 $source = new CRM_Activity_DAO_ActivityContact();
2945 $source->activity_id
= $activityId;
2946 $source->record_type_id
= $sourceID;
2947 $source->contact_id
= $contactId;
2948 if ($source->find(TRUE)) {
2952 if ($operation == 'edit') {
2953 if ($isAssignee ||
$isSource) {
2957 if ($operation == 'view') {
2958 if ($isTarget ||
$isAssignee ||
$isSource) {
2964 elseif (is_array($hasPermissions[$operation])) {
2965 $allowOperations[$operation] = $allow = TRUE;
2969 //contact do not have permission.
2970 $allowOperations[$operation] = FALSE;
2975 //here contact might have supper/non permission.
2976 $allow = $allowOperations[$operation];
2980 //do further only when operation is granted.
2982 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, TRUE, FALSE, 'name');
2984 //get the activity type name.
2985 $actTypeName = CRM_Utils_Array
::value($actTypeId, $activityTypes);
2987 //do not allow multiple copy / edit action.
2988 $singletonNames = array(
2998 //do not allow to delete these activities, CRM-4543
2999 $doNotDeleteNames = array('Open Case', 'Change Case Type', 'Change Case Status', 'Change Case Start Date');
3001 //allow edit operation.
3002 $allowEditNames = array('Open Case');
3004 // do not allow File on Case
3005 $doNotFileNames = array(
3008 'Change Case Status',
3009 'Change Case Start Date',
3016 if (in_array($actTypeName, $singletonNames)) {
3018 if ($operation == 'File On Case') {
3019 $allow = (in_array($actTypeName, $doNotFileNames)) ?
FALSE : TRUE;
3021 if (in_array($operation, $actionOperations)) {
3023 if ($operation == 'edit') {
3024 $allow = (in_array($actTypeName, $allowEditNames)) ?
TRUE : FALSE;
3026 elseif ($operation == 'delete') {
3027 $allow = (in_array($actTypeName, $doNotDeleteNames)) ?
FALSE : TRUE;
3031 if ($allow && ($operation == 'delete') &&
3032 in_array($actTypeName, $doNotDeleteNames)
3037 if ($allow && ($operation == 'File On Case') &&
3038 in_array($actTypeName, $doNotFileNames)
3043 //check settings file for masking actions
3044 //on the basis the activity types
3045 //hide Edit link if activity type is NOT editable
3046 //(special case activities).CRM-5871
3047 if ($allow && in_array($operation, $actionOperations)) {
3048 static $actionFilter = array();
3049 if (!array_key_exists($operation, $actionFilter)) {
3050 $xmlProcessor = new CRM_Case_XMLProcessor_Process();
3051 $actionFilter[$operation] = $xmlProcessor->get('Settings', 'ActivityTypes', FALSE, $operation);
3053 if (array_key_exists($operation, $actionFilter[$operation]) &&
3054 in_array($actTypeId, $actionFilter[$operation][$operation])
3065 * Since we drop 'access CiviCase', allow access
3066 * if user has 'access my cases and activities'
3067 * or 'access all cases and activities'
3069 public static function accessCiviCase() {
3070 if (!self
::enabled()) {
3074 if (CRM_Core_Permission
::check('access my cases and activities') ||
3075 CRM_Core_Permission
::check('access all cases and activities')
3084 * Verify user has permission to access a case.
3086 * @param int $caseId
3087 * @param bool $denyClosed
3088 * Set TRUE if one wants closed cases to be treated as inaccessible.
3092 public static function accessCase($caseId, $denyClosed = TRUE) {
3093 if (!$caseId ||
!self
::enabled()) {
3097 // This permission always has access
3098 if (CRM_Core_Permission
::check('access all cases and activities')) {
3102 // This permission is required at minimum
3103 if (!CRM_Core_Permission
::check('access my cases and activities')) {
3107 $session = CRM_Core_Session
::singleton();
3108 $userID = CRM_Utils_Type
::validate($session->get('userID'), 'Positive');
3109 $caseId = CRM_Utils_Type
::validate($caseId, 'Positive');
3111 $condition = " AND civicrm_case.is_deleted = 0 ";
3112 $condition .= " AND case_relationship.contact_id_b = {$userID} ";
3113 $condition .= " AND civicrm_case.id = {$caseId}";
3116 $closedId = CRM_Core_OptionGroup
::getValue('case_status', 'Closed', 'name');
3117 $condition .= " AND civicrm_case.status_id != $closedId";
3120 // We don't actually care about activities in the case, but the underlying
3121 // query is verbose, and this allows us to share the basic query with
3122 // getCases(). $type=='any' means that activities will be left-joined.
3123 $query = self
::getCaseActivityQuery('any', $userID, $condition);
3124 $queryParams = array();
3125 $dao = CRM_Core_DAO
::executeQuery($query,
3129 return (bool) $dao->fetch();
3133 * Check whether activity is a case Activity.
3135 * @param int $activityID
3140 public static function isCaseActivity($activityID) {
3141 $isCaseActivity = FALSE;
3143 $params = array(1 => array($activityID, 'Integer'));
3144 $query = "SELECT id FROM civicrm_case_activity WHERE activity_id = %1";
3145 if (CRM_Core_DAO
::singleValueQuery($query, $params)) {
3146 $isCaseActivity = TRUE;
3150 return $isCaseActivity;
3154 * Get all the case type ids currently in use.
3158 public static function getUsedCaseType() {
3159 static $caseTypeIds;
3161 if (!is_array($caseTypeIds)) {
3162 $query = "SELECT DISTINCT( civicrm_case.case_type_id ) FROM civicrm_case";
3164 $dao = CRM_Core_DAO
::executeQuery($query);
3165 $caseTypeIds = array();
3166 while ($dao->fetch()) {
3167 $typeId = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
3170 $caseTypeIds[] = $typeId[1];
3174 return $caseTypeIds;
3178 * Get all the case status ids currently in use.
3182 public static function getUsedCaseStatuses() {
3183 static $caseStatusIds;
3185 if (!is_array($caseStatusIds)) {
3186 $query = "SELECT DISTINCT( civicrm_case.status_id ) FROM civicrm_case";
3188 $dao = CRM_Core_DAO
::executeQuery($query);
3189 $caseStatusIds = array();
3190 while ($dao->fetch()) {
3191 $caseStatusIds[] = $dao->status_id
;
3195 return $caseStatusIds;
3199 * Get all the encounter medium ids currently in use.
3203 public static function getUsedEncounterMediums() {
3206 if (!is_array($mediumIds)) {
3207 $query = "SELECT DISTINCT( civicrm_activity.medium_id ) FROM civicrm_activity";
3209 $dao = CRM_Core_DAO
::executeQuery($query);
3210 $mediumIds = array();
3211 while ($dao->fetch()) {
3212 $mediumIds[] = $dao->medium_id
;
3220 * Check case configuration.
3222 * @param int $contactId
3226 public static function isCaseConfigured($contactId = NULL) {
3227 $configured = array_fill_keys(array('configured', 'allowToAddNewCase', 'redirectToCaseAdmin'), FALSE);
3229 //lets check for case configured.
3230 $allCasesCount = CRM_Case_BAO_Case
::caseCount(NULL, FALSE);
3231 $configured['configured'] = ($allCasesCount) ?
TRUE : FALSE;
3232 if (!$configured['configured']) {
3233 //do check for case type and case status.
3234 $caseTypes = CRM_Case_PseudoConstant
::caseType('title', FALSE);
3235 if (!empty($caseTypes)) {
3236 $configured['configured'] = TRUE;
3237 if (!$configured['configured']) {
3238 $caseStatuses = CRM_Case_PseudoConstant
::caseStatus('label', FALSE);
3239 if (!empty($caseStatuses)) {
3240 $configured['configured'] = TRUE;
3245 if ($configured['configured']) {
3246 //do check for active case type and case status.
3247 $caseTypes = CRM_Case_PseudoConstant
::caseType();
3248 if (!empty($caseTypes)) {
3249 $caseStatuses = CRM_Case_PseudoConstant
::caseStatus();
3250 if (!empty($caseStatuses)) {
3251 $configured['allowToAddNewCase'] = TRUE;
3255 //do we need to redirect user to case admin.
3256 if (!$configured['allowToAddNewCase'] && $contactId) {
3257 //check for current contact case count.
3258 $currentContatCasesCount = CRM_Case_BAO_Case
::caseCount($contactId);
3259 //redirect user to case admin page.
3260 if (!$currentContatCasesCount) {
3261 $configured['redirectToCaseAdmin'] = TRUE;
3270 * Used during case component enablement and during ugprade.
3274 public static function createCaseViews() {
3275 $errorScope = CRM_Core_TemporaryErrorScope
::ignoreException();
3276 $dao = new CRM_Core_DAO();
3278 $sql = self
::createCaseViewsQuery('upcoming');
3280 if (PEAR
::getStaticProperty('DB_DataObject', 'lastError')) {
3284 // Above error doesn't get caught?
3285 $doublecheck = $dao->singleValueQuery("SELECT count(id) FROM civicrm_view_case_activity_upcoming");
3286 if (is_null($doublecheck)) {
3290 $sql = self
::createCaseViewsQuery('recent');
3292 if (PEAR
::getStaticProperty('DB_DataObject', 'lastError')) {
3296 // Above error doesn't get caught?
3297 $doublecheck = $dao->singleValueQuery("SELECT count(id) FROM civicrm_view_case_activity_recent");
3298 if (is_null($doublecheck)) {
3306 * Helper function, also used by the upgrade in case of error
3308 * @param string $section
3312 public static function createCaseViewsQuery($section = 'upcoming') {
3314 $scheduled_id = CRM_Core_OptionGroup
::getValue('activity_status', 'Scheduled', 'name');
3317 $sql = "CREATE OR REPLACE VIEW `civicrm_view_case_activity_upcoming`
3318 AS SELECT ca.case_id, a.id, a.activity_date_time, a.status_id, a.activity_type_id
3319 FROM civicrm_case_activity ca
3320 INNER JOIN civicrm_activity a ON ca.activity_id=a.id
3321 WHERE a.activity_date_time <= DATE_ADD( NOW(), INTERVAL 14 DAY )
3322 AND a.is_current_revision = 1 AND a.is_deleted=0 AND a.status_id = $scheduled_id";
3326 $sql = "CREATE OR REPLACE VIEW `civicrm_view_case_activity_recent`
3327 AS SELECT ca.case_id, a.id, a.activity_date_time, a.status_id, a.activity_type_id
3328 FROM civicrm_case_activity ca
3329 INNER JOIN civicrm_activity a ON ca.activity_id=a.id
3330 WHERE a.activity_date_time <= NOW()
3331 AND a.activity_date_time >= DATE_SUB( NOW(), INTERVAL 14 DAY )
3332 AND a.is_current_revision = 1 AND a.is_deleted=0 AND a.status_id <> $scheduled_id";
3339 * Add/copy relationships, when new client is added for a case
3341 * @param int $caseId
3343 * @param int $contactId
3344 * Contact id / new client id.
3346 public static function addCaseRelationships($caseId, $contactId) {
3347 // get the case role / relationships for the case
3348 $caseRelationships = new CRM_Contact_DAO_Relationship();
3349 $caseRelationships->case_id
= $caseId;
3350 $caseRelationships->find();
3351 $relationshipTypes = array();
3353 // make sure we don't add duplicate relationships of same relationship type.
3354 while ($caseRelationships->fetch() && !in_array($caseRelationships->relationship_type_id
, $relationshipTypes)) {
3356 CRM_Core_DAO
::storeValues($caseRelationships, $values);
3358 // add relationship for new client.
3359 $newRelationship = new CRM_Contact_DAO_Relationship();
3360 $newRelationship->copyValues($values);
3361 $newRelationship->id
= NULL;
3362 $newRelationship->case_id
= $caseId;
3363 $newRelationship->contact_id_a
= $contactId;
3364 $newRelationship->end_date
= CRM_Utils_Date
::isoToMysql($caseRelationships->end_date
);
3365 $newRelationship->start_date
= CRM_Utils_Date
::isoToMysql($caseRelationships->start_date
);
3367 // another check to avoid duplicate relationship, in cases where client is removed and re-added again.
3368 if (!$newRelationship->find(TRUE)) {
3369 $newRelationship->save();
3371 $newRelationship->free();
3373 // store relationship type of newly created relationship
3374 $relationshipTypes[] = $caseRelationships->relationship_type_id
;
3379 * Get the list of clients for a case.
3381 * @param int $caseId
3384 * associated array with client ids
3386 public static function getCaseClients($caseId) {
3388 $caseContact = new CRM_Case_DAO_CaseContact();
3389 $caseContact->case_id
= $caseId;
3390 $caseContact->find();
3392 while ($caseContact->fetch()) {
3393 $clients[] = $caseContact->contact_id
;
3400 * @param int $caseId
3401 * @param string $direction
3403 * @param int $relTypeId
3404 * @throws \CRM_Core_Exception
3405 * @throws \CiviCRM_API3_Exception
3407 public static function endCaseRole($caseId, $direction, $cid, $relTypeId) {
3409 if ($direction !== 'a' && $direction !== 'b') {
3410 throw new CRM_Core_Exception('Invalid relationship direction');
3413 // This case might have multiple clients, so we lookup by relationship instead of by id to get them all
3414 $sql = "SELECT id FROM civicrm_relationship WHERE case_id = %1 AND contact_id_{$direction} = %2 AND relationship_type_id = %3";
3415 $dao = CRM_Core_DAO
::executeQuery($sql, array(
3416 1 => array($caseId, 'Positive'),
3417 2 => array($cid, 'Positive'),
3418 3 => array($relTypeId, 'Positive'),
3420 while ($dao->fetch()) {
3421 civicrm_api3('relationship', 'create', array(
3424 'end_date' => 'now',
3430 * Get options for a given case field.
3431 * @see CRM_Core_DAO::buildOptions
3433 * @param string $fieldName
3434 * @param string $context
3435 * @see CRM_Core_DAO::buildOptionsContext
3436 * @param array $props
3437 * Whatever is known about this dao object.
3439 * @return array|bool
3441 public static function buildOptions($fieldName, $context = NULL, $props = array()) {
3442 $className = __CLASS__
;
3444 switch ($fieldName) {
3445 // This field is not part of this object but the api supports it
3447 $className = 'CRM_Activity_BAO_Activity';
3450 return CRM_Core_PseudoConstant
::get($className, $fieldName, $params, $context);