3 * File for the TestContact class
7 * @author Walt Haas <walt@dharmatech.org> (801) 534-1262
8 * @copyright Copyright CiviCRM LLC (C) 2009
9 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html
10 * GNU Affero General Public License version 3
11 * @version $Id: ContactTest.php 31254 2010-12-15 10:09:29Z eileen $
14 * This file is part of CiviCRM
16 * CiviCRM is free software; you can redistribute it and/or
17 * modify it under the terms of the GNU Affero General Public License
18 * as published by the Free Software Foundation; either version 3 of
19 * the License, or (at your option) any later version.
21 * CiviCRM is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU Affero General Public License for more details.
26 * You should have received a copy of the GNU Affero General Public
27 * License along with this program. If not, see
28 * <http://www.gnu.org/licenses/>.
32 * Include class definitions
34 require_once 'CiviTest/CiviUnitTestCase.php';
38 * Test APIv3 civicrm_contact* functions
40 * @package CiviCRM_APIv3
41 * @subpackage API_Contact
44 class api_v3_ContactTest
extends CiviUnitTestCase
{
45 public $DBResetRequired = FALSE;
46 protected $_apiversion;
50 protected $_contactID;
51 protected $_financialTypeId =1;
56 * Initialize configuration
58 function __construct() {
59 parent
::__construct();
63 * Test setup for every test
65 * Connect to the database, truncate the tables that will be used
66 * and redirect stdin to a temporary file
68 public function setUp() {
69 // Connect to the database
71 $this->_apiversion
= 3;
72 $this->_entity
= 'contact';
73 $this->_params
= array(
74 'first_name' => 'abc1',
75 'contact_type' => 'Individual',
76 'last_name' => 'xyz1',
81 // truncate a few tables
82 $tablesToTruncate = array(
85 'civicrm_contribution',
88 'civicrm_relationship',
93 $this->quickCleanup($tablesToTruncate, TRUE);
97 * Test civicrm_contact_create
99 * Verify that attempt to create individual contact with only
100 * first and last names succeeds
102 function testAddCreateIndividual() {
103 $oldCount = CRM_Core_DAO
::singleValueQuery('select count(*) from civicrm_contact');
105 'first_name' => 'abc1',
106 'contact_type' => 'Individual',
107 'last_name' => 'xyz1',
110 $contact = $this->callAPISuccess('contact', 'create', $params);
111 $this->assertTrue(is_numeric($contact['id']), "In line " . __LINE__
);
112 $this->assertTrue($contact['id'] > 0, "In line " . __LINE__
);
113 $newCount = CRM_Core_DAO
::singleValueQuery('select count(*) from civicrm_contact');
114 $this->assertEquals($oldCount+
1, $newCount);
116 $this->assertDBState('CRM_Contact_DAO_Contact',
123 * Test civicrm_contact_create with sub-types
125 * Verify that sub-types are created successfully and not deleted by subsequent updates
127 function testIndividualSubType() {
129 'first_name' => 'test abc',
130 'contact_type' => 'Individual',
131 'last_name' => 'test xyz',
132 'contact_sub_type' => array('Student', 'Staff'),
134 $contact = $this->callAPISuccess('contact', 'create', $params);
135 $cid = $contact['id'];
139 'middle_name' => 'foo',
141 $this->callAPISuccess('contact', 'create', $params);
142 unset($params['middle_name']);
144 $contact = $this->callAPISuccess('contact', 'get', $params);
146 $this->assertEquals(array('Student', 'Staff'), $contact['values'][$cid]['contact_sub_type'], "In line " . __LINE__
);
150 * Verify that attempt to create contact with empty params fails
152 function testCreateEmptyContact() {
153 $this->callAPIFailure('contact', 'create', array());
157 * Verify that attempt to create contact with bad contact type fails
159 function testCreateBadTypeContact() {
161 'email' => 'man1@yahoo.com',
162 'contact_type' => 'Does not Exist',
164 $result = $this->callAPIFailure('contact', 'create', $params,"'Does not Exist' is not a valid option for field contact_type");
168 * Verify that attempt to create individual contact with required
169 * fields missing fails
171 function testCreateBadRequiredFieldsIndividual() {
173 'middle_name' => 'This field is not required',
174 'contact_type' => 'Individual',
177 $contact = $this->callAPIFailure('contact', 'create', $params);
181 * Verify that attempt to create household contact with required
182 * fields missing fails
184 function testCreateBadRequiredFieldsHousehold() {
186 'middle_name' => 'This field is not required',
187 'contact_type' => 'Household',
189 $contact = $this->callAPIFailure('contact', 'create', $params);
193 * Verify that attempt to create organization contact with
194 * required fields missing fails
196 function testCreateBadRequiredFieldsOrganization() {
198 'middle_name' => 'This field is not required',
199 'contact_type' => 'Organization',
202 $contact = $this->callAPIFailure('contact', 'create', $params);
206 * Verify that attempt to create individual contact with only an
209 function testCreateEmailIndividual() {
212 'email' => 'man3@yahoo.com',
213 'contact_type' => 'Individual',
214 'location_type_id' => 1,
217 $contact = $this->callAPISuccess('contact', 'create', $params);
219 $this->assertEquals(1, $contact['id'], "In line " . __LINE__
);
220 $email = $this->callAPISuccess('email', 'get', array('contact_id' => $contact['id']));
221 $this->assertEquals(1, $email['count']);
222 $this->assertEquals('man3@yahoo.com', $email['values'][$email['id']]['email']);
224 $this->callAPISuccess('contact', 'delete', $contact);
228 * Verify that attempt to create individual contact with only
229 * first and last names succeeds
231 function testCreateNameIndividual() {
233 'first_name' => 'abc1',
234 'contact_type' => 'Individual',
235 'last_name' => 'xyz1',
238 $contact = $this->callAPISuccess('contact', 'create', $params);
239 $this->assertEquals(1, $contact['id']);
243 * Verify that attempt to create individual contact with
244 * first and last names and old key values works
246 function testCreateNameIndividualOldKeys() {
248 'individual_prefix' => 'Dr.',
249 'first_name' => 'abc1',
250 'contact_type' => 'Individual',
251 'last_name' => 'xyz1',
252 'individual_suffix' => 'Jr.',
255 $contact = $this->callAPISuccess('contact', 'create', $params);
256 $result = $this->callAPISuccess('contact', 'getsingle', array('id' => $contact['id']));
258 $this->assertArrayKeyExists('prefix_id', $result);
259 $this->assertArrayKeyExists('suffix_id', $result);
260 $this->assertArrayKeyExists('gender_id', $result);
261 $this->assertEquals(4, $result['prefix_id']);
262 $this->assertEquals(1, $result['suffix_id']);
266 * Verify that attempt to create individual contact with
267 * first and last names and old key values works
269 function testCreateNameIndividualrecommendedKeys2() {
271 'prefix_id' => 'Dr.',
272 'first_name' => 'abc1',
273 'contact_type' => 'Individual',
274 'last_name' => 'xyz1',
275 'suffix_id' => 'Jr.',
276 'gender_id' => 'Male',
279 $contact = $this->callAPISuccess('contact', 'create', $params);
280 $result = $this->callAPISuccess('contact', 'getsingle', array('id' => $contact['id']));
282 $this->assertArrayKeyExists('prefix_id', $result);
283 $this->assertArrayKeyExists('suffix_id', $result);
284 $this->assertArrayKeyExists('gender_id', $result);
285 $this->assertEquals(4, $result['prefix_id']);
286 $this->assertEquals(1, $result['suffix_id']);
290 * Verify that attempt to create household contact with only
291 * household name succeeds
293 function testCreateNameHousehold() {
295 'household_name' => 'The abc Household',
296 'contact_type' => 'Household',
298 $contact = $this->callAPISuccess('contact', 'create', $params);
299 $this->assertEquals(1, $contact['id'], "In line " . __LINE__
);
303 * Verify that attempt to create organization contact with only
304 * organization name succeeds
306 function testCreateNameOrganization() {
308 'organization_name' => 'The abc Organization',
309 'contact_type' => 'Organization',
311 $contact = $this->callAPISuccess('contact', 'create', $params);
312 $this->assertEquals(1, $contact['id']);
315 * Verify that attempt to create organization contact without organization name fails
317 function testCreateNoNameOrganization() {
319 'first_name' => 'The abc Organization',
320 'contact_type' => 'Organization',
322 $result = $this->callAPIFailure('contact', 'create', $params);
325 * check with complete array + custom field
326 * Note that the test is written on purpose without any
327 * variables specific to participant so it can be replicated into other entities
328 * and / or moved to the automated test suite
330 function testCreateWithCustom() {
331 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__
, __FILE__
);
333 $params = $this->_params
;
334 $params['custom_' . $ids['custom_field_id']] = "custom string";
335 $description = "/*this demonstrates setting a custom field through the API ";
336 $subfile = "CustomFieldCreate";
337 $result = $this->callAPIAndDocument($this->_entity
, 'create', $params, __FUNCTION__
, __FILE__
, $description);
339 $check = $this->callAPISuccess($this->_entity
, 'get', array('return.custom_' . $ids['custom_field_id'] => 1, 'id' => $result['id']));
340 $this->assertEquals("custom string", $check['values'][$check['id']]['custom_' . $ids['custom_field_id']], ' in line ' . __LINE__
);
342 $this->customFieldDelete($ids['custom_field_id']);
343 $this->customGroupDelete($ids['custom_group_id']);
347 * CRM-12773 - expectation is that civicrm quietly ignores
348 * fields without values
350 function testCreateWithNULLCustomCRM12773() {
351 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__
, __FILE__
);
352 $params = $this->_params
;
353 $params['custom_' . $ids['custom_field_id']] = NULL;
354 $result = $this->callAPISuccess('contact', 'create', $params);
355 $this->customFieldDelete($ids['custom_field_id']);
356 $this->customGroupDelete($ids['custom_group_id']);
361 * Test creating a current employer through API
363 function testContactCreateCurrentEmployer(){
364 //here we will just do the get for set-up purposes
365 $count = $this->callAPISuccess('contact', 'getcount', array(
366 'organization_name' => 'new employer org',
367 'contact_type' => 'Organization'
369 $this->assertEquals(0, $count);
370 $employerResult = $this->callAPISuccess('contact', 'create', array_merge($this->_params
, array(
371 'current_employer' => 'new employer org',)
373 // do it again as an update to check it doesn't cause an error
374 $employerResult = $this->callAPISuccess('contact', 'create', array_merge($this->_params
, array(
375 'current_employer' => 'new employer org', 'id' => $employerResult['id'])
378 $count = $this->callAPISuccess('contact', 'getcount', array(
379 'organization_name' => 'new employer org',
380 'contact_type' => 'Organization'
384 $result = $this->callAPISuccess('contact', 'getsingle', array(
385 'id' => $employerResult['id'],
388 $this->assertEquals('new employer org', $result['current_employer']);
392 * Test creating a current employer through API
393 * - check it will re-activate a de-activated employer
395 function testContactCreateDuplicateCurrentEmployerEnables(){
396 //set up - create employer relationship
397 $employerResult = $this->callAPISuccess('contact', 'create', array_merge($this->_params
, array(
398 'current_employer' => 'new employer org',)
400 $relationship = $this->callAPISuccess('relationship','get', array(
401 'contact_id_a' => $employerResult['id'],
404 //disable & check it is disabled
405 $this->callAPISuccess('relationship', 'create', array('id' => $relationship['id'], 'is_active' => 0));
406 $relationship = $this->callAPISuccess('relationship','getvalue', array(
407 'id' => $relationship['id'],
408 'return' => 'is_active'
411 //re-set the current employer - thus enabling the relationshp
412 $employerResult = $this->callAPISuccess('contact', 'create', array_merge($this->_params
, array(
413 'current_employer' => 'new employer org', 'id' => $employerResult['id'])
415 //check is_active is now 1
416 $relationship = $this->callAPISuccess('relationship','getsingle', array(
417 'return' => 'is_active',));
418 $this->assertEquals(1, $relationship['is_active']);
422 * Check deceased contacts are not retrieved
423 * Note at time of writing the default is to return default. This should possibly be changed & test added
426 function testGetDeceasedRetrieved() {
427 $c1 = $this->callAPISuccess($this->_entity
, 'create', $this->_params
);
428 $c2 = $this->callAPISuccess($this->_entity
, 'create', array('first_name' => 'bb', 'last_name' => 'ccc', 'contact_type' => 'Individual', 'is_deceased' => 1));
429 $result = $this->callAPISuccess($this->_entity
, 'get', array('is_deceased' => 0));
430 $this->assertFalse(array_key_exists($c2['id'], $result['values']));
434 * Test that sort works - old syntax
436 function testGetSort() {
437 $c1 = $this->callAPISuccess($this->_entity
, 'create', $this->_params
);
438 $c2 = $this->callAPISuccess($this->_entity
, 'create', array('first_name' => 'bb', 'last_name' => 'ccc', 'contact_type' => 'Individual'));
439 $result = $this->callAPISuccess($this->_entity
, 'get', array(
440 'sort' => 'first_name ASC',
441 'return.first_name' => 1,
446 $this->assertEquals('abc1', $result['values'][0]['first_name']);
447 $result = $this->callAPISuccess($this->_entity
, 'get', array(
448 'sort' => 'first_name DESC',
449 'return.first_name' => 1,
453 $this->assertEquals('bb', $result['values'][0]['first_name']);
455 $this->callAPISuccess($this->_entity
, 'delete', array('id' => $c1['id']));
456 $this->callAPISuccess($this->_entity
, 'delete', array('id' => $c2['id']));
459 * Test that we can retrieve contacts using
460 * 'id' => array('IN' => array('3,4')) syntax
462 function testGetINIDArray() {
463 $c1 = $this->callAPISuccess($this->_entity
, 'create', $this->_params
);
464 $c2 = $this->callAPISuccess($this->_entity
, 'create', array('first_name' => 'bb', 'last_name' => 'ccc', 'contact_type' => 'Individual'));
465 $c3 = $this->callAPISuccess($this->_entity
, 'create', array('first_name' => 'hh', 'last_name' => 'll', 'contact_type' => 'Individual'));
466 $result = $this->callAPISuccess($this->_entity
, 'get', array('id' => array('IN' => array($c1['id'], $c3['id']))));
467 $this->assertEquals(2, $result['count']);
468 $this->assertEquals(array($c1['id'], $c3['id']), array_keys($result['values']));
469 $this->callAPISuccess($this->_entity
, 'delete', array('id' => $c1['id']));
470 $this->callAPISuccess($this->_entity
, 'delete', array('id' => $c2['id']));
471 $this->callAPISuccess($this->_entity
, 'delete', array('id' => $c3['id']));
474 * Test variants on deleted behaviour
476 function testGetDeleted() {
477 $params = $this->_params
;
478 $contact1 = $this->callAPISuccess('contact', 'create', $params);
479 $params['is_deleted'] = 1;
480 $params['last_name'] = 'bcd';
481 $contact2 = $this->callAPISuccess('contact', 'create', $params);
482 $countActive = $this->callAPISuccess('contact', 'getcount', array('showAll' => 'active'));
483 $countAll = $this->callAPISuccess('contact', 'getcount', array('showAll' => 'all'));
484 $countTrash = $this->callAPISuccess('contact', 'getcount', array('showAll' => 'trash'));
485 $countDefault = $this->callAPISuccess('contact', 'getcount', array());
486 $countDeleted = $this->callAPISuccess('contact', 'getcount', array(
487 'contact_is_deleted' => 1,
489 $countNotDeleted = $this->callAPISuccess('contact', 'getcount', array(
490 'contact_is_deleted' => 0,
492 $this->callAPISuccess('contact', 'delete', array('id' => $contact1['id']));
493 $this->callAPISuccess('contact', 'delete', array('id' => $contact2['id']));
494 $this->assertEquals(1, $countNotDeleted, 'contact_is_deleted => 0 is respected in line ' . __LINE__
);
495 $this->assertEquals(1, $countActive, 'in line ' . __LINE__
);
496 $this->assertEquals(1, $countTrash, 'in line ' . __LINE__
);
497 $this->assertEquals(2, $countAll, 'in line ' . __LINE__
);
498 $this->assertEquals(1, $countDeleted, 'in line ' . __LINE__
);
499 $this->assertEquals(1, $countDefault, 'Only active by default in line ' . __LINE__
);
502 * Test that sort works - new syntax
504 function testGetSortNewSYntax() {
505 $c1 = $this->callAPISuccess($this->_entity
, 'create', $this->_params
);
506 $c2 = $this->callAPISuccess($this->_entity
, 'create', array('first_name' => 'bb', 'last_name' => 'ccc', 'contact_type' => 'Individual'));
507 $result = $this->callAPISuccess($this->_entity
, 'getvalue', array(
508 'return' => 'first_name',
511 'sort' => 'first_name',
514 $this->assertEquals('abc1', $result, 'in line' . __LINE__
);
516 $result = $this->callAPISuccess($this->_entity
, 'getvalue', array(
517 'return' => 'first_name',
520 'sort' => 'first_name DESC',
523 $this->assertEquals('bb', $result);
525 $this->callAPISuccess($this->_entity
, 'delete', array('id' => $c1['id']));
526 $this->callAPISuccess($this->_entity
, 'delete', array('id' => $c2['id']));
529 * Test appostrophe works in get & create
531 function testGetAppostropheCRM10857() {
532 $params = array_merge($this->_params
, array('last_name' => "O'Connor"));
533 $contact = $this->callAPISuccess($this->_entity
, 'create', $params);
534 $result = $this->callAPISuccess($this->_entity
, 'getsingle', array(
535 'last_name' => "O'Connor",
538 $this->assertEquals("O'Connor", $result['last_name'], 'in line' . __LINE__
);
542 * check with complete array + custom field
543 * Note that the test is written on purpose without any
544 * variables specific to participant so it can be replicated into other entities
545 * and / or moved to the automated test suite
547 function testGetWithCustom() {
548 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__
, __FILE__
);
550 $params = $this->_params
;
551 $params['custom_' . $ids['custom_field_id']] = "custom string";
552 $description = "/*this demonstrates setting a custom field through the API ";
553 $subfile = "CustomFieldGet";
554 $result = $this->callAPISuccess($this->_entity
, 'create', $params);
556 $check = $this->callAPIAndDocument($this->_entity
, 'get', array('return.custom_' . $ids['custom_field_id'] => 1, 'id' => $result['id']), __FUNCTION__
, __FILE__
, $description, $subfile);
558 $this->assertEquals("custom string", $check['values'][$check['id']]['custom_' . $ids['custom_field_id']], ' in line ' . __LINE__
);
559 $fields = ($this->callAPISuccess('contact', 'getfields', $params));
560 $this->assertTrue(is_array($fields['values']['custom_' . $ids['custom_field_id']]));
561 $this->customFieldDelete($ids['custom_field_id']);
562 $this->customGroupDelete($ids['custom_group_id']);
565 * check with complete array + custom field
566 * Note that the test is written on purpose without any
567 * variables specific to participant so it can be replicated into other entities
568 * and / or moved to the automated test suite
570 function testGetWithCustomReturnSyntax() {
571 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__
, __FILE__
);
573 $params = $this->_params
;
574 $params['custom_' . $ids['custom_field_id']] = "custom string";
575 $description = "/*this demonstrates setting a custom field through the API ";
576 $subfile = "CustomFieldGetReturnSyntaxVariation";
577 $result = $this->callAPISuccess($this->_entity
, 'create', $params);
578 $params = array('return' => 'custom_' . $ids['custom_field_id'], 'id' => $result['id']);
579 $check = $this->callAPIAndDocument($this->_entity
, 'get', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
581 $this->assertEquals("custom string", $check['values'][$check['id']]['custom_' . $ids['custom_field_id']]);
582 $this->customFieldDelete($ids['custom_field_id']);
583 $this->customGroupDelete($ids['custom_group_id']);
587 * Check that address name is returned if required
589 function testGetReturnAddressName () {
590 $contactID = $this->individualCreate();
591 $this->callAPISuccess('address', 'create', array('contact_id' => $contactID, 'address_name' => 'My house', 'location_type_id' => 'Home', 'street_address' => '1 my road'));
592 $result = $this->callAPISuccessGetSingle('contact', array('return' => 'address_name, street_address', 'id' => $contactID));
593 $this->assertEquals('1 my road', $result['street_address']);
594 $this->assertEquals('My house', $result['address_name']);
598 function testGetGroupIDFromContact() {
599 $groupId = $this->groupCreate();
600 $description = "Get all from group and display contacts";
601 $subfile = "GroupFilterUsingContactAPI";
603 'email' => 'man2@yahoo.com',
604 'contact_type' => 'Individual',
605 'location_type_id' => 1,
606 'api.group_contact.create' => array('group_id' => $groupId),
609 $contact = $this->callAPISuccess('contact', 'create', $params);
610 // testing as integer
612 'filter.group_id' => $groupId,
613 'contact_type' => 'Individual',
615 $result = $this->callAPIAndDocument('contact', 'get', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
616 $this->assertEquals(1, $result['count']);
617 // group 26 doesn't exist, but we can still search contacts in it.
619 'filter.group_id' => 26,
620 'contact_type' => 'Individual',
622 $result = $this->callAPISuccess('contact', 'get', $params);
625 'filter.group_id' => "$groupId, 26",
626 'contact_type' => 'Individual',
628 $result = $this->callAPIAndDocument('contact', 'get', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
629 $this->assertEquals(1, $result['count']);
631 'filter.group_id' => "26,27",
632 'contact_type' => 'Individual',
634 $result = $this->callAPISuccess('contact', 'get', $params);
637 $params = array('filter.group_id' => array($groupId, 26),
638 'contact_type' => 'Individual',
640 $result = $this->callAPIAndDocument('contact', 'get', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
641 $this->assertEquals(1, $result['count']);
643 //test in conjunction with other criteria
644 $params = array('filter.group_id' => array($groupId, 26),
645 'contact_type' => 'Organization',
647 $result = $this->callAPISuccess('contact', 'get', $params);
648 $params = array('filter.group_id' => array(26, 27),
649 'contact_type' => 'Individual',
651 $result = $this->callAPISuccess('contact', 'get', $params);
652 $this->assertEquals(0, $result['count'], " in line " . __LINE__
);
656 * Verify that attempt to create individual contact with two chained websites succeeds
658 function testCreateIndividualWithContributionDottedSyntax() {
659 $description = "test demonstrates the syntax to create 2 chained entities";
660 $subfile = "ChainTwoWebsites";
662 'first_name' => 'abc3',
663 'last_name' => 'xyz3',
664 'contact_type' => 'Individual',
665 'email' => 'man3@yahoo.com',
666 'api.contribution.create' => array(
667 'receive_date' => '2010-01-01',
668 'total_amount' => 100.00,
669 'financial_type_id' => $this->_financialTypeId
,
670 'payment_instrument_id' => 1,
671 'non_deductible_amount' => 10.00,
672 'fee_amount' => 50.00,
673 'net_amount' => 90.00,
675 'invoice_id' => 67990,
677 'contribution_status_id' => 1,
679 'api.website.create' => array(
680 'url' => "http://civicrm.org",
682 'api.website.create.2' => array(
683 'url' => "http://chained.org",
687 $result = $this->callAPIAndDocument('Contact', 'create', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
689 $this->assertEquals(1, $result['id'], "In line " . __LINE__
);
690 // checking child function result not covered in callAPIAndDocument
691 $this->assertAPISuccess($result['values'][$result['id']]['api.website.create']);
692 $this->assertEquals("http://chained.org", $result['values'][$result['id']]['api.website.create.2']['values'][0]['url'], "In line " . __LINE__
);
693 $this->assertEquals("http://civicrm.org", $result['values'][$result['id']]['api.website.create']['values'][0]['url'], "In line " . __LINE__
);
695 // delete the contact
696 $this->callAPISuccess('contact', 'delete', $result);
700 * Verify that attempt to create individual contact with chained contribution and website succeeds
702 function testCreateIndividualWithContributionChainedArrays() {
704 'first_name' => 'abc3',
705 'last_name' => 'xyz3',
706 'contact_type' => 'Individual',
707 'email' => 'man3@yahoo.com',
708 'api.contribution.create' => array(
709 'receive_date' => '2010-01-01',
710 'total_amount' => 100.00,
711 'financial_type_id' => $this->_financialTypeId
,
712 'payment_instrument_id' => 1,
713 'non_deductible_amount' => 10.00,
714 'fee_amount' => 50.00,
715 'net_amount' => 90.00,
717 'invoice_id' => 67890,
719 'contribution_status_id' => 1,
721 'api.website.create' => array(
723 'url' => "http://civicrm.org",
726 'url' => "http://chained.org",
727 'website_type_id' => 2,
732 $description = "demonstrates creating two websites as an array";
733 $subfile = "ChainTwoWebsitesSyntax2";
734 $result = $this->callAPIAndDocument('Contact', 'create', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
736 $this->assertEquals(1, $result['id']);
737 // the callAndDocument doesn't check the chained call
738 $this->assertEquals(0, $result['values'][$result['id']]['api.website.create'][0]['is_error'], "In line " . __LINE__
);
739 $this->assertEquals("http://chained.org", $result['values'][$result['id']]['api.website.create'][1]['values'][0]['url'], "In line " . __LINE__
);
740 $this->assertEquals("http://civicrm.org", $result['values'][$result['id']]['api.website.create'][0]['values'][0]['url'], "In line " . __LINE__
);
742 $this->callAPISuccess('contact', 'delete', $result);
746 * Verify that attempt to create individual contact with first
747 * and last names and email succeeds
749 function testCreateIndividualWithNameEmail() {
751 'first_name' => 'abc3',
752 'last_name' => 'xyz3',
753 'contact_type' => 'Individual',
754 'email' => 'man3@yahoo.com',
757 $contact = $this->callAPISuccess('contact', 'create', $params);
758 $this->assertEquals(1, $contact['id'], "In line " . __LINE__
);
760 // delete the contact
761 $this->callAPISuccess('contact', 'delete', $contact);
764 * Verify that attempt to create individual contact with no data fails
766 function testCreateIndividualWithOutNameEmail() {
768 'contact_type' => 'Individual',
771 $result = $this->callAPIFailure('contact', 'create', $params);
774 * Verify that attempt to create individual contact with first
775 * and last names, email and location type succeeds
777 function testCreateIndividualWithNameEmailLocationType() {
779 'first_name' => 'abc4',
780 'last_name' => 'xyz4',
781 'email' => 'man4@yahoo.com',
782 'contact_type' => 'Individual',
783 'location_type_id' => 1,
785 $result = $this->callAPISuccess('contact', 'create', $params);
787 $this->assertEquals(1, $result['id'], "In line " . __LINE__
);
789 $this->callAPISuccess('contact', 'delete', array('id' => $result['id']));
793 * Verify that when changing employers
794 * the old employer relationship becomes inactive
796 function testCreateIndividualWithEmployer() {
797 $employer = $this->organizationCreate();
798 $employer2 = $this->organizationCreate();
801 'email' => 'man4@yahoo.com',
802 'contact_type' => 'Individual',
803 'employer_id' => $employer,
806 $result = $this->callAPISuccess('contact', 'create', $params);
807 $relationships = $this->callAPISuccess('relationship', 'get', array(
808 'contact_id_a' => $result['id'],
812 $this->assertEquals($employer, $relationships['values'][0]['contact_id_b']);
814 // Add more random relationships to make the test more realistic
815 foreach (array('Employee of', 'Volunteer for') as $rtype) {
816 $relTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_RelationshipType', $rtype, 'id', 'name_a_b');
817 $random_rel = $this->callAPISuccess('relationship', 'create', array(
818 'contact_id_a' => $result['id'],
819 'contact_id_b' => $this->organizationCreate(),
821 'relationship_type_id' => $relTypeId,
825 // Add second employer
826 $params['employer_id'] = $employer2;
827 $params['id'] = $result['id'];
828 $result = $this->callAPISuccess('contact', 'create', $params);
830 $relationships = $this->callAPISuccess('relationship', 'get', array(
831 'contact_id_a' => $result['id'],
836 $this->assertEquals($employer, $relationships['values'][0]['contact_id_b']);
840 * Verify that attempt to create household contact with details
843 function testCreateHouseholdDetails() {
845 'household_name' => 'abc8\'s House',
846 'nick_name' => 'x House',
847 'email' => 'man8@yahoo.com',
848 'contact_type' => 'Household',
851 $contact = $this->callAPISuccess('contact', 'create', $params);
853 $this->assertEquals(1, $contact['id'], "In line " . __LINE__
);
855 $this->callAPISuccess('contact', 'delete', $contact);
858 * Verify that attempt to create household contact with inadequate details
861 function testCreateHouseholdInadequateDetails() {
863 'nick_name' => 'x House',
864 'email' => 'man8@yahoo.com',
865 'contact_type' => 'Household',
868 $result = $this->callAPIFailure('contact', 'create', $params);
872 * Verify successful update of individual contact
874 function testUpdateIndividualWithAll() {
875 // Insert a row in civicrm_contact creating individual contact
876 $op = new PHPUnit_Extensions_Database_Operation_Insert();
877 $op->execute($this->_dbconn
,
878 new PHPUnit_Extensions_Database_DataSet_XMLDataSet(
879 dirname(__FILE__
) . '/dataset/contact_ind.xml'
885 'first_name' => 'abcd',
886 'contact_type' => 'Individual',
887 'nick_name' => 'This is nickname first',
888 'do_not_email' => '1',
889 'do_not_phone' => '1',
890 'do_not_mail' => '1',
891 'do_not_trade' => '1',
892 'legal_identifier' => 'ABC23853ZZ2235',
893 'external_identifier' => '1928837465',
894 'image_URL' => 'http://some.url.com/image.jpg',
895 'home_url' => 'http://www.example.org',
899 $result = $this->callAPISuccess('Contact', 'Update', $params);
900 $getResult = $this->callAPISuccess('Contact', 'Get', $params);
901 unset($params['contact_id']);
902 //Todo - neither API v2 or V3 are testing for home_url - not sure if it is being set.
903 //reducing this test partially back to apiv2 level to get it through
904 unset($params['home_url']);
905 foreach ($params as $key => $value) {
906 $this->assertEquals($value, $result['values'][23][$key], "In line " . __LINE__
);
908 // Check updated civicrm_contact against expected
909 $expected = new PHPUnit_Extensions_Database_DataSet_XMLDataSet(
910 dirname(__FILE__
) . '/dataset/contact_ind_upd.xml'
912 $actual = new PHPUnit_Extensions_Database_DataSet_QueryDataset(
915 $actual->addTable('civicrm_contact');
916 $expected->matches($actual);
920 * Verify successful update of organization contact
922 function testUpdateOrganizationWithAll() {
923 // Insert a row in civicrm_contact creating organization contact
924 $op = new PHPUnit_Extensions_Database_Operation_Insert();
925 $op->execute($this->_dbconn
,
926 new PHPUnit_Extensions_Database_DataSet_XMLDataSet(
927 dirname(__FILE__
) . '/dataset/contact_org.xml'
933 'organization_name' => 'WebAccess India Pvt Ltd',
934 'legal_name' => 'WebAccess',
935 'sic_code' => 'ABC12DEF',
936 'contact_type' => 'Organization',
939 $result = $this->callAPISuccess('Contact', 'Update', $params);
941 // Check updated civicrm_contact against expected
942 $expected = new PHPUnit_Extensions_Database_DataSet_XMLDataSet(
943 dirname(__FILE__
) . '/dataset/contact_org_upd.xml'
945 $actual = new PHPUnit_Extensions_Database_DataSet_QueryDataset(
948 $actual->addTable('civicrm_contact');
949 $expected->matches($actual);
953 * Verify successful update of household contact
955 function testUpdateHouseholdwithAll() {
956 // Insert a row in civicrm_contact creating household contact
957 $op = new PHPUnit_Extensions_Database_Operation_Insert();
958 $op->execute($this->_dbconn
,
959 new PHPUnit_Extensions_Database_DataSet_XMLDataSet(
960 dirname(__FILE__
) . '/dataset/contact_hld.xml'
966 'household_name' => 'ABC household',
967 'nick_name' => 'ABC House',
968 'contact_type' => 'Household',
971 $result = $this->callAPISuccess('Contact', 'Update', $params);
974 'contact_type' => 'Household',
976 'sort_name' => 'ABC household',
977 'display_name' => 'ABC household',
978 'nick_name' => 'ABC House',
980 $this->getAndCheck($expected, $result['id'], 'contact');
984 * Test civicrm_update() Deliberately exclude contact_type as it should still
985 * cope using civicrm_api CRM-7645
988 public function testUpdateCreateWithID() {
989 // Insert a row in civicrm_contact creating individual contact
990 $op = new PHPUnit_Extensions_Database_Operation_Insert();
991 $op->execute($this->_dbconn
,
992 new PHPUnit_Extensions_Database_DataSet_XMLDataSet(
993 dirname(__FILE__
) . '/dataset/contact_ind.xml'
1001 'first_name' => 'abcd',
1002 'last_name' => 'wxyz',
1005 $result = $this->callAPISuccess('Contact', 'Update', $params);
1009 * Test civicrm_contact_delete() with no contact ID
1011 function testContactDeleteNoID() {
1015 $result = $this->callAPIFailure('contact', 'delete', $params);
1019 * Test civicrm_contact_delete() with error
1021 function testContactDeleteError() {
1022 $params = array('contact_id' => 999);
1023 $result = $this->callAPIFailure('contact', 'delete', $params);
1027 * Test civicrm_contact_delete()
1029 function testContactDelete() {
1030 $contactID = $this->individualCreate();
1032 'id' => $contactID ,
1034 $result = $this->callAPIAndDocument('contact', 'delete', $params, __FUNCTION__
, __FILE__
);
1038 * Test civicrm_contact_get() return only first name
1040 public function testContactGetRetFirst() {
1041 $contact = $this->callAPISuccess('contact', 'create', $this->_params
);
1043 'contact_id' => $contact['id'],
1044 'return_first_name' => TRUE,
1045 'sort' => 'first_name',
1047 $result = $this->callAPISuccess('contact', 'get', $params);
1048 $this->assertEquals(1, $result['count'], "In line " . __LINE__
);
1049 $this->assertEquals($contact['id'], $result['id'], "In line " . __LINE__
);
1050 $this->assertEquals('abc1', $result['values'][$contact['id']]['first_name'], "In line " . __LINE__
);
1054 * Test civicrm_contact_get() return only first name & last name
1055 * Use comma separated string return with a space
1057 public function testContactGetRetFirstLast() {
1058 $contact = $this->callAPISuccess('contact', 'create', $this->_params
);
1060 'contact_id' => $contact['id'],
1061 'return' => 'first_name, last_name',
1063 $result = $this->callAPISuccess('contact', 'getsingle', $params);
1064 $this->assertEquals('abc1', $result['first_name'], "In line " . __LINE__
);
1065 $this->assertEquals('xyz1', $result['last_name'], "In line " . __LINE__
);
1066 //check that other defaults not returns
1067 $this->assertArrayNotHasKey('sort_name', $result);
1069 'contact_id' => $contact['id'],
1070 'return' => 'first_name,last_name',
1072 $result = $this->callAPISuccess('contact', 'getsingle', $params);
1073 $this->assertEquals('abc1', $result['first_name'], "In line " . __LINE__
);
1074 $this->assertEquals('xyz1', $result['last_name'], "In line " . __LINE__
);
1075 //check that other defaults not returns
1076 $this->assertArrayNotHasKey('sort_name', $result);
1080 * Test civicrm_contact_get() return only first name & last name
1081 * Use comma separated string return without a space
1083 public function testContactGetRetFirstLastNoComma() {
1084 $contact = $this->callAPISuccess('contact', 'create', $this->_params
);
1086 'contact_id' => $contact['id'],
1087 'return' => 'first_name,last_name',
1089 $result = $this->callAPISuccess('contact', 'getsingle', $params);
1090 $this->assertEquals('abc1', $result['first_name'], "In line " . __LINE__
);
1091 $this->assertEquals('xyz1', $result['last_name'], "In line " . __LINE__
);
1092 //check that other defaults not returns
1093 $this->assertArrayNotHasKey('sort_name', $result);
1097 * Test civicrm_contact_get() with default return properties
1099 public function testContactGetRetDefault() {
1100 $contactID = $this->individualCreate();
1102 'contact_id' => $contactID,
1103 'sort' => 'first_name',
1105 $result = $this->callAPISuccess('contact', 'get', $params);
1106 $this->assertEquals($contactID, $result['values'][$contactID]['contact_id']);
1107 $this->assertEquals('Anthony', $result['values'][$contactID]['first_name']);
1111 * Test civicrm_contact_getquick() with empty name param
1113 public function testContactGetQuick() {
1114 // Insert a row in civicrm_contact creating individual contact
1115 $op = new PHPUnit_Extensions_Database_Operation_Insert();
1116 $op->execute($this->_dbconn
,
1117 new PHPUnit_Extensions_Database_DataSet_XMLDataSet(
1118 dirname(__FILE__
) . '/dataset/contact_17.xml'
1121 $op->execute($this->_dbconn
,
1122 new PHPUnit_Extensions_Database_DataSet_XMLDataSet(
1123 dirname(__FILE__
) . '/dataset/email_contact_17.xml'
1130 $result = $this->callAPISuccess('contact', 'getquick', $params);
1131 $this->assertEquals(17, $result['values'][0]['id'], 'in line ' . __LINE__
);
1135 * Test civicrm_contact_get) with empty params
1137 public function testContactGetEmptyParams() {
1138 $result = $this->callAPISuccess('contact', 'get', array());
1142 * Test civicrm_contact_get(,true) with no matches
1144 public function testContactGetOldParamsNoMatches() {
1145 // Insert a row in civicrm_contact creating contact 17
1146 $op = new PHPUnit_Extensions_Database_Operation_Insert();
1147 $op->execute($this->_dbconn
,
1148 new PHPUnit_Extensions_Database_DataSet_XMLDataSet(
1149 dirname(__FILE__
) . '/dataset/contact_17.xml'
1154 'first_name' => 'Fred',
1156 $result = $this->callAPISuccess('contact', 'get', $params);
1157 $this->assertEquals(0, $result['count'], 'in line ' . __LINE__
);
1161 * Test civicrm_contact_get(,true) with one match
1163 public function testContactGetOldParamsOneMatch() {
1164 // Insert a row in civicrm_contact creating contact 17
1165 $op = new PHPUnit_Extensions_Database_Operation_Insert();
1166 $op->execute($this->_dbconn
,
1167 new PHPUnit_Extensions_Database_DataSet_XMLDataSet(dirname(__FILE__
) . '/dataset/contact_17.xml'
1172 'first_name' => 'Test',
1174 $result = $this->callAPISuccess('contact', 'get', $params);
1175 $this->assertEquals(17, $result['values'][17]['contact_id'], 'in line ' . __LINE__
);
1176 $this->assertEquals(17, $result['id'], 'in line ' . __LINE__
);
1180 * Test civicrm_contact_search_count()
1182 public function testContactGetEmail() {
1184 'email' => 'man2@yahoo.com',
1185 'contact_type' => 'Individual',
1186 'location_type_id' => 1,
1189 $contact = $this->callAPISuccess('contact', 'create', $params);
1191 $this->assertEquals(1, $contact['id'], "In line " . __LINE__
);
1194 'email' => 'man2@yahoo.com',
1196 $result = $this->callAPIAndDocument('contact', 'get', $params, __FUNCTION__
, __FILE__
);
1197 $this->assertEquals(1, $result['values'][1]['contact_id'], "In line " . __LINE__
);
1198 $this->assertEquals('man2@yahoo.com', $result['values'][1]['email'], "In line " . __LINE__
);
1200 // delete the contact
1201 $this->callAPISuccess('contact', 'delete', $contact);
1205 * Test for Contact.get id=@user:username
1207 function testContactGetByUsername() {
1208 // setup - create contact with a uf-match
1209 $cid = $this->individualCreate(array(
1210 'contact_type' => 'Individual',
1211 'first_name' => 'testGetByUsername',
1212 'last_name' => 'testGetByUsername',
1215 $ufMatchParams = array(
1216 'domain_id' => CRM_Core_Config
::domainID(),
1218 'uf_name' => 'the-email-matching-key-is-not-really-the-username',
1219 'contact_id' => $cid,
1221 $ufMatch = CRM_Core_BAO_UFMatch
::create($ufMatchParams);
1222 $this->assertTrue(is_numeric($ufMatch->id
));
1224 // setup - mock the calls to CRM_Utils_System_*::getUfId
1225 $userSystem = $this->getMock('CRM_Utils_System_UnitTests', array('getUfId'));
1226 $userSystem->expects($this->once())
1228 ->with($this->equalTo('exampleUser'))
1229 ->will($this->returnValue(99));
1230 CRM_Core_Config
::singleton()->userSystem
= $userSystem;
1233 $result = $this->callAPISuccess('Contact', 'get', array(
1234 'id' => '@user:exampleUser',
1236 $this->assertEquals('testGetByUsername', $result['values'][$cid]['first_name']);
1240 * Test to check return works OK
1242 function testContactGetReturnValues() {
1243 $extraParams = array('nick_name' => 'Bob', 'phone' => '456', 'email' => 'e@mail.com');
1244 $contactID = $this->individualCreate($extraParams);
1245 //actually it turns out the above doesn't create a phone
1246 $phones = $this->callAPISuccess('phone', 'create', array('contact_id' => $contactID, 'phone' => '456',));
1247 $result = $this->callAPISuccess('contact', 'getsingle', array('id' => $contactID));
1248 foreach ($extraParams as $key => $value) {
1249 $this->assertEquals($result[$key], $value);
1251 //now we check they are still returned with 'return' key
1252 $result = $this->callAPISuccess('contact', 'getsingle', array('id' => $contactID, 'return' => array_keys($extraParams)));
1253 foreach ($extraParams as $key => $value) {
1254 $this->assertEquals($result[$key], $value);
1258 function testCRM13252MultipleChainedPhones() {
1259 $contactID = $this->householdCreate();
1260 $this->callAPISuccessGetCount('phone', array('contact_id' => $contactID), 0);
1262 'contact_id' => $contactID,
1263 'household_name' => 'Household 1',
1264 'contact_type' => 'Household',
1265 'api.phone.create' => array(
1267 'phone' => '111-111-1111',
1268 'location_type_id' => 1,
1269 'phone_type_id' => 1,
1272 'phone' => '222-222-2222',
1273 'location_type_id' => 1,
1274 'phone_type_id' => 2,
1278 $result = $this->callAPISuccess('contact', 'create', $params);
1279 $this->callAPISuccessGetCount('phone', array('contact_id' => $contactID), 2);
1283 * Test for Contact.get id=@user:username (with an invalid username)
1285 function testContactGetByUnknownUsername() {
1286 // setup - mock the calls to CRM_Utils_System_*::getUfId
1287 $userSystem = $this->getMock('CRM_Utils_System_UnitTests', array('getUfId'));
1288 $userSystem->expects($this->once())
1290 ->with($this->equalTo('exampleUser'))
1291 ->will($this->returnValue(NULL));
1292 CRM_Core_Config
::singleton()->userSystem
= $userSystem;
1295 $result = $this->callAPIFailure('Contact', 'get', array(
1296 'id' => '@user:exampleUser',
1298 $this->assertRegExp('/cannot be resolved to a contact ID/', $result['error_message']);
1302 * Verify attempt to create individual with chained arrays
1304 function testGetIndividualWithChainedArrays() {
1305 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__
, __FILE__
);
1306 $params['custom_' . $ids['custom_field_id']] = "custom string";
1308 $moreids = $this->CustomGroupMultipleCreateWithFields();
1309 $description = "/*this demonstrates the usage of chained api functions. In this case no notes or custom fields have been created ";
1310 $subfile = "APIChainedArray";
1312 'first_name' => 'abc3',
1313 'last_name' => 'xyz3',
1314 'contact_type' => 'Individual',
1315 'email' => 'man3@yahoo.com',
1316 'api.contribution.create' => array(
1317 'receive_date' => '2010-01-01',
1318 'total_amount' => 100.00,
1319 'financial_type_id' => 1,
1320 'payment_instrument_id' => 1,
1321 'non_deductible_amount' => 10.00,
1322 'fee_amount' => 50.00,
1323 'net_amount' => 90.00,
1325 'invoice_id' => 67890,
1327 'contribution_status_id' => 1,
1329 'api.contribution.create.1' => array(
1330 'receive_date' => '2011-01-01',
1331 'total_amount' => 120.00,
1332 'financial_type_id' => $this->_financialTypeId
=1,
1333 'payment_instrument_id' => 1,
1334 'non_deductible_amount' => 10.00,
1335 'fee_amount' => 50.00,
1336 'net_amount' => 90.00,
1338 'invoice_id' => 67830,
1340 'contribution_status_id' => 1,
1342 'api.website.create' => array(
1344 'url' => "http://civicrm.org",
1349 $result = $this->callAPISuccess('Contact', 'create', $params);
1351 'id' => $result['id'],
1352 'api.website.get' => array(),
1353 'api.Contribution.get' => array(
1354 'total_amount' => '120.00',
1355 ), 'api.CustomValue.get' => 1,
1356 'api.Note.get' => 1,
1358 $result = $this->callAPIAndDocument('Contact', 'Get', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
1359 // delete the contact
1360 $this->callAPISuccess('contact', 'delete', $result);
1361 $this->customGroupDelete($ids['custom_group_id']);
1362 $this->customGroupDelete($moreids['custom_group_id']);
1363 $this->assertEquals(1, $result['id'], "In line " . __LINE__
);
1364 $this->assertEquals(0, $result['values'][$result['id']]['api.website.get']['is_error'], "In line " . __LINE__
);
1365 $this->assertEquals("http://civicrm.org", $result['values'][$result['id']]['api.website.get']['values'][0]['url'], "In line " . __LINE__
);
1368 function testGetIndividualWithChainedArraysFormats() {
1369 $description = "/*this demonstrates the usage of chained api functions. A variety of return formats are used. Note that no notes
1370 *custom fields or memberships exist";
1371 $subfile = "APIChainedArrayFormats";
1372 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__
, __FILE__
);
1373 $params['custom_' . $ids['custom_field_id']] = "custom string";
1375 $moreids = $this->CustomGroupMultipleCreateWithFields();
1377 'first_name' => 'abc3',
1378 'last_name' => 'xyz3',
1379 'contact_type' => 'Individual',
1380 'email' => 'man3@yahoo.com',
1381 'api.contribution.create' => array(
1382 'receive_date' => '2010-01-01',
1383 'total_amount' => 100.00,
1384 'financial_type_id' => $this->_financialTypeId
,
1385 'payment_instrument_id' => 1,
1386 'non_deductible_amount' => 10.00,
1387 'fee_amount' => 50.00,
1388 'net_amount' => 90.00,
1390 'contribution_status_id' => 1,
1392 'api.contribution.create.1' => array(
1393 'receive_date' => '2011-01-01',
1394 'total_amount' => 120.00,
1395 'financial_type_id' => $this->_financialTypeId
,
1396 'payment_instrument_id' => 1,
1397 'non_deductible_amount' => 10.00,
1398 'fee_amount' => 50.00,
1399 'net_amount' => 90.00,
1401 'contribution_status_id' => 1,
1403 'api.website.create' => array(
1405 'url' => "http://civicrm.org",
1411 $result = $this->callAPISuccess('Contact', 'create', $params);
1413 'id' => $result['id'],
1414 'api.website.getValue' => array('return' => 'url'),
1415 'api.Contribution.getCount' => array(),
1416 'api.CustomValue.get' => 1,
1417 'api.Note.get' => 1,
1418 'api.Membership.getCount' => array(),
1420 $result = $this->callAPIAndDocument('Contact', 'Get', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
1421 $this->assertEquals(1, $result['id'], "In line " . __LINE__
);
1422 $this->assertEquals(2, $result['values'][$result['id']]['api.Contribution.getCount'], "In line " . __LINE__
);
1423 $this->assertEquals(0, $result['values'][$result['id']]['api.Note.get']['is_error'], "In line " . __LINE__
);
1424 $this->assertEquals("http://civicrm.org", $result['values'][$result['id']]['api.website.getValue'], "In line " . __LINE__
);
1426 $this->callAPISuccess('contact', 'delete', $result);
1427 $this->customGroupDelete($ids['custom_group_id']);
1428 $this->customGroupDelete($moreids['custom_group_id']);
1431 function testGetIndividualWithChainedArraysAndMultipleCustom() {
1432 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__
, __FILE__
);
1433 $params['custom_' . $ids['custom_field_id']] = "custom string";
1434 $moreids = $this->CustomGroupMultipleCreateWithFields();
1435 $andmoreids = $this->CustomGroupMultipleCreateWithFields(array('title' => "another group", 'name' => 'another name'));
1436 $description = "/*this demonstrates the usage of chained api functions. A variety of techniques are used";
1437 $subfile = "APIChainedArrayMultipleCustom";
1439 'first_name' => 'abc3',
1440 'last_name' => 'xyz3',
1441 'contact_type' => 'Individual',
1442 'email' => 'man3@yahoo.com',
1443 'api.contribution.create' => array(
1444 'receive_date' => '2010-01-01',
1445 'total_amount' => 100.00,
1446 'financial_type_id' => 1,
1447 'payment_instrument_id' => 1,
1448 'non_deductible_amount' => 10.00,
1449 'fee_amount' => 50.00,
1450 'net_amount' => 90.00,
1452 'invoice_id' => 67890,
1454 'contribution_status_id' => 1,
1456 'api.contribution.create.1' => array(
1457 'receive_date' => '2011-01-01',
1458 'total_amount' => 120.00,
1459 'financial_type_id' => 1,
1460 'payment_instrument_id' => 1,
1461 'non_deductible_amount' => 10.00,
1462 'fee_amount' => 50.00,
1463 'net_amount' => 90.00,
1465 'invoice_id' => 67830,
1467 'contribution_status_id' => 1,
1469 'api.website.create' => array(
1471 'url' => "http://civicrm.org",
1474 'custom_' . $ids['custom_field_id'] => "value 1",
1475 'custom_' . $moreids['custom_field_id'][0] => "value 2",
1476 'custom_' . $moreids['custom_field_id'][1] => "warm beer",
1477 'custom_' . $andmoreids['custom_field_id'][1] => "vegemite",
1481 $result = $this->callAPISuccess('Contact', 'create', $params);
1482 $result = $this->callAPISuccess('Contact', 'create', array(
1483 'contact_type' => 'Individual', 'id' => $result['id'], 'custom_' . $moreids['custom_field_id'][0] => "value 3", 'custom_' . $ids['custom_field_id'] => "value 4",
1487 'id' => $result['id'],
1488 'api.website.getValue' => array('return' => 'url'),
1489 'api.Contribution.getCount' => array(),
1490 'api.CustomValue.get' => 1,
1492 $result = $this->callAPIAndDocument('Contact', 'Get', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
1494 $this->customGroupDelete($ids['custom_group_id']);
1495 $this->customGroupDelete($moreids['custom_group_id']);
1496 $this->customGroupDelete($andmoreids['custom_group_id']);
1497 $this->assertEquals(1, $result['id'], "In line " . __LINE__
);
1498 $this->assertEquals(0, $result['values'][$result['id']]['api.CustomValue.get']['is_error'], "In line " . __LINE__
);
1499 $this->assertEquals('http://civicrm.org', $result['values'][$result['id']]['api.website.getValue'], "In line " . __LINE__
);
1502 * Test checks siusage of $values to pick & choose inputs
1504 function testChainingValuesCreate() {
1505 $description = "/*this demonstrates the usage of chained api functions. Specifically it has one 'parent function' &
1506 2 child functions - one receives values from the parent (Contact) and the other child (Tag). ";
1507 $subfile = "APIChainedArrayValuesFromSiblingFunction";
1509 'display_name' => 'batman', 'contact_type' => 'Individual',
1510 'api.tag.create' => array('name' => '$value.id', 'description' => '$value.display_name', 'format.only_id' => 1),
1511 'api.entity_tag.create' => array('tag_id' => '$value.api.tag.create'),
1513 $result = $this->callAPIAndDocument('Contact', 'Create', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
1514 $this->assertEquals(0, $result['values'][$result['id']]['api.entity_tag.create']['is_error']);
1516 $tablesToTruncate = array(
1519 'civicrm_entity_tag',
1522 $this->quickCleanup($tablesToTruncate, TRUE);
1526 * test TrueFalse format - I couldn't come up with an easy way to get an error on Get
1528 function testContactGetFormatIsSuccessTrue() {
1529 $this->createContactFromXML();
1530 $description = "This demonstrates use of the 'format.is_success' param.
1531 This param causes only the success or otherwise of the function to be returned as BOOLEAN";
1532 $subfile = "FormatIsSuccess_True";
1533 $params = array('id' => 17, 'format.is_success' => 1);
1534 $result = $this->callAPIAndDocument('Contact', 'Get', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
1535 $this->assertEquals(1, $result);
1536 $this->callAPISuccess('Contact', 'Delete', $params);
1539 * test TrueFalse format
1541 function testContactCreateFormatIsSuccessFalse() {
1543 $description = "This demonstrates use of the 'format.is_success' param.
1544 This param causes only the success or otherwise of the function to be returned as BOOLEAN";
1545 $subfile = "FormatIsSuccess_Fail";
1546 $params = array('id' => 500, 'format.is_success' => 1);
1547 $result = $this->callAPIAndDocument('Contact', 'Create', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
1548 $this->assertEquals(0, $result);
1551 * test Single Entity format
1553 function testContactGetSingle_entity_array() {
1554 $this->createContactFromXML();
1555 $description = "This demonstrates use of the 'format.single_entity_array' param.
1556 /* This param causes the only contact to be returned as an array without the other levels.
1557 /* it will be ignored if there is not exactly 1 result";
1558 $subfile = "GetSingleContact";
1559 $params = array('id' => 17);
1560 $result = $this->callAPIAndDocument('Contact', 'GetSingle', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
1561 $this->assertEquals('Test Contact', $result['display_name'], "in line " . __LINE__
);
1562 $this->callAPISuccess('Contact', 'Delete', $params);
1566 * test Single Entity format
1568 function testContactGetFormatcount_only() {
1569 $this->createContactFromXML();
1570 $description = "/*This demonstrates use of the 'getCount' action
1571 /* This param causes the count of the only function to be returned as an integer";
1572 $subfile = "GetCountContact";
1573 $params = array('id' => 17);
1574 $result = $this->callAPIAndDocument('Contact', 'GetCount', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
1575 $this->assertEquals('1', $result, "in line " . __LINE__
);
1576 $this->callAPISuccess('Contact', 'Delete', $params);
1579 * Test id only format
1581 function testContactGetFormatID_only() {
1582 $this->createContactFromXML();
1583 $description = "This demonstrates use of the 'format.id_only' param.
1584 /* This param causes the id of the only entity to be returned as an integer.
1585 /* it will be ignored if there is not exactly 1 result";
1586 $subfile = "FormatOnlyID";
1587 $params = array('id' => 17, 'format.only_id' => 1);
1588 $result = $this->callAPIAndDocument('Contact', 'Get', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
1589 $this->assertEquals('17', $result, "in line " . __LINE__
);
1590 $this->callAPISuccess('Contact', 'Delete', $params);
1594 * Test id only format
1596 function testContactGetFormatSingleValue() {
1597 $this->createContactFromXML();
1598 $description = "This demonstrates use of the 'format.single_value' param.
1599 /* This param causes only a single value of the only entity to be returned as an string.
1600 /* it will be ignored if there is not exactly 1 result";
1601 $subfile = "FormatSingleValue";
1602 $params = array('id' => 17, 'return' => 'display_name');
1603 $result = $this->callAPIAndDocument('Contact', 'getvalue', $params, __FUNCTION__
, __FILE__
, $description, $subfile,'getvalue');
1604 $this->assertEquals('Test Contact', $result, "in line " . __LINE__
);
1605 $this->callAPISuccess('Contact', 'Delete', $params);
1608 function testContactCreationPermissions() {
1610 'contact_type' => 'Individual', 'first_name' => 'Foo',
1611 'last_name' => 'Bear',
1612 'check_permissions' => TRUE,
1614 $config = CRM_Core_Config
::singleton();
1615 $config->userPermissionClass
->permissions
= array('access CiviCRM');
1616 $result = $this->callAPIFailure('contact', 'create', $params);
1617 $this->assertEquals('API permission check failed for contact/create call; insufficient permission: require access CiviCRM and add contacts', $result['error_message'], 'lacking permissions should not be enough to create a contact');
1619 $config->userPermissionClass
->permissions
= array('access CiviCRM', 'add contacts', 'import contacts');
1620 $result = $this->callAPISuccess('contact', 'create', $params, NULL, 'overfluous permissions should be enough to create a contact');
1623 function testContactUpdatePermissions() {
1624 $params = array('contact_type' => 'Individual', 'first_name' => 'Foo', 'last_name' => 'Bear', 'check_permissions' => TRUE,);
1625 $result = $this->callAPISuccess('contact', 'create', $params);
1626 $config = CRM_Core_Config
::singleton();
1627 $params = array('id' => $result['id'], 'contact_type' => 'Individual', 'last_name' => 'Bar', 'check_permissions' => TRUE,);
1629 $config->userPermissionClass
->permissions
= array('access CiviCRM');
1630 $result = $this->callAPIFailure('contact', 'update', $params);
1631 $this->assertEquals('API permission check failed for contact/update call; insufficient permission: require access CiviCRM and edit all contacts', $result['error_message'], 'lacking permissions should not be enough to update a contact');
1633 $config->userPermissionClass
->permissions
= array('access CiviCRM', 'add contacts', 'view all contacts', 'edit all contacts', 'import contacts');
1634 $result = $this->callAPISuccess('contact', 'update', $params, NULL, 'overfluous permissions should be enough to update a contact');
1637 function createContactFromXML() {
1638 // Insert a row in civicrm_contact creating contact 17
1639 $op = new PHPUnit_Extensions_Database_Operation_Insert();
1640 $op->execute($this->_dbconn
,
1641 new PHPUnit_Extensions_Database_DataSet_XMLDataSet(
1642 dirname(__FILE__
) . '/dataset/contact_17.xml'
1647 function testContactProximity() {
1648 // first create a contact with a SF location with a specific
1650 $contactID = $this->organizationCreate();
1652 // now create the address
1654 'street_address' => '123 Main Street',
1655 'city' => 'San Francisco',
1657 'country_id' => 1228,
1658 'state_province_id' => 1004,
1659 'geo_code_1' => '37.79',
1660 'geo_code_2' => '-122.40',
1661 'location_type_id' => 1,
1662 'contact_id' => $contactID,
1665 $result = $this->callAPISuccess('address', 'create', $params);
1666 $this->assertEquals(1, $result['count'], 'In line ' . __LINE__
);
1668 // now do a proximity search with a close enough geocode and hope to match
1669 // that specific contact only!
1670 $proxParams = array(
1672 'longitude' => -122.3,
1676 $result = $this->callAPISuccess('contact', 'proximity', $proxParams);
1677 $this->assertEquals(1, $result['count'], 'In line ' . __LINE__
);
1681 * Test that Ajax API permission is suffient to access getquick api
1682 * (note that getquick api is required for autocomplete & has ACL permissions applied)
1684 function testgetquickPermission_CRM_13744() {
1685 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= array('access CiviEvent');
1686 $result = $this->callAPIFailure('contact', 'getquick', array('name' => 'b', 'check_permissions' => TRUE));
1687 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= array('access CiviCRM');
1688 $result = $this->callAPISuccess('contact', 'getquick', array('name' => 'b', 'check_permissions' => TRUE));
1689 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= array('access AJAX API');
1690 $result = $this->callAPISuccess('contact', 'getquick', array('name' => 'b', 'check_permissions' => TRUE));