Merge pull request #10686 from totten/master-sql
[civicrm-core.git] / tests / phpunit / api / v3 / ActivityTest.php
1 <?php
2 /**
3 * @file
4 * File for the TestActivity class
5 *
6 * (PHP 5)
7 *
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 $
13 * @package CiviCRM
14 *
15 * This file is part of CiviCRM
16 *
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.
21 *
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.
26 *
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/>.
30 */
31
32 /**
33 * Include class definitions
34 */
35
36 /**
37 * Test APIv3 civicrm_activity_* functions
38 *
39 * @package CiviCRM_APIv3
40 * @subpackage API_Activity
41 * @group headless
42 */
43 class api_v3_ActivityTest extends CiviUnitTestCase {
44 protected $_params;
45 protected $_params2;
46 protected $_entity = 'activity';
47 protected $_apiversion = 3;
48 protected $test_activity_type_value;
49 protected $_contactID;
50
51 /**
52 * Test setup for every test.
53 *
54 * Connect to the database, truncate the tables that will be used
55 * and redirect stdin to a temporary file
56 */
57 public function setUp() {
58 // Connect to the database
59 parent::setUp();
60
61 $this->_contactID = $this->individualCreate();
62 //create activity types
63 $this->test_activity_type_value = 9999;
64 $activityTypes = $this->callAPISuccess('option_value', 'create', array(
65 'option_group_id' => 2,
66 'name' => 'Test activity type',
67 'label' => 'Test activity type',
68 'value' => $this->test_activity_type_value,
69 'sequential' => 1,
70 ));
71 $this->test_activity_type_id = $activityTypes['id'];
72 $this->_params = array(
73 'source_contact_id' => $this->_contactID,
74 'activity_type_id' => 'Test activity type',
75 'subject' => 'test activity type id',
76 'activity_date_time' => '2011-06-02 14:36:13',
77 'status_id' => 2,
78 'priority_id' => 1,
79 'duration' => 120,
80 'location' => 'Pennsylvania',
81 'details' => 'a test activity',
82 );
83 $this->_params2 = array(
84 'source_contact_id' => $this->_contactID,
85 'subject' => 'Eat & drink',
86 'activity_date_time' => date('Ymd'),
87 'duration' => 120,
88 'location' => 'Napier',
89 'details' => 'discuss & eat',
90 'status_id' => 1,
91 'activity_type_id' => $this->test_activity_type_value,
92 );
93 // create a logged in USER since the code references it for source_contact_id
94 $this->createLoggedInUser();
95 }
96
97 /**
98 * Tears down the fixture, for example, closes a network connection.
99 *
100 * This method is called after a test is executed.
101 */
102 public function tearDown() {
103 $tablesToTruncate = array(
104 'civicrm_contact',
105 'civicrm_activity',
106 'civicrm_activity_contact',
107 'civicrm_uf_match',
108 );
109 $this->quickCleanup($tablesToTruncate, TRUE);
110 $type = $this->callAPISuccess('optionValue', 'get', array('id' => $this->test_activity_type_id));
111 if (!empty($type['count'])) {
112 $this->callAPISuccess('option_value', 'delete', array('id' => $this->test_activity_type_id));
113 }
114 }
115
116 /**
117 * Check fails with empty array.
118 */
119 public function testActivityCreateEmpty() {
120 $this->callAPIFailure('activity', 'create', array());
121 }
122
123 /**
124 * Check if required fields are not passed.
125 */
126 public function testActivityCreateWithoutRequired() {
127 $params = array(
128 'subject' => 'this case should fail',
129 'scheduled_date_time' => date('Ymd'),
130 );
131 $result = $this->callAPIFailure('activity', 'create', $params);
132 }
133
134 /**
135 * Test civicrm_activity_create() with mismatched activity_type_id
136 * and activity_name.
137 */
138 public function testActivityCreateMismatchNameType() {
139 $params = array(
140 'source_contact_id' => $this->_contactID,
141 'subject' => 'Test activity',
142 'activity_date_time' => date('Ymd'),
143 'duration' => 120,
144 'location' => 'Pennsylvania',
145 'details' => 'a test activity',
146 'status_id' => 1,
147 'activity_name' => 'Fubar activity type',
148 'activity_type_id' => 5,
149 'scheduled_date_time' => date('Ymd'),
150 );
151
152 $result = $this->callAPIFailure('activity', 'create', $params);
153 }
154
155 /**
156 * Test civicrm_activity_id() with missing source_contact_id is put with the current user.
157 */
158 public function testActivityCreateWithMissingContactId() {
159 $params = array(
160 'subject' => 'Make-it-Happen Meeting',
161 'activity_date_time' => date('Ymd'),
162 'duration' => 120,
163 'location' => 'Pennsylvania',
164 'details' => 'a test activity',
165 'status_id' => 1,
166 'activity_name' => 'Test activity type',
167 );
168
169 $this->callAPISuccess('activity', 'create', $params);
170 }
171
172 /**
173 * CRM-20316 this should fail based on validation with no logged in user.
174 *
175 * Since the field is required the validation should reject the default.
176 */
177 public function testActivityCreateWithMissingContactIdNoLoggedInUser() {
178 CRM_Core_Session::singleton()->set('userID', NULL);
179 $params = array(
180 'subject' => 'Make-it-Happen Meeting',
181 'activity_date_time' => date('Ymd'),
182 'duration' => 120,
183 'location' => 'Pennsylvania',
184 'details' => 'a test activity',
185 'status_id' => 1,
186 'activity_name' => 'Test activity type',
187 );
188
189 $this->callAPIFailure('activity', 'create', $params, 'source_contact_id is not a valid integer');
190 }
191
192 /**
193 * Test civicrm_activity_id() with non-numeric source_contact_id.
194 */
195 public function testActivityCreateWithNonNumericContactId() {
196 $params = array(
197 'source_contact_id' => 'fubar',
198 'subject' => 'Make-it-Happen Meeting',
199 'activity_date_time' => date('Ymd'),
200 'duration' => 120,
201 'location' => 'Pennsylvania',
202 'details' => 'a test activity',
203 'status_id' => 1,
204 'activity_name' => 'Test activity type',
205 );
206
207 $this->callAPIFailure('activity', 'create', $params);
208 }
209
210 /**
211 * Ensure that an invalid activity type causes failure.
212 *
213 * Oddly enough this test was failing because the creation of the invalid type
214 * got added to the set up routine. Probably a mis-fix on a test
215 */
216 public function testActivityCreateWithNonNumericActivityTypeId() {
217 $params = array(
218 'source_contact_id' => $this->_contactID,
219 'subject' => 'Make-it-Happen Meeting',
220 'activity_date_time' => date('Ymd'),
221 'duration' => 120,
222 'location' => 'Pennsylvania',
223 'details' => 'a test activity',
224 'status_id' => 1,
225 'activity_type_id' => 'Invalid Test activity type',
226 );
227
228 $result = $this->callAPIFailure('activity', 'create', $params);
229 }
230
231 /**
232 * Check with incorrect required fields.
233 */
234 public function testActivityCreateWithUnknownActivityTypeId() {
235 $params = array(
236 'source_contact_id' => $this->_contactID,
237 'subject' => 'Make-it-Happen Meeting',
238 'activity_date_time' => date('Ymd'),
239 'duration' => 120,
240 'location' => 'Pennsylvania',
241 'details' => 'a test activity',
242 'status_id' => 1,
243 'activity_type_id' => 699,
244 );
245
246 $result = $this->callAPIFailure('activity', 'create', $params);
247 }
248
249 public function testActivityCreateWithInvalidPriority() {
250 $params = array(
251 'source_contact_id' => $this->_contactID,
252 'subject' => 'Make-it-Happen Meeting',
253 'activity_date_time' => date('Ymd'),
254 'duration' => 120,
255 'location' => 'Pennsylvania',
256 'details' => 'a test activity',
257 'status_id' => 1,
258 'priority_id' => 44,
259 'activity_type_id' => 1,
260 );
261
262 $result = $this->callAPIFailure('activity', 'create', $params,
263 "'44' is not a valid option for field priority_id");
264 $this->assertEquals('priority_id', $result['error_field']);
265 }
266
267
268 /**
269 * Test create succeeds with valid string for priority.
270 */
271 public function testActivityCreateWithValidStringPriority() {
272 $params = array(
273 'source_contact_id' => $this->_contactID,
274 'subject' => 'Make-it-Happen Meeting',
275 'activity_date_time' => date('Ymd'),
276 'duration' => 120,
277 'location' => 'Pennsylvania',
278 'details' => 'a test activity',
279 'status_id' => 1,
280 'priority_id' => 'Urgent',
281 'activity_type_id' => 1,
282 );
283
284 $result = $this->callAPISuccess('activity', 'create', $params);
285 $this->assertEquals(1, $result['values'][$result['id']]['priority_id']);
286 }
287
288 /**
289 * Test create fails with invalid priority string.
290 */
291 public function testActivityCreateWithInValidStringPriority() {
292 $params = array(
293 'source_contact_id' => $this->_contactID,
294 'subject' => 'Make-it-Happen Meeting',
295 'activity_date_time' => date('Ymd'),
296 'duration' => 120,
297 'location' => 'Pennsylvania',
298 'details' => 'a test activity',
299 'status_id' => 1,
300 'priority_id' => 'ergUrgent',
301 'activity_type_id' => 1,
302 );
303
304 $this->callAPIFailure('activity', 'create', $params,
305 "'ergUrgent' is not a valid option for field priority_id");
306 }
307
308 /**
309 * Test civicrm_activity_create() with valid parameters.
310 */
311 public function testActivityCreate() {
312
313 $this->callAPISuccess('activity', 'create', $this->_params);
314 $result = $this->callAPISuccess('activity', 'get', $this->_params);
315 $this->assertEquals($result['values'][$result['id']]['duration'], 120);
316 $this->assertEquals($result['values'][$result['id']]['subject'], 'test activity type id');
317 $this->assertEquals($result['values'][$result['id']]['activity_date_time'], '2011-06-02 14:36:13');
318 $this->assertEquals($result['values'][$result['id']]['location'], 'Pennsylvania');
319 $this->assertEquals($result['values'][$result['id']]['details'], 'a test activity');
320 $this->assertEquals($result['values'][$result['id']]['status_id'], 2);
321 $this->assertEquals($result['values'][$result['id']]['id'], $result['id']);
322 }
323
324 /**
325 * Test civicrm_activity_create() with valid parameters - use type_id.
326 */
327 public function testActivityCreateCampaignTypeID() {
328 $this->enableCiviCampaign();
329
330 $params = array(
331 'source_contact_id' => $this->_contactID,
332 'subject' => 'Make-it-Happen Meeting',
333 'activity_date_time' => '20110316',
334 'duration' => 120,
335 'location' => 'Pennsylvania',
336 'details' => 'a test activity',
337 'status_id' => 1,
338 'activity_type_id' => 29,
339 );
340
341 $result = $this->callAPISuccess('activity', 'create', $params);
342
343 $result = $this->callAPISuccess('activity', 'getsingle', array('id' => $result['id']));
344 $this->assertEquals($result['duration'], 120);
345 $this->assertEquals($result['subject'], 'Make-it-Happen Meeting');
346 $this->assertEquals($result['activity_date_time'], '2011-03-16 00:00:00');
347 $this->assertEquals($result['location'], 'Pennsylvania');
348 $this->assertEquals($result['details'], 'a test activity');
349 $this->assertEquals($result['status_id'], 1);
350
351 $priorities = $this->callAPISuccess('activity', 'getoptions', array('field' => 'priority_id'));
352 $this->assertEquals($result['priority_id'], array_search('Normal', $priorities['values']));
353 }
354
355 /**
356 * Test get returns target and assignee contacts.
357 */
358 public function testActivityReturnTargetAssignee() {
359
360 $description = "Demonstrates setting & retrieving activity target & source.";
361 $subfile = "GetTargetandAssignee";
362 $params = array(
363 'source_contact_id' => $this->_contactID,
364 'subject' => 'Make-it-Happen Meeting',
365 'activity_date_time' => '20110316',
366 'duration' => 120,
367 'location' => 'Pennsylvania',
368 'details' => 'a test activity',
369 'status_id' => 1,
370 'activity_type_id' => 1,
371 'priority_id' => 1,
372 'target_contact_id' => $this->_contactID,
373 'assignee_contact_id' => $this->_contactID,
374 );
375
376 $result = $this->callAPIAndDocument('activity', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
377 $result = $this->callAPISuccess('activity', 'get', array(
378 'id' => $result['id'],
379 'version' => $this->_apiversion,
380 'return.assignee_contact_id' => 1,
381 'return.target_contact_id' => 1,
382 ));
383
384 $this->assertEquals($this->_contactID, $result['values'][$result['id']]['assignee_contact_id'][0]);
385 $this->assertEquals($this->_contactID, $result['values'][$result['id']]['target_contact_id'][0]);
386 }
387
388 /**
389 * Test get returns target and assignee contact names.
390 */
391 public function testActivityReturnTargetAssigneeName() {
392
393 $description = "Demonstrates retrieving activity target & source contact names.";
394 $subfile = "GetTargetandAssigneeName";
395 $target1 = $this->callAPISuccess('Contact', 'create', array('contact_type' => 'Individual', 'first_name' => 'A', 'last_name' => 'Cat'));
396 $target2 = $this->callAPISuccess('Contact', 'create', array('contact_type' => 'Individual', 'first_name' => 'B', 'last_name' => 'Good'));
397 $assignee = $this->callAPISuccess('Contact', 'create', array('contact_type' => 'Individual', 'first_name' => 'C', 'last_name' => 'Shore'));
398 $source = $this->callAPISuccess('Contact', 'create', array('contact_type' => 'Individual', 'first_name' => 'D', 'last_name' => 'Bug'));
399
400 $params = array(
401 'source_contact_id' => $source['id'],
402 'subject' => 'Make-it-Happen Meeting',
403 'activity_date_time' => '20170316',
404 'status_id' => 1,
405 'activity_type_id' => 1,
406 'target_contact_id' => array($target1['id'], $target2['id']),
407 'assignee_contact_id' => $assignee['id'],
408 );
409
410 $result = $this->callAPISuccess('activity', 'create', $params);
411 $result = $this->callAPIAndDocument('activity', 'getsingle', array(
412 'id' => $result['id'],
413 'return' => array('source_contact_name', 'target_contact_name', 'assignee_contact_name', 'subject'),
414 ), __FUNCTION__, __FILE__, $description, $subfile);
415
416 $this->assertEquals($params['subject'], $result['subject']);
417 $this->assertEquals($source['id'], $result['source_contact_id']);
418 $this->assertEquals('D Bug', $result['source_contact_name']);
419 $this->assertEquals('A Cat', $result['target_contact_name'][$target1['id']]);
420 $this->assertEquals('B Good', $result['target_contact_name'][$target2['id']]);
421 $this->assertEquals('C Shore', $result['assignee_contact_name'][$assignee['id']]);
422 $this->assertEquals($assignee['id'], $result['assignee_contact_id'][0]);
423 }
424
425 /**
426 * Test civicrm_activity_create() with valid parameters and custom data.
427 */
428 public function testActivityCreateCustom() {
429 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
430 $params = $this->_params;
431 $params['custom_' . $ids['custom_field_id']] = "custom string";
432 $result = $this->callAPIAndDocument($this->_entity, 'create', $params, __FUNCTION__, __FILE__);
433 $result = $this->callAPISuccess($this->_entity, 'get', array(
434 'return.custom_' . $ids['custom_field_id'] => 1,
435 'id' => $result['id'],
436 ));
437 $this->assertEquals("custom string", $result['values'][$result['id']]['custom_' . $ids['custom_field_id']], ' in line ' . __LINE__);
438
439 $this->customFieldDelete($ids['custom_field_id']);
440 $this->customGroupDelete($ids['custom_group_id']);
441 }
442
443 /**
444 * Test civicrm_activity_create() using example code.
445 */
446 public function testActivityCreateExample() {
447 require_once 'api/v3/examples/Activity/Create.php';
448 $result = activity_create_example();
449 $expectedResult = activity_create_expectedresult();
450 $this->assertEquals($result, $expectedResult);
451 }
452
453 /**
454 * Test civicrm_activity_create() with valid parameters and custom data.
455 */
456 public function testActivityCreateCustomSubType() {
457 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
458 $this->callAPISuccess('CustomGroup', 'create', array(
459 'extends_entity_column_value' => $this->test_activity_type_value,
460 'id' => $ids['custom_group_id'],
461 'extends' => 'Activity',
462 'is_active' => TRUE,
463 ));
464 $params = $this->_params;
465 $params['custom_' . $ids['custom_field_id']] = "custom string";
466 $result = $this->callAPIAndDocument($this->_entity, 'create', $params, __FUNCTION__, __FILE__);
467 $result = $this->callAPISuccess($this->_entity, 'get', array(
468 'return.custom_' . $ids['custom_field_id'] => 1,
469 'id' => $result['id'],
470 ));
471 $this->assertEquals("custom string", $result['values'][$result['id']]['custom_' . $ids['custom_field_id']]);
472
473 $this->customFieldDelete($ids['custom_field_id']);
474 $this->customGroupDelete($ids['custom_group_id']);
475 }
476
477 /**
478 * Test civicrm_activity_create() with valid parameters and custom data.
479 */
480 public function testActivityCreateCustomContactRefField() {
481
482 $this->callAPISuccess('contact', 'create', array('id' => $this->_contactID, 'sort_name' => 'Contact, Test'));
483 $subfile = 'ContactRefCustomField';
484 $description = "Demonstrates create with Contact Reference Custom Field.";
485 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
486 $params = array(
487 'custom_group_id' => $ids['custom_group_id'],
488 'name' => 'Worker_Lookup',
489 'label' => 'Worker Lookup',
490 'html_type' => 'Autocomplete-Select',
491 'data_type' => 'ContactReference',
492 'weight' => 4,
493 'is_searchable' => 1,
494 'is_active' => 1,
495 );
496
497 $customField = $this->callAPISuccess('custom_field', 'create', $params);
498 $params = $this->_params;
499 $params['custom_' . $customField['id']] = "$this->_contactID";
500
501 $result = $this->callAPIAndDocument($this->_entity, 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
502 $result = $this->callAPIAndDocument($this->_entity, 'get', array(
503 'return.custom_' . $customField['id'] => 1,
504 'id' => $result['id'],
505 ), __FUNCTION__, __FILE__, 'Get with Contact Ref Custom Field', 'ContactRefCustomFieldGet');
506
507 $this->assertEquals('Anderson, Anthony', $result['values'][$result['id']]['custom_' . $customField['id']]);
508 $this->assertEquals($this->_contactID, $result['values'][$result['id']]['custom_' . $customField['id'] . "_id"], ' in line ' . __LINE__);
509 $this->assertEquals('Anderson, Anthony', $result['values'][$result['id']]['custom_' . $customField['id'] . '_1'], ' in line ' . __LINE__);
510 $this->assertEquals($this->_contactID, $result['values'][$result['id']]['custom_' . $customField['id'] . "_1_id"], ' in line ' . __LINE__);
511 $this->customFieldDelete($ids['custom_field_id']);
512 $this->customGroupDelete($ids['custom_group_id']);
513 }
514
515 /**
516 * Test civicrm_activity_create() with an invalid text status_id.
517 */
518 public function testActivityCreateBadTextStatus() {
519
520 $params = array(
521 'source_contact_id' => $this->_contactID,
522 'subject' => 'Discussion on Apis for v3',
523 'activity_date_time' => date('Ymd'),
524 'duration' => 120,
525 'location' => 'Pennsylvania',
526 'details' => 'a test activity',
527 'status_id' => 'Invalid',
528 'activity_name' => 'Test activity type',
529 );
530
531 $this->callAPIFailure('activity', 'create', $params);
532 }
533
534 /**
535 * Test civicrm_activity_create() with an invalid text status_id.
536 */
537 public function testActivityCreateSupportActivityStatus() {
538
539 $params = array(
540 'source_contact_id' => $this->_contactID,
541 'subject' => 'Discussion on Apis for v3',
542 'activity_date_time' => date('Ymd'),
543 'duration' => 120,
544 'location' => 'Pennsylvania',
545 'details' => 'a test activity',
546 'activity_status_id' => 'Invalid',
547 'activity_name' => 'Test activity type',
548 );
549
550 $result = $this->callAPIFailure('activity', 'create', $params,
551 "'Invalid' is not a valid option for field status_id");
552 }
553
554
555 /**
556 * Test civicrm_activity_create() with using a text status_id.
557 */
558 public function testActivityCreateTextStatus() {
559
560 $params = array(
561 'source_contact_id' => $this->_contactID,
562 'subject' => 'Make-it-Happen Meeting',
563 'activity_date_time' => date('Ymd'),
564 'duration' => 120,
565 'location' => 'Pennsylvania',
566 'details' => 'a test activity',
567 'status_id' => 'Scheduled',
568 'activity_name' => 'Test activity type',
569 );
570
571 $result = $this->callAPISuccess('activity', 'create', $params);
572 $this->assertEquals($result['values'][$result['id']]['duration'], 120);
573 $this->assertEquals($result['values'][$result['id']]['subject'], 'Make-it-Happen Meeting');
574 $this->assertEquals($result['values'][$result['id']]['activity_date_time'], date('Ymd') . '000000');
575 $this->assertEquals($result['values'][$result['id']]['location'], 'Pennsylvania');
576 $this->assertEquals($result['values'][$result['id']]['details'], 'a test activity');
577 }
578
579 /**
580 * Test civicrm_activity_get() with no params
581 */
582 public function testActivityGetEmpty() {
583 $result = $this->callAPISuccess('activity', 'get', array());
584 }
585
586 /**
587 * Test civicrm_activity_get() with a good activity ID
588 */
589 public function testActivityGetGoodID1() {
590 // Insert rows in civicrm_activity creating activities 4 and 13
591 $description = "Demonstrates getting assignee_contact_id & using it to get the contact.";
592 $subfile = 'ReturnAssigneeContact';
593 $activity = $this->callAPISuccess('activity', 'create', $this->_params);
594
595 $contact = $this->callAPISuccess('Contact', 'Create', array(
596 'first_name' => "The Rock",
597 'last_name' => 'roccky',
598 'contact_type' => 'Individual',
599 'version' => 3,
600 'api.activity.create' => array(
601 'id' => $activity['id'],
602 'assignee_contact_id' => '$value.id',
603 ),
604 ));
605
606 $params = array(
607 'activity_id' => $activity['id'],
608 'version' => $this->_apiversion,
609 'sequential' => 1,
610 'return.assignee_contact_id' => 1,
611 'api.contact.get' => array(
612 'id' => '$value.source_contact_id',
613 ),
614 );
615
616 $result = $this->callAPIAndDocument('Activity', 'Get', $params, __FUNCTION__, __FILE__, $description, $subfile);
617
618 $this->assertEquals($activity['id'], $result['id']);
619
620 $this->assertEquals($contact['id'], $result['values'][0]['assignee_contact_id'][0]);
621
622 $this->assertEquals($this->_contactID, $result['values'][0]['api.contact.get']['values'][0]['contact_id']);
623 $this->assertEquals($this->test_activity_type_value, $result['values'][0]['activity_type_id']);
624 $this->assertEquals("test activity type id", $result['values'][0]['subject']);
625 }
626
627 /**
628 * test that get functioning does filtering.
629 */
630 public function testGetFilter() {
631 $params = array(
632 'source_contact_id' => $this->_contactID,
633 'subject' => 'Make-it-Happen Meeting',
634 'activity_date_time' => '20110316',
635 'duration' => 120,
636 'location' => 'Pennsylvania',
637 'details' => 'a test activity',
638 'status_id' => 1,
639 'activity_name' => 'Test activity type',
640 'priority_id' => 1,
641 );
642 $result = $this->callAPISuccess('Activity', 'Create', $params);
643 $this->callAPISuccess('Activity', 'Get', array('subject' => 'Make-it-Happen Meeting'));
644 $this->assertEquals(1, $result['count']);
645 $this->assertEquals('Make-it-Happen Meeting', $result['values'][$result['id']]['subject']);
646 $this->callAPISuccess('Activity', 'Delete', array('id' => $result['id']));
647 }
648
649
650 /**
651 * Test civicrm_activity_get() with filter target_contact_id
652 */
653 public function testActivityGetTargetFilter() {
654 $params = $this->_params;
655 $contact1Params = array(
656 'first_name' => 'John',
657 'middle_name' => 'J.',
658 'last_name' => 'Anderson',
659 'prefix_id' => 3,
660 'suffix_id' => 3,
661 'email' => 'john_anderson@civicrm.org',
662 'contact_type' => 'Individual',
663 );
664
665 $contact1 = $this->individualCreate($contact1Params);
666 $contact2Params = array(
667 'first_name' => 'Michal',
668 'middle_name' => 'J.',
669 'last_name' => 'Anderson',
670 'prefix_id' => 3,
671 'suffix_id' => 3,
672 'email' => 'michal_anderson@civicrm.org',
673 'contact_type' => 'Individual',
674 );
675
676 $contact2 = $this->individualCreate($contact2Params);
677
678 $params['assignee_contact_id'] = array($contact1, $contact2);
679 $params['target_contact_id'] = array($contact2 => $contact2);
680 $activity = $this->callAPISuccess('Activity', 'Create', $params);
681
682 $activityget = $this->callAPISuccess('Activity', 'get', array(
683 'id' => $activity['id'],
684 'target_contact_id' => $contact2,
685 'return.target_contact_id' => 1,
686 ));
687 $this->assertEquals($activity['id'], $activityget['id']);
688 $this->assertEquals($contact2, $activityget['values'][$activityget['id']]['target_contact_id'][0]);
689
690 $activityget = $this->callAPISuccess('activity', 'get', array(
691 'target_contact_id' => $this->_contactID,
692 'return.target_contact_id' => 1,
693 'id' => $activity['id'],
694 ));
695 if ($activityget['count'] > 0) {
696 $this->assertNotEquals($contact2, $activityget['values'][$activityget['id']]['target_contact_id'][0]);
697 }
698 }
699
700 /**
701 * Test that activity.get api works when filtering on subject.
702 */
703 public function testActivityGetSubjectFilter() {
704 $subject = 'test activity ' . __FUNCTION__ . mt_rand();
705 $params = $this->_params;
706 $params['subject'] = $subject;
707 $activity = $this->callAPISuccess('Activity', 'Create', $params);
708 $activityget = $this->callAPISuccess('activity', 'getsingle', array(
709 'subject' => $subject,
710 ));
711 $this->assertEquals($activityget['subject'], $subject);
712 }
713
714 /**
715 * Test that activity.get api works when filtering on details.
716 */
717 public function testActivityGetDetailsFilter() {
718 $details = 'test activity ' . __FUNCTION__ . mt_rand();
719 $params = $this->_params;
720 $params['details'] = $details;
721 $activity = $this->callAPISuccess('Activity', 'Create', $params);
722 $activityget = $this->callAPISuccess('activity', 'getsingle', array(
723 'details' => $details,
724 ));
725 $this->assertEquals($activityget['details'], $details);
726 }
727
728 /**
729 * Test that activity.get api works when filtering on tag.
730 */
731 public function testActivityGetTagFilter() {
732 $tag = $this->callAPISuccess('Tag', 'create', array('name' => mt_rand(), 'used_for' => 'Activities'));
733 $activity = $this->callAPISuccess('Activity', 'Create', $this->_params);
734 $this->callAPISuccess('EntityTag', 'create', array('entity_table' => 'civicrm_activity', 'tag_id' => $tag['id'], 'entity_id' => $activity['id']));
735 $activityget = $this->callAPISuccess('activity', 'getsingle', array(
736 'tag_id' => $tag['id'],
737 ));
738 $this->assertEquals($activityget['id'], $activity['id']);
739 }
740
741 /**
742 * Return tag info
743 */
744 public function testJoinOnTags() {
745 $tagName = 'act_tag_nm_' . mt_rand();
746 $tagDescription = 'act_tag_ds_' . mt_rand();
747 $tagColor = '#' . substr(md5(mt_rand()), 0, 6);
748 $tag = $this->callAPISuccess('Tag', 'create', array('name' => $tagName, 'color' => $tagColor, 'description' => $tagDescription, 'used_for' => 'Activities'));
749 $activity = $this->callAPISuccess('Activity', 'Create', $this->_params);
750 $this->callAPISuccess('EntityTag', 'create', array('entity_table' => 'civicrm_activity', 'tag_id' => $tag['id'], 'entity_id' => $activity['id']));
751 $activityget = $this->callAPISuccess('activity', 'getsingle', array(
752 'id' => $activity['id'],
753 'return' => array('tag_id.name', 'tag_id.description', 'tag_id.color'),
754 ));
755 $this->assertEquals($tagName, $activityget['tag_id'][$tag['id']]['tag_id.name']);
756 $this->assertEquals($tagColor, $activityget['tag_id'][$tag['id']]['tag_id.color']);
757 $this->assertEquals($tagDescription, $activityget['tag_id'][$tag['id']]['tag_id.description']);
758 }
759
760
761 /**
762 * Test that activity.get api works to filter on and return files.
763 */
764 public function testActivityGetFile() {
765 $activity = $this->callAPISuccess('Activity', 'create', $this->_params);
766 $activity2 = $this->callAPISuccess('Activity', 'create', $this->_params2);
767 $file = $this->callAPISuccess('Attachment', 'create', array(
768 'name' => 'actAttachment.txt',
769 'mime_type' => 'text/plain',
770 'description' => 'My test description',
771 'content' => 'My test content',
772 'entity_table' => 'civicrm_activity',
773 'entity_id' => $activity2['id'],
774 ));
775 $activityget = $this->callAPISuccess('activity', 'getsingle', array(
776 'file_id' => $file['id'],
777 'return' => 'file_id',
778 ));
779 $this->assertEquals($activityget['id'], $activity2['id']);
780 $this->assertEquals($file['id'], $activityget['file_id'][0]);
781 }
782
783 /**
784 * test that get functioning does filtering.
785 */
786 public function testGetStatusID() {
787 $params = array(
788 'source_contact_id' => $this->_contactID,
789 'subject' => 'Make-it-Happen Meeting',
790 'activity_date_time' => '20110316',
791 'duration' => 120,
792 'location' => 'Pennsylvania',
793 'details' => 'a test activity',
794 'status_id' => 1,
795 'activity_name' => 'Test activity type',
796 'priority_id' => 1,
797 );
798 $this->callAPISuccess('Activity', 'Create', $params);
799 $result = $this->callAPISuccess('Activity', 'Get', array('activity_status_id' => '1'));
800 $this->assertEquals(1, $result['count'], 'one activity of status 1 should exist');
801
802 $result = $this->callAPISuccess('Activity', 'Get', array('status_id' => '1'));
803 $this->assertEquals(1, $result['count'], 'status_id should also work');
804
805 $result = $this->callAPISuccess('Activity', 'Get', array('activity_status_id' => '2'));
806 $this->assertEquals(0, $result['count'], 'No activities of status 1 should exist');
807 $result = $this->callAPISuccess('Activity', 'Get', array(
808 'version' => $this->_apiversion,
809 'status_id' => '2',
810 ));
811 $this->assertEquals(0, $result['count'], 'No activities of status 1 should exist');
812
813 }
814
815 /**
816 * test that get functioning does filtering.
817 */
818 public function testGetFilterMaxDate() {
819 $params = array(
820 'source_contact_id' => $this->_contactID,
821 'subject' => 'Make-it-Happen Meeting',
822 'activity_date_time' => '20110101',
823 'duration' => 120,
824 'location' => 'Pennsylvania',
825 'details' => 'a test activity',
826 'status_id' => 1,
827 'activity_name' => 'Test activity type',
828 'version' => $this->_apiversion,
829 'priority_id' => 1,
830 );
831 $activityOne = $this->callAPISuccess('Activity', 'Create', $params);
832 $params['activity_date_time'] = 20120216;
833 $activityTwo = $this->callAPISuccess('Activity', 'Create', $params);
834 $result = $this->callAPISuccess('Activity', 'Get', array(
835 'version' => 3,
836 ));
837 $description = "Demonstrates _low filter (at time of writing doesn't work if contact_id is set.";
838 $subfile = "DateTimeLow";
839 $this->assertEquals(2, $result['count']);
840 $params = array(
841 'version' => 3,
842 'filter.activity_date_time_low' => '20120101000000',
843 'sequential' => 1,
844 );
845 $result = $this->callAPIAndDocument('Activity', 'Get', $params, __FUNCTION__, __FILE__, $description, $subfile);
846 $this->assertEquals(1, $result['count']);
847 $description = "Demonstrates _high filter (at time of writing doesn't work if contact_id is set.";
848 $subfile = "DateTimeHigh";
849 $this->assertEquals('2012-02-16 00:00:00', $result['values'][0]['activity_date_time']);
850 $params = array(
851 'source_contact_id' => $this->_contactID,
852 'version' => 3,
853 'filter.activity_date_time_high' => '20120101000000',
854 'sequential' => 1,
855 );
856 $result = $this->callAPIAndDocument('Activity', 'Get', $params, __FUNCTION__, __FILE__, $description, $subfile);
857
858 $this->assertEquals(1, $result['count']);
859 $this->assertEquals('2011-01-01 00:00:00', $result['values'][0]['activity_date_time']);
860
861 $this->callAPISuccess('Activity', 'Delete', array('version' => 3, 'id' => $activityOne['id']));
862 $this->callAPISuccess('Activity', 'Delete', array('version' => 3, 'id' => $activityTwo['id']));
863 }
864
865 /**
866 * Test civicrm_activity_get() with a good activity ID which
867 * has associated custom data
868 */
869 public function testActivityGetGoodIDCustom() {
870 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
871
872 $params = $this->_params;
873 $params['custom_' . $ids['custom_field_id']] = "custom string";
874
875 $this->callAPISuccess($this->_entity, 'create', $params);
876
877 // Retrieve the test value.
878 $params = array(
879 'activity_type_id' => $this->test_activity_type_value,
880 'sequential' => 1,
881 'return.custom_' . $ids['custom_field_id'] => 1,
882 );
883 $result = $this->callAPIAndDocument('activity', 'get', $params, __FUNCTION__, __FILE__);
884 $this->assertEquals("custom string", $result['values'][0]['custom_' . $ids['custom_field_id']]);
885
886 $this->assertEquals($this->test_activity_type_value, $result['values'][0]['activity_type_id']);
887 $this->assertEquals('test activity type id', $result['values'][0]['subject']);
888 $this->customFieldDelete($ids['custom_field_id']);
889 $this->customGroupDelete($ids['custom_group_id']);
890 }
891
892 /**
893 * Test civicrm_activity_get() with a good activity ID which
894 * has associated custom data
895 */
896 public function testActivityGetContact_idCustom() {
897 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
898
899 $params = $this->_params;
900 $params['custom_' . $ids['custom_field_id']] = "custom string";
901
902 $result = $this->callAPISuccess($this->_entity, 'create', $params);
903 // Retrieve the test value
904 $params = array(
905 'contact_id' => $this->_params['source_contact_id'],
906 'activity_type_id' => $this->test_activity_type_value,
907 'sequential' => 1,
908 'return.custom_' . $ids['custom_field_id'] => 1,
909 );
910 $result = $this->callAPIAndDocument('activity', 'get', $params, __FUNCTION__, __FILE__);
911 $this->assertEquals("custom string", $result['values'][0]['custom_' . $ids['custom_field_id']], ' in line ' . __LINE__);
912
913 $this->assertEquals($this->test_activity_type_value, $result['values'][0]['activity_type_id']);
914 $this->assertEquals('test activity type id', $result['values'][0]['subject']);
915 $this->assertEquals($result['values'][0]['id'], $result['id']);
916 }
917
918 /**
919 * Check activity deletion with empty params.
920 */
921 public function testDeleteActivityForEmptyParams() {
922 $params = array('version' => $this->_apiversion);
923 $this->callAPIFailure('activity', 'delete', $params);
924 }
925
926 /**
927 * Check activity deletion without activity id.
928 */
929 public function testDeleteActivityWithoutId() {
930 $params = array(
931 'activity_name' => 'Meeting',
932 'version' => $this->_apiversion,
933 );
934 $result = $this->callAPIFailure('activity', 'delete', $params);
935 }
936
937 /**
938 * Check activity deletion without activity type.
939 */
940 public function testDeleteActivityWithoutActivityType() {
941 $params = array('id' => 1);
942 $result = $this->callAPIFailure('activity', 'delete', $params);
943 }
944
945 /**
946 * Check activity deletion with incorrect data.
947 */
948 public function testDeleteActivityWithIncorrectActivityType() {
949 $params = array(
950 'id' => 1,
951 'activity_name' => 'Test Activity',
952 );
953
954 $result = $this->callAPIFailure('activity', 'delete', $params);
955 }
956
957 /**
958 * Check activity deletion with correct data.
959 */
960 public function testDeleteActivity() {
961 $result = $this->callAPISuccess('activity', 'create', $this->_params);
962 $params = array(
963 'id' => $result['id'],
964 'version' => $this->_apiversion,
965 );
966
967 $this->callAPIAndDocument('activity', 'delete', $params, __FUNCTION__, __FILE__);
968 }
969
970 /**
971 * Check if required fields are not passed.
972 */
973 public function testActivityUpdateWithoutRequired() {
974 $params = array(
975 'subject' => 'this case should fail',
976 'scheduled_date_time' => date('Ymd'),
977 );
978
979 $result = $this->callAPIFailure('activity', 'create', $params);
980 }
981
982 /**
983 * Test civicrm_activity_update() with non-numeric id
984 */
985 public function testActivityUpdateWithNonNumericId() {
986 $params = array(
987 'id' => 'lets break it',
988 'activity_name' => 'Meeting',
989 'subject' => 'this case should fail',
990 'scheduled_date_time' => date('Ymd'),
991 );
992
993 $result = $this->callAPIFailure('activity', 'create', $params);
994 }
995
996 /**
997 * Check with incorrect required fields.
998 */
999 public function testActivityUpdateWithIncorrectContactActivityType() {
1000 $params = array(
1001 'id' => 1,
1002 'activity_name' => 'Test Activity',
1003 'subject' => 'this case should fail',
1004 'scheduled_date_time' => date('Ymd'),
1005 'source_contact_id' => $this->_contactID,
1006 );
1007
1008 $result = $this->callAPIFailure('activity', 'create', $params,
1009 'Invalid Activity Id');
1010 }
1011
1012 /**
1013 * Test civicrm_activity_update() to update an existing activity
1014 */
1015 public function testActivityUpdate() {
1016 $result = $this->callAPISuccess('activity', 'create', $this->_params);
1017 $this->_contactID2 = $this->individualCreate();
1018
1019 $params = array(
1020 'id' => $result['id'],
1021 'subject' => 'Make-it-Happen Meeting',
1022 'activity_date_time' => '20091011123456',
1023 'duration' => 120,
1024 'location' => '21, Park Avenue',
1025 'details' => 'Lets update Meeting',
1026 'status_id' => 1,
1027 'source_contact_id' => $this->_contactID,
1028 'assignee_contact_id' => $this->_contactID2,
1029 'priority_id' => 1,
1030 );
1031
1032 $result = $this->callAPISuccess('activity', 'create', $params);
1033 //hack on date comparison - really we should make getAndCheck smarter to handle dates
1034 $params['activity_date_time'] = '2009-10-11 12:34:56';
1035 // we also unset source_contact_id since it is stored in an aux table
1036 unset($params['source_contact_id']);
1037 //Check if assignee created.
1038 $assignee = $this->callAPISuccess('ActivityContact', 'get', array(
1039 'activity_id' => $result['id'],
1040 'return' => array("contact_id"),
1041 'record_type_id' => "Activity Assignees",
1042 ));
1043 $this->assertNotEmpty($assignee['values']);
1044
1045 //clear assignee contacts.
1046 $updateParams = array(
1047 'id' => $result['id'],
1048 'assignee_contact_id' => array(),
1049 );
1050 $activity = $this->callAPISuccess('activity', 'create', $updateParams);
1051 $assignee = $this->callAPISuccess('ActivityContact', 'get', array(
1052 'activity_id' => $activity['id'],
1053 'return' => array("contact_id"),
1054 'record_type_id' => "Activity Assignees",
1055 ));
1056 $this->assertEmpty($assignee['values']);
1057 $this->getAndCheck($params, $result['id'], 'activity');
1058 }
1059
1060 /**
1061 * Test civicrm_activity_update() with valid parameters
1062 * and some custom data
1063 */
1064 public function testActivityUpdateCustom() {
1065 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
1066
1067 $params = $this->_params;
1068
1069 // Create an activity with custom data
1070 //this has been updated from the previous 'old format' function - need to make it work
1071 $params = array(
1072 'source_contact_id' => $this->_contactID,
1073 'subject' => 'Make-it-Happen Meeting',
1074 'activity_date_time' => '2009-10-18',
1075 'duration' => 120,
1076 'location' => 'Pennsylvania',
1077 'details' => 'a test activity to check the update api',
1078 'status_id' => 1,
1079 'activity_name' => 'Test activity type',
1080 'version' => $this->_apiversion,
1081 'custom_' . $ids['custom_field_id'] => 'custom string',
1082 );
1083 $result = $this->callAPISuccess('activity', 'create', $params);
1084
1085 $activityId = $result['id'];
1086 $result = $this->callAPISuccess($this->_entity, 'get', array(
1087 'return.custom_' . $ids['custom_field_id'] => 1,
1088 'version' => 3,
1089 'id' => $result['id'],
1090 ));
1091 $this->assertEquals("custom string", $result['values'][$result['id']]['custom_' . $ids['custom_field_id']]);
1092 $this->assertEquals("2009-10-18 00:00:00", $result['values'][$result['id']]['activity_date_time']);
1093 $fields = $this->callAPISuccess('activity', 'getfields', array('version' => $this->_apiversion));
1094 $this->assertTrue(is_array($fields['values']['custom_' . $ids['custom_field_id']]));
1095
1096 // Update the activity with custom data.
1097 $params = array(
1098 'id' => $activityId,
1099 'source_contact_id' => $this->_contactID,
1100 'subject' => 'Make-it-Happen Meeting',
1101 'status_id' => 1,
1102 'activity_name' => 'Test activity type',
1103 // add this since dates are messed up
1104 'activity_date_time' => date('Ymd'),
1105 'custom_' . $ids['custom_field_id'] => 'Updated my test data',
1106 'version' => $this->_apiversion,
1107 );
1108 $result = $this->callAPISuccess('Activity', 'Create', $params);
1109
1110 $result = $this->callAPISuccess($this->_entity, 'get', array(
1111 'return.custom_' . $ids['custom_field_id'] => 1,
1112 'version' => 3,
1113 'id' => $result['id'],
1114 ));
1115 $this->assertEquals("Updated my test data", $result['values'][$result['id']]['custom_' . $ids['custom_field_id']]);
1116 }
1117
1118 /**
1119 * Test civicrm_activity_update() for core activity fields
1120 * and some custom data
1121 */
1122 public function testActivityUpdateCheckCoreFields() {
1123 $params = $this->_params;
1124 $contact1Params = array(
1125 'first_name' => 'John',
1126 'middle_name' => 'J.',
1127 'last_name' => 'Anderson',
1128 'prefix_id' => 3,
1129 'suffix_id' => 3,
1130 'email' => 'john_anderson@civicrm.org',
1131 'contact_type' => 'Individual',
1132 );
1133
1134 $contact1 = $this->individualCreate($contact1Params);
1135 $contact2Params = array(
1136 'first_name' => 'Michal',
1137 'middle_name' => 'J.',
1138 'last_name' => 'Anderson',
1139 'prefix_id' => 3,
1140 'suffix_id' => 3,
1141 'email' => 'michal_anderson@civicrm.org',
1142 'contact_type' => 'Individual',
1143 );
1144
1145 $contact2 = $this->individualCreate($contact2Params);
1146
1147 $params['assignee_contact_id'] = array($contact1, $contact2);
1148 $params['target_contact_id'] = array($contact2 => $contact2);
1149 $result = $this->callAPISuccess('Activity', 'Create', $params);
1150
1151 $activityId = $result['id'];
1152 $getParams = array(
1153 'return.assignee_contact_id' => 1,
1154 'return.target_contact_id' => 1,
1155 'version' => $this->_apiversion,
1156 'id' => $activityId,
1157 );
1158 $result = $this->callAPISuccess($this->_entity, 'get', $getParams);
1159 $assignee = $result['values'][$result['id']]['assignee_contact_id'];
1160 $target = $result['values'][$result['id']]['target_contact_id'];
1161 $this->assertEquals(2, count($assignee), ' in line ' . __LINE__);
1162 $this->assertEquals(1, count($target), ' in line ' . __LINE__);
1163 $this->assertEquals(TRUE, in_array($contact1, $assignee), ' in line ' . __LINE__);
1164 $this->assertEquals(TRUE, in_array($contact2, $target), ' in line ' . __LINE__);
1165
1166 $contact3Params = array(
1167 'first_name' => 'Jijo',
1168 'middle_name' => 'J.',
1169 'last_name' => 'Anderson',
1170 'prefix_id' => 3,
1171 'suffix_id' => 3,
1172 'email' => 'jijo_anderson@civicrm.org',
1173 'contact_type' => 'Individual',
1174 );
1175
1176 $contact4Params = array(
1177 'first_name' => 'Grant',
1178 'middle_name' => 'J.',
1179 'last_name' => 'Anderson',
1180 'prefix_id' => 3,
1181 'suffix_id' => 3,
1182 'email' => 'grant_anderson@civicrm.org',
1183 'contact_type' => 'Individual',
1184 );
1185
1186 $contact3 = $this->individualCreate($contact3Params);
1187 $contact4 = $this->individualCreate($contact4Params);
1188
1189 $params = array();
1190 $params['id'] = $activityId;
1191 $params['assignee_contact_id'] = array($contact3 => $contact3);
1192 $params['target_contact_id'] = array($contact4 => $contact4);
1193
1194 $result = $this->callAPISuccess('activity', 'create', $params);
1195
1196 $this->assertEquals($activityId, $result['id'], ' in line ' . __LINE__);
1197
1198 $result = $this->callAPISuccess(
1199 $this->_entity,
1200 'get',
1201 array(
1202 'return.assignee_contact_id' => 1,
1203 'return.target_contact_id' => 1,
1204 'return.source_contact_id' => 1,
1205 'id' => $result['id'],
1206 )
1207 );
1208
1209 $assignee = $result['values'][$result['id']]['assignee_contact_id'];
1210 $target = $result['values'][$result['id']]['target_contact_id'];
1211
1212 $this->assertEquals(1, count($assignee), ' in line ' . __LINE__);
1213 $this->assertEquals(1, count($target), ' in line ' . __LINE__);
1214 $this->assertEquals(TRUE, in_array($contact3, $assignee), ' in line ' . __LINE__);
1215 $this->assertEquals(TRUE, in_array($contact4, $target), ' in line ' . __LINE__);
1216 $this->_params['activity_type_id'] = $this->test_activity_type_value;
1217 foreach ($this->_params as $fld => $val) {
1218 $this->assertEquals($val, $result['values'][$result['id']][$fld]);
1219 }
1220 }
1221
1222 /**
1223 * Test civicrm_activity_update() where the DB has a date_time
1224 * value and there is none in the update params.
1225 */
1226 public function testActivityUpdateNotDate() {
1227 $result = $this->callAPISuccess('activity', 'create', $this->_params);
1228
1229 $params = array(
1230 'id' => $result['id'],
1231 'subject' => 'Make-it-Happen Meeting',
1232 'duration' => 120,
1233 'location' => '21, Park Avenue',
1234 'details' => 'Lets update Meeting',
1235 'status_id' => 1,
1236 'source_contact_id' => $this->_contactID,
1237 'priority_id' => 1,
1238 );
1239
1240 $result = $this->callAPISuccess('activity', 'create', $params);
1241 //hack on date comparison - really we should make getAndCheck smarter to handle dates
1242 $params['activity_date_time'] = $this->_params['activity_date_time'];
1243 // we also unset source_contact_id since it is stored in an aux table
1244 unset($params['source_contact_id']);
1245 $this->getAndCheck($params, $result['id'], 'activity');
1246 }
1247
1248 /**
1249 * Check activity update with status.
1250 */
1251 public function testActivityUpdateWithStatus() {
1252 $activity = $this->callAPISuccess('activity', 'create', $this->_params);
1253 $params = array(
1254 'id' => $activity['id'],
1255 'source_contact_id' => $this->_contactID,
1256 'subject' => 'Hurry update works',
1257 'status_id' => 1,
1258 'activity_name' => 'Test activity type',
1259 );
1260
1261 $result = $this->callAPISuccess('activity', 'create', $params);
1262 $this->assertEquals($result['id'], $activity['id']);
1263 $this->assertEquals($result['values'][$activity['id']]['subject'], 'Hurry update works');
1264 $this->assertEquals($result['values'][$activity['id']]['status_id'], 1
1265 );
1266 }
1267
1268 /**
1269 * Test civicrm_activity_update() where the source_contact_id
1270 * is not in the update params.
1271 */
1272 public function testActivityUpdateKeepSource() {
1273 $activity = $this->callAPISuccess('activity', 'create', $this->_params);
1274 // Updating the activity but not providing anything for the source contact
1275 // (It was set as $this->_contactID earlier.)
1276 $params = array(
1277 'id' => $activity['id'],
1278 'subject' => 'Updated Make-it-Happen Meeting',
1279 'duration' => 120,
1280 'location' => '21, Park Avenue',
1281 'details' => 'Lets update Meeting',
1282 'status_id' => 1,
1283 'activity_name' => 'Test activity type',
1284 'priority_id' => 1,
1285 );
1286
1287 $result = $this->callAPISuccess('activity', 'create', $params);
1288 $findactivity = $this->callAPISuccess('Activity', 'Get', array('id' => $activity['id']));
1289 }
1290
1291 /**
1292 * Test civicrm_activities_contact_get()
1293 */
1294 public function testActivitiesContactGet() {
1295 $activity = $this->callAPISuccess('activity', 'create', $this->_params);
1296 $activity2 = $this->callAPISuccess('activity', 'create', $this->_params2);
1297 // Get activities associated with contact $this->_contactID.
1298 $params = array(
1299 'contact_id' => $this->_contactID,
1300 );
1301 $result = $this->callAPISuccess('activity', 'get', $params);
1302
1303 $this->assertEquals(2, $result['count']);
1304 $this->assertEquals($this->test_activity_type_value, $result['values'][$activity['id']]['activity_type_id']);
1305 $this->assertEquals('Test activity type', $result['values'][$activity['id']]['activity_name']);
1306 $this->assertEquals('Test activity type', $result['values'][$activity2['id']]['activity_name']);
1307 }
1308
1309 /**
1310 * Test chained Activity format.
1311 */
1312 public function testChainedActivityGet() {
1313
1314 $activity = $this->callAPISuccess('Contact', 'Create', array(
1315 'display_name' => "bob brown",
1316 'contact_type' => 'Individual',
1317 'api.activity_type.create' => array(
1318 'weight' => '2',
1319 'label' => 'send out letters',
1320 'filter' => 0,
1321 'is_active' => 1,
1322 'is_optgroup' => 1,
1323 'is_default' => 0,
1324 ),
1325 'api.activity.create' => array(
1326 'subject' => 'send letter',
1327 'activity_type_id' => '$value.api.activity_type.create.values.0.value',
1328 ),
1329 ));
1330
1331 $result = $this->callAPISuccess('Activity', 'Get', array(
1332 'id' => $activity['id'],
1333 'return.assignee_contact_id' => 1,
1334 'api.contact.get' => array('api.pledge.get' => 1),
1335 ));
1336 }
1337
1338 /**
1339 * Test civicrm_activity_contact_get() with invalid Contact ID.
1340 */
1341 public function testActivitiesContactGetWithInvalidContactId() {
1342 $params = array('contact_id' => 'contact');
1343 $this->callAPIFailure('activity', 'get', $params);
1344 }
1345
1346 /**
1347 * Test civicrm_activity_contact_get() with contact having no Activity.
1348 */
1349 public function testActivitiesContactGetHavingNoActivity() {
1350 $params = array(
1351 'first_name' => 'dan',
1352 'last_name' => 'conberg',
1353 'email' => 'dan.conberg@w.co.in',
1354 'contact_type' => 'Individual',
1355 );
1356
1357 $contact = $this->callAPISuccess('contact', 'create', $params);
1358 $params = array(
1359 'contact_id' => $contact['id'],
1360 );
1361 $result = $this->callAPISuccess('activity', 'get', $params);
1362 $this->assertEquals($result['count'], 0);
1363 }
1364
1365 /**
1366 * Test getfields function.
1367 */
1368 public function testGetFields() {
1369 $params = array('action' => 'create');
1370 $result = $this->callAPIAndDocument('activity', 'getfields', $params, __FUNCTION__, __FILE__, NULL, NULL);
1371 $this->assertTrue(is_array($result['values']), 'get fields doesn\'t return values array');
1372 foreach ($result['values'] as $key => $value) {
1373 $this->assertTrue(is_array($value), $key . " is not an array");
1374 }
1375 }
1376
1377 /**
1378 * Test or operator in api params
1379 */
1380 public function testGetWithOr() {
1381 $acts = array(
1382 'test or 1' => 'orOperator',
1383 'test or 2' => 'orOperator',
1384 'test or 3' => 'nothing',
1385 );
1386 foreach ($acts as $subject => $details) {
1387 $params = $this->_params;
1388 $params['subject'] = $subject;
1389 $params['details'] = $details;
1390 $this->callAPISuccess('Activity', 'create', $params);
1391 }
1392 $result = $this->callAPISuccess('Activity', 'get', array(
1393 'details' => 'orOperator',
1394 ));
1395 $this->assertEquals(2, $result['count']);
1396 $result = $this->callAPISuccess('Activity', 'get', array(
1397 'details' => 'orOperator',
1398 'subject' => 'test or 3',
1399 ));
1400 $this->assertEquals(0, $result['count']);
1401 $result = $this->callAPISuccess('Activity', 'get', array(
1402 'details' => 'orOperator',
1403 'subject' => 'test or 3',
1404 'options' => array('or' => array(array('details', 'subject'))),
1405 ));
1406 $this->assertEquals(3, $result['count']);
1407 }
1408
1409 /**
1410 * Test handling of is_overdue calculated field
1411 */
1412 public function testGetOverdue() {
1413 $overdueAct = $this->callAPISuccess('Activity', 'create', array(
1414 'activity_date_time' => 'now - 1 week',
1415 'status_id' => 'Scheduled',
1416 ) + $this->_params
1417 );
1418 $completedAct = $this->callAPISuccess('Activity', 'create', array(
1419 'activity_date_time' => 'now - 1 week',
1420 'status_id' => 'Completed',
1421 ) + $this->_params
1422 );
1423 $ids = array($overdueAct['id'], $completedAct['id']);
1424
1425 // Test sorting
1426 $completedFirst = $this->callAPISuccess('Activity', 'get', array(
1427 'id' => array('IN' => $ids),
1428 'options' => array('sort' => 'is_overdue ASC'),
1429 ));
1430 $this->assertEquals(array_reverse($ids), array_keys($completedFirst['values']));
1431 $overdueFirst = $this->callAPISuccess('Activity', 'get', array(
1432 'id' => array('IN' => $ids),
1433 'options' => array('sort' => 'is_overdue DESC'),
1434 'return' => 'is_overdue',
1435 ));
1436 $this->assertEquals($ids, array_keys($overdueFirst['values']));
1437
1438 // Test return value
1439 $this->assertEquals(1, $overdueFirst['values'][$overdueAct['id']]['is_overdue']);
1440 $this->assertEquals(0, $overdueFirst['values'][$completedAct['id']]['is_overdue']);
1441
1442 // Test filtering
1443 $onlyOverdue = $this->callAPISuccess('Activity', 'get', array(
1444 'id' => array('IN' => $ids),
1445 'is_overdue' => 1,
1446 ));
1447 $this->assertEquals(array($overdueAct['id']), array_keys($onlyOverdue['values']));
1448 }
1449
1450 }