4 * File for the TestCase class
8 * @author Walt Haas <walt@dharmatech.org> (801) 534-1262
9 * @copyright Copyright CiviCRM LLC (C) 2009
10 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html
11 * GNU Affero General Public License version 3
12 * @version $Id: ActivityTest.php 31254 2010-12-15 10:09:29Z eileen $
15 * This file is part of CiviCRM
17 * CiviCRM is free software; you can redistribute it and/or
18 * modify it under the terms of the GNU Affero General Public License
19 * as published by the Free Software Foundation; either version 3 of
20 * the License, or (at your option) any later version.
22 * CiviCRM is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU Affero General Public License for more details.
27 * You should have received a copy of the GNU Affero General Public
28 * License along with this program. If not, see
29 * <http://www.gnu.org/licenses/>.
33 * Test APIv3 civicrm_case_* functions
35 * @package CiviCRM_APIv3
38 class api_v3_CaseTest
extends CiviCaseTestCase
{
41 protected $_apiversion = 3;
42 protected $followup_activity_type_value;
44 * Activity ID of created case.
48 protected $_caseActivityId;
51 * @var \Civi\Core\SettingsStack
53 protected $settingsStack;
56 * Test setup for every test.
58 * Connect to the database, truncate the tables that will be used
59 * and redirect stdin to a temporary file.
61 public function setUp() {
62 $this->_entity
= 'case';
66 $activityTypes = $this->callAPISuccess('option_value', 'get', [
67 'option_group_id' => 2,
68 'name' => 'Follow Up',
69 'label' => 'Follow Up',
72 $this->followup_activity_type_value
= $activityTypes['values'][0]['value'];
75 'case_type_id' => $this->caseTypeId
,
76 'subject' => 'Test case',
80 $this->settingsStack
= new \Civi\Core\
SettingsStack();
83 public function tearDown() {
84 $this->settingsStack
->popAll();
89 * Check with empty array.
91 public function testCaseCreateEmpty() {
92 $this->callAPIFailure('case', 'create', []);
96 * Check if required fields are not passed.
98 public function testCaseCreateWithoutRequired() {
100 'subject' => 'this case should fail',
104 $this->callAPIFailure('case', 'create', $params);
108 * Test Getlist with id and case_id
110 public function testCaseGetListById() {
111 $params = $this->_params
;
112 $params['contact_id'] = $this->individualCreate();
114 //Create 3 sample Cases.
115 $case1 = $this->callAPISuccess('case', 'create', $params);
116 $params['subject'] = 'Test Case 2';
117 $case2 = $this->callAPISuccess('case', 'create', $params);
118 $params['subject'] = 'Test Case 3';
119 $this->callAPISuccess('case', 'create', $params);
122 'id' => [$case1['id']],
123 'extra' => ['contact_id'],
126 'case_id' => ['!=' => $case2['id']],
127 'case_id.is_deleted' => 0,
128 'case_id.status_id' => ['!=' => "Closed"],
129 'case_id.end_date' => ['IS NULL' => 1],
132 $result = $this->callAPISuccess('case', 'getlist', $getParams);
134 //Only 1 case should be returned.
135 $this->assertEquals(count($result['values']), 1);
136 $this->assertEquals($result['values'][0]['id'], $case1['id']);
140 * Test create function with valid parameters.
142 public function testCaseCreate() {
143 $params = $this->_params
;
144 // Test using label instead of value.
145 unset($params['case_type_id']);
146 $params['case_type'] = $this->caseType
;
147 $result = $this->callAPIAndDocument('case', 'create', $params, __FUNCTION__
, __FILE__
);
151 $result = $this->callAPISuccess('case', 'get', ['id' => $id]);
152 $this->assertEquals($result['values'][$id]['id'], $id);
153 $this->assertEquals($result['values'][$id]['case_type_id'], $this->caseTypeId
);
154 $this->assertEquals($result['values'][$id]['subject'], $params['subject']);
158 * Test create function with resolved status.
160 public function testCaseCreateWithResolvedStatus() {
161 $params = $this->_params
;
162 // Test using label instead of value.
163 unset($params['case_type_id']);
164 $params['case_type'] = $this->caseType
;
165 $params['status_id'] = 'Closed';
166 $result = $this->callAPISuccess('case', 'create', $params);
170 $result = $this->callAPISuccess('case', 'get', ['id' => $id]);
171 $this->assertEquals($result['values'][$id]['id'], $id);
172 $this->assertEquals($result['values'][$id]['case_type_id'], $this->caseTypeId
);
173 $this->assertEquals($result['values'][$id]['subject'], $params['subject']);
174 $this->assertEquals($result['values'][$id]['end_date'], date('Y-m-d'));
176 //Check all relationship end dates are set to case end date.
177 $relationships = $this->callAPISuccess('Relationship', 'get', [
181 foreach ($relationships['values'] as $key => $values) {
182 $this->assertEquals($values['end_date'], date('Y-m-d'));
185 //Verify there are no active relationships.
186 $activeCaseRelationships = CRM_Case_BAO_Case
::getCaseRoles($result['values'][$id]['client_id'][1], $id);
187 $this->assertEquals(count($activeCaseRelationships), 0, "Checking for empty array");
189 //Check if getCaseRoles() is able to return inactive relationships.
190 $caseRelationships = CRM_Case_BAO_Case
::getCaseRoles($result['values'][$id]['client_id'][1], $id, NULL, FALSE);
191 $this->assertEquals(count($caseRelationships), 1);
195 * Test case create with valid parameters and custom data.
197 public function testCaseCreateCustom() {
198 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__
, __FILE__
);
199 $params = $this->_params
;
200 $params['custom_' . $ids['custom_field_id']] = "custom string";
201 $result = $this->callAPIAndDocument($this->_entity
, 'create', $params, __FUNCTION__
, __FILE__
);
202 $result = $this->callAPISuccess($this->_entity
, 'get', [
203 'return.custom_' . $ids['custom_field_id'] => 1,
204 'id' => $result['id'],
206 $this->assertEquals("custom string", $result['values'][$result['id']]['custom_' . $ids['custom_field_id']]);
208 $this->customFieldDelete($ids['custom_field_id']);
209 $this->customGroupDelete($ids['custom_group_id']);
213 * Test update (create with id) function with valid parameters.
215 public function testCaseUpdate() {
216 $params = $this->_params
;
217 // Test using name instead of value
218 unset($params['case_type_id']);
219 $params['case_type'] = $this->caseType
;
220 $result = $this->callAPISuccess('case', 'create', $params);
222 $case = $this->callAPISuccess('case', 'getsingle', ['id' => $id]);
225 $params = ['id' => $id];
226 $params['subject'] = $case['subject'] = 'Something Else';
227 $this->callAPISuccess('case', 'create', $params);
229 // Verify that updated case is equal to the original with new subject.
230 $result = $this->callAPISuccessGetSingle('Case', ['case_id' => $id]);
231 // Modification dates are likely to differ by 0-2 sec. Check manually.
232 $this->assertGreaterThanOrEqual($case['modified_date'], $result['modified_date']);
233 unset($result['modified_date'], $case['modified_date']);
234 // Everything else should be identical.
235 $this->assertAPIArrayComparison($result, $case);
239 * Test update (create with id) function with valid parameters.
241 public function testCaseUpdateWithExistingCaseContact() {
242 $params = $this->_params
;
243 // Test using name instead of value
244 unset($params['case_type_id']);
245 $params['case_type'] = $this->caseType
;
246 $result = $this->callAPISuccess('case', 'create', $params);
248 $case = $this->callAPISuccess('case', 'getsingle', ['id' => $id]);
250 // Update Case, we specify existing case ID and existing contact ID to verify that CaseContact.create is not called
251 $params = $this->_params
;
253 $this->callAPISuccess('case', 'create', $params);
255 // Verify that updated case is equal to the original with new subject.
256 $result = $this->callAPISuccessGetSingle('Case', ['case_id' => $id]);
257 // Modification dates are likely to differ by 0-2 sec. Check manually.
258 $this->assertGreaterThanOrEqual($case['modified_date'], $result['modified_date']);
259 unset($result['modified_date'], $case['modified_date']);
260 // Everything else should be identical.
261 $this->assertAPIArrayComparison($result, $case);
265 * Test case update with custom data
267 public function testCaseUpdateCustom() {
268 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__
, __FILE__
);
269 $params = $this->_params
;
271 // Create a case with custom data
272 $params['custom_' . $ids['custom_field_id']] = 'custom string';
273 $result = $this->callAPISuccess($this->_entity
, 'create', $params);
275 $caseId = $result['id'];
276 $result = $this->callAPISuccess($this->_entity
, 'get', [
277 'return.custom_' . $ids['custom_field_id'] => 1,
279 'id' => $result['id'],
281 $this->assertEquals("custom string", $result['values'][$result['id']]['custom_' . $ids['custom_field_id']]);
282 $fields = $this->callAPISuccess($this->_entity
, 'getfields', ['version' => $this->_apiversion
]);
283 $this->assertTrue(is_array($fields['values']['custom_' . $ids['custom_field_id']]));
285 // Update the activity with custom data.
288 'custom_' . $ids['custom_field_id'] => 'Updated my test data',
289 'version' => $this->_apiversion
,
291 $result = $this->callAPISuccess($this->_entity
, 'create', $params);
293 $result = $this->callAPISuccess($this->_entity
, 'get', [
294 'return.custom_' . $ids['custom_field_id'] => 1,
296 'id' => $result['id'],
298 $this->assertEquals("Updated my test data", $result['values'][$result['id']]['custom_' . $ids['custom_field_id']]);
302 * Test delete function with valid parameters.
304 public function testCaseDelete() {
306 $result = $this->callAPISuccess('case', 'create', $this->_params
);
308 // Move Case to Trash
310 $this->callAPISuccess('case', 'delete', ['id' => $id, 'move_to_trash' => 1]);
312 // Check result - also check that 'case_id' works as well as 'id'
313 $result = $this->callAPISuccess('case', 'get', ['case_id' => $id]);
314 $this->assertEquals(1, $result['values'][$id]['is_deleted']);
316 // Restore Case from Trash
317 $this->callAPISuccess('case', 'restore', ['id' => $id]);
320 $result = $this->callAPISuccess('case', 'get', ['case_id' => $id]);
321 $this->assertEquals(0, $result['values'][$id]['is_deleted']);
323 // Delete Case Permanently
324 $this->callAPISuccess('case', 'delete', ['case_id' => $id]);
326 // Check result - case should no longer exist
327 $result = $this->callAPISuccess('case', 'get', ['id' => $id]);
328 $this->assertEquals(0, $result['count']);
332 * Test Case role relationship is correctly created
335 public function testCaseRoleRelationships() {
337 $case = $this->callAPISuccess('case', 'create', $this->_params
);
338 $relType = $this->relationshipTypeCreate(['name_a_b' => 'Test AB', 'name_b_a' => 'Test BA', 'contact_type_b' => 'Individual']);
339 $relContact = $this->individualCreate(['first_name' => 'First', 'last_name' => 'Last']);
342 'rel_type' => "{$relType}_b_a",
343 'rel_contact' => $relContact,
344 'case_id' => $case['id'],
345 'is_unit_test' => TRUE,
347 $ret = CRM_Contact_Page_AJAX
::relationship();
348 $this->assertEquals(0, $ret['is_error']);
349 //Check if relationship exist for the case.
350 $relationship = $this->callAPISuccess('Relationship', 'get', [
352 'relationship_type_id' => $relType,
353 'case_id' => $case['id'],
355 $this->assertEquals($relContact, $relationship['values'][0]['contact_id_a']);
356 $this->assertEquals($this->_params
['contact_id'], $relationship['values'][0]['contact_id_b']);
358 //Check if activity is assigned to correct contact.
359 $activity = $this->callAPISuccess('Activity', 'get', [
360 'subject' => 'Test BA : Mr. First Last II',
362 $this->callAPISuccess('ActivityContact', 'get', [
363 'contact_id' => $relContact,
364 'activity_id' => $activity['id'],
369 * Test get function based on activity.
371 public function testCaseGetByActivity() {
373 $result = $this->callAPISuccess('case', 'create', $this->_params
);
376 // Check result - we should get a list of activity ids
377 $result = $this->callAPISuccess('case', 'get', ['id' => $id, 'return' => 'activities']);
378 $case = $result['values'][$id];
379 $activity = $case['activities'][0];
381 // Fetch case based on an activity id
382 $result = $this->callAPISuccess('case', 'get', [
383 'activity_id' => $activity,
384 'return' => 'activities',
386 $this->assertEquals(FALSE, empty($result['values'][$id]));
387 $this->assertEquals($result['values'][$id], $case);
391 * Test get function based on contact id.
393 public function testCaseGetByContact() {
395 $result = $this->callAPISuccess('case', 'create', $this->_params
);
398 // Store result for later
399 $case = $this->callAPISuccessGetSingle('case', ['id' => $id, 'return' => ['activities', 'contacts']]);
401 // Fetch case based on client contact id
402 $result = $this->callAPISuccess('case', 'get', [
403 'client_id' => $this->_params
['contact_id'],
404 'return' => ['activities', 'contacts'],
406 $this->assertAPIArrayComparison($result['values'][$id], $case);
410 * Test get function based on subject.
412 public function testCaseGetBySubject() {
414 $result = $this->callAPISuccess('case', 'create', $this->_params
);
417 // Store result for later
418 $case = $this->callAPISuccessGetSingle('Case', ['id' => $id, 'return' => 'subject']);
420 // Fetch case based on client contact id
421 $result = $this->callAPISuccess('case', 'get', [
422 'subject' => $this->_params
['subject'],
423 'return' => ['subject'],
425 $this->assertAPIArrayComparison($result['values'][$id], $case);
429 * Test get function based on wrong subject.
431 public function testCaseGetByWrongSubject() {
432 $this->callAPISuccess('case', 'create', $this->_params
);
434 // Append 'wrong' to subject so that it is no longer the same.
435 $result = $this->callAPISuccess('case', 'get', [
436 'subject' => $this->_params
['subject'] . 'wrong',
437 'return' => ['activities', 'contacts'],
439 $this->assertEquals(0, $result['count']);
443 * Test get function with no criteria.
445 public function testCaseGetNoCriteria() {
446 $result = $this->callAPISuccess('case', 'create', $this->_params
);
449 // Store result for later
450 $case = $this->callAPISuccessGetSingle('Case', ['id' => $id, 'return' => 'contact_id']);
452 $result = $this->callAPISuccess('case', 'get', ['limit' => 0, 'return' => ['contact_id']]);
453 $this->assertAPIArrayComparison($result['values'][$id], $case);
457 * Test activity api create for case activities.
459 public function testCaseActivityCreate() {
460 $params = $this->_params
;
461 $case = $this->callAPISuccess('case', 'create', $params);
463 'case_id' => $case['id'],
465 'activity_type_id' => $this->followup_activity_type_value
,
466 'subject' => 'Test followup 123',
467 'source_contact_id' => $this->_loggedInUser
,
468 'target_contact_id' => $this->_params
['contact_id'],
470 $result = $this->callAPISuccess('activity', 'create', $params);
471 $this->assertEquals($result['values'][$result['id']]['activity_type_id'], $params['activity_type_id']);
473 // might need this for other tests that piggyback on this one
474 $this->_caseActivityId
= $result['values'][$result['id']]['id'];
476 // Check other DB tables populated properly - is there a better way to do this? assertDBState() requires that we know the id already.
477 $dao = new CRM_Case_DAO_CaseActivity();
478 $dao->case_id
= $case['id'];
479 $dao->activity_id
= $this->_caseActivityId
;
480 $this->assertEquals($dao->find(), 1, 'case_activity table not populated correctly');
482 $dao = new CRM_Activity_DAO_ActivityContact();
483 $dao->activity_id
= $this->_caseActivityId
;
484 $dao->contact_id
= $this->_params
['contact_id'];
485 $dao->record_type_id
= 3;
486 $this->assertEquals($dao->find(), 1, 'activity_contact table not populated correctly');
488 // Check that fetching an activity by case id works, as well as returning case_id
489 $result = $this->callAPISuccessGetSingle('Activity', [
490 'case_id' => $case['id'],
491 'activity_type_id' => $this->followup_activity_type_value
,
492 'subject' => 'Test followup 123',
493 'return' => ['case_id'],
495 $this->assertContains($case['id'], $result['case_id']);
499 * Test activity api update for case activities.
501 public function testCaseActivityUpdate_Tracked() {
502 $this->settingsStack
->push('civicaseActivityRevisions', TRUE);
504 // Need to create the case and activity before we can update it
505 $this->testCaseActivityCreate();
508 'activity_id' => $this->_caseActivityId
,
510 'activity_type_id' => 14,
511 'source_contact_id' => $this->_loggedInUser
,
512 'subject' => 'New subject',
514 $result = $this->callAPISuccess('activity', 'create', $params);
516 $this->assertEquals($result['values'][$result['id']]['subject'], $params['subject']);
518 // id should be one greater, since this is a new revision
519 $this->assertEquals($result['values'][$result['id']]['id'], $this->_caseActivityId +
1);
520 $this->assertEquals($result['values'][$result['id']]['original_id'], $this->_caseActivityId
);
522 // Check revision is as expected
524 'activity_id' => $this->_caseActivityId
,
526 $revActivity = $this->callAPISuccess('activity', 'get', $revParams);
527 $this->assertEquals($revActivity['values'][$this->_caseActivityId
]['is_current_revision'],
529 $this->assertEquals($revActivity['values'][$this->_caseActivityId
]['is_deleted'],
535 * If you disable `civicaseActivityRevisions`, then editing an activity
536 * will *not* create or change IDs.
538 public function testCaseActivityUpdate_Untracked() {
539 $this->settingsStack
->push('civicaseActivityRevisions', FALSE);
541 // Need to create the case and activity before we can update it
542 $this->testCaseActivityCreate();
544 $oldIDs = CRM_Utils_SQL_Select
::from('civicrm_activity')
545 ->select('id, original_id, is_current_revision')
547 ->execute()->fetchAll();
550 'activity_id' => $this->_caseActivityId
,
552 'activity_type_id' => 14,
553 'source_contact_id' => $this->_loggedInUser
,
554 'subject' => 'New subject',
556 $result = $this->callAPISuccess('activity', 'create', $params);
557 $this->assertEquals($result['values'][$result['id']]['subject'], $params['subject']);
559 // id should not change because we've opted out.
560 $this->assertEquals($this->_caseActivityId
, $result['values'][$result['id']]['id']);
561 $this->assertEmpty($result['values'][$result['id']]['original_id']);
563 $newIDs = CRM_Utils_SQL_Select
::from('civicrm_activity')
564 ->select('id, original_id, is_current_revision')
566 ->execute()->fetchAll();
567 $this->assertEquals($oldIDs, $newIDs);
570 public function testCaseActivityUpdateCustom() {
571 $this->settingsStack
->push('civicaseActivityRevisions', TRUE);
573 // Create a case first
574 $result = $this->callAPISuccess('case', 'create', $this->_params
);
576 // Create custom field group
577 // Note the second parameter is Activity on purpose, not Case.
578 $custom_ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__
, 'ActivityTest.php');
582 'case_id' => $result['id'],
584 'activity_type_id' => 14,
585 'subject' => 'Test followup',
586 'source_contact_id' => $this->_loggedInUser
,
587 'target_contact_id' => $this->_params
['contact_id'],
588 'custom_' . $custom_ids['custom_field_id'] => "custom string",
590 $result = $this->callAPISuccess('activity', 'create', $params);
592 $aid = $result['values'][$result['id']]['id'];
596 'activity_id' => $aid,
598 'activity_type_id' => 14,
599 'source_contact_id' => $this->_loggedInUser
,
600 'subject' => 'New subject',
602 $this->callAPISuccess('activity', 'create', $params);
604 // Retrieve revision and check custom fields got copied.
606 'activity_id' => $aid +
1,
607 'return.custom_' . $custom_ids['custom_field_id'] => 1,
609 $revAct = $this->callAPISuccess('activity', 'get', $revParams);
611 $this->assertEquals($revAct['values'][$aid +
1]['custom_' . $custom_ids['custom_field_id']], "custom string",
612 "Error message: " . CRM_Utils_Array
::value('error_message', $revAct));
614 $this->customFieldDelete($custom_ids['custom_field_id']);
615 $this->customGroupDelete($custom_ids['custom_group_id']);
618 public function testCaseGetByStatus() {
619 // Create 2 cases with different status ids.
620 $case1 = $this->callAPISuccess('Case', 'create', [
622 'subject' => "Test case 1",
623 'case_type_id' => $this->caseTypeId
,
624 'status_id' => "Open",
627 $this->callAPISuccess('Case', 'create', [
629 'subject' => "Test case 2",
630 'case_type_id' => $this->caseTypeId
,
631 'status_id' => "Urgent",
634 $result = $this->callAPISuccessGetSingle('Case', [
637 'status_id' => "Open",
639 $this->assertEquals($case1['id'], $result['id']);
642 public function testCaseGetWithRoles() {
643 $case1 = $this->callAPISuccess('Case', 'create', [
645 'subject' => "Test case with roles",
646 'case_type_id' => $this->caseTypeId
,
647 'status_id' => "Open",
649 $result = $this->callAPISuccessGetSingle('Case', [
650 'id' => $case1['id'],
651 'status_id' => "Open",
652 'return' => ['contacts'],
654 foreach ($result['contacts'] as $contact) {
655 if ($contact['role'] == 'Client') {
656 $this->assertEquals(17, $contact['contact_id']);
658 elseif ($contact['role'] == 'Homeless Services Coordinator') {
659 $this->assertEquals(1, $contact['creator']);
660 $this->assertEquals(1, $contact['manager']);
665 public function testCaseGetWithDefinition() {
666 $case1 = $this->callAPISuccess('Case', 'create', [
668 'subject' => "Test case with definition",
669 'case_type_id' => $this->caseTypeId
,
670 'status_id' => "Open",
672 $result1 = $this->callAPISuccessGetSingle('Case', [
673 'id' => $case1['id'],
674 'status_id' => "Open",
675 'return' => ['case_type_id.definition'],
677 $result2 = $this->callAPISuccessGetSingle('Case', [
678 'id' => $case1['id'],
679 'status_id' => "Open",
680 'return' => ['case_type_id', 'case_type_id.definition'],
682 $this->assertEquals($result1['case_type_id.definition'], $result2['case_type_id.definition']);
683 $def = $result1['case_type_id.definition'];
684 $this->assertEquals(['name' => 'Open Case', 'max_instances' => 1], $def['activityTypes'][0]);
685 $this->assertNotEmpty($def['activitySets'][0]['activityTypes']);
686 $this->assertNotEmpty($def['caseRoles'][0]['manager']);
687 $this->assertNotEmpty($def['caseRoles'][0]['creator']);
690 public function testCaseGetTags() {
691 $case1 = $this->callAPISuccess('Case', 'create', [
693 'subject' => "Test case with tags",
694 'case_type_id' => $this->caseTypeId
,
695 'status_id' => "Open",
697 $tag1 = $this->tagCreate([
698 'name' => 'CaseTag1',
699 'used_for' => 'civicrm_case',
701 $tag2 = $this->tagCreate([
702 'name' => 'CaseTag2',
703 'used_for' => 'civicrm_case',
705 $this->callAPISuccess('EntityTag', 'create', [
706 'entity_table' => 'civicrm_case',
707 'entity_id' => $case1['id'],
708 'tag_id' => $tag1['id'],
710 $this->callAPIFailure('Case', 'getsingle', [
711 'tag_id' => $tag2['id'],
713 $result = $this->callAPISuccessGetSingle('Case', [
714 'tag_id' => $tag1['id'],
715 'return' => 'tag_id.name',
717 $this->assertEquals('CaseTag1', $result['tag_id'][$tag1['id']]['tag_id.name']);
721 * Test that a chained api call can use the operator syntax.
723 * E.g. array('IN' => $value.contact_id)
727 public function testCaseGetChainedOp() {
728 $contact1 = $this->individualCreate([], 1);
729 $contact2 = $this->individualCreate([], 2);
730 $case1 = $this->callAPISuccess('Case', 'create', [
731 'contact_id' => $contact1,
732 'subject' => "Test case 1",
733 'case_type_id' => $this->caseTypeId
,
735 $case2 = $this->callAPISuccess('Case', 'create', [
736 'contact_id' => $contact2,
737 'subject' => "Test case 2",
738 'case_type_id' => $this->caseTypeId
,
740 $case3 = $this->callAPISuccess('Case', 'create', [
741 'contact_id' => [$contact1, $contact2],
742 'subject' => "Test case 3",
743 'case_type_id' => $this->caseTypeId
,
746 // Fetch case 1 and all cases with the same client. Chained get should return case 3.
747 $result = $this->callAPISuccessGetSingle('Case', [
748 'id' => $case1['id'],
749 'return' => 'contact_id',
751 'contact_id' => ['IN' => "\$value.contact_id"],
752 'id' => ['!=' => "\$value.id"],
755 $this->assertEquals($case3['id'], $result['api.Case.get']['id']);
757 // Fetch case 3 and all cases with the same clients. Chained get should return case 1&2.
758 $result = $this->callAPISuccessGetSingle('Case', [
759 'id' => $case3['id'],
760 'return' => ['contact_id'],
763 'contact_id' => ['IN' => "\$value.contact_id"],
764 'id' => ['!=' => "\$value.id"],
767 $this->assertEquals([$case1['id'], $case2['id']], array_keys(CRM_Utils_Array
::rekey($result['api.Case.get']['values'], 'id')));
771 * Test the ability to order by client using the join syntax.
773 * For multi-client cases, should order by the first client.
775 public function testCaseGetOrderByClient() {
776 $contact1 = $this->individualCreate(['first_name' => 'Aa', 'last_name' => 'Zz']);
777 $contact2 = $this->individualCreate(['first_name' => 'Bb', 'last_name' => 'Zz']);
778 $contact3 = $this->individualCreate(['first_name' => 'Cc', 'last_name' => 'Xx']);
780 $case1 = $this->callAPISuccess('Case', 'create', [
781 'contact_id' => $contact1,
782 'subject' => "Test case 1",
783 'case_type_id' => $this->caseTypeId
,
785 $case2 = $this->callAPISuccess('Case', 'create', [
786 'contact_id' => $contact2,
787 'subject' => "Test case 2",
788 'case_type_id' => $this->caseTypeId
,
790 $case3 = $this->callAPISuccess('Case', 'create', [
791 'contact_id' => [$contact3, $contact1],
792 'subject' => "Test case 3",
793 'case_type_id' => $this->caseTypeId
,
796 $result = $this->callAPISuccess('Case', 'get', [
797 'contact_id' => ['IN' => [$contact1, $contact2, $contact3]],
800 'options' => ['sort' => 'contact_id.first_name'],
802 $this->assertEquals($case3['id'], $result['values'][2]['id']);
803 $this->assertEquals($case2['id'], $result['values'][1]['id']);
804 $this->assertEquals($case1['id'], $result['values'][0]['id']);
806 $result = $this->callAPISuccess('Case', 'get', [
807 'contact_id' => ['IN' => [$contact1, $contact2, $contact3]],
810 'options' => ['sort' => 'contact_id.last_name ASC, contact_id.first_name DESC'],
812 $this->assertEquals($case1['id'], $result['values'][2]['id']);
813 $this->assertEquals($case2['id'], $result['values'][1]['id']);
814 $this->assertEquals($case3['id'], $result['values'][0]['id']);
816 $result = $this->callAPISuccess('Case', 'get', [
817 'contact_id' => ['IN' => [$contact1, $contact2, $contact3]],
820 'options' => ['sort' => 'contact_id.first_name DESC'],
822 $this->assertEquals($case1['id'], $result['values'][2]['id']);
823 $this->assertEquals($case2['id'], $result['values'][1]['id']);
824 $this->assertEquals($case3['id'], $result['values'][0]['id']);
826 $result = $this->callAPISuccess('Case', 'get', [
827 'contact_id' => ['IN' => [$contact1, $contact2, $contact3]],
830 'options' => ['sort' => 'case_type_id, contact_id DESC, status_id'],
832 $this->assertEquals($case1['id'], $result['values'][2]['id']);
833 $this->assertEquals($case2['id'], $result['values'][1]['id']);
834 $this->assertEquals($case3['id'], $result['values'][0]['id']);
835 $this->assertCount(3, $result['values']);
839 * Test the ability to add a timeline to an existing case.
841 * See the case.addtimeline api.
843 * @param bool $enableRevisions
845 * @dataProvider caseActivityRevisionExamples
849 public function testCaseAddtimeline($enableRevisions) {
850 $this->settingsStack
->push('civicaseActivityRevisions', $enableRevisions);
853 'title' => 'Application with Definition',
854 'name' => 'Application_with_Definition',
859 ['name' => 'Follow up'],
864 'label' => 'Label 1',
867 ['name' => 'Open Case', 'status' => 'Completed'],
872 'label' => 'Label 2',
875 ['name' => 'Follow up'],
880 ['name' => 'Homeless Services Coordinator', 'creator' => 1, 'manager' => 1],
884 $cid = $this->individualCreate();
885 $caseType = $this->callAPISuccess('CaseType', 'create', $caseSpec);
886 $case = $this->callAPISuccess('Case', 'create', [
887 'case_type_id' => $caseType['id'],
888 'contact_id' => $cid,
889 'subject' => 'Test case with timeline',
891 // Created case should only have 1 activity per the spec
892 $result = $this->callAPISuccessGetSingle('Activity', ['case_id' => $case['id'], 'return' => 'activity_type_id.name']);
893 $this->assertEquals('Open Case', $result['activity_type_id.name']);
895 $this->callAPISuccess('Case', 'addtimeline', [
896 'case_id' => $case['id'],
897 'timeline' => 'set2',
899 $result = $this->callAPISuccess('Activity', 'get', [
900 'case_id' => $case['id'],
901 'return' => 'activity_type_id.name',
903 'options' => ['sort' => 'id'],
905 $this->assertEquals(2, $result['count']);
906 $this->assertEquals('Follow up', $result['values'][1]['activity_type_id.name']);
910 * Test the case merge function.
912 * 2 cases should be mergeable into 1
916 public function testCaseMerge() {
917 $contact1 = $this->individualCreate([], 1);
918 $case1 = $this->callAPISuccess('Case', 'create', [
919 'contact_id' => $contact1,
920 'subject' => "Test case 1",
921 'case_type_id' => $this->caseTypeId
,
923 $case2 = $this->callAPISuccess('Case', 'create', [
924 'contact_id' => $contact1,
925 'subject' => "Test case 2",
926 'case_type_id' => $this->caseTypeId
,
928 $result = $this->callAPISuccess('Case', 'getcount', ['contact_id' => $contact1]);
929 $this->assertEquals(2, $result);
931 $this->callAPISuccess('Case', 'merge', ['case_id_1' => $case1['id'], 'case_id_2' => $case2['id']]);
933 $result = $this->callAPISuccess('Case', 'getsingle', ['id' => $case2['id']]);
934 $this->assertEquals(1, $result['is_deleted']);
938 * Get case activity revision sample data.
942 public function caseActivityRevisionExamples() {
944 $examples[] = [FALSE];
945 $examples[] = [TRUE];
949 public function testTimestamps() {
950 $params = $this->_params
;
951 $case_created = $this->callAPISuccess('case', 'create', $params);
953 $case_1 = $this->callAPISuccess('Case', 'getsingle', [
954 'id' => $case_created['id'],
956 $this->assertRegExp(';^\d\d\d\d-\d\d-\d\d \d\d:\d\d;', $case_1['created_date']);
957 $this->assertRegExp(';^\d\d\d\d-\d\d-\d\d \d\d:\d\d;', $case_1['modified_date']);
958 $this->assertApproxEquals(strtotime($case_1['created_date']), strtotime($case_1['modified_date']), 2);
960 $activity_1 = $this->callAPISuccess('activity', 'getsingle', [
961 'case_id' => $case_created['id'],
966 $this->assertRegExp(';^\d\d\d\d-\d\d-\d\d \d\d:\d\d;', $activity_1['created_date']);
967 $this->assertRegExp(';^\d\d\d\d-\d\d-\d\d \d\d:\d\d;', $activity_1['modified_date']);
968 $this->assertApproxEquals(strtotime($activity_1['created_date']), strtotime($activity_1['modified_date']), 2);
970 usleep(1.5 * 1000000);
971 $this->callAPISuccess('activity', 'create', [
972 'id' => $activity_1['id'],
973 'subject' => 'Make cheese',
976 $activity_2 = $this->callAPISuccess('activity', 'getsingle', [
977 'id' => $activity_1['id'],
979 $this->assertRegExp(';^\d\d\d\d-\d\d-\d\d \d\d:\d\d;', $activity_2['created_date']);
980 $this->assertRegExp(';^\d\d\d\d-\d\d-\d\d \d\d:\d\d;', $activity_2['modified_date']);
981 $this->assertNotEquals($activity_2['created_date'], $activity_2['modified_date']);
983 $this->assertEquals($activity_1['created_date'], $activity_2['created_date']);
984 $this->assertNotEquals($activity_1['modified_date'], $activity_2['modified_date']);
985 $this->assertLessThan($activity_2['modified_date'], $activity_1['modified_date'],
986 sprintf("Original modification time (%s) should predate later modification time (%s)", $activity_1['modified_date'], $activity_2['modified_date']));
988 $case_2 = $this->callAPISuccess('Case', 'getsingle', [
989 'id' => $case_created['id'],
991 $this->assertRegExp(';^\d\d\d\d-\d\d-\d\d \d\d:\d\d;', $case_2['created_date']);
992 $this->assertRegExp(';^\d\d\d\d-\d\d-\d\d \d\d:\d\d;', $case_2['modified_date']);
993 $this->assertEquals($case_1['created_date'], $case_2['created_date']);
994 $this->assertNotEquals($case_2['created_date'], $case_2['modified_date']);