4 * File for the TestActivity 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 * Include class definitions
35 require_once 'CiviTest/CiviUnitTestCase.php';
39 * Test APIv3 civicrm_activity_* functions
41 * @package CiviCRM_APIv3
42 * @subpackage API_Activity
44 class api_v3_ActivityTest
extends CiviUnitTestCase
{
47 protected $_entity = 'activity';
48 protected $_apiversion = 3;
49 protected $test_activity_type_value;
50 protected $_contactID;
53 * Test setup for every test.
55 * Connect to the database, truncate the tables that will be used
56 * and redirect stdin to a temporary file
58 public function setUp() {
59 // Connect to the database
62 $this->_contactID
= $this->individualCreate();
63 //create activity types
64 $activityTypes = $this->callAPISuccess('option_value', 'create', array(
65 'option_group_id' => 2,
66 'name' => 'Test activity type',
67 'label' => 'Test activity type',
70 $this->test_activity_type_value
= $activityTypes['values'][0]['value'];
71 $this->test_activity_type_id
= $activityTypes['id'];
72 $this->_params
= array(
73 'source_contact_id' => $this->_contactID
,
74 'activity_type_id' => $this->test_activity_type_value
,
75 'subject' => 'test activity type id',
76 'activity_date_time' => '2011-06-02 14:36:13',
80 'location' => 'Pennsylvania',
81 'details' => 'a test activity',
83 $this->_params2
= array(
84 'source_contact_id' => $this->_contactID
,
85 'subject' => 'Eat & drink',
86 'activity_date_time' => date('Ymd'),
88 'location' => 'Napier',
89 'details' => 'discuss & eat',
91 'activity_type_id' => $this->test_activity_type_value
,
93 // create a logged in USER since the code references it for source_contact_id
94 $this->createLoggedInUser();
98 * Tears down the fixture, for example, closes a network connection.
100 * This method is called after a test is executed.
102 public function tearDown() {
103 $tablesToTruncate = array(
106 'civicrm_activity_contact',
108 $this->quickCleanup($tablesToTruncate, TRUE);
109 $this->callAPISuccess('option_value', 'delete', array('id' => $this->test_activity_type_id
));
113 * Check fails with empty array.
115 public function testActivityCreateEmpty() {
116 $this->callAPIFailure('activity', 'create', array());
120 * Check if required fields are not passed
122 public function testActivityCreateWithoutRequired() {
124 'subject' => 'this case should fail',
125 'scheduled_date_time' => date('Ymd'),
127 $result = $this->callAPIFailure('activity', 'create', $params);
131 * Test civicrm_activity_create() with mismatched activity_type_id
134 public function testActivityCreateMismatchNameType() {
136 'source_contact_id' => $this->_contactID
,
137 'subject' => 'Test activity',
138 'activity_date_time' => date('Ymd'),
140 'location' => 'Pennsylvania',
141 'details' => 'a test activity',
143 'activity_name' => 'Fubar activity type',
144 'activity_type_id' => 5,
145 'scheduled_date_time' => date('Ymd'),
148 $result = $this->callAPIFailure('activity', 'create', $params);
152 * Test civicrm_activity_id() with missing source_contact_id is put with the current user.
154 public function testActivityCreateWithMissingContactId() {
156 'subject' => 'Make-it-Happen Meeting',
157 'activity_date_time' => date('Ymd'),
159 'location' => 'Pennsylvania',
160 'details' => 'a test activity',
162 'activity_name' => 'Test activity type',
165 $this->callAPISuccess('activity', 'create', $params);
169 * Test civicrm_activity_id() with non-numeric source_contact_id.
171 public function testActivityCreateWithNonNumericContactId() {
173 'source_contact_id' => 'fubar',
174 'subject' => 'Make-it-Happen Meeting',
175 'activity_date_time' => date('Ymd'),
177 'location' => 'Pennsylvania',
178 'details' => 'a test activity',
180 'activity_name' => 'Test activity type',
183 $this->callAPIFailure('activity', 'create', $params);
187 * Ensure that an invalid activity type causes failure
188 * oddly enough this test was failing because the creation of the invalid type
189 * got added to the set up routine. Probably a mis-fix on a test
191 public function testActivityCreateWithNonNumericActivityTypeId() {
193 'source_contact_id' => $this->_contactID
,
194 'subject' => 'Make-it-Happen Meeting',
195 'activity_date_time' => date('Ymd'),
197 'location' => 'Pennsylvania',
198 'details' => 'a test activity',
200 'activity_type_id' => 'Invalid Test activity type',
203 $result = $this->callAPIFailure('activity', 'create', $params);
207 * Check with incorrect required fields.
209 public function testActivityCreateWithUnknownActivityTypeId() {
211 'source_contact_id' => $this->_contactID
,
212 'subject' => 'Make-it-Happen Meeting',
213 'activity_date_time' => date('Ymd'),
215 'location' => 'Pennsylvania',
216 'details' => 'a test activity',
218 'activity_type_id' => 699,
221 $result = $this->callAPIFailure('activity', 'create', $params);
224 public function testActivityCreateWithInvalidPriority() {
226 'source_contact_id' => $this->_contactID
,
227 'subject' => 'Make-it-Happen Meeting',
228 'activity_date_time' => date('Ymd'),
230 'location' => 'Pennsylvania',
231 'details' => 'a test activity',
234 'activity_type_id' => 1,
237 $result = $this->callAPIFailure('activity', 'create', $params,
238 "'44' is not a valid option for field priority_id");
239 $this->assertEquals('priority_id', $result['error_field']);
244 * Test create succeeds with valid string for priority.
246 public function testActivityCreateWithValidStringPriority() {
248 'source_contact_id' => $this->_contactID
,
249 'subject' => 'Make-it-Happen Meeting',
250 'activity_date_time' => date('Ymd'),
252 'location' => 'Pennsylvania',
253 'details' => 'a test activity',
255 'priority_id' => 'Urgent',
256 'activity_type_id' => 1,
259 $result = $this->callAPISuccess('activity', 'create', $params);
260 $this->assertEquals(1, $result['values'][$result['id']]['priority_id']);
264 * Test create fails with invalid priority string.
266 public function testActivityCreateWithInValidStringPriority() {
268 'source_contact_id' => $this->_contactID
,
269 'subject' => 'Make-it-Happen Meeting',
270 'activity_date_time' => date('Ymd'),
272 'location' => 'Pennsylvania',
273 'details' => 'a test activity',
275 'priority_id' => 'ergUrgent',
276 'activity_type_id' => 1,
279 $this->callAPIFailure('activity', 'create', $params,
280 "'ergUrgent' is not a valid option for field priority_id");
284 * Test civicrm_activity_create() with valid parameters.
286 public function testActivityCreate() {
288 $this->callAPISuccess('activity', 'create', $this->_params
);
289 $result = $this->callAPISuccess('activity', 'get', $this->_params
);
290 $this->assertEquals($result['values'][$result['id']]['duration'], 120);
291 $this->assertEquals($result['values'][$result['id']]['subject'], 'test activity type id');
292 $this->assertEquals($result['values'][$result['id']]['activity_date_time'], '2011-06-02 14:36:13');
293 $this->assertEquals($result['values'][$result['id']]['location'], 'Pennsylvania');
294 $this->assertEquals($result['values'][$result['id']]['details'], 'a test activity');
295 $this->assertEquals($result['values'][$result['id']]['status_id'], 2);
296 $this->assertEquals($result['values'][$result['id']]['id'], $result['id']);
300 * Test civicrm_activity_create() with valid parameters - use type_id.
302 public function testActivityCreateCampaignTypeID() {
303 $this->enableCiviCampaign();
306 'source_contact_id' => $this->_contactID
,
307 'subject' => 'Make-it-Happen Meeting',
308 'activity_date_time' => '20110316',
310 'location' => 'Pennsylvania',
311 'details' => 'a test activity',
313 'activity_type_id' => 29,
317 $result = $this->callAPISuccess('activity', 'create', $params);
319 $result = $this->callAPISuccess('activity', 'get', array('id' => $result['id']));
320 $this->assertEquals($result['values'][$result['id']]['duration'], 120);
321 $this->assertEquals($result['values'][$result['id']]['subject'], 'Make-it-Happen Meeting');
322 $this->assertEquals($result['values'][$result['id']]['activity_date_time'], '2011-03-16 00:00:00');
323 $this->assertEquals($result['values'][$result['id']]['location'], 'Pennsylvania');
324 $this->assertEquals($result['values'][$result['id']]['details'], 'a test activity');
325 $this->assertEquals($result['values'][$result['id']]['status_id'], 1);
329 * Test get returns target and assignee contacts.
331 public function testActivityReturnTargetAssignee() {
333 $description = "Example demonstrates setting & retrieving the target & source";
334 $subfile = "GetTargetandAssignee";
336 'source_contact_id' => $this->_contactID
,
337 'subject' => 'Make-it-Happen Meeting',
338 'activity_date_time' => '20110316',
340 'location' => 'Pennsylvania',
341 'details' => 'a test activity',
343 'activity_type_id' => 1,
345 'target_contact_id' => $this->_contactID
,
346 'assignee_contact_id' => $this->_contactID
,
349 $result = $this->callAPIAndDocument('activity', 'create', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
350 $result = $this->callAPISuccess('activity', 'get', array(
351 'id' => $result['id'],
352 'version' => $this->_apiversion
,
353 'return.assignee_contact_id' => 1,
354 'return.target_contact_id' => 1,
357 $this->assertEquals($this->_contactID
, $result['values'][$result['id']]['assignee_contact_id'][0]);
358 $this->assertEquals($this->_contactID
, $result['values'][$result['id']]['target_contact_id'][0]);
362 * Test civicrm_activity_create() using example code.
364 public function testActivityCreateExample() {
365 require_once 'api/v3/examples/Activity/Create.php';
366 $result = activity_create_example();
367 $expectedResult = activity_create_expectedresult();
368 $this->assertEquals($result, $expectedResult);
372 * Test civicrm_activity_create() with valid parameters and custom data.
374 public function testActivityCreateCustom() {
375 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__
, __FILE__
);
376 $params = $this->_params
;
377 $params['custom_' . $ids['custom_field_id']] = "custom string";
378 $result = $this->callAPIAndDocument($this->_entity
, 'create', $params, __FUNCTION__
, __FILE__
);
379 $result = $this->callAPISuccess($this->_entity
, 'get', array(
380 'return.custom_' . $ids['custom_field_id'] => 1,
381 'id' => $result['id'],
383 $this->assertEquals("custom string", $result['values'][$result['id']]['custom_' . $ids['custom_field_id']], ' in line ' . __LINE__
);
385 $this->customFieldDelete($ids['custom_field_id']);
386 $this->customGroupDelete($ids['custom_group_id']);
390 * Test civicrm_activity_create() with valid parameters and custom data.
392 public function testActivityCreateCustomContactRefField() {
394 $this->callAPISuccess('contact', 'create', array('id' => $this->_contactID
, 'sort_name' => 'Contact, Test'));
395 $subfile = 'ContactRefCustomField';
396 $description = "demonstrates create with Contact Reference Custom Field";
397 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__
, __FILE__
);
399 'custom_group_id' => $ids['custom_group_id'],
400 'name' => 'Worker_Lookup',
401 'label' => 'Worker Lookup',
402 'html_type' => 'Autocomplete-Select',
403 'data_type' => 'ContactReference',
405 'is_searchable' => 1,
409 $customField = $this->callAPISuccess('custom_field', 'create', $params);
410 $params = $this->_params
;
411 $params['custom_' . $customField['id']] = "$this->_contactID";
413 $result = $this->callAPIAndDocument($this->_entity
, 'create', $params, __FUNCTION__
, __FILE__
, $description, $subfile, 'Create');
414 $result = $this->callAPIAndDocument($this->_entity
, 'get', array(
415 'return.custom_' . $customField['id'] => 1,
416 'id' => $result['id'],
417 ), __FUNCTION__
, __FILE__
, 'Get with Contact Ref Custom Field', 'ContactRefCustomFieldGet', 'get');
419 $this->assertEquals('Anderson, Anthony', $result['values'][$result['id']]['custom_' . $customField['id']]);
420 $this->assertEquals($this->_contactID
, $result['values'][$result['id']]['custom_' . $customField['id'] . "_id"], ' in line ' . __LINE__
);
421 $this->assertEquals('Anderson, Anthony', $result['values'][$result['id']]['custom_' . $customField['id'] . '_1'], ' in line ' . __LINE__
);
422 $this->assertEquals($this->_contactID
, $result['values'][$result['id']]['custom_' . $customField['id'] . "_1_id"], ' in line ' . __LINE__
);
423 $this->customFieldDelete($ids['custom_field_id']);
424 $this->customGroupDelete($ids['custom_group_id']);
428 * Test civicrm_activity_create() with an invalid text status_id.
430 public function testActivityCreateBadTextStatus() {
433 'source_contact_id' => $this->_contactID
,
434 'subject' => 'Discussion on Apis for v3',
435 'activity_date_time' => date('Ymd'),
437 'location' => 'Pennsylvania',
438 'details' => 'a test activity',
439 'status_id' => 'Invalid',
440 'activity_name' => 'Test activity type',
443 $this->callAPIFailure('activity', 'create', $params);
447 * Test civicrm_activity_create() with an invalid text status_id.
449 public function testActivityCreateSupportActivityStatus() {
452 'source_contact_id' => $this->_contactID
,
453 'subject' => 'Discussion on Apis for v3',
454 'activity_date_time' => date('Ymd'),
456 'location' => 'Pennsylvania',
457 'details' => 'a test activity',
458 'activity_status_id' => 'Invalid',
459 'activity_name' => 'Test activity type',
462 $result = $this->callAPIFailure('activity', 'create', $params,
463 "'Invalid' is not a valid option for field status_id");
468 * Test civicrm_activity_create() with using a text status_id.
470 public function testActivityCreateTextStatus() {
473 'source_contact_id' => $this->_contactID
,
474 'subject' => 'Make-it-Happen Meeting',
475 'activity_date_time' => date('Ymd'),
477 'location' => 'Pennsylvania',
478 'details' => 'a test activity',
479 'status_id' => 'Scheduled',
480 'activity_name' => 'Test activity type',
483 $result = $this->callAPISuccess('activity', 'create', $params);
484 $this->assertEquals($result['values'][$result['id']]['duration'], 120);
485 $this->assertEquals($result['values'][$result['id']]['subject'], 'Make-it-Happen Meeting');
486 $this->assertEquals($result['values'][$result['id']]['activity_date_time'], date('Ymd') . '000000');
487 $this->assertEquals($result['values'][$result['id']]['location'], 'Pennsylvania');
488 $this->assertEquals($result['values'][$result['id']]['details'], 'a test activity');
492 * Test civicrm_activity_get() with no params
494 public function testActivityGetEmpty() {
495 $result = $this->callAPISuccess('activity', 'get', array());
499 * Test civicrm_activity_get() with a good activity ID
501 public function testActivityGetGoodID1() {
502 // Insert rows in civicrm_activity creating activities 4 and
504 $description = "Function demonstrates getting asignee_contact_id & using it to get the contact";
505 $subfile = 'ReturnAssigneeContact';
506 $activity = $this->callAPISuccess('activity', 'create', $this->_params
);
508 $contact = $this->callAPISuccess('Contact', 'Create', array(
509 'first_name' => "The Rock",
510 'last_name' => 'roccky',
511 'contact_type' => 'Individual',
513 'api.activity.create' => array(
514 'id' => $activity['id'],
515 'assignee_contact_id' => '$value.id',
520 'activity_id' => $activity['id'],
521 'version' => $this->_apiversion
,
523 'return.assignee_contact_id' => 1,
524 'api.contact.get' => array(
525 'id' => '$value.source_contact_id',
529 $result = $this->callAPIAndDocument('Activity', 'Get', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
531 $this->assertEquals($activity['id'], $result['id'], 'In line ' . __LINE__
);
533 $this->assertEquals($contact['id'], $result['values'][0]['assignee_contact_id'][0], 'In line ' . __LINE__
);
535 $this->assertEquals($this->_contactID
, $result['values'][0]['api.contact.get']['values'][0]['contact_id'], 'In line ' . __LINE__
);
536 $this->assertEquals($this->test_activity_type_value
, $result['values'][0]['activity_type_id'], 'In line ' . __LINE__
);
537 $this->assertEquals("test activity type id", $result['values'][0]['subject'], 'In line ' . __LINE__
);
541 * test that get functioning does filtering
543 public function testGetFilter() {
545 'source_contact_id' => $this->_contactID
,
546 'subject' => 'Make-it-Happen Meeting',
547 'activity_date_time' => '20110316',
549 'location' => 'Pennsylvania',
550 'details' => 'a test activity',
552 'activity_name' => 'Test activity type',
555 $result = $this->callAPISuccess('Activity', 'Create', $params);
556 $this->callAPISuccess('Activity', 'Get', array('subject' => 'Make-it-Happen Meeting'));
557 $this->assertEquals(1, $result['count']);
558 $this->assertEquals('Make-it-Happen Meeting', $result['values'][$result['id']]['subject']);
559 $this->callAPISuccess('Activity', 'Delete', array('id' => $result['id']));
564 * Test civicrm_activity_get() with filter target_contact_id
566 public function testActivityGetTargetFilter() {
567 $params = $this->_params
;
568 $contact1Params = array(
569 'first_name' => 'John',
570 'middle_name' => 'J.',
571 'last_name' => 'Anderson',
574 'email' => 'john_anderson@civicrm.org',
575 'contact_type' => 'Individual',
578 $contact1 = $this->individualCreate($contact1Params);
579 $contact2Params = array(
580 'first_name' => 'Michal',
581 'middle_name' => 'J.',
582 'last_name' => 'Anderson',
585 'email' => 'michal_anderson@civicrm.org',
586 'contact_type' => 'Individual',
589 $contact2 = $this->individualCreate($contact2Params);
591 $params['assignee_contact_id'] = array($contact1, $contact2);
592 $params['target_contact_id'] = array($contact2 => $contact2);
593 $activity = $this->callAPISuccess('Activity', 'Create', $params);
595 $activityget = $this->callAPISuccess('Activity', 'get', array(
596 'id' => $activity['id'],
597 'target_contact_id' => $contact2,
598 'return.target_contact_id' => 1,
600 $this->assertEquals($activity['id'], $activityget['id'], 'In line ' . __LINE__
);
601 $this->assertEquals($contact2, $activityget['values'][$activityget['id']]['target_contact_id'][0], 'In line ' . __LINE__
);
603 $activityget = $this->callAPISuccess('activity', 'get', array(
604 'target_contact_id' => $this->_contactID
,
605 'return.target_contact_id' => 1,
606 'id' => $activity['id'],
608 if ($activityget['count'] > 0) {
609 $this->assertNotEquals($contact2, $activityget['values'][$activityget['id']]['target_contact_id'][0], 'In line ' . __LINE__
);
614 * test that get functioning does filtering
616 public function testGetStatusID() {
618 'source_contact_id' => $this->_contactID
,
619 'subject' => 'Make-it-Happen Meeting',
620 'activity_date_time' => '20110316',
622 'location' => 'Pennsylvania',
623 'details' => 'a test activity',
625 'activity_name' => 'Test activity type',
628 $this->callAPISuccess('Activity', 'Create', $params);
629 $result = $this->callAPISuccess('Activity', 'Get', array('activity_status_id' => '1'));
630 $this->assertEquals(1, $result['count'], 'one activity of status 1 should exist');
632 $result = $this->callAPISuccess('Activity', 'Get', array('status_id' => '1'));
633 $this->assertEquals(1, $result['count'], 'status_id should also work');
635 $result = $this->callAPISuccess('Activity', 'Get', array('activity_status_id' => '2'));
636 $this->assertEquals(0, $result['count'], 'No activities of status 1 should exist');
637 $result = $this->callAPISuccess('Activity', 'Get', array(
638 'version' => $this->_apiversion
,
641 $this->assertEquals(0, $result['count'], 'No activities of status 1 should exist');
646 * test that get functioning does filtering
648 public function testGetFilterMaxDate() {
650 'source_contact_id' => $this->_contactID
,
651 'subject' => 'Make-it-Happen Meeting',
652 'activity_date_time' => '20110101',
654 'location' => 'Pennsylvania',
655 'details' => 'a test activity',
657 'activity_name' => 'Test activity type',
658 'version' => $this->_apiversion
,
661 $activityOne = $this->callAPISuccess('Activity', 'Create', $params);
662 $params['activity_date_time'] = 20120216;
663 $activityTwo = $this->callAPISuccess('Activity', 'Create', $params);
664 $result = $this->callAPISuccess('Activity', 'Get', array(
667 $description = "demonstrates _low filter (at time of writing doesn't work if contact_id is set";
668 $subfile = "DateTimeLow";
669 $this->assertEquals(2, $result['count']);
672 'filter.activity_date_time_low' => '20120101000000',
675 $result = $this->callAPIAndDocument('Activity', 'Get', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
676 $this->assertEquals(1, $result['count']);
677 $description = "demonstrates _high filter (at time of writing doesn't work if contact_id is set";
678 $subfile = "DateTimeHigh";
679 $this->assertEquals('2012-02-16 00:00:00', $result['values'][0]['activity_date_time']);
681 'source_contact_id' => $this->_contactID
,
683 'filter.activity_date_time_high' => '20120101000000',
686 $result = $this->callAPIAndDocument('Activity', 'Get', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
688 $this->assertEquals(1, $result['count']);
689 $this->assertEquals('2011-01-01 00:00:00', $result['values'][0]['activity_date_time']);
691 $this->callAPISuccess('Activity', 'Delete', array('version' => 3, 'id' => $activityOne['id']));
692 $this->callAPISuccess('Activity', 'Delete', array('version' => 3, 'id' => $activityTwo['id']));
696 * Test civicrm_activity_get() with a good activity ID which
697 * has associated custom data
699 public function testActivityGetGoodIDCustom() {
700 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__
, __FILE__
);
702 $params = $this->_params
;
703 $params['custom_' . $ids['custom_field_id']] = "custom string";
705 $this->callAPISuccess($this->_entity
, 'create', $params);
707 // Retrieve the test value.
709 'activity_type_id' => $this->test_activity_type_value
,
711 'return.custom_' . $ids['custom_field_id'] => 1,
713 $result = $this->callAPIAndDocument('activity', 'get', $params, __FUNCTION__
, __FILE__
);
714 $this->assertEquals("custom string", $result['values'][0]['custom_' . $ids['custom_field_id']]);
716 $this->assertEquals($this->test_activity_type_value
, $result['values'][0]['activity_type_id']);
717 $this->assertEquals('test activity type id', $result['values'][0]['subject'], 'In line ' . __LINE__
);
718 $this->customFieldDelete($ids['custom_field_id']);
719 $this->customGroupDelete($ids['custom_group_id']);
723 * Test civicrm_activity_get() with a good activity ID which
724 * has associated custom data
726 public function testActivityGetContact_idCustom() {
727 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__
, __FILE__
);
729 $params = $this->_params
;
730 $params['custom_' . $ids['custom_field_id']] = "custom string";
732 $result = $this->callAPISuccess($this->_entity
, 'create', $params);
733 // Retrieve the test value
735 'contact_id' => $this->_params
['source_contact_id'],
736 'activity_type_id' => $this->test_activity_type_value
,
738 'return.custom_' . $ids['custom_field_id'] => 1,
740 $result = $this->callAPIAndDocument('activity', 'get', $params, __FUNCTION__
, __FILE__
);
741 $this->assertEquals("custom string", $result['values'][0]['custom_' . $ids['custom_field_id']], ' in line ' . __LINE__
);
743 $this->assertEquals($this->test_activity_type_value
, $result['values'][0]['activity_type_id'], 'In line ' . __LINE__
);
744 $this->assertEquals('test activity type id', $result['values'][0]['subject'], 'In line ' . __LINE__
);
745 $this->assertEquals($result['values'][0]['id'], $result['id']);
749 * Check activity deletion with empty params.
751 public function testDeleteActivityForEmptyParams() {
752 $params = array('version' => $this->_apiversion
);
753 $this->callAPIFailure('activity', 'delete', $params);
757 * Check activity deletion without activity id.
759 public function testDeleteActivityWithoutId() {
761 'activity_name' => 'Meeting',
762 'version' => $this->_apiversion
,
764 $result = $this->callAPIFailure('activity', 'delete', $params);
768 * Check activity deletion without activity type
770 public function testDeleteActivityWithoutActivityType() {
771 $params = array('id' => 1);
772 $result = $this->callAPIFailure('activity', 'delete', $params);
776 * Check activity deletion with incorrect data
778 public function testDeleteActivityWithIncorrectActivityType() {
781 'activity_name' => 'Test Activity',
784 $result = $this->callAPIFailure('activity', 'delete', $params);
788 * Check activity deletion with correct data
790 public function testDeleteActivity() {
791 $result = $this->callAPISuccess('activity', 'create', $this->_params
);
793 'id' => $result['id'],
794 'version' => $this->_apiversion
,
797 $result = $this->callAPISuccess('activity', 'delete', $params);
798 $this->documentMe($params, $result, __FUNCTION__
, __FILE__
);
802 * Check if required fields are not passed
804 public function testActivityUpdateWithoutRequired() {
806 'subject' => 'this case should fail',
807 'scheduled_date_time' => date('Ymd'),
810 $result = $this->callAPIFailure('activity', 'create', $params);
814 * Test civicrm_activity_update() with non-numeric id
816 public function testActivityUpdateWithNonNumericId() {
818 'id' => 'lets break it',
819 'activity_name' => 'Meeting',
820 'subject' => 'this case should fail',
821 'scheduled_date_time' => date('Ymd'),
824 $result = $this->callAPIFailure('activity', 'create', $params);
828 * Check with incorrect required fields
830 public function testActivityUpdateWithIncorrectContactActivityType() {
833 'activity_name' => 'Test Activity',
834 'subject' => 'this case should fail',
835 'scheduled_date_time' => date('Ymd'),
836 'source_contact_id' => $this->_contactID
,
839 $result = $this->callAPIFailure('activity', 'create', $params,
840 'Invalid Activity Id');
844 * Test civicrm_activity_update() to update an existing activity
846 public function testActivityUpdate() {
847 $result = $this->callAPISuccess('activity', 'create', $this->_params
);
850 'id' => $result['id'],
851 'subject' => 'Make-it-Happen Meeting',
852 'activity_date_time' => '20091011123456',
854 'location' => '21, Park Avenue',
855 'details' => 'Lets update Meeting',
857 'source_contact_id' => $this->_contactID
,
861 $result = $this->callAPISuccess('activity', 'create', $params);
862 //hack on date comparison - really we should make getAndCheck smarter to handle dates
863 $params['activity_date_time'] = '2009-10-11 12:34:56';
864 // we also unset source_contact_id since it is stored in an aux table
865 unset($params['source_contact_id']);
866 $this->getAndCheck($params, $result['id'], 'activity');
870 * Test civicrm_activity_update() with valid parameters
871 * and some custom data
873 public function testActivityUpdateCustom() {
874 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__
, __FILE__
);
876 $params = $this->_params
;
878 // Create an activity with custom data
879 //this has been updated from the previous 'old format' function - need to make it work
881 'source_contact_id' => $this->_contactID
,
882 'subject' => 'Make-it-Happen Meeting',
883 'activity_date_time' => '2009-10-18',
885 'location' => 'Pennsylvania',
886 'details' => 'a test activity to check the update api',
888 'activity_name' => 'Test activity type',
889 'version' => $this->_apiversion
,
890 'custom_' . $ids['custom_field_id'] => 'custom string',
892 $result = $this->callAPISuccess('activity', 'create', $params);
894 $activityId = $result['id'];
895 $result = $this->callAPISuccess($this->_entity
, 'get', array(
896 'return.custom_' . $ids['custom_field_id'] => 1,
898 'id' => $result['id'],
900 $this->assertEquals("custom string", $result['values'][$result['id']]['custom_' . $ids['custom_field_id']]);
901 $this->assertEquals("2009-10-18 00:00:00", $result['values'][$result['id']]['activity_date_time']);
902 $fields = $this->callAPISuccess('activity', 'getfields', array('version' => $this->_apiversion
));
903 $this->assertTrue(is_array($fields['values']['custom_' . $ids['custom_field_id']]));
905 // Update the activity with custom data.
908 'source_contact_id' => $this->_contactID
,
909 'subject' => 'Make-it-Happen Meeting',
911 'activity_name' => 'Test activity type',
912 // add this since dates are messed up
913 'activity_date_time' => date('Ymd'),
914 'custom_' . $ids['custom_field_id'] => 'Updated my test data',
915 'version' => $this->_apiversion
,
917 $result = $this->callAPISuccess('Activity', 'Create', $params);
919 $result = $this->callAPISuccess($this->_entity
, 'get', array(
920 'return.custom_' . $ids['custom_field_id'] => 1,
922 'id' => $result['id'],
924 $this->assertEquals("Updated my test data", $result['values'][$result['id']]['custom_' . $ids['custom_field_id']]);
928 * Test civicrm_activity_update() for core activity fields
929 * and some custom data
931 public function testActivityUpdateCheckCoreFields() {
932 $params = $this->_params
;
933 $contact1Params = array(
934 'first_name' => 'John',
935 'middle_name' => 'J.',
936 'last_name' => 'Anderson',
939 'email' => 'john_anderson@civicrm.org',
940 'contact_type' => 'Individual',
943 $contact1 = $this->individualCreate($contact1Params);
944 $contact2Params = array(
945 'first_name' => 'Michal',
946 'middle_name' => 'J.',
947 'last_name' => 'Anderson',
950 'email' => 'michal_anderson@civicrm.org',
951 'contact_type' => 'Individual',
954 $contact2 = $this->individualCreate($contact2Params);
956 $params['assignee_contact_id'] = array($contact1, $contact2);
957 $params['target_contact_id'] = array($contact2 => $contact2);
958 $result = $this->callAPISuccess('Activity', 'Create', $params);
960 $activityId = $result['id'];
962 'return.assignee_contact_id' => 1,
963 'return.target_contact_id' => 1,
964 'version' => $this->_apiversion
,
967 $result = $this->callAPISuccess($this->_entity
, 'get', $getParams);
968 $assignee = $result['values'][$result['id']]['assignee_contact_id'];
969 $target = $result['values'][$result['id']]['target_contact_id'];
970 $this->assertEquals(2, count($assignee), ' in line ' . __LINE__
);
971 $this->assertEquals(1, count($target), ' in line ' . __LINE__
);
972 $this->assertEquals(TRUE, in_array($contact1, $assignee), ' in line ' . __LINE__
);
973 $this->assertEquals(TRUE, in_array($contact2, $target), ' in line ' . __LINE__
);
975 $contact3Params = array(
976 'first_name' => 'Jijo',
977 'middle_name' => 'J.',
978 'last_name' => 'Anderson',
981 'email' => 'jijo_anderson@civicrm.org',
982 'contact_type' => 'Individual',
985 $contact4Params = array(
986 'first_name' => 'Grant',
987 'middle_name' => 'J.',
988 'last_name' => 'Anderson',
991 'email' => 'grant_anderson@civicrm.org',
992 'contact_type' => 'Individual',
995 $contact3 = $this->individualCreate($contact3Params);
996 $contact4 = $this->individualCreate($contact4Params);
999 $params['id'] = $activityId;
1000 $params['assignee_contact_id'] = array($contact3 => $contact3);
1001 $params['target_contact_id'] = array($contact4 => $contact4);
1003 $result = $this->callAPISuccess('activity', 'create', $params);
1005 $this->assertEquals($activityId, $result['id'], ' in line ' . __LINE__
);
1007 $result = $this->callAPISuccess(
1011 'return.assignee_contact_id' => 1,
1012 'return.target_contact_id' => 1,
1013 'return.source_contact_id' => 1,
1014 'id' => $result['id'],
1018 $assignee = $result['values'][$result['id']]['assignee_contact_id'];
1019 $target = $result['values'][$result['id']]['target_contact_id'];
1021 $this->assertEquals(1, count($assignee), ' in line ' . __LINE__
);
1022 $this->assertEquals(1, count($target), ' in line ' . __LINE__
);
1023 $this->assertEquals(TRUE, in_array($contact3, $assignee), ' in line ' . __LINE__
);
1024 $this->assertEquals(TRUE, in_array($contact4, $target), ' in line ' . __LINE__
);
1026 foreach ($this->_params
as $fld => $val) {
1027 $this->assertEquals($val, $result['values'][$result['id']][$fld]);
1032 * Test civicrm_activity_update() where the DB has a date_time
1033 * value and there is none in the update params.
1035 public function testActivityUpdateNotDate() {
1036 $result = $this->callAPISuccess('activity', 'create', $this->_params
);
1039 'id' => $result['id'],
1040 'subject' => 'Make-it-Happen Meeting',
1042 'location' => '21, Park Avenue',
1043 'details' => 'Lets update Meeting',
1045 'source_contact_id' => $this->_contactID
,
1049 $result = $this->callAPISuccess('activity', 'create', $params);
1050 //hack on date comparison - really we should make getAndCheck smarter to handle dates
1051 $params['activity_date_time'] = $this->_params
['activity_date_time'];
1052 // we also unset source_contact_id since it is stored in an aux table
1053 unset($params['source_contact_id']);
1054 $this->getAndCheck($params, $result['id'], 'activity');
1058 * Check activity update with status
1060 public function testActivityUpdateWithStatus() {
1061 $activity = $this->callAPISuccess('activity', 'create', $this->_params
);
1063 'id' => $activity['id'],
1064 'source_contact_id' => $this->_contactID
,
1065 'subject' => 'Hurry update works',
1067 'activity_name' => 'Test activity type',
1070 $result = $this->callAPISuccess('activity', 'create', $params);
1071 $this->assertEquals($result['id'], $activity['id']);
1072 $this->assertEquals($result['values'][$activity['id']]['subject'], 'Hurry update works');
1073 $this->assertEquals($result['values'][$activity['id']]['status_id'], 1
1078 * Test civicrm_activity_update() where the source_contact_id
1079 * is not in the update params.
1081 public function testActivityUpdateKeepSource() {
1082 $activity = $this->callAPISuccess('activity', 'create', $this->_params
);
1083 // Updating the activity but not providing anything for the source contact
1084 // (It was set as $this->_contactID earlier.)
1086 'id' => $activity['id'],
1087 'subject' => 'Updated Make-it-Happen Meeting',
1089 'location' => '21, Park Avenue',
1090 'details' => 'Lets update Meeting',
1092 'activity_name' => 'Test activity type',
1096 $result = $this->callAPISuccess('activity', 'create', $params);
1097 $findactivity = $this->callAPISuccess('Activity', 'Get', array('id' => $activity['id']));
1101 * Test civicrm_activities_contact_get()
1103 public function testActivitiesContactGet() {
1104 $activity = $this->callAPISuccess('activity', 'create', $this->_params
);
1105 $activity2 = $this->callAPISuccess('activity', 'create', $this->_params2
);
1106 // Get activities associated with contact $this->_contactID.
1108 'contact_id' => $this->_contactID
,
1110 $result = $this->callAPISuccess('activity', 'get', $params);
1112 $this->assertEquals(2, $result['count'], 'In line ' . __LINE__
);
1113 $this->assertEquals($this->test_activity_type_value
, $result['values'][$activity['id']]['activity_type_id']);
1114 $this->assertEquals('Test activity type', $result['values'][$activity['id']]['activity_name']);
1115 $this->assertEquals('Test activity type', $result['values'][$activity2['id']]['activity_name']);
1119 * Test chained Activity format.
1121 public function testChainedActivityGet() {
1123 $activity = $this->callAPISuccess('Contact', 'Create', array(
1124 'display_name' => "bob brown",
1125 'contact_type' => 'Individual',
1126 'api.activity_type.create' => array(
1128 'label' => 'send out letters',
1134 'api.activity.create' => array(
1135 'subject' => 'send letter',
1136 'activity_type_id' => '$value.api.activity_type.create.values.0.value',
1140 $result = $this->callAPISuccess('Activity', 'Get', array(
1141 'id' => $activity['id'],
1142 'return.assignee_contact_id' => 1,
1143 'api.contact.get' => array('api.pledge.get' => 1),
1148 * Test civicrm_activity_contact_get() with invalid Contact ID.
1150 public function testActivitiesContactGetWithInvalidContactId() {
1151 $params = array('contact_id' => 'contact');
1152 $this->callAPIFailure('activity', 'get', $params);
1156 * Test civicrm_activity_contact_get() with contact having no Activity.
1158 public function testActivitiesContactGetHavingNoActivity() {
1160 'first_name' => 'dan',
1161 'last_name' => 'conberg',
1162 'email' => 'dan.conberg@w.co.in',
1163 'contact_type' => 'Individual',
1166 $contact = $this->callAPISuccess('contact', 'create', $params);
1168 'contact_id' => $contact['id'],
1170 $result = $this->callAPISuccess('activity', 'get', $params);
1171 $this->assertEquals($result['count'], 0);
1175 * Test getfields function.
1177 public function testGetFields() {
1178 $params = array('action' => 'create');
1179 $result = $this->callAPIAndDocument('activity', 'getfields', $params, __FUNCTION__
, __FILE__
, NULL, NULL, 'getfields');
1180 $this->assertTrue(is_array($result['values']), 'get fields doesn\'t return values array');
1181 foreach ($result['values'] as $key => $value) {
1182 $this->assertTrue(is_array($value), $key . " is not an array");