Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /** | |
3 | * File for the TestContact class | |
4 | * | |
5 | * (PHP 5) | |
6 | * | |
6c6e6187 TO |
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 | |
6a488035 | 10 | * GNU Affero General Public License version 3 |
6c6e6187 TO |
11 | * @version $Id: ContactTest.php 31254 2010-12-15 10:09:29Z eileen $ |
12 | * @package CiviCRM | |
6a488035 TO |
13 | * |
14 | * This file is part of CiviCRM | |
15 | * | |
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. | |
20 | * | |
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. | |
25 | * | |
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/>. | |
29 | */ | |
30 | ||
31 | /** | |
32 | * Include class definitions | |
33 | */ | |
34 | require_once 'CiviTest/CiviUnitTestCase.php'; | |
35 | ||
36 | ||
37 | /** | |
38 | * Test APIv3 civicrm_contact* functions | |
39 | * | |
6c6e6187 TO |
40 | * @package CiviCRM_APIv3 |
41 | * @subpackage API_Contact | |
6a488035 | 42 | */ |
6a488035 TO |
43 | class api_v3_ContactTest extends CiviUnitTestCase { |
44 | public $DBResetRequired = FALSE; | |
45 | protected $_apiversion; | |
46 | protected $_entity; | |
47 | protected $_params; | |
b7c9bc4c | 48 | |
f6722559 | 49 | protected $_contactID; |
6c6e6187 | 50 | protected $_financialTypeId = 1; |
6a488035 | 51 | |
6a488035 TO |
52 | /** |
53 | * Test setup for every test | |
54 | * | |
55 | * Connect to the database, truncate the tables that will be used | |
56 | * and redirect stdin to a temporary file | |
57 | */ | |
58 | public function setUp() { | |
59 | // Connect to the database | |
60 | parent::setUp(); | |
61 | $this->_apiversion = 3; | |
f6722559 | 62 | $this->_entity = 'contact'; |
63 | $this->_params = array( | |
6a488035 TO |
64 | 'first_name' => 'abc1', |
65 | 'contact_type' => 'Individual', | |
66 | 'last_name' => 'xyz1', | |
6a488035 | 67 | ); |
6a488035 TO |
68 | } |
69 | ||
00be9182 | 70 | public function tearDown() { |
6a488035 TO |
71 | // truncate a few tables |
72 | $tablesToTruncate = array( | |
73 | 'civicrm_contact', | |
74 | 'civicrm_email', | |
75 | 'civicrm_contribution', | |
76 | 'civicrm_line_item', | |
77 | 'civicrm_website', | |
e635f9d4 TO |
78 | 'civicrm_relationship', |
79 | 'civicrm_uf_match', | |
405f289b | 80 | 'civicrm_phone', |
6a488035 TO |
81 | ); |
82 | ||
f6722559 | 83 | $this->quickCleanup($tablesToTruncate, TRUE); |
6a488035 TO |
84 | } |
85 | ||
86 | /** | |
87 | * Test civicrm_contact_create | |
88 | * | |
89 | * Verify that attempt to create individual contact with only | |
90 | * first and last names succeeds | |
91 | */ | |
00be9182 | 92 | public function testAddCreateIndividual() { |
6a488035 TO |
93 | $oldCount = CRM_Core_DAO::singleValueQuery('select count(*) from civicrm_contact'); |
94 | $params = array( | |
95 | 'first_name' => 'abc1', | |
96 | 'contact_type' => 'Individual', | |
97 | 'last_name' => 'xyz1', | |
6a488035 TO |
98 | ); |
99 | ||
f6722559 | 100 | $contact = $this->callAPISuccess('contact', 'create', $params); |
6a488035 TO |
101 | $this->assertTrue(is_numeric($contact['id']), "In line " . __LINE__); |
102 | $this->assertTrue($contact['id'] > 0, "In line " . __LINE__); | |
103 | $newCount = CRM_Core_DAO::singleValueQuery('select count(*) from civicrm_contact'); | |
6c6e6187 | 104 | $this->assertEquals($oldCount + 1, $newCount); |
6a488035 | 105 | |
6a488035 TO |
106 | $this->assertDBState('CRM_Contact_DAO_Contact', |
107 | $contact['id'], | |
108 | $params | |
109 | ); | |
110 | } | |
111 | ||
112 | /** | |
113 | * Test civicrm_contact_create with sub-types | |
114 | * | |
115 | * Verify that sub-types are created successfully and not deleted by subsequent updates | |
116 | */ | |
00be9182 | 117 | public function testIndividualSubType() { |
6a488035 TO |
118 | $params = array( |
119 | 'first_name' => 'test abc', | |
120 | 'contact_type' => 'Individual', | |
121 | 'last_name' => 'test xyz', | |
122 | 'contact_sub_type' => array('Student', 'Staff'), | |
5896d037 | 123 | ); |
f6722559 | 124 | $contact = $this->callAPISuccess('contact', 'create', $params); |
6a488035 TO |
125 | $cid = $contact['id']; |
126 | ||
127 | $params = array( | |
128 | 'id' => $cid, | |
129 | 'middle_name' => 'foo', | |
6a488035 | 130 | ); |
f6722559 | 131 | $this->callAPISuccess('contact', 'create', $params); |
6a488035 TO |
132 | unset($params['middle_name']); |
133 | ||
f6722559 | 134 | $contact = $this->callAPISuccess('contact', 'get', $params); |
6a488035 TO |
135 | |
136 | $this->assertEquals(array('Student', 'Staff'), $contact['values'][$cid]['contact_sub_type'], "In line " . __LINE__); | |
137 | } | |
138 | ||
139 | /** | |
140 | * Verify that attempt to create contact with empty params fails | |
141 | */ | |
00be9182 | 142 | public function testCreateEmptyContact() { |
f6722559 | 143 | $this->callAPIFailure('contact', 'create', array()); |
6a488035 TO |
144 | } |
145 | ||
146 | /** | |
147 | * Verify that attempt to create contact with bad contact type fails | |
148 | */ | |
00be9182 | 149 | public function testCreateBadTypeContact() { |
6a488035 TO |
150 | $params = array( |
151 | 'email' => 'man1@yahoo.com', | |
152 | 'contact_type' => 'Does not Exist', | |
6a488035 | 153 | ); |
6c6e6187 | 154 | $this->callAPIFailure('contact', 'create', $params, "'Does not Exist' is not a valid option for field contact_type"); |
6a488035 TO |
155 | } |
156 | ||
157 | /** | |
158 | * Verify that attempt to create individual contact with required | |
159 | * fields missing fails | |
160 | */ | |
00be9182 | 161 | public function testCreateBadRequiredFieldsIndividual() { |
6a488035 TO |
162 | $params = array( |
163 | 'middle_name' => 'This field is not required', | |
164 | 'contact_type' => 'Individual', | |
165 | ); | |
4b58ed3b | 166 | $this->callAPIFailure('contact', 'create', $params); |
6a488035 TO |
167 | } |
168 | ||
169 | /** | |
170 | * Verify that attempt to create household contact with required | |
171 | * fields missing fails | |
172 | */ | |
00be9182 | 173 | public function testCreateBadRequiredFieldsHousehold() { |
6a488035 TO |
174 | $params = array( |
175 | 'middle_name' => 'This field is not required', | |
176 | 'contact_type' => 'Household', | |
177 | ); | |
4b58ed3b | 178 | $this->callAPIFailure('contact', 'create', $params); |
6a488035 TO |
179 | } |
180 | ||
181 | /** | |
182 | * Verify that attempt to create organization contact with | |
183 | * required fields missing fails | |
184 | */ | |
00be9182 | 185 | public function testCreateBadRequiredFieldsOrganization() { |
6a488035 TO |
186 | $params = array( |
187 | 'middle_name' => 'This field is not required', | |
188 | 'contact_type' => 'Organization', | |
189 | ); | |
190 | ||
4b58ed3b | 191 | $this->callAPIFailure('contact', 'create', $params); |
6a488035 TO |
192 | } |
193 | ||
194 | /** | |
195 | * Verify that attempt to create individual contact with only an | |
196 | * email succeeds | |
197 | */ | |
00be9182 | 198 | public function testCreateEmailIndividual() { |
6a488035 TO |
199 | |
200 | $params = array( | |
201 | 'email' => 'man3@yahoo.com', | |
202 | 'contact_type' => 'Individual', | |
203 | 'location_type_id' => 1, | |
6a488035 TO |
204 | ); |
205 | ||
f6722559 | 206 | $contact = $this->callAPISuccess('contact', 'create', $params); |
207 | ||
6a488035 | 208 | $this->assertEquals(1, $contact['id'], "In line " . __LINE__); |
f6722559 | 209 | $email = $this->callAPISuccess('email', 'get', array('contact_id' => $contact['id'])); |
210 | $this->assertEquals(1, $email['count']); | |
211 | $this->assertEquals('man3@yahoo.com', $email['values'][$email['id']]['email']); | |
6a488035 | 212 | |
f6722559 | 213 | $this->callAPISuccess('contact', 'delete', $contact); |
6a488035 TO |
214 | } |
215 | ||
216 | /** | |
217 | * Verify that attempt to create individual contact with only | |
218 | * first and last names succeeds | |
219 | */ | |
00be9182 | 220 | public function testCreateNameIndividual() { |
6a488035 TO |
221 | $params = array( |
222 | 'first_name' => 'abc1', | |
223 | 'contact_type' => 'Individual', | |
224 | 'last_name' => 'xyz1', | |
6a488035 | 225 | ); |
6a488035 | 226 | |
f6722559 | 227 | $contact = $this->callAPISuccess('contact', 'create', $params); |
228 | $this->assertEquals(1, $contact['id']); | |
6a488035 TO |
229 | } |
230 | ||
231 | /** | |
232 | * Verify that attempt to create individual contact with | |
233 | * first and last names and old key values works | |
234 | */ | |
00be9182 | 235 | public function testCreateNameIndividualOldKeys() { |
6a488035 TO |
236 | $params = array( |
237 | 'individual_prefix' => 'Dr.', | |
238 | 'first_name' => 'abc1', | |
239 | 'contact_type' => 'Individual', | |
240 | 'last_name' => 'xyz1', | |
241 | 'individual_suffix' => 'Jr.', | |
6a488035 TO |
242 | ); |
243 | ||
f6722559 | 244 | $contact = $this->callAPISuccess('contact', 'create', $params); |
6ecbca5b | 245 | $result = $this->callAPISuccess('contact', 'getsingle', array('id' => $contact['id'])); |
fd651abc | 246 | |
a1255c80 CW |
247 | $this->assertArrayKeyExists('prefix_id', $result); |
248 | $this->assertArrayKeyExists('suffix_id', $result); | |
249 | $this->assertArrayKeyExists('gender_id', $result); | |
250 | $this->assertEquals(4, $result['prefix_id']); | |
251 | $this->assertEquals(1, $result['suffix_id']); | |
6a488035 TO |
252 | } |
253 | ||
254 | /** | |
255 | * Verify that attempt to create individual contact with | |
256 | * first and last names and old key values works | |
257 | */ | |
00be9182 | 258 | public function testCreateNameIndividualrecommendedKeys2() { |
6a488035 TO |
259 | $params = array( |
260 | 'prefix_id' => 'Dr.', | |
261 | 'first_name' => 'abc1', | |
262 | 'contact_type' => 'Individual', | |
263 | 'last_name' => 'xyz1', | |
264 | 'suffix_id' => 'Jr.', | |
265 | 'gender_id' => 'Male', | |
6a488035 TO |
266 | ); |
267 | ||
f6722559 | 268 | $contact = $this->callAPISuccess('contact', 'create', $params); |
6ecbca5b | 269 | $result = $this->callAPISuccess('contact', 'getsingle', array('id' => $contact['id'])); |
fd651abc | 270 | |
a1255c80 CW |
271 | $this->assertArrayKeyExists('prefix_id', $result); |
272 | $this->assertArrayKeyExists('suffix_id', $result); | |
273 | $this->assertArrayKeyExists('gender_id', $result); | |
274 | $this->assertEquals(4, $result['prefix_id']); | |
275 | $this->assertEquals(1, $result['suffix_id']); | |
6a488035 TO |
276 | } |
277 | ||
278 | /** | |
279 | * Verify that attempt to create household contact with only | |
280 | * household name succeeds | |
281 | */ | |
00be9182 | 282 | public function testCreateNameHousehold() { |
6a488035 TO |
283 | $params = array( |
284 | 'household_name' => 'The abc Household', | |
285 | 'contact_type' => 'Household', | |
6a488035 | 286 | ); |
f6722559 | 287 | $contact = $this->callAPISuccess('contact', 'create', $params); |
6a488035 | 288 | $this->assertEquals(1, $contact['id'], "In line " . __LINE__); |
6a488035 TO |
289 | } |
290 | ||
291 | /** | |
292 | * Verify that attempt to create organization contact with only | |
293 | * organization name succeeds | |
294 | */ | |
00be9182 | 295 | public function testCreateNameOrganization() { |
6a488035 TO |
296 | $params = array( |
297 | 'organization_name' => 'The abc Organization', | |
298 | 'contact_type' => 'Organization', | |
6a488035 | 299 | ); |
f6722559 | 300 | $contact = $this->callAPISuccess('contact', 'create', $params); |
301 | $this->assertEquals(1, $contact['id']); | |
6a488035 | 302 | } |
5896d037 | 303 | |
6a488035 | 304 | /** |
d0e1eff2 | 305 | * Verify that attempt to create organization contact without organization name fails |
6a488035 | 306 | */ |
00be9182 | 307 | public function testCreateNoNameOrganization() { |
6a488035 TO |
308 | $params = array( |
309 | 'first_name' => 'The abc Organization', | |
310 | 'contact_type' => 'Organization', | |
6a488035 | 311 | ); |
4b58ed3b | 312 | $this->callAPIFailure('contact', 'create', $params); |
6a488035 | 313 | } |
5896d037 | 314 | |
6a488035 | 315 | /** |
100fef9d | 316 | * Check with complete array + custom field |
6a488035 TO |
317 | * Note that the test is written on purpose without any |
318 | * variables specific to participant so it can be replicated into other entities | |
319 | * and / or moved to the automated test suite | |
320 | */ | |
00be9182 | 321 | public function testCreateWithCustom() { |
6a488035 TO |
322 | $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__); |
323 | ||
324 | $params = $this->_params; | |
325 | $params['custom_' . $ids['custom_field_id']] = "custom string"; | |
326 | $description = "/*this demonstrates setting a custom field through the API "; | |
fb32de45 | 327 | $result = $this->callAPIAndDocument($this->_entity, 'create', $params, __FUNCTION__, __FILE__, $description); |
6a488035 | 328 | |
5896d037 | 329 | $check = $this->callAPISuccess($this->_entity, 'get', array( |
92915c55 TO |
330 | 'return.custom_' . $ids['custom_field_id'] => 1, |
331 | 'id' => $result['id'], | |
332 | )); | |
4b58ed3b | 333 | $this->assertEquals("custom string", $check['values'][$check['id']]['custom_' . $ids['custom_field_id']]); |
6a488035 TO |
334 | |
335 | $this->customFieldDelete($ids['custom_field_id']); | |
336 | $this->customGroupDelete($ids['custom_group_id']); | |
337 | } | |
338 | ||
fe6daa04 | 339 | /** |
340 | * CRM-12773 - expectation is that civicrm quietly ignores | |
341 | * fields without values | |
342 | */ | |
00be9182 | 343 | public function testCreateWithNULLCustomCRM12773() { |
fe6daa04 | 344 | $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__); |
345 | $params = $this->_params; | |
346 | $params['custom_' . $ids['custom_field_id']] = NULL; | |
4b58ed3b | 347 | $this->callAPISuccess('contact', 'create', $params); |
fe6daa04 | 348 | $this->customFieldDelete($ids['custom_field_id']); |
349 | $this->customGroupDelete($ids['custom_group_id']); | |
350 | } | |
351 | ||
352 | ||
d424ffde | 353 | /** |
6a488035 TO |
354 | * Test creating a current employer through API |
355 | */ | |
5896d037 | 356 | public function testContactCreateCurrentEmployer() { |
6a488035 | 357 | //here we will just do the get for set-up purposes |
f6722559 | 358 | $count = $this->callAPISuccess('contact', 'getcount', array( |
6a488035 | 359 | 'organization_name' => 'new employer org', |
21dfd5f5 | 360 | 'contact_type' => 'Organization', |
6a488035 TO |
361 | )); |
362 | $this->assertEquals(0, $count); | |
f6722559 | 363 | $employerResult = $this->callAPISuccess('contact', 'create', array_merge($this->_params, array( |
5896d037 TO |
364 | 'current_employer' => 'new employer org', |
365 | ) | |
6a488035 | 366 | )); |
bb043d6f E |
367 | // do it again as an update to check it doesn't cause an error |
368 | $employerResult = $this->callAPISuccess('contact', 'create', array_merge($this->_params, array( | |
6c6e6187 | 369 | 'current_employer' => 'new employer org', |
21dfd5f5 | 370 | 'id' => $employerResult['id'], |
5896d037 | 371 | ) |
bb043d6f | 372 | )); |
f6722559 | 373 | $expectedCount = 1; |
4b58ed3b | 374 | $this->callAPISuccess('contact', 'getcount', array( |
5896d037 | 375 | 'organization_name' => 'new employer org', |
21dfd5f5 | 376 | 'contact_type' => 'Organization', |
5896d037 TO |
377 | ), |
378 | $expectedCount); | |
6a488035 | 379 | |
f6722559 | 380 | $result = $this->callAPISuccess('contact', 'getsingle', array( |
6a488035 TO |
381 | 'id' => $employerResult['id'], |
382 | )); | |
383 | ||
384 | $this->assertEquals('new employer org', $result['current_employer']); | |
385 | ||
386 | } | |
5896d037 | 387 | |
d424ffde | 388 | /** |
bb043d6f E |
389 | * Test creating a current employer through API |
390 | * - check it will re-activate a de-activated employer | |
d424ffde | 391 | */ |
5896d037 | 392 | public function testContactCreateDuplicateCurrentEmployerEnables() { |
bb043d6f E |
393 | //set up - create employer relationship |
394 | $employerResult = $this->callAPISuccess('contact', 'create', array_merge($this->_params, array( | |
5896d037 TO |
395 | 'current_employer' => 'new employer org', |
396 | ) | |
bb043d6f | 397 | )); |
6c6e6187 | 398 | $relationship = $this->callAPISuccess('relationship', 'get', array( |
bb043d6f | 399 | 'contact_id_a' => $employerResult['id'], |
6c6e6187 | 400 | )); |
bb043d6f E |
401 | |
402 | //disable & check it is disabled | |
403 | $this->callAPISuccess('relationship', 'create', array('id' => $relationship['id'], 'is_active' => 0)); | |
6c6e6187 | 404 | $this->callAPISuccess('relationship', 'getvalue', array( |
bb043d6f | 405 | 'id' => $relationship['id'], |
21dfd5f5 | 406 | 'return' => 'is_active', |
bb043d6f E |
407 | ), 0); |
408 | ||
409 | //re-set the current employer - thus enabling the relationshp | |
4b58ed3b | 410 | $this->callAPISuccess('contact', 'create', array_merge($this->_params, array( |
6c6e6187 | 411 | 'current_employer' => 'new employer org', |
21dfd5f5 | 412 | 'id' => $employerResult['id'], |
5896d037 | 413 | ) |
bb043d6f E |
414 | )); |
415 | //check is_active is now 1 | |
6c6e6187 | 416 | $relationship = $this->callAPISuccess('relationship', 'getsingle', array( |
5896d037 TO |
417 | 'return' => 'is_active', |
418 | )); | |
6c6e6187 | 419 | $this->assertEquals(1, $relationship['is_active']); |
bb043d6f E |
420 | } |
421 | ||
8f32b005 | 422 | /** |
423 | * Check deceased contacts are not retrieved | |
424 | * Note at time of writing the default is to return default. This should possibly be changed & test added | |
8f32b005 | 425 | */ |
00be9182 | 426 | public function testGetDeceasedRetrieved() { |
4b58ed3b | 427 | $this->callAPISuccess($this->_entity, 'create', $this->_params); |
5896d037 | 428 | $c2 = $this->callAPISuccess($this->_entity, 'create', array( |
92915c55 TO |
429 | 'first_name' => 'bb', |
430 | 'last_name' => 'ccc', | |
431 | 'contact_type' => 'Individual', | |
432 | 'is_deceased' => 1, | |
433 | )); | |
8f32b005 | 434 | $result = $this->callAPISuccess($this->_entity, 'get', array('is_deceased' => 0)); |
435 | $this->assertFalse(array_key_exists($c2['id'], $result['values'])); | |
436 | } | |
6a488035 | 437 | |
c490a46a CW |
438 | /** |
439 | * Test that sort works - old syntax | |
440 | */ | |
00be9182 | 441 | public function testGetSort() { |
f6722559 | 442 | $c1 = $this->callAPISuccess($this->_entity, 'create', $this->_params); |
5896d037 | 443 | $c2 = $this->callAPISuccess($this->_entity, 'create', array( |
92915c55 TO |
444 | 'first_name' => 'bb', |
445 | 'last_name' => 'ccc', | |
446 | 'contact_type' => 'Individual', | |
447 | )); | |
5896d037 TO |
448 | $result = $this->callAPISuccess($this->_entity, 'get', array( |
449 | 'sort' => 'first_name ASC', | |
450 | 'return.first_name' => 1, | |
451 | 'sequential' => 1, | |
452 | 'rowCount' => 1, | |
453 | )); | |
6a488035 TO |
454 | |
455 | $this->assertEquals('abc1', $result['values'][0]['first_name']); | |
f6722559 | 456 | $result = $this->callAPISuccess($this->_entity, 'get', array( |
457 | 'sort' => 'first_name DESC', | |
458 | 'return.first_name' => 1, | |
459 | 'sequential' => 1, | |
460 | 'rowCount' => 1, | |
461 | )); | |
6a488035 TO |
462 | $this->assertEquals('bb', $result['values'][0]['first_name']); |
463 | ||
f6722559 | 464 | $this->callAPISuccess($this->_entity, 'delete', array('id' => $c1['id'])); |
465 | $this->callAPISuccess($this->_entity, 'delete', array('id' => $c2['id'])); | |
6a488035 | 466 | } |
5896d037 | 467 | |
d424ffde | 468 | /** |
78c0bfc0 | 469 | * Test that we can retrieve contacts using |
470 | * 'id' => array('IN' => array('3,4')) syntax | |
d424ffde | 471 | */ |
00be9182 | 472 | public function testGetINIDArray() { |
78c0bfc0 | 473 | $c1 = $this->callAPISuccess($this->_entity, 'create', $this->_params); |
5896d037 | 474 | $c2 = $this->callAPISuccess($this->_entity, 'create', array( |
92915c55 TO |
475 | 'first_name' => 'bb', |
476 | 'last_name' => 'ccc', | |
477 | 'contact_type' => 'Individual', | |
478 | )); | |
5896d037 | 479 | $c3 = $this->callAPISuccess($this->_entity, 'create', array( |
92915c55 TO |
480 | 'first_name' => 'hh', |
481 | 'last_name' => 'll', | |
482 | 'contact_type' => 'Individual', | |
483 | )); | |
78c0bfc0 | 484 | $result = $this->callAPISuccess($this->_entity, 'get', array('id' => array('IN' => array($c1['id'], $c3['id'])))); |
485 | $this->assertEquals(2, $result['count']); | |
486 | $this->assertEquals(array($c1['id'], $c3['id']), array_keys($result['values'])); | |
487 | $this->callAPISuccess($this->_entity, 'delete', array('id' => $c1['id'])); | |
488 | $this->callAPISuccess($this->_entity, 'delete', array('id' => $c2['id'])); | |
489 | $this->callAPISuccess($this->_entity, 'delete', array('id' => $c3['id'])); | |
490 | } | |
5896d037 | 491 | |
d424ffde | 492 | /** |
6a488035 TO |
493 | * Test variants on deleted behaviour |
494 | */ | |
00be9182 | 495 | public function testGetDeleted() { |
6a488035 | 496 | $params = $this->_params; |
f6722559 | 497 | $contact1 = $this->callAPISuccess('contact', 'create', $params); |
6a488035 TO |
498 | $params['is_deleted'] = 1; |
499 | $params['last_name'] = 'bcd'; | |
f6722559 | 500 | $contact2 = $this->callAPISuccess('contact', 'create', $params); |
501 | $countActive = $this->callAPISuccess('contact', 'getcount', array('showAll' => 'active')); | |
502 | $countAll = $this->callAPISuccess('contact', 'getcount', array('showAll' => 'all')); | |
503 | $countTrash = $this->callAPISuccess('contact', 'getcount', array('showAll' => 'trash')); | |
504 | $countDefault = $this->callAPISuccess('contact', 'getcount', array()); | |
505 | $countDeleted = $this->callAPISuccess('contact', 'getcount', array( | |
506 | 'contact_is_deleted' => 1, | |
5896d037 | 507 | )); |
f6722559 | 508 | $countNotDeleted = $this->callAPISuccess('contact', 'getcount', array( |
509 | 'contact_is_deleted' => 0, | |
5896d037 | 510 | )); |
f6722559 | 511 | $this->callAPISuccess('contact', 'delete', array('id' => $contact1['id'])); |
512 | $this->callAPISuccess('contact', 'delete', array('id' => $contact2['id'])); | |
6a488035 TO |
513 | $this->assertEquals(1, $countNotDeleted, 'contact_is_deleted => 0 is respected in line ' . __LINE__); |
514 | $this->assertEquals(1, $countActive, 'in line ' . __LINE__); | |
515 | $this->assertEquals(1, $countTrash, 'in line ' . __LINE__); | |
516 | $this->assertEquals(2, $countAll, 'in line ' . __LINE__); | |
517 | $this->assertEquals(1, $countDeleted, 'in line ' . __LINE__); | |
518 | $this->assertEquals(1, $countDefault, 'Only active by default in line ' . __LINE__); | |
519 | } | |
c490a46a CW |
520 | |
521 | /** | |
522 | * Test that sort works - new syntax | |
523 | */ | |
00be9182 | 524 | public function testGetSortNewSYntax() { |
5896d037 TO |
525 | $c1 = $this->callAPISuccess($this->_entity, 'create', $this->_params); |
526 | $c2 = $this->callAPISuccess($this->_entity, 'create', array( | |
92915c55 TO |
527 | 'first_name' => 'bb', |
528 | 'last_name' => 'ccc', | |
529 | 'contact_type' => 'Individual', | |
530 | )); | |
f6722559 | 531 | $result = $this->callAPISuccess($this->_entity, 'getvalue', array( |
6a488035 | 532 | 'return' => 'first_name', |
5896d037 TO |
533 | 'options' => array( |
534 | 'limit' => 1, | |
535 | 'sort' => 'first_name', | |
536 | ), | |
537 | )); | |
6a488035 TO |
538 | $this->assertEquals('abc1', $result, 'in line' . __LINE__); |
539 | ||
f6722559 | 540 | $result = $this->callAPISuccess($this->_entity, 'getvalue', array( |
5896d037 TO |
541 | 'return' => 'first_name', |
542 | 'options' => array( | |
543 | 'limit' => 1, | |
544 | 'sort' => 'first_name DESC', | |
545 | ), | |
546 | )); | |
6a488035 TO |
547 | $this->assertEquals('bb', $result); |
548 | ||
f6722559 | 549 | $this->callAPISuccess($this->_entity, 'delete', array('id' => $c1['id'])); |
550 | $this->callAPISuccess($this->_entity, 'delete', array('id' => $c2['id'])); | |
6a488035 | 551 | } |
c490a46a CW |
552 | |
553 | /** | |
4b58ed3b | 554 | * Test apostrophe works in get & create |
6a488035 | 555 | */ |
00be9182 | 556 | public function testGetApostropheCRM10857() { |
6a488035 | 557 | $params = array_merge($this->_params, array('last_name' => "O'Connor")); |
4b58ed3b | 558 | $this->callAPISuccess($this->_entity, 'create', $params); |
f6722559 | 559 | $result = $this->callAPISuccess($this->_entity, 'getsingle', array( |
6a488035 TO |
560 | 'last_name' => "O'Connor", |
561 | 'sequential' => 1, | |
562 | )); | |
563 | $this->assertEquals("O'Connor", $result['last_name'], 'in line' . __LINE__); | |
564 | } | |
565 | ||
566 | /** | |
100fef9d | 567 | * Check with complete array + custom field |
6a488035 TO |
568 | * Note that the test is written on purpose without any |
569 | * variables specific to participant so it can be replicated into other entities | |
570 | * and / or moved to the automated test suite | |
571 | */ | |
00be9182 | 572 | public function testGetWithCustom() { |
6a488035 TO |
573 | $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__); |
574 | ||
575 | $params = $this->_params; | |
576 | $params['custom_' . $ids['custom_field_id']] = "custom string"; | |
577 | $description = "/*this demonstrates setting a custom field through the API "; | |
578 | $subfile = "CustomFieldGet"; | |
f6722559 | 579 | $result = $this->callAPISuccess($this->_entity, 'create', $params); |
6a488035 | 580 | |
5896d037 | 581 | $check = $this->callAPIAndDocument($this->_entity, 'get', array( |
92915c55 TO |
582 | 'return.custom_' . $ids['custom_field_id'] => 1, |
583 | 'id' => $result['id'], | |
584 | ), __FUNCTION__, __FILE__, $description, $subfile); | |
6a488035 | 585 | |
4b58ed3b | 586 | $this->assertEquals("custom string", $check['values'][$check['id']]['custom_' . $ids['custom_field_id']]); |
f6722559 | 587 | $fields = ($this->callAPISuccess('contact', 'getfields', $params)); |
6a488035 TO |
588 | $this->assertTrue(is_array($fields['values']['custom_' . $ids['custom_field_id']])); |
589 | $this->customFieldDelete($ids['custom_field_id']); | |
590 | $this->customGroupDelete($ids['custom_group_id']); | |
591 | } | |
c490a46a CW |
592 | |
593 | /** | |
100fef9d | 594 | * Check with complete array + custom field |
c490a46a CW |
595 | * Note that the test is written on purpose without any |
596 | * variables specific to participant so it can be replicated into other entities | |
597 | * and / or moved to the automated test suite | |
598 | */ | |
00be9182 | 599 | public function testGetWithCustomReturnSyntax() { |
6a488035 TO |
600 | $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__); |
601 | ||
602 | $params = $this->_params; | |
603 | $params['custom_' . $ids['custom_field_id']] = "custom string"; | |
604 | $description = "/*this demonstrates setting a custom field through the API "; | |
605 | $subfile = "CustomFieldGetReturnSyntaxVariation"; | |
f6722559 | 606 | $result = $this->callAPISuccess($this->_entity, 'create', $params); |
607 | $params = array('return' => 'custom_' . $ids['custom_field_id'], 'id' => $result['id']); | |
608 | $check = $this->callAPIAndDocument($this->_entity, 'get', $params, __FUNCTION__, __FILE__, $description, $subfile); | |
6a488035 | 609 | |
43ef1263 | 610 | $this->assertEquals("custom string", $check['values'][$check['id']]['custom_' . $ids['custom_field_id']]); |
6a488035 TO |
611 | $this->customFieldDelete($ids['custom_field_id']); |
612 | $this->customGroupDelete($ids['custom_group_id']); | |
613 | } | |
614 | ||
43ef1263 EM |
615 | /** |
616 | * Check that address name is returned if required | |
617 | */ | |
5896d037 | 618 | public function testGetReturnAddressName() { |
43ef1263 | 619 | $contactID = $this->individualCreate(); |
5896d037 | 620 | $this->callAPISuccess('address', 'create', array( |
92915c55 TO |
621 | 'contact_id' => $contactID, |
622 | 'address_name' => 'My house', | |
623 | 'location_type_id' => 'Home', | |
624 | 'street_address' => '1 my road', | |
625 | )); | |
5896d037 | 626 | $result = $this->callAPISuccessGetSingle('contact', array( |
92915c55 TO |
627 | 'return' => 'address_name, street_address', |
628 | 'id' => $contactID, | |
629 | )); | |
43ef1263 EM |
630 | $this->assertEquals('1 my road', $result['street_address']); |
631 | $this->assertEquals('My house', $result['address_name']); | |
632 | ||
633 | } | |
634 | ||
00be9182 | 635 | public function testGetGroupIDFromContact() { |
5896d037 | 636 | $groupId = $this->groupCreate(); |
6a488035 | 637 | $description = "Get all from group and display contacts"; |
5896d037 TO |
638 | $subFile = "GroupFilterUsingContactAPI"; |
639 | $params = array( | |
6a488035 TO |
640 | 'email' => 'man2@yahoo.com', |
641 | 'contact_type' => 'Individual', | |
642 | 'location_type_id' => 1, | |
6a488035 TO |
643 | 'api.group_contact.create' => array('group_id' => $groupId), |
644 | ); | |
645 | ||
4b58ed3b | 646 | $this->callAPISuccess('contact', 'create', $params); |
6a488035 TO |
647 | // testing as integer |
648 | $params = array( | |
649 | 'filter.group_id' => $groupId, | |
6a488035 TO |
650 | 'contact_type' => 'Individual', |
651 | ); | |
4b58ed3b | 652 | $result = $this->callAPIAndDocument('contact', 'get', $params, __FUNCTION__, __FILE__, $description, $subFile); |
6a488035 TO |
653 | $this->assertEquals(1, $result['count']); |
654 | // group 26 doesn't exist, but we can still search contacts in it. | |
655 | $params = array( | |
656 | 'filter.group_id' => 26, | |
6a488035 TO |
657 | 'contact_type' => 'Individual', |
658 | ); | |
4b58ed3b | 659 | $this->callAPISuccess('contact', 'get', $params); |
6a488035 TO |
660 | // testing as string |
661 | $params = array( | |
f6722559 | 662 | 'filter.group_id' => "$groupId, 26", |
6a488035 TO |
663 | 'contact_type' => 'Individual', |
664 | ); | |
4b58ed3b | 665 | $result = $this->callAPIAndDocument('contact', 'get', $params, __FUNCTION__, __FILE__, $description, $subFile); |
6a488035 TO |
666 | $this->assertEquals(1, $result['count']); |
667 | $params = array( | |
668 | 'filter.group_id' => "26,27", | |
6a488035 TO |
669 | 'contact_type' => 'Individual', |
670 | ); | |
4b58ed3b | 671 | $this->callAPISuccess('contact', 'get', $params); |
6a488035 TO |
672 | |
673 | // testing as string | |
6c6e6187 | 674 | $params = array( |
5896d037 | 675 | 'filter.group_id' => array($groupId, 26), |
6a488035 TO |
676 | 'contact_type' => 'Individual', |
677 | ); | |
4b58ed3b | 678 | $result = $this->callAPIAndDocument('contact', 'get', $params, __FUNCTION__, __FILE__, $description, $subFile); |
6a488035 TO |
679 | $this->assertEquals(1, $result['count']); |
680 | ||
681 | //test in conjunction with other criteria | |
6c6e6187 | 682 | $params = array( |
5896d037 | 683 | 'filter.group_id' => array($groupId, 26), |
6a488035 TO |
684 | 'contact_type' => 'Organization', |
685 | ); | |
6c6e6187 TO |
686 | $this->callAPISuccess('contact', 'get', $params); |
687 | $params = array( | |
5896d037 | 688 | 'filter.group_id' => array(26, 27), |
6a488035 TO |
689 | 'contact_type' => 'Individual', |
690 | ); | |
f6722559 | 691 | $result = $this->callAPISuccess('contact', 'get', $params); |
4b58ed3b | 692 | $this->assertEquals(0, $result['count']); |
6a488035 TO |
693 | } |
694 | ||
695 | /** | |
696 | * Verify that attempt to create individual contact with two chained websites succeeds | |
697 | */ | |
00be9182 | 698 | public function testCreateIndividualWithContributionDottedSyntax() { |
6a488035 | 699 | $description = "test demonstrates the syntax to create 2 chained entities"; |
5896d037 TO |
700 | $subFile = "ChainTwoWebsites"; |
701 | $params = array( | |
6a488035 TO |
702 | 'first_name' => 'abc3', |
703 | 'last_name' => 'xyz3', | |
704 | 'contact_type' => 'Individual', | |
705 | 'email' => 'man3@yahoo.com', | |
6a488035 TO |
706 | 'api.contribution.create' => array( |
707 | 'receive_date' => '2010-01-01', | |
708 | 'total_amount' => 100.00, | |
5896d037 | 709 | 'financial_type_id' => $this->_financialTypeId, |
6a488035 TO |
710 | 'payment_instrument_id' => 1, |
711 | 'non_deductible_amount' => 10.00, | |
712 | 'fee_amount' => 50.00, | |
713 | 'net_amount' => 90.00, | |
714 | 'trxn_id' => 15345, | |
715 | 'invoice_id' => 67990, | |
716 | 'source' => 'SSF', | |
717 | 'contribution_status_id' => 1, | |
718 | ), | |
719 | 'api.website.create' => array( | |
720 | 'url' => "http://civicrm.org", | |
721 | ), | |
722 | 'api.website.create.2' => array( | |
723 | 'url' => "http://chained.org", | |
724 | ), | |
725 | ); | |
726 | ||
4b58ed3b | 727 | $result = $this->callAPIAndDocument('Contact', 'create', $params, __FUNCTION__, __FILE__, $description, $subFile); |
6a488035 TO |
728 | |
729 | $this->assertEquals(1, $result['id'], "In line " . __LINE__); | |
f6722559 | 730 | // checking child function result not covered in callAPIAndDocument |
731 | $this->assertAPISuccess($result['values'][$result['id']]['api.website.create']); | |
6a488035 TO |
732 | $this->assertEquals("http://chained.org", $result['values'][$result['id']]['api.website.create.2']['values'][0]['url'], "In line " . __LINE__); |
733 | $this->assertEquals("http://civicrm.org", $result['values'][$result['id']]['api.website.create']['values'][0]['url'], "In line " . __LINE__); | |
734 | ||
735 | // delete the contact | |
f6722559 | 736 | $this->callAPISuccess('contact', 'delete', $result); |
6a488035 TO |
737 | } |
738 | ||
739 | /** | |
740 | * Verify that attempt to create individual contact with chained contribution and website succeeds | |
741 | */ | |
00be9182 | 742 | public function testCreateIndividualWithContributionChainedArrays() { |
6a488035 TO |
743 | $params = array( |
744 | 'first_name' => 'abc3', | |
745 | 'last_name' => 'xyz3', | |
746 | 'contact_type' => 'Individual', | |
747 | 'email' => 'man3@yahoo.com', | |
6a488035 TO |
748 | 'api.contribution.create' => array( |
749 | 'receive_date' => '2010-01-01', | |
750 | 'total_amount' => 100.00, | |
5896d037 | 751 | 'financial_type_id' => $this->_financialTypeId, |
6a488035 TO |
752 | 'payment_instrument_id' => 1, |
753 | 'non_deductible_amount' => 10.00, | |
754 | 'fee_amount' => 50.00, | |
755 | 'net_amount' => 90.00, | |
756 | 'trxn_id' => 12345, | |
757 | 'invoice_id' => 67890, | |
758 | 'source' => 'SSF', | |
759 | 'contribution_status_id' => 1, | |
760 | ), | |
761 | 'api.website.create' => array( | |
762 | array( | |
763 | 'url' => "http://civicrm.org", | |
764 | ), | |
765 | array( | |
766 | 'url' => "http://chained.org", | |
767 | 'website_type_id' => 2, | |
768 | ), | |
769 | ), | |
770 | ); | |
771 | ||
772 | $description = "demonstrates creating two websites as an array"; | |
5896d037 TO |
773 | $subfile = "ChainTwoWebsitesSyntax2"; |
774 | $result = $this->callAPIAndDocument('Contact', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile); | |
f6722559 | 775 | |
776 | $this->assertEquals(1, $result['id']); | |
777 | // the callAndDocument doesn't check the chained call | |
6a488035 TO |
778 | $this->assertEquals(0, $result['values'][$result['id']]['api.website.create'][0]['is_error'], "In line " . __LINE__); |
779 | $this->assertEquals("http://chained.org", $result['values'][$result['id']]['api.website.create'][1]['values'][0]['url'], "In line " . __LINE__); | |
780 | $this->assertEquals("http://civicrm.org", $result['values'][$result['id']]['api.website.create'][0]['values'][0]['url'], "In line " . __LINE__); | |
781 | ||
f6722559 | 782 | $this->callAPISuccess('contact', 'delete', $result); |
6a488035 TO |
783 | } |
784 | ||
785 | /** | |
786 | * Verify that attempt to create individual contact with first | |
787 | * and last names and email succeeds | |
788 | */ | |
00be9182 | 789 | public function testCreateIndividualWithNameEmail() { |
6a488035 TO |
790 | $params = array( |
791 | 'first_name' => 'abc3', | |
792 | 'last_name' => 'xyz3', | |
793 | 'contact_type' => 'Individual', | |
794 | 'email' => 'man3@yahoo.com', | |
6a488035 TO |
795 | ); |
796 | ||
f6722559 | 797 | $contact = $this->callAPISuccess('contact', 'create', $params); |
6a488035 TO |
798 | $this->assertEquals(1, $contact['id'], "In line " . __LINE__); |
799 | ||
800 | // delete the contact | |
f6722559 | 801 | $this->callAPISuccess('contact', 'delete', $contact); |
6a488035 | 802 | } |
5896d037 | 803 | |
6a488035 TO |
804 | /** |
805 | * Verify that attempt to create individual contact with no data fails | |
806 | */ | |
00be9182 | 807 | public function testCreateIndividualWithOutNameEmail() { |
6a488035 TO |
808 | $params = array( |
809 | 'contact_type' => 'Individual', | |
6a488035 | 810 | ); |
4b58ed3b | 811 | $this->callAPIFailure('contact', 'create', $params); |
6a488035 | 812 | } |
5896d037 | 813 | |
6a488035 TO |
814 | /** |
815 | * Verify that attempt to create individual contact with first | |
816 | * and last names, email and location type succeeds | |
817 | */ | |
00be9182 | 818 | public function testCreateIndividualWithNameEmailLocationType() { |
6a488035 TO |
819 | $params = array( |
820 | 'first_name' => 'abc4', | |
821 | 'last_name' => 'xyz4', | |
822 | 'email' => 'man4@yahoo.com', | |
823 | 'contact_type' => 'Individual', | |
824 | 'location_type_id' => 1, | |
6a488035 | 825 | ); |
f6722559 | 826 | $result = $this->callAPISuccess('contact', 'create', $params); |
6a488035 | 827 | |
6a488035 TO |
828 | $this->assertEquals(1, $result['id'], "In line " . __LINE__); |
829 | ||
f6722559 | 830 | $this->callAPISuccess('contact', 'delete', array('id' => $result['id'])); |
6a488035 TO |
831 | } |
832 | ||
833 | /** | |
834 | * Verify that when changing employers | |
835 | * the old employer relationship becomes inactive | |
836 | */ | |
00be9182 | 837 | public function testCreateIndividualWithEmployer() { |
6a488035 TO |
838 | $employer = $this->organizationCreate(); |
839 | $employer2 = $this->organizationCreate(); | |
840 | ||
841 | $params = array( | |
5896d037 TO |
842 | 'email' => 'man4@yahoo.com', |
843 | 'contact_type' => 'Individual', | |
844 | 'employer_id' => $employer, | |
6a488035 TO |
845 | ); |
846 | ||
f6722559 | 847 | $result = $this->callAPISuccess('contact', 'create', $params); |
848 | $relationships = $this->callAPISuccess('relationship', 'get', array( | |
6a488035 TO |
849 | 'contact_id_a' => $result['id'], |
850 | 'sequential' => 1, | |
851 | )); | |
852 | ||
853 | $this->assertEquals($employer, $relationships['values'][0]['contact_id_b']); | |
854 | ||
855 | // Add more random relationships to make the test more realistic | |
4b58ed3b EM |
856 | foreach (array('Employee of', 'Volunteer for') as $relationshipType) { |
857 | $relTypeId = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_RelationshipType', $relationshipType, 'id', 'name_a_b'); | |
858 | $this->callAPISuccess('relationship', 'create', array( | |
6a488035 TO |
859 | 'contact_id_a' => $result['id'], |
860 | 'contact_id_b' => $this->organizationCreate(), | |
861 | 'is_active' => 1, | |
862 | 'relationship_type_id' => $relTypeId, | |
863 | )); | |
6c6e6187 | 864 | } |
6a488035 TO |
865 | |
866 | // Add second employer | |
867 | $params['employer_id'] = $employer2; | |
868 | $params['id'] = $result['id']; | |
f6722559 | 869 | $result = $this->callAPISuccess('contact', 'create', $params); |
6a488035 | 870 | |
f6722559 | 871 | $relationships = $this->callAPISuccess('relationship', 'get', array( |
6a488035 TO |
872 | 'contact_id_a' => $result['id'], |
873 | 'sequential' => 1, | |
874 | 'is_active' => 0, | |
875 | )); | |
876 | ||
877 | $this->assertEquals($employer, $relationships['values'][0]['contact_id_b']); | |
878 | } | |
879 | ||
880 | /** | |
881 | * Verify that attempt to create household contact with details | |
882 | * succeeds | |
883 | */ | |
00be9182 | 884 | public function testCreateHouseholdDetails() { |
6a488035 TO |
885 | $params = array( |
886 | 'household_name' => 'abc8\'s House', | |
887 | 'nick_name' => 'x House', | |
888 | 'email' => 'man8@yahoo.com', | |
889 | 'contact_type' => 'Household', | |
6a488035 TO |
890 | ); |
891 | ||
f6722559 | 892 | $contact = $this->callAPISuccess('contact', 'create', $params); |
893 | ||
6a488035 TO |
894 | $this->assertEquals(1, $contact['id'], "In line " . __LINE__); |
895 | ||
f6722559 | 896 | $this->callAPISuccess('contact', 'delete', $contact); |
6a488035 | 897 | } |
5896d037 | 898 | |
6a488035 TO |
899 | /** |
900 | * Verify that attempt to create household contact with inadequate details | |
901 | * fails | |
902 | */ | |
00be9182 | 903 | public function testCreateHouseholdInadequateDetails() { |
6a488035 TO |
904 | $params = array( |
905 | 'nick_name' => 'x House', | |
906 | 'email' => 'man8@yahoo.com', | |
907 | 'contact_type' => 'Household', | |
6a488035 | 908 | ); |
4b58ed3b | 909 | $this->callAPIFailure('contact', 'create', $params); |
6a488035 TO |
910 | } |
911 | ||
6a488035 TO |
912 | /** |
913 | * Verify successful update of individual contact | |
914 | */ | |
00be9182 | 915 | public function testUpdateIndividualWithAll() { |
6a488035 TO |
916 | // Insert a row in civicrm_contact creating individual contact |
917 | $op = new PHPUnit_Extensions_Database_Operation_Insert(); | |
918 | $op->execute($this->_dbconn, | |
bbfd46a5 | 919 | $this->createXMLDataSet( |
6a488035 TO |
920 | dirname(__FILE__) . '/dataset/contact_ind.xml' |
921 | ) | |
922 | ); | |
923 | ||
924 | $params = array( | |
925 | 'id' => 23, | |
926 | 'first_name' => 'abcd', | |
927 | 'contact_type' => 'Individual', | |
928 | 'nick_name' => 'This is nickname first', | |
929 | 'do_not_email' => '1', | |
930 | 'do_not_phone' => '1', | |
931 | 'do_not_mail' => '1', | |
932 | 'do_not_trade' => '1', | |
933 | 'legal_identifier' => 'ABC23853ZZ2235', | |
934 | 'external_identifier' => '1928837465', | |
935 | 'image_URL' => 'http://some.url.com/image.jpg', | |
936 | 'home_url' => 'http://www.example.org', | |
f6722559 | 937 | |
938 | ); | |
43ef1263 | 939 | |
4b58ed3b | 940 | $this->callAPISuccess('Contact', 'Update', $params); |
f6722559 | 941 | $getResult = $this->callAPISuccess('Contact', 'Get', $params); |
6a488035 TO |
942 | unset($params['contact_id']); |
943 | //Todo - neither API v2 or V3 are testing for home_url - not sure if it is being set. | |
4b58ed3b | 944 | //reducing this test partially back to api v2 level to get it through |
6a488035 TO |
945 | unset($params['home_url']); |
946 | foreach ($params as $key => $value) { | |
4b58ed3b | 947 | $this->assertEquals($value, $getResult['values'][23][$key]); |
6a488035 TO |
948 | } |
949 | // Check updated civicrm_contact against expected | |
bbfd46a5 | 950 | $expected = $this->createXMLDataSet( |
6a488035 TO |
951 | dirname(__FILE__) . '/dataset/contact_ind_upd.xml' |
952 | ); | |
bbfd46a5 | 953 | $actual = new PHPUnit_Extensions_Database_DataSet_QueryDataSet( |
6a488035 TO |
954 | $this->_dbconn |
955 | ); | |
956 | $actual->addTable('civicrm_contact'); | |
957 | $expected->matches($actual); | |
958 | } | |
959 | ||
960 | /** | |
961 | * Verify successful update of organization contact | |
962 | */ | |
00be9182 | 963 | public function testUpdateOrganizationWithAll() { |
6a488035 TO |
964 | // Insert a row in civicrm_contact creating organization contact |
965 | $op = new PHPUnit_Extensions_Database_Operation_Insert(); | |
966 | $op->execute($this->_dbconn, | |
bbfd46a5 | 967 | $this->createXMLDataSet( |
6a488035 TO |
968 | dirname(__FILE__) . '/dataset/contact_org.xml' |
969 | ) | |
970 | ); | |
971 | ||
972 | $params = array( | |
973 | 'id' => 24, | |
974 | 'organization_name' => 'WebAccess India Pvt Ltd', | |
975 | 'legal_name' => 'WebAccess', | |
976 | 'sic_code' => 'ABC12DEF', | |
977 | 'contact_type' => 'Organization', | |
6a488035 TO |
978 | ); |
979 | ||
4b58ed3b | 980 | $this->callAPISuccess('Contact', 'Update', $params); |
6a488035 TO |
981 | |
982 | // Check updated civicrm_contact against expected | |
bbfd46a5 | 983 | $expected = $this->createXMLDataSet( |
6a488035 TO |
984 | dirname(__FILE__) . '/dataset/contact_org_upd.xml' |
985 | ); | |
bbfd46a5 | 986 | $actual = new PHPUnit_Extensions_Database_DataSet_QueryDataSet( |
6a488035 TO |
987 | $this->_dbconn |
988 | ); | |
989 | $actual->addTable('civicrm_contact'); | |
990 | $expected->matches($actual); | |
991 | } | |
992 | ||
993 | /** | |
994 | * Verify successful update of household contact | |
995 | */ | |
00be9182 | 996 | public function testUpdateHouseholdwithAll() { |
6a488035 TO |
997 | // Insert a row in civicrm_contact creating household contact |
998 | $op = new PHPUnit_Extensions_Database_Operation_Insert(); | |
999 | $op->execute($this->_dbconn, | |
bbfd46a5 | 1000 | $this->createXMLDataSet( |
6a488035 TO |
1001 | dirname(__FILE__) . '/dataset/contact_hld.xml' |
1002 | ) | |
1003 | ); | |
1004 | ||
1005 | $params = array( | |
1006 | 'id' => 25, | |
1007 | 'household_name' => 'ABC household', | |
1008 | 'nick_name' => 'ABC House', | |
1009 | 'contact_type' => 'Household', | |
6a488035 TO |
1010 | ); |
1011 | ||
f6722559 | 1012 | $result = $this->callAPISuccess('Contact', 'Update', $params); |
6a488035 | 1013 | |
43ef1263 EM |
1014 | $expected = array( |
1015 | 'contact_type' => 'Household', | |
1016 | 'is_opt_out' => 0, | |
1017 | 'sort_name' => 'ABC household', | |
1018 | 'display_name' => 'ABC household', | |
1019 | 'nick_name' => 'ABC House', | |
6a488035 | 1020 | ); |
43ef1263 | 1021 | $this->getAndCheck($expected, $result['id'], 'contact'); |
6a488035 TO |
1022 | } |
1023 | ||
1024 | /** | |
1025 | * Test civicrm_update() Deliberately exclude contact_type as it should still | |
1026 | * cope using civicrm_api CRM-7645 | |
1027 | */ | |
1028 | ||
1029 | public function testUpdateCreateWithID() { | |
1030 | // Insert a row in civicrm_contact creating individual contact | |
1031 | $op = new PHPUnit_Extensions_Database_Operation_Insert(); | |
1032 | $op->execute($this->_dbconn, | |
bbfd46a5 | 1033 | $this->createXMLDataSet( |
6a488035 TO |
1034 | dirname(__FILE__) . '/dataset/contact_ind.xml' |
1035 | ) | |
1036 | ); | |
1037 | ||
6a488035 TO |
1038 | $params = array( |
1039 | 'id' => 23, | |
1040 | 'first_name' => 'abcd', | |
1041 | 'last_name' => 'wxyz', | |
6a488035 | 1042 | ); |
4b58ed3b | 1043 | $this->callAPISuccess('Contact', 'Update', $params); |
6a488035 TO |
1044 | } |
1045 | ||
1046 | /** | |
1047 | * Test civicrm_contact_delete() with no contact ID | |
1048 | */ | |
00be9182 | 1049 | public function testContactDeleteNoID() { |
6a488035 TO |
1050 | $params = array( |
1051 | 'foo' => 'bar', | |
6a488035 | 1052 | ); |
4b58ed3b | 1053 | $this->callAPIFailure('contact', 'delete', $params); |
6a488035 TO |
1054 | } |
1055 | ||
1056 | /** | |
1057 | * Test civicrm_contact_delete() with error | |
1058 | */ | |
00be9182 | 1059 | public function testContactDeleteError() { |
f6722559 | 1060 | $params = array('contact_id' => 999); |
4b58ed3b | 1061 | $this->callAPIFailure('contact', 'delete', $params); |
6a488035 TO |
1062 | } |
1063 | ||
1064 | /** | |
1065 | * Test civicrm_contact_delete() | |
1066 | */ | |
00be9182 | 1067 | public function testContactDelete() { |
f6722559 | 1068 | $contactID = $this->individualCreate(); |
6a488035 | 1069 | $params = array( |
5896d037 | 1070 | 'id' => $contactID, |
6a488035 | 1071 | ); |
4b58ed3b | 1072 | $this->callAPIAndDocument('contact', 'delete', $params, __FUNCTION__, __FILE__); |
6a488035 TO |
1073 | } |
1074 | ||
1075 | /** | |
1076 | * Test civicrm_contact_get() return only first name | |
1077 | */ | |
1078 | public function testContactGetRetFirst() { | |
f6722559 | 1079 | $contact = $this->callAPISuccess('contact', 'create', $this->_params); |
6a488035 TO |
1080 | $params = array( |
1081 | 'contact_id' => $contact['id'], | |
1082 | 'return_first_name' => TRUE, | |
1083 | 'sort' => 'first_name', | |
6a488035 | 1084 | ); |
f6722559 | 1085 | $result = $this->callAPISuccess('contact', 'get', $params); |
4b58ed3b EM |
1086 | $this->assertEquals(1, $result['count']); |
1087 | $this->assertEquals($contact['id'], $result['id']); | |
1088 | $this->assertEquals('abc1', $result['values'][$contact['id']]['first_name']); | |
6a488035 TO |
1089 | } |
1090 | ||
1091 | /** | |
1092 | * Test civicrm_contact_get() return only first name & last name | |
1093 | * Use comma separated string return with a space | |
1094 | */ | |
1095 | public function testContactGetRetFirstLast() { | |
f6722559 | 1096 | $contact = $this->callAPISuccess('contact', 'create', $this->_params); |
6a488035 TO |
1097 | $params = array( |
1098 | 'contact_id' => $contact['id'], | |
1099 | 'return' => 'first_name, last_name', | |
6a488035 | 1100 | ); |
f6722559 | 1101 | $result = $this->callAPISuccess('contact', 'getsingle', $params); |
4b58ed3b EM |
1102 | $this->assertEquals('abc1', $result['first_name']); |
1103 | $this->assertEquals('xyz1', $result['last_name']); | |
6a488035 TO |
1104 | //check that other defaults not returns |
1105 | $this->assertArrayNotHasKey('sort_name', $result); | |
1106 | $params = array( | |
1107 | 'contact_id' => $contact['id'], | |
1108 | 'return' => 'first_name,last_name', | |
6a488035 | 1109 | ); |
f6722559 | 1110 | $result = $this->callAPISuccess('contact', 'getsingle', $params); |
4b58ed3b EM |
1111 | $this->assertEquals('abc1', $result['first_name']); |
1112 | $this->assertEquals('xyz1', $result['last_name']); | |
6a488035 TO |
1113 | //check that other defaults not returns |
1114 | $this->assertArrayNotHasKey('sort_name', $result); | |
1115 | } | |
1116 | ||
1117 | /** | |
1118 | * Test civicrm_contact_get() return only first name & last name | |
1119 | * Use comma separated string return without a space | |
1120 | */ | |
1121 | public function testContactGetRetFirstLastNoComma() { | |
f6722559 | 1122 | $contact = $this->callAPISuccess('contact', 'create', $this->_params); |
6a488035 TO |
1123 | $params = array( |
1124 | 'contact_id' => $contact['id'], | |
1125 | 'return' => 'first_name,last_name', | |
6a488035 | 1126 | ); |
f6722559 | 1127 | $result = $this->callAPISuccess('contact', 'getsingle', $params); |
4b58ed3b EM |
1128 | $this->assertEquals('abc1', $result['first_name']); |
1129 | $this->assertEquals('xyz1', $result['last_name']); | |
6a488035 TO |
1130 | //check that other defaults not returns |
1131 | $this->assertArrayNotHasKey('sort_name', $result); | |
1132 | } | |
1133 | ||
1134 | /** | |
1135 | * Test civicrm_contact_get() with default return properties | |
1136 | */ | |
1137 | public function testContactGetRetDefault() { | |
43ef1263 | 1138 | $contactID = $this->individualCreate(); |
6a488035 | 1139 | $params = array( |
43ef1263 | 1140 | 'contact_id' => $contactID, |
6a488035 | 1141 | 'sort' => 'first_name', |
6a488035 | 1142 | ); |
f6722559 | 1143 | $result = $this->callAPISuccess('contact', 'get', $params); |
43ef1263 EM |
1144 | $this->assertEquals($contactID, $result['values'][$contactID]['contact_id']); |
1145 | $this->assertEquals('Anthony', $result['values'][$contactID]['first_name']); | |
6a488035 TO |
1146 | } |
1147 | ||
1148 | /** | |
1d6020f1 | 1149 | * Test civicrm_contact_getquick() with empty name param |
6a488035 TO |
1150 | */ |
1151 | public function testContactGetQuick() { | |
1152 | // Insert a row in civicrm_contact creating individual contact | |
1153 | $op = new PHPUnit_Extensions_Database_Operation_Insert(); | |
1154 | $op->execute($this->_dbconn, | |
bbfd46a5 | 1155 | $this->createXMLDataSet( |
6a488035 TO |
1156 | dirname(__FILE__) . '/dataset/contact_17.xml' |
1157 | ) | |
1158 | ); | |
1159 | $op->execute($this->_dbconn, | |
bbfd46a5 | 1160 | $this->createXMLDataSet( |
6a488035 TO |
1161 | dirname(__FILE__) . '/dataset/email_contact_17.xml' |
1162 | ) | |
1163 | ); | |
1164 | $params = array( | |
1165 | 'name' => "T", | |
6a488035 TO |
1166 | ); |
1167 | ||
1d6020f1 | 1168 | $result = $this->callAPISuccess('contact', 'getquick', $params); |
6a488035 TO |
1169 | $this->assertEquals(17, $result['values'][0]['id'], 'in line ' . __LINE__); |
1170 | } | |
1171 | ||
1172 | /** | |
1173 | * Test civicrm_contact_get) with empty params | |
1174 | */ | |
1175 | public function testContactGetEmptyParams() { | |
4b58ed3b | 1176 | $this->callAPISuccess('contact', 'get', array()); |
6a488035 TO |
1177 | } |
1178 | ||
1179 | /** | |
1180 | * Test civicrm_contact_get(,true) with no matches | |
1181 | */ | |
1182 | public function testContactGetOldParamsNoMatches() { | |
1183 | // Insert a row in civicrm_contact creating contact 17 | |
1184 | $op = new PHPUnit_Extensions_Database_Operation_Insert(); | |
1185 | $op->execute($this->_dbconn, | |
bbfd46a5 | 1186 | $this->createXMLDataSet( |
6a488035 TO |
1187 | dirname(__FILE__) . '/dataset/contact_17.xml' |
1188 | ) | |
1189 | ); | |
1190 | ||
1191 | $params = array( | |
1192 | 'first_name' => 'Fred', | |
6a488035 | 1193 | ); |
f6722559 | 1194 | $result = $this->callAPISuccess('contact', 'get', $params); |
6a488035 TO |
1195 | $this->assertEquals(0, $result['count'], 'in line ' . __LINE__); |
1196 | } | |
1197 | ||
1198 | /** | |
1199 | * Test civicrm_contact_get(,true) with one match | |
1200 | */ | |
1201 | public function testContactGetOldParamsOneMatch() { | |
1202 | // Insert a row in civicrm_contact creating contact 17 | |
1203 | $op = new PHPUnit_Extensions_Database_Operation_Insert(); | |
1204 | $op->execute($this->_dbconn, | |
bbfd46a5 | 1205 | $this->createXMLDataSet(dirname(__FILE__) . '/dataset/contact_17.xml' |
6a488035 TO |
1206 | ) |
1207 | ); | |
1208 | ||
1209 | $params = array( | |
1210 | 'first_name' => 'Test', | |
6a488035 | 1211 | ); |
f6722559 | 1212 | $result = $this->callAPISuccess('contact', 'get', $params); |
6a488035 TO |
1213 | $this->assertEquals(17, $result['values'][17]['contact_id'], 'in line ' . __LINE__); |
1214 | $this->assertEquals(17, $result['id'], 'in line ' . __LINE__); | |
1215 | } | |
6a488035 TO |
1216 | |
1217 | /** | |
1218 | * Test civicrm_contact_search_count() | |
1219 | */ | |
1220 | public function testContactGetEmail() { | |
1221 | $params = array( | |
1222 | 'email' => 'man2@yahoo.com', | |
1223 | 'contact_type' => 'Individual', | |
1224 | 'location_type_id' => 1, | |
6a488035 TO |
1225 | ); |
1226 | ||
f6722559 | 1227 | $contact = $this->callAPISuccess('contact', 'create', $params); |
1228 | ||
4b58ed3b | 1229 | $this->assertEquals(1, $contact['id']); |
6a488035 TO |
1230 | |
1231 | $params = array( | |
1232 | 'email' => 'man2@yahoo.com', | |
6a488035 | 1233 | ); |
f6722559 | 1234 | $result = $this->callAPIAndDocument('contact', 'get', $params, __FUNCTION__, __FILE__); |
4b58ed3b EM |
1235 | $this->assertEquals(1, $result['values'][1]['contact_id']); |
1236 | $this->assertEquals('man2@yahoo.com', $result['values'][1]['email']); | |
6a488035 TO |
1237 | |
1238 | // delete the contact | |
f6722559 | 1239 | $this->callAPISuccess('contact', 'delete', $contact); |
6a488035 TO |
1240 | } |
1241 | ||
b1f09bea | 1242 | /** |
4b58ed3b | 1243 | * Test birth date params incl value, array & birth_date_high, birth_date_low |
b1f09bea E |
1244 | * && deceased |
1245 | */ | |
4b58ed3b | 1246 | public function testContactGetBirthDate() { |
b1f09bea E |
1247 | $contact1 = $this->callAPISuccess('contact', 'create', array_merge($this->_params, array('birth_date' => 'first day of next month - 2 years'))); |
1248 | $contact2 = $this->callAPISuccess('contact', 'create', array_merge($this->_params, array('birth_date' => 'first day of next month - 5 years'))); | |
1249 | $contact3 = $this->callAPISuccess('contact', 'create', array_merge($this->_params, array('birth_date' => 'first day of next month -20 years'))); | |
1250 | ||
1251 | $result = $this->callAPISuccess('contact', 'get', array()); | |
1252 | $this->assertEquals(date('Y-m-d', strtotime('first day of next month -2 years')), $result['values'][$contact1['id']]['birth_date']); | |
1253 | $result = $this->callAPISuccess('contact', 'get', array('birth_date' => 'first day of next month -5 years')); | |
1254 | $this->assertEquals(1, $result['count']); | |
1255 | $this->assertEquals(date('Y-m-d', strtotime('first day of next month -5 years')), $result['values'][$contact2['id']]['birth_date']); | |
1256 | $result = $this->callAPISuccess('contact', 'get', array('birth_date_high' => date('Y-m-d', strtotime('-6 years')))); | |
1257 | $this->assertEquals(1, $result['count']); | |
1258 | $this->assertEquals(date('Y-m-d', strtotime('first day of next month -20 years')), $result['values'][$contact3['id']]['birth_date']); | |
5896d037 | 1259 | $result = $this->callAPISuccess('contact', 'get', array( |
92915c55 TO |
1260 | 'birth_date_low' => date('Y-m-d', strtotime('-6 years')), |
1261 | 'birth_date_high' => date('Y-m-d', strtotime('- 3 years')), | |
1262 | )); | |
b1f09bea E |
1263 | $this->assertEquals(1, $result['count']); |
1264 | $this->assertEquals(date('Y-m-d', strtotime('first day of next month -5 years')), $result['values'][$contact2['id']]['birth_date']); | |
5896d037 | 1265 | $result = $this->callAPISuccess('contact', 'get', array( |
92915c55 TO |
1266 | 'birth_date_low' => '-6 years', |
1267 | 'birth_date_high' => '- 3 years', | |
1268 | )); | |
9f60788a EM |
1269 | $this->assertEquals(1, $result['count']); |
1270 | $this->assertEquals(date('Y-m-d', strtotime('first day of next month -5 years')), $result['values'][$contact2['id']]['birth_date']); | |
b1f09bea E |
1271 | } |
1272 | ||
1273 | /** | |
1274 | * Test Deceaseddate params incl value, array & Deceased_date_high, Deceaseddate_low | |
1275 | * && deceased | |
1276 | */ | |
4b58ed3b | 1277 | public function testContactGetDeceasedDate() { |
b1f09bea E |
1278 | $contact1 = $this->callAPISuccess('contact', 'create', array_merge($this->_params, array('deceased_date' => 'first day of next month - 2 years'))); |
1279 | $contact2 = $this->callAPISuccess('contact', 'create', array_merge($this->_params, array('deceased_date' => 'first day of next month - 5 years'))); | |
1280 | $contact3 = $this->callAPISuccess('contact', 'create', array_merge($this->_params, array('deceased_date' => 'first day of next month -20 years'))); | |
1281 | ||
1282 | $result = $this->callAPISuccess('contact', 'get', array()); | |
1283 | $this->assertEquals(date('Y-m-d', strtotime('first day of next month -2 years')), $result['values'][$contact1['id']]['deceased_date']); | |
1284 | $result = $this->callAPISuccess('contact', 'get', array('deceased_date' => 'first day of next month -5 years')); | |
1285 | $this->assertEquals(1, $result['count']); | |
1286 | $this->assertEquals(date('Y-m-d', strtotime('first day of next month -5 years')), $result['values'][$contact2['id']]['deceased_date']); | |
1287 | $result = $this->callAPISuccess('contact', 'get', array('deceased_date_high' => date('Y-m-d', strtotime('-6 years')))); | |
1288 | $this->assertEquals(1, $result['count']); | |
1289 | $this->assertEquals(date('Y-m-d', strtotime('first day of next month -20 years')), $result['values'][$contact3['id']]['deceased_date']); | |
5896d037 | 1290 | $result = $this->callAPISuccess('contact', 'get', array( |
92915c55 TO |
1291 | 'deceased_date_low' => '-6 years', |
1292 | 'deceased_date_high' => date('Y-m-d', strtotime('- 3 years')), | |
1293 | )); | |
b1f09bea E |
1294 | $this->assertEquals(1, $result['count']); |
1295 | $this->assertEquals(date('Y-m-d', strtotime('first day of next month -5 years')), $result['values'][$contact2['id']]['deceased_date']); | |
1296 | } | |
1297 | ||
e635f9d4 TO |
1298 | /** |
1299 | * Test for Contact.get id=@user:username | |
1300 | */ | |
00be9182 | 1301 | public function testContactGetByUsername() { |
e635f9d4 TO |
1302 | // setup - create contact with a uf-match |
1303 | $cid = $this->individualCreate(array( | |
1304 | 'contact_type' => 'Individual', | |
1305 | 'first_name' => 'testGetByUsername', | |
1306 | 'last_name' => 'testGetByUsername', | |
1307 | )); | |
1308 | ||
1309 | $ufMatchParams = array( | |
1310 | 'domain_id' => CRM_Core_Config::domainID(), | |
1311 | 'uf_id' => 99, | |
1312 | 'uf_name' => 'the-email-matching-key-is-not-really-the-username', | |
1313 | 'contact_id' => $cid, | |
1314 | ); | |
1315 | $ufMatch = CRM_Core_BAO_UFMatch::create($ufMatchParams); | |
1316 | $this->assertTrue(is_numeric($ufMatch->id)); | |
1317 | ||
1318 | // setup - mock the calls to CRM_Utils_System_*::getUfId | |
1319 | $userSystem = $this->getMock('CRM_Utils_System_UnitTests', array('getUfId')); | |
1320 | $userSystem->expects($this->once()) | |
1321 | ->method('getUfId') | |
1322 | ->with($this->equalTo('exampleUser')) | |
1323 | ->will($this->returnValue(99)); | |
1324 | CRM_Core_Config::singleton()->userSystem = $userSystem; | |
1325 | ||
1326 | // perform a lookup | |
1327 | $result = $this->callAPISuccess('Contact', 'get', array( | |
e635f9d4 TO |
1328 | 'id' => '@user:exampleUser', |
1329 | )); | |
1330 | $this->assertEquals('testGetByUsername', $result['values'][$cid]['first_name']); | |
1331 | } | |
1332 | ||
265cc07d | 1333 | /** |
1334 | * Test to check return works OK | |
1335 | */ | |
00be9182 | 1336 | public function testContactGetReturnValues() { |
265cc07d | 1337 | $extraParams = array('nick_name' => 'Bob', 'phone' => '456', 'email' => 'e@mail.com'); |
1338 | $contactID = $this->individualCreate($extraParams); | |
1339 | //actually it turns out the above doesn't create a phone | |
6c6e6187 | 1340 | $this->callAPISuccess('phone', 'create', array('contact_id' => $contactID, 'phone' => '456')); |
265cc07d | 1341 | $result = $this->callAPISuccess('contact', 'getsingle', array('id' => $contactID)); |
1342 | foreach ($extraParams as $key => $value) { | |
1343 | $this->assertEquals($result[$key], $value); | |
1344 | } | |
1345 | //now we check they are still returned with 'return' key | |
5896d037 | 1346 | $result = $this->callAPISuccess('contact', 'getsingle', array( |
92915c55 TO |
1347 | 'id' => $contactID, |
1348 | 'return' => array_keys($extraParams), | |
1349 | )); | |
265cc07d | 1350 | foreach ($extraParams as $key => $value) { |
1351 | $this->assertEquals($result[$key], $value); | |
1352 | } | |
1353 | } | |
1354 | ||
00be9182 | 1355 | public function testCRM13252MultipleChainedPhones() { |
265cc07d | 1356 | $contactID = $this->householdCreate(); |
1357 | $this->callAPISuccessGetCount('phone', array('contact_id' => $contactID), 0); | |
1358 | $params = array( | |
5896d037 TO |
1359 | 'contact_id' => $contactID, |
1360 | 'household_name' => 'Household 1', | |
1361 | 'contact_type' => 'Household', | |
1362 | 'api.phone.create' => array( | |
265cc07d | 1363 | 0 => array( |
1364 | 'phone' => '111-111-1111', | |
1365 | 'location_type_id' => 1, | |
1366 | 'phone_type_id' => 1, | |
1367 | ), | |
1368 | 1 => array( | |
1369 | 'phone' => '222-222-2222', | |
1370 | 'location_type_id' => 1, | |
1371 | 'phone_type_id' => 2, | |
21dfd5f5 TO |
1372 | ), |
1373 | ), | |
265cc07d | 1374 | ); |
4b58ed3b | 1375 | $this->callAPISuccess('contact', 'create', $params); |
265cc07d | 1376 | $this->callAPISuccessGetCount('phone', array('contact_id' => $contactID), 2); |
1377 | ||
1378 | } | |
5896d037 | 1379 | |
e635f9d4 TO |
1380 | /** |
1381 | * Test for Contact.get id=@user:username (with an invalid username) | |
1382 | */ | |
00be9182 | 1383 | public function testContactGetByUnknownUsername() { |
e635f9d4 TO |
1384 | // setup - mock the calls to CRM_Utils_System_*::getUfId |
1385 | $userSystem = $this->getMock('CRM_Utils_System_UnitTests', array('getUfId')); | |
1386 | $userSystem->expects($this->once()) | |
1387 | ->method('getUfId') | |
1388 | ->with($this->equalTo('exampleUser')) | |
1389 | ->will($this->returnValue(NULL)); | |
1390 | CRM_Core_Config::singleton()->userSystem = $userSystem; | |
1391 | ||
1392 | // perform a lookup | |
1393 | $result = $this->callAPIFailure('Contact', 'get', array( | |
e635f9d4 TO |
1394 | 'id' => '@user:exampleUser', |
1395 | )); | |
1396 | $this->assertRegExp('/cannot be resolved to a contact ID/', $result['error_message']); | |
1397 | } | |
1398 | ||
6a488035 TO |
1399 | /** |
1400 | * Verify attempt to create individual with chained arrays | |
1401 | */ | |
00be9182 | 1402 | public function testGetIndividualWithChainedArrays() { |
6a488035 TO |
1403 | $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__); |
1404 | $params['custom_' . $ids['custom_field_id']] = "custom string"; | |
1405 | ||
5896d037 | 1406 | $moreids = $this->CustomGroupMultipleCreateWithFields(); |
6a488035 | 1407 | $description = "/*this demonstrates the usage of chained api functions. In this case no notes or custom fields have been created "; |
5896d037 TO |
1408 | $subfile = "APIChainedArray"; |
1409 | $params = array( | |
6a488035 TO |
1410 | 'first_name' => 'abc3', |
1411 | 'last_name' => 'xyz3', | |
1412 | 'contact_type' => 'Individual', | |
1413 | 'email' => 'man3@yahoo.com', | |
6a488035 TO |
1414 | 'api.contribution.create' => array( |
1415 | 'receive_date' => '2010-01-01', | |
1416 | 'total_amount' => 100.00, | |
1417 | 'financial_type_id' => 1, | |
1418 | 'payment_instrument_id' => 1, | |
1419 | 'non_deductible_amount' => 10.00, | |
1420 | 'fee_amount' => 50.00, | |
1421 | 'net_amount' => 90.00, | |
1422 | 'trxn_id' => 12345, | |
1423 | 'invoice_id' => 67890, | |
1424 | 'source' => 'SSF', | |
1425 | 'contribution_status_id' => 1, | |
1426 | ), | |
1427 | 'api.contribution.create.1' => array( | |
1428 | 'receive_date' => '2011-01-01', | |
1429 | 'total_amount' => 120.00, | |
6c6e6187 | 1430 | 'financial_type_id' => $this->_financialTypeId = 1, |
6a488035 TO |
1431 | 'payment_instrument_id' => 1, |
1432 | 'non_deductible_amount' => 10.00, | |
1433 | 'fee_amount' => 50.00, | |
1434 | 'net_amount' => 90.00, | |
1435 | 'trxn_id' => 12335, | |
1436 | 'invoice_id' => 67830, | |
1437 | 'source' => 'SSF', | |
1438 | 'contribution_status_id' => 1, | |
1439 | ), | |
1440 | 'api.website.create' => array( | |
1441 | array( | |
1442 | 'url' => "http://civicrm.org", | |
1443 | ), | |
1444 | ), | |
1445 | ); | |
1446 | ||
f6722559 | 1447 | $result = $this->callAPISuccess('Contact', 'create', $params); |
6a488035 | 1448 | $params = array( |
f6722559 | 1449 | 'id' => $result['id'], |
6a488035 TO |
1450 | 'api.website.get' => array(), |
1451 | 'api.Contribution.get' => array( | |
1452 | 'total_amount' => '120.00', | |
5896d037 TO |
1453 | ), |
1454 | 'api.CustomValue.get' => 1, | |
6a488035 TO |
1455 | 'api.Note.get' => 1, |
1456 | ); | |
f6722559 | 1457 | $result = $this->callAPIAndDocument('Contact', 'Get', $params, __FUNCTION__, __FILE__, $description, $subfile); |
6a488035 | 1458 | // delete the contact |
f6722559 | 1459 | $this->callAPISuccess('contact', 'delete', $result); |
6a488035 TO |
1460 | $this->customGroupDelete($ids['custom_group_id']); |
1461 | $this->customGroupDelete($moreids['custom_group_id']); | |
4b58ed3b EM |
1462 | $this->assertEquals(1, $result['id']); |
1463 | $this->assertEquals(0, $result['values'][$result['id']]['api.website.get']['is_error']); | |
1464 | $this->assertEquals("http://civicrm.org", $result['values'][$result['id']]['api.website.get']['values'][0]['url']); | |
6a488035 TO |
1465 | } |
1466 | ||
00be9182 | 1467 | public function testGetIndividualWithChainedArraysFormats() { |
6a488035 TO |
1468 | $description = "/*this demonstrates the usage of chained api functions. A variety of return formats are used. Note that no notes |
1469 | *custom fields or memberships exist"; | |
1470 | $subfile = "APIChainedArrayFormats"; | |
1471 | $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__); | |
1472 | $params['custom_' . $ids['custom_field_id']] = "custom string"; | |
1473 | ||
1474 | $moreids = $this->CustomGroupMultipleCreateWithFields(); | |
1475 | $params = array( | |
1476 | 'first_name' => 'abc3', | |
1477 | 'last_name' => 'xyz3', | |
1478 | 'contact_type' => 'Individual', | |
1479 | 'email' => 'man3@yahoo.com', | |
6a488035 TO |
1480 | 'api.contribution.create' => array( |
1481 | 'receive_date' => '2010-01-01', | |
1482 | 'total_amount' => 100.00, | |
f6722559 | 1483 | 'financial_type_id' => $this->_financialTypeId, |
6a488035 TO |
1484 | 'payment_instrument_id' => 1, |
1485 | 'non_deductible_amount' => 10.00, | |
1486 | 'fee_amount' => 50.00, | |
1487 | 'net_amount' => 90.00, | |
1488 | 'source' => 'SSF', | |
1489 | 'contribution_status_id' => 1, | |
1490 | ), | |
1491 | 'api.contribution.create.1' => array( | |
1492 | 'receive_date' => '2011-01-01', | |
1493 | 'total_amount' => 120.00, | |
f6722559 | 1494 | 'financial_type_id' => $this->_financialTypeId, |
6a488035 TO |
1495 | 'payment_instrument_id' => 1, |
1496 | 'non_deductible_amount' => 10.00, | |
1497 | 'fee_amount' => 50.00, | |
1498 | 'net_amount' => 90.00, | |
1499 | 'source' => 'SSF', | |
1500 | 'contribution_status_id' => 1, | |
1501 | ), | |
1502 | 'api.website.create' => array( | |
1503 | array( | |
1504 | 'url' => "http://civicrm.org", | |
1505 | ), | |
1506 | ), | |
1507 | ); | |
1508 | ||
f6722559 | 1509 | $result = $this->callAPISuccess('Contact', 'create', $params); |
6a488035 | 1510 | $params = array( |
f6722559 | 1511 | 'id' => $result['id'], |
6a488035 TO |
1512 | 'api.website.getValue' => array('return' => 'url'), |
1513 | 'api.Contribution.getCount' => array(), | |
1514 | 'api.CustomValue.get' => 1, | |
1515 | 'api.Note.get' => 1, | |
1516 | 'api.Membership.getCount' => array(), | |
1517 | ); | |
f6722559 | 1518 | $result = $this->callAPIAndDocument('Contact', 'Get', $params, __FUNCTION__, __FILE__, $description, $subfile); |
4b58ed3b EM |
1519 | $this->assertEquals(1, $result['id']); |
1520 | $this->assertEquals(2, $result['values'][$result['id']]['api.Contribution.getCount']); | |
1521 | $this->assertEquals(0, $result['values'][$result['id']]['api.Note.get']['is_error']); | |
1522 | $this->assertEquals("http://civicrm.org", $result['values'][$result['id']]['api.website.getValue']); | |
6a488035 | 1523 | |
f6722559 | 1524 | $this->callAPISuccess('contact', 'delete', $result); |
6a488035 TO |
1525 | $this->customGroupDelete($ids['custom_group_id']); |
1526 | $this->customGroupDelete($moreids['custom_group_id']); | |
1527 | } | |
1528 | ||
00be9182 | 1529 | public function testGetIndividualWithChainedArraysAndMultipleCustom() { |
6a488035 TO |
1530 | $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__); |
1531 | $params['custom_' . $ids['custom_field_id']] = "custom string"; | |
1532 | $moreids = $this->CustomGroupMultipleCreateWithFields(); | |
5896d037 | 1533 | $andmoreids = $this->CustomGroupMultipleCreateWithFields(array( |
92915c55 TO |
1534 | 'title' => "another group", |
1535 | 'name' => 'another name', | |
1536 | )); | |
6a488035 TO |
1537 | $description = "/*this demonstrates the usage of chained api functions. A variety of techniques are used"; |
1538 | $subfile = "APIChainedArrayMultipleCustom"; | |
1539 | $params = array( | |
1540 | 'first_name' => 'abc3', | |
1541 | 'last_name' => 'xyz3', | |
1542 | 'contact_type' => 'Individual', | |
1543 | 'email' => 'man3@yahoo.com', | |
6a488035 TO |
1544 | 'api.contribution.create' => array( |
1545 | 'receive_date' => '2010-01-01', | |
1546 | 'total_amount' => 100.00, | |
5896d037 | 1547 | 'financial_type_id' => 1, |
6a488035 TO |
1548 | 'payment_instrument_id' => 1, |
1549 | 'non_deductible_amount' => 10.00, | |
1550 | 'fee_amount' => 50.00, | |
1551 | 'net_amount' => 90.00, | |
1552 | 'trxn_id' => 12345, | |
1553 | 'invoice_id' => 67890, | |
1554 | 'source' => 'SSF', | |
1555 | 'contribution_status_id' => 1, | |
1556 | ), | |
1557 | 'api.contribution.create.1' => array( | |
1558 | 'receive_date' => '2011-01-01', | |
1559 | 'total_amount' => 120.00, | |
5896d037 | 1560 | 'financial_type_id' => 1, |
6a488035 TO |
1561 | 'payment_instrument_id' => 1, |
1562 | 'non_deductible_amount' => 10.00, | |
1563 | 'fee_amount' => 50.00, | |
1564 | 'net_amount' => 90.00, | |
1565 | 'trxn_id' => 12335, | |
1566 | 'invoice_id' => 67830, | |
1567 | 'source' => 'SSF', | |
1568 | 'contribution_status_id' => 1, | |
1569 | ), | |
1570 | 'api.website.create' => array( | |
1571 | array( | |
1572 | 'url' => "http://civicrm.org", | |
1573 | ), | |
1574 | ), | |
1575 | 'custom_' . $ids['custom_field_id'] => "value 1", | |
1576 | 'custom_' . $moreids['custom_field_id'][0] => "value 2", | |
1577 | 'custom_' . $moreids['custom_field_id'][1] => "warm beer", | |
1578 | 'custom_' . $andmoreids['custom_field_id'][1] => "vegemite", | |
1579 | ); | |
1580 | ||
f6722559 | 1581 | $result = $this->callAPISuccess('Contact', 'create', $params); |
1582 | $result = $this->callAPISuccess('Contact', 'create', array( | |
6c6e6187 | 1583 | 'contact_type' => 'Individual', |
5896d037 TO |
1584 | 'id' => $result['id'], |
1585 | 'custom_' . | |
1586 | $moreids['custom_field_id'][0] => "value 3", | |
1587 | 'custom_' . | |
1588 | $ids['custom_field_id'] => "value 4", | |
1589 | )); | |
6a488035 TO |
1590 | |
1591 | $params = array( | |
f6722559 | 1592 | 'id' => $result['id'], |
6a488035 TO |
1593 | 'api.website.getValue' => array('return' => 'url'), |
1594 | 'api.Contribution.getCount' => array(), | |
1595 | 'api.CustomValue.get' => 1, | |
1596 | ); | |
f6722559 | 1597 | $result = $this->callAPIAndDocument('Contact', 'Get', $params, __FUNCTION__, __FILE__, $description, $subfile); |
1598 | ||
6a488035 TO |
1599 | $this->customGroupDelete($ids['custom_group_id']); |
1600 | $this->customGroupDelete($moreids['custom_group_id']); | |
1601 | $this->customGroupDelete($andmoreids['custom_group_id']); | |
4b58ed3b EM |
1602 | $this->assertEquals(1, $result['id']); |
1603 | $this->assertEquals(0, $result['values'][$result['id']]['api.CustomValue.get']['is_error']); | |
1604 | $this->assertEquals('http://civicrm.org', $result['values'][$result['id']]['api.website.getValue']); | |
6a488035 | 1605 | } |
5896d037 | 1606 | |
d424ffde | 1607 | /** |
6a488035 TO |
1608 | * Test checks siusage of $values to pick & choose inputs |
1609 | */ | |
00be9182 | 1610 | public function testChainingValuesCreate() { |
6a488035 TO |
1611 | $description = "/*this demonstrates the usage of chained api functions. Specifically it has one 'parent function' & |
1612 | 2 child functions - one receives values from the parent (Contact) and the other child (Tag). "; | |
1613 | $subfile = "APIChainedArrayValuesFromSiblingFunction"; | |
1614 | $params = array( | |
6c6e6187 | 1615 | 'display_name' => 'batman', |
5896d037 | 1616 | 'contact_type' => 'Individual', |
6a488035 TO |
1617 | 'api.tag.create' => array('name' => '$value.id', 'description' => '$value.display_name', 'format.only_id' => 1), |
1618 | 'api.entity_tag.create' => array('tag_id' => '$value.api.tag.create'), | |
1619 | ); | |
f6722559 | 1620 | $result = $this->callAPIAndDocument('Contact', 'Create', $params, __FUNCTION__, __FILE__, $description, $subfile); |
6a488035 | 1621 | $this->assertEquals(0, $result['values'][$result['id']]['api.entity_tag.create']['is_error']); |
f6722559 | 1622 | |
6a488035 TO |
1623 | $tablesToTruncate = array( |
1624 | 'civicrm_contact', | |
1625 | 'civicrm_activity', | |
1626 | 'civicrm_entity_tag', | |
1627 | 'civicrm_tag', | |
1628 | ); | |
1629 | $this->quickCleanup($tablesToTruncate, TRUE); | |
1630 | } | |
1631 | ||
d424ffde | 1632 | /** |
6a488035 TO |
1633 | * test TrueFalse format - I couldn't come up with an easy way to get an error on Get |
1634 | */ | |
00be9182 | 1635 | public function testContactGetFormatIsSuccessTrue() { |
6a488035 TO |
1636 | $this->createContactFromXML(); |
1637 | $description = "This demonstrates use of the 'format.is_success' param. | |
1638 | This param causes only the success or otherwise of the function to be returned as BOOLEAN"; | |
1639 | $subfile = "FormatIsSuccess_True"; | |
5896d037 TO |
1640 | $params = array('id' => 17, 'format.is_success' => 1); |
1641 | $result = $this->callAPIAndDocument('Contact', 'Get', $params, __FUNCTION__, __FILE__, $description, $subfile); | |
6a488035 | 1642 | $this->assertEquals(1, $result); |
f6722559 | 1643 | $this->callAPISuccess('Contact', 'Delete', $params); |
6a488035 | 1644 | } |
5896d037 | 1645 | |
d424ffde | 1646 | /** |
6a488035 TO |
1647 | * test TrueFalse format |
1648 | */ | |
00be9182 | 1649 | public function testContactCreateFormatIsSuccessFalse() { |
6a488035 TO |
1650 | |
1651 | $description = "This demonstrates use of the 'format.is_success' param. | |
1652 | This param causes only the success or otherwise of the function to be returned as BOOLEAN"; | |
1653 | $subfile = "FormatIsSuccess_Fail"; | |
5896d037 TO |
1654 | $params = array('id' => 500, 'format.is_success' => 1); |
1655 | $result = $this->callAPIAndDocument('Contact', 'Create', $params, __FUNCTION__, __FILE__, $description, $subfile); | |
6a488035 TO |
1656 | $this->assertEquals(0, $result); |
1657 | } | |
5896d037 | 1658 | |
d424ffde | 1659 | /** |
6a488035 TO |
1660 | * test Single Entity format |
1661 | */ | |
00be9182 | 1662 | public function testContactGetSingle_entity_array() { |
6a488035 TO |
1663 | $this->createContactFromXML(); |
1664 | $description = "This demonstrates use of the 'format.single_entity_array' param. | |
1665 | /* This param causes the only contact to be returned as an array without the other levels. | |
1666 | /* it will be ignored if there is not exactly 1 result"; | |
1667 | $subfile = "GetSingleContact"; | |
5896d037 TO |
1668 | $params = array('id' => 17); |
1669 | $result = $this->callAPIAndDocument('Contact', 'GetSingle', $params, __FUNCTION__, __FILE__, $description, $subfile); | |
4b58ed3b | 1670 | $this->assertEquals('Test Contact', $result['display_name']); |
f6722559 | 1671 | $this->callAPISuccess('Contact', 'Delete', $params); |
6a488035 TO |
1672 | } |
1673 | ||
d424ffde | 1674 | /** |
6a488035 TO |
1675 | * test Single Entity format |
1676 | */ | |
00be9182 | 1677 | public function testContactGetFormatcount_only() { |
6a488035 TO |
1678 | $this->createContactFromXML(); |
1679 | $description = "/*This demonstrates use of the 'getCount' action | |
1680 | /* This param causes the count of the only function to be returned as an integer"; | |
1681 | $subfile = "GetCountContact"; | |
5896d037 TO |
1682 | $params = array('id' => 17); |
1683 | $result = $this->callAPIAndDocument('Contact', 'GetCount', $params, __FUNCTION__, __FILE__, $description, $subfile); | |
4b58ed3b | 1684 | $this->assertEquals('1', $result); |
f6722559 | 1685 | $this->callAPISuccess('Contact', 'Delete', $params); |
6a488035 | 1686 | } |
5896d037 | 1687 | |
d424ffde | 1688 | /** |
6a488035 TO |
1689 | * Test id only format |
1690 | */ | |
00be9182 | 1691 | public function testContactGetFormatID_only() { |
6a488035 TO |
1692 | $this->createContactFromXML(); |
1693 | $description = "This demonstrates use of the 'format.id_only' param. | |
1694 | /* This param causes the id of the only entity to be returned as an integer. | |
1695 | /* it will be ignored if there is not exactly 1 result"; | |
1696 | $subfile = "FormatOnlyID"; | |
5896d037 TO |
1697 | $params = array('id' => 17, 'format.only_id' => 1); |
1698 | $result = $this->callAPIAndDocument('Contact', 'Get', $params, __FUNCTION__, __FILE__, $description, $subfile); | |
4b58ed3b | 1699 | $this->assertEquals('17', $result); |
f6722559 | 1700 | $this->callAPISuccess('Contact', 'Delete', $params); |
6a488035 TO |
1701 | } |
1702 | ||
d424ffde | 1703 | /** |
6a488035 TO |
1704 | * Test id only format |
1705 | */ | |
00be9182 | 1706 | public function testContactGetFormatSingleValue() { |
6a488035 TO |
1707 | $this->createContactFromXML(); |
1708 | $description = "This demonstrates use of the 'format.single_value' param. | |
1709 | /* This param causes only a single value of the only entity to be returned as an string. | |
1710 | /* it will be ignored if there is not exactly 1 result"; | |
4b58ed3b | 1711 | $subFile = "FormatSingleValue"; |
5896d037 TO |
1712 | $params = array('id' => 17, 'return' => 'display_name'); |
1713 | $result = $this->callAPIAndDocument('Contact', 'getvalue', $params, __FUNCTION__, __FILE__, $description, $subFile, 'getvalue'); | |
4b58ed3b | 1714 | $this->assertEquals('Test Contact', $result); |
f6722559 | 1715 | $this->callAPISuccess('Contact', 'Delete', $params); |
6a488035 TO |
1716 | } |
1717 | ||
b2130237 | 1718 | /** |
100fef9d | 1719 | * Test that permissions are respected when creating contacts |
b2130237 | 1720 | */ |
00be9182 | 1721 | public function testContactCreationPermissions() { |
6a488035 | 1722 | $params = array( |
6c6e6187 | 1723 | 'contact_type' => 'Individual', |
5896d037 | 1724 | 'first_name' => 'Foo', |
6a488035 TO |
1725 | 'last_name' => 'Bear', |
1726 | 'check_permissions' => TRUE, | |
6a488035 TO |
1727 | ); |
1728 | $config = CRM_Core_Config::singleton(); | |
1729 | $config->userPermissionClass->permissions = array('access CiviCRM'); | |
d0e1eff2 | 1730 | $result = $this->callAPIFailure('contact', 'create', $params); |
60ec9f43 | 1731 | $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'); |
6a488035 TO |
1732 | |
1733 | $config->userPermissionClass->permissions = array('access CiviCRM', 'add contacts', 'import contacts'); | |
dcbec360 | 1734 | $this->callAPISuccess('contact', 'create', $params, NULL, 'overfluous permissions should be enough to create a contact'); |
6a488035 TO |
1735 | } |
1736 | ||
00be9182 | 1737 | public function testContactUpdatePermissions() { |
5896d037 TO |
1738 | $params = array( |
1739 | 'contact_type' => 'Individual', | |
1740 | 'first_name' => 'Foo', | |
1741 | 'last_name' => 'Bear', | |
21dfd5f5 | 1742 | 'check_permissions' => TRUE, |
5896d037 | 1743 | ); |
f6722559 | 1744 | $result = $this->callAPISuccess('contact', 'create', $params); |
6a488035 | 1745 | $config = CRM_Core_Config::singleton(); |
5896d037 TO |
1746 | $params = array( |
1747 | 'id' => $result['id'], | |
1748 | 'contact_type' => 'Individual', | |
1749 | 'last_name' => 'Bar', | |
21dfd5f5 | 1750 | 'check_permissions' => TRUE, |
5896d037 | 1751 | ); |
6a488035 TO |
1752 | |
1753 | $config->userPermissionClass->permissions = array('access CiviCRM'); | |
d0e1eff2 | 1754 | $result = $this->callAPIFailure('contact', 'update', $params); |
60ec9f43 | 1755 | $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'); |
6a488035 | 1756 | |
5896d037 TO |
1757 | $config->userPermissionClass->permissions = array( |
1758 | 'access CiviCRM', | |
1759 | 'add contacts', | |
1760 | 'view all contacts', | |
1761 | 'edit all contacts', | |
21dfd5f5 | 1762 | 'import contacts', |
5896d037 | 1763 | ); |
dcbec360 | 1764 | $this->callAPISuccess('contact', 'update', $params, NULL, 'overfluous permissions should be enough to update a contact'); |
6a488035 TO |
1765 | } |
1766 | ||
00be9182 | 1767 | public function createContactFromXML() { |
6a488035 TO |
1768 | // Insert a row in civicrm_contact creating contact 17 |
1769 | $op = new PHPUnit_Extensions_Database_Operation_Insert(); | |
1770 | $op->execute($this->_dbconn, | |
bbfd46a5 | 1771 | $this->createXMLDataSet( |
6a488035 TO |
1772 | dirname(__FILE__) . '/dataset/contact_17.xml' |
1773 | ) | |
1774 | ); | |
1775 | } | |
1776 | ||
00be9182 | 1777 | public function testContactProximity() { |
6a488035 TO |
1778 | // first create a contact with a SF location with a specific |
1779 | // geocode | |
1780 | $contactID = $this->organizationCreate(); | |
1781 | ||
1782 | // now create the address | |
1783 | $params = array( | |
1784 | 'street_address' => '123 Main Street', | |
1785 | 'city' => 'San Francisco', | |
1786 | 'is_primary' => 1, | |
1787 | 'country_id' => 1228, | |
1788 | 'state_province_id' => 1004, | |
1789 | 'geo_code_1' => '37.79', | |
1790 | 'geo_code_2' => '-122.40', | |
1791 | 'location_type_id' => 1, | |
1792 | 'contact_id' => $contactID, | |
6a488035 TO |
1793 | ); |
1794 | ||
f6722559 | 1795 | $result = $this->callAPISuccess('address', 'create', $params); |
6a488035 TO |
1796 | $this->assertEquals(1, $result['count'], 'In line ' . __LINE__); |
1797 | ||
1798 | // now do a proximity search with a close enough geocode and hope to match | |
1799 | // that specific contact only! | |
1800 | $proxParams = array( | |
1801 | 'latitude' => 37.7, | |
1802 | 'longitude' => -122.3, | |
1803 | 'unit' => 'mile', | |
1804 | 'distance' => 10, | |
6a488035 | 1805 | ); |
f6722559 | 1806 | $result = $this->callAPISuccess('contact', 'proximity', $proxParams); |
6a488035 TO |
1807 | $this->assertEquals(1, $result['count'], 'In line ' . __LINE__); |
1808 | } | |
60ec9f43 E |
1809 | |
1810 | /** | |
b2560503 | 1811 | * Test that Ajax API permission is sufficient to access getquick api |
1d6020f1 | 1812 | * (note that getquick api is required for autocomplete & has ACL permissions applied) |
60ec9f43 | 1813 | */ |
00be9182 | 1814 | public function testGetquickPermission_CRM_13744() { |
60ec9f43 | 1815 | CRM_Core_Config::singleton()->userPermissionClass->permissions = array('access CiviEvent'); |
4b58ed3b | 1816 | $this->callAPIFailure('contact', 'getquick', array('name' => 'b', 'check_permissions' => TRUE)); |
60ec9f43 | 1817 | CRM_Core_Config::singleton()->userPermissionClass->permissions = array('access CiviCRM'); |
4b58ed3b | 1818 | $this->callAPISuccess('contact', 'getquick', array('name' => 'b', 'check_permissions' => TRUE)); |
60ec9f43 | 1819 | CRM_Core_Config::singleton()->userPermissionClass->permissions = array('access AJAX API'); |
4b58ed3b | 1820 | $this->callAPISuccess('contact', 'getquick', array('name' => 'b', 'check_permissions' => TRUE)); |
60ec9f43 | 1821 | } |
9c8096cb | 1822 | |
b2130237 | 1823 | /** |
100fef9d | 1824 | * Test get ref api - gets a list of references to an entity |
b2130237 | 1825 | */ |
00be9182 | 1826 | public function testGetReferenceCounts() { |
9c8096cb TO |
1827 | $result = $this->callAPISuccess('Contact', 'create', array( |
1828 | 'first_name' => 'Testily', | |
1829 | 'last_name' => 'McHaste', | |
1830 | 'contact_type' => 'Individual', | |
1831 | 'api.Address.replace' => array( | |
1832 | 'values' => array(), | |
1833 | ), | |
1834 | 'api.Email.replace' => array( | |
1835 | 'values' => array( | |
1836 | array( | |
1837 | 'email' => 'spam@dev.null', | |
1838 | 'is_primary' => 0, | |
1839 | 'location_type_id' => 1, | |
21dfd5f5 | 1840 | ), |
9c8096cb TO |
1841 | ), |
1842 | ), | |
1843 | 'api.Phone.replace' => array( | |
1844 | 'values' => array( | |
1845 | array( | |
1846 | 'phone' => '234-567-0001', | |
1847 | 'is_primary' => 1, | |
1848 | 'location_type_id' => 1, | |
1849 | ), | |
1850 | array( | |
1851 | 'phone' => '234-567-0002', | |
1852 | 'is_primary' => 0, | |
1853 | 'location_type_id' => 1, | |
1854 | ), | |
1855 | ), | |
1856 | ), | |
1857 | )); | |
1858 | ||
1859 | //$dao = new CRM_Contact_BAO_Contact(); | |
1860 | //$dao->id = $result['id']; | |
1861 | //$this->assertTrue((bool) $dao->find(TRUE)); | |
1862 | // | |
1863 | //$refCounts = $dao->getReferenceCounts(); | |
1864 | //$this->assertTrue(is_array($refCounts)); | |
1865 | //$refCountsIdx = CRM_Utils_Array::index(array('name'), $refCounts); | |
1866 | ||
1867 | $refCounts = $this->callAPISuccess('Contact', 'getrefcount', array( | |
21dfd5f5 | 1868 | 'id' => $result['id'], |
9c8096cb TO |
1869 | )); |
1870 | $refCountsIdx = CRM_Utils_Array::index(array('name'), $refCounts['values']); | |
1871 | ||
1872 | $this->assertEquals(1, $refCountsIdx['sql:civicrm_email:contact_id']['count']); | |
1873 | $this->assertEquals('civicrm_email', $refCountsIdx['sql:civicrm_email:contact_id']['table']); | |
1874 | $this->assertEquals(2, $refCountsIdx['sql:civicrm_phone:contact_id']['count']); | |
1875 | $this->assertEquals('civicrm_phone', $refCountsIdx['sql:civicrm_phone:contact_id']['table']); | |
1876 | $this->assertTrue(!isset($refCountsIdx['sql:civicrm_address:contact_id'])); | |
1877 | } | |
1878 | ||
00be9182 | 1879 | public function testSQLOperatorsOnContactAPI() { |
a75c13cc EM |
1880 | $this->individualCreate(); |
1881 | $this->organizationCreate(); | |
1882 | $this->householdCreate(); | |
1883 | $contacts = $this->callAPISuccess('contact', 'get', array('legal_name' => array('IS NOT NULL' => TRUE))); | |
1884 | $this->assertEquals($contacts['count'], CRM_Core_DAO::singleValueQuery('select count(*) FROM civicrm_contact WHERE legal_name IS NOT NULL')); | |
1885 | $contacts = $this->callAPISuccess('contact', 'get', array('legal_name' => array('IS NULL' => TRUE))); | |
1886 | $this->assertEquals($contacts['count'], CRM_Core_DAO::singleValueQuery('select count(*) FROM civicrm_contact WHERE legal_name IS NULL')); | |
1887 | } | |
9bee5ea2 | 1888 | |
9bee5ea2 EM |
1889 | /** |
1890 | * CRM-14743 - test api respects search operators | |
1891 | */ | |
00be9182 | 1892 | public function testGetModifiedDateByOperators() { |
9bee5ea2 EM |
1893 | $preExistingContactCount = CRM_Core_DAO::singleValueQuery('select count(*) FROM civicrm_contact'); |
1894 | $contact1 = $this->individualCreate(); | |
1895 | $sql = "UPDATE civicrm_contact SET created_date = '2012-01-01', modified_date = '2013-01-01' WHERE id = " . $contact1; | |
1896 | CRM_Core_DAO::executeQuery($sql); | |
1897 | $contact2 = $this->individualCreate(); | |
1898 | $sql = "UPDATE civicrm_contact SET created_date = '2012-02-01', modified_date = '2013-02-01' WHERE id = " . $contact2; | |
1899 | CRM_Core_DAO::executeQuery($sql); | |
1900 | $contact3 = $this->householdCreate(); | |
1901 | $sql = "UPDATE civicrm_contact SET created_date = '2012-03-01', modified_date = '2013-03-01' WHERE id = " . $contact3; | |
1902 | CRM_Core_DAO::executeQuery($sql); | |
1903 | $contacts = $this->callAPISuccess('contact', 'get', array('modified_date' => array('<' => '2014-01-01'))); | |
1904 | $this->assertEquals($contacts['count'], 3); | |
1905 | $contacts = $this->callAPISuccess('contact', 'get', array('modified_date' => array('>' => '2014-01-01'))); | |
1906 | $this->assertEquals($contacts['count'], $preExistingContactCount); | |
1907 | } | |
2134e310 | 1908 | |
2134e310 EM |
1909 | /** |
1910 | * CRM-14743 - test api respects search operators | |
1911 | */ | |
00be9182 | 1912 | public function testGetCreatedDateByOperators() { |
2134e310 EM |
1913 | $preExistingContactCount = CRM_Core_DAO::singleValueQuery('select count(*) FROM civicrm_contact'); |
1914 | $contact1 = $this->individualCreate(); | |
1915 | $sql = "UPDATE civicrm_contact SET created_date = '2012-01-01' WHERE id = " . $contact1; | |
1916 | CRM_Core_DAO::executeQuery($sql); | |
1917 | $contact2 = $this->individualCreate(); | |
1918 | $sql = "UPDATE civicrm_contact SET created_date = '2012-02-01' WHERE id = " . $contact2; | |
1919 | CRM_Core_DAO::executeQuery($sql); | |
1920 | $contact3 = $this->householdCreate(); | |
1921 | $sql = "UPDATE civicrm_contact SET created_date = '2012-03-01' WHERE id = " . $contact3; | |
1922 | CRM_Core_DAO::executeQuery($sql); | |
1923 | $contacts = $this->callAPISuccess('contact', 'get', array('created_date' => array('<' => '2014-01-01'))); | |
1924 | $this->assertEquals($contacts['count'], 3); | |
1925 | $contacts = $this->callAPISuccess('contact', 'get', array('created_date' => array('>' => '2014-01-01'))); | |
1926 | $this->assertEquals($contacts['count'], $preExistingContactCount); | |
1927 | } | |
e5fccefb EM |
1928 | |
1929 | /** | |
1930 | * CRM-14263 check that API is not affected by search profile related bug | |
1931 | */ | |
5896d037 | 1932 | public function testReturnCityProfile() { |
e5fccefb EM |
1933 | $contactID = $this->individualCreate(); |
1934 | CRM_Core_Config::singleton()->defaultSearchProfileID = 1; | |
5896d037 | 1935 | $this->callAPISuccess('address', 'create', array( |
92915c55 TO |
1936 | 'contact_id' => $contactID, |
1937 | 'city' => 'Cool City', | |
1938 | 'location_type_id' => 1, | |
1939 | )); | |
e5fccefb EM |
1940 | $result = $this->callAPISuccess('contact', 'get', array('city' => 'Cool City', 'return' => 'contact_type')); |
1941 | $this->assertEquals(1, $result['count']); | |
1942 | } | |
eaa112a5 | 1943 | |
eaa112a5 | 1944 | /** |
45fcf8b7 | 1945 | * CRM-15443 - ensure getlist api does not return deleted contacts |
eaa112a5 | 1946 | */ |
00be9182 | 1947 | public function testGetlistExcludeConditions() { |
eaa112a5 | 1948 | $name = md5(time()); |
45fcf8b7 CW |
1949 | $contact = $this->individualCreate(array('last_name' => $name)); |
1950 | $deceasedContact = $this->individualCreate(array('last_name' => $name, 'is_deceased' => 1)); | |
1951 | $deletedContact = $this->individualCreate(array('last_name' => $name, 'is_deleted' => 1)); | |
1952 | // We should get all but the deleted contact | |
eaa112a5 | 1953 | $result = $this->callAPISuccess('contact', 'getlist', array('input' => $name)); |
45fcf8b7 CW |
1954 | $this->assertEquals(2, $result['count'], 'In line ' . __LINE__); |
1955 | // Force-exclude the deceased contact | |
5896d037 | 1956 | $result = $this->callAPISuccess('contact', 'getlist', array( |
92915c55 TO |
1957 | 'input' => $name, |
1958 | 'params' => array('is_deceased' => 0), | |
1959 | )); | |
eaa112a5 | 1960 | $this->assertEquals(1, $result['count'], 'In line ' . __LINE__); |
45fcf8b7 | 1961 | $this->assertEquals($contact, $result['values'][0]['id'], 'In line ' . __LINE__); |
eaa112a5 | 1962 | } |
92776611 CW |
1963 | |
1964 | /** | |
1965 | * Test contact.getactions | |
1966 | */ | |
00be9182 | 1967 | public function testGetActions() { |
92776611 CW |
1968 | $description = "Getting the available actions for an entity."; |
1969 | $result = $this->callAPIAndDocument($this->_entity, 'getactions', array(), __FUNCTION__, __FILE__, $description); | |
1970 | $expected = array( | |
1971 | 'create', | |
1972 | 'delete', | |
1973 | 'get', | |
1974 | 'getactions', | |
1975 | 'getcount', | |
1976 | 'getfields', | |
1977 | 'getlist', | |
1978 | 'getoptions', | |
1979 | 'getquick', | |
1980 | 'getrefcount', | |
1981 | 'getsingle', | |
1982 | 'getvalue', | |
1983 | 'merge', | |
1984 | 'proximity', | |
1985 | 'replace', | |
1986 | 'setvalue', | |
1987 | 'update', | |
1988 | ); | |
1989 | $deprecated = array( | |
1990 | 'update', | |
1991 | 'getquick', | |
1992 | ); | |
1993 | foreach ($expected as $action) { | |
1994 | $this->assertTrue(in_array($action, $result['values']), "Expected action $action"); | |
1995 | } | |
1996 | foreach ($deprecated as $action) { | |
1997 | $this->assertArrayKeyExists($action, $result['deprecated']); | |
1998 | } | |
1999 | } | |
6a488035 | 2000 | } |