Merge pull request #17253 from mattwire/utf8convertblocksize
[civicrm-core.git] / tests / phpunit / CRM / Core / BAO / AddressTest.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
5 | |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
10 */
11
12 /**
13 * Class CRM_Core_BAO_AddressTest
14 * @group headless
15 */
16 class CRM_Core_BAO_AddressTest extends CiviUnitTestCase {
17
18 public function setUp() {
19 parent::setUp();
20
21 $this->quickCleanup(['civicrm_contact', 'civicrm_address']);
22 }
23
24 /**
25 * Create() method (create and update modes)
26 */
27 public function testCreate() {
28 $contactId = $this->individualCreate();
29
30 $params = [];
31 $params['address']['1'] = [
32 'street_address' => 'Oberoi Garden',
33 'supplemental_address_1' => 'Attn: Accounting',
34 'supplemental_address_2' => 'Powai',
35 'supplemental_address_3' => 'Somewhere',
36 'city' => 'Athens',
37 'postal_code' => '01903',
38 'state_province_id' => '1000',
39 'country_id' => '1228',
40 'geo_code_1' => '18.219023',
41 'geo_code_2' => '-105.00973',
42 'location_type_id' => '1',
43 'is_primary' => '1',
44 'is_billing' => '0',
45 ];
46
47 $params['contact_id'] = $contactId;
48
49 $fixAddress = TRUE;
50
51 CRM_Core_BAO_Address::create($params, $fixAddress, $entity = NULL);
52 $addressId = $this->assertDBNotNull('CRM_Core_DAO_Address', 'Oberoi Garden', 'id', 'street_address',
53 'Database check for created address.'
54 );
55
56 // Now call add() to modify an existing address
57
58 $params = [];
59 $params['address']['1'] = [
60 'id' => $addressId,
61 'street_address' => '120 Terminal Road',
62 'supplemental_address_1' => 'A-wing:3037',
63 'supplemental_address_2' => 'Bandra',
64 'supplemental_address_3' => 'Somewhere',
65 'city' => 'Athens',
66 'postal_code' => '01903',
67 'state_province_id' => '1000',
68 'country_id' => '1228',
69 'geo_code_1' => '18.219023',
70 'geo_code_2' => '-105.00973',
71 'location_type_id' => '1',
72 'is_primary' => '1',
73 'is_billing' => '0',
74 ];
75 $params['contact_id'] = $contactId;
76
77 $block = CRM_Core_BAO_Address::create($params, $fixAddress, $entity = NULL);
78
79 $this->assertDBNotNull('CRM_Core_DAO_Address', $contactId, 'id', 'contact_id',
80 'Database check for updated address by contactId.'
81 );
82 $this->assertDBNotNull('CRM_Core_DAO_Address', '120 Terminal Road', 'id', 'street_address',
83 'Database check for updated address by street_name.'
84 );
85 $this->contactDelete($contactId);
86 }
87
88 /**
89 * Add() method ( )
90 */
91 public function testAdd() {
92 $contactId = $this->individualCreate();
93
94 $fixParams = [
95 'street_address' => 'E 906N Pine Pl W',
96 'supplemental_address_1' => 'Editorial Dept',
97 'supplemental_address_2' => '',
98 'supplemental_address_3' => '',
99 'city' => 'El Paso',
100 'postal_code' => '88575',
101 'postal_code_suffix' => '',
102 'state_province_id' => '1001',
103 'country_id' => '1228',
104 'geo_code_1' => '31.694842',
105 'geo_code_2' => '-106.29998',
106 'location_type_id' => '1',
107 'is_primary' => '1',
108 'is_billing' => '0',
109 'contact_id' => $contactId,
110 ];
111
112 $addAddress = CRM_Core_BAO_Address::add($fixParams, $fixAddress = TRUE);
113
114 $addParams = $this->assertDBNotNull('CRM_Core_DAO_Address', $contactId, 'id', 'contact_id',
115 'Database check for created contact address.'
116 );
117
118 $this->assertEquals($addAddress->street_address, 'E 906N Pine Pl W', 'In line' . __LINE__);
119 $this->assertEquals($addAddress->supplemental_address_1, 'Editorial Dept', 'In line' . __LINE__);
120 $this->assertEquals($addAddress->city, 'El Paso', 'In line' . __LINE__);
121 $this->assertEquals($addAddress->postal_code, '88575', 'In line' . __LINE__);
122 $this->assertEquals($addAddress->geo_code_1, '31.694842', 'In line' . __LINE__);
123 $this->assertEquals($addAddress->geo_code_2, '-106.29998', 'In line' . __LINE__);
124 $this->assertEquals($addAddress->country_id, '1228', 'In line' . __LINE__);
125 $this->contactDelete($contactId);
126 }
127
128 /**
129 * AllAddress() method ( )
130 */
131 public function testallAddress() {
132 $contactId = $this->individualCreate();
133
134 $fixParams = [
135 'street_address' => 'E 906N Pine Pl W',
136 'supplemental_address_1' => 'Editorial Dept',
137 'supplemental_address_2' => '',
138 'supplemental_address_3' => '',
139 'city' => 'El Paso',
140 'postal_code' => '88575',
141 'postal_code_suffix' => '',
142 'state_province_id' => '1001',
143 'country_id' => '1228',
144 'geo_code_1' => '31.694842',
145 'geo_code_2' => '-106.29998',
146 'location_type_id' => '1',
147 'is_primary' => '1',
148 'is_billing' => '0',
149 'contact_id' => $contactId,
150 ];
151
152 CRM_Core_BAO_Address::add($fixParams, $fixAddress = TRUE);
153
154 $addParams = $this->assertDBNotNull('CRM_Core_DAO_Address', $contactId, 'id', 'contact_id',
155 'Database check for created contact address.'
156 );
157 $fixParams = [
158 'street_address' => 'SW 719B Beech Dr NW',
159 'supplemental_address_1' => 'C/o OPDC',
160 'supplemental_address_2' => '',
161 'supplemental_address_3' => '',
162 'city' => 'Neillsville',
163 'postal_code' => '54456',
164 'postal_code_suffix' => '',
165 'state_province_id' => '1001',
166 'country_id' => '1228',
167 'geo_code_1' => '44.553719',
168 'geo_code_2' => '-90.61457',
169 'location_type_id' => '2',
170 'is_primary' => '',
171 'is_billing' => '1',
172 'contact_id' => $contactId,
173 ];
174
175 CRM_Core_BAO_Address::add($fixParams, $fixAddress = TRUE);
176
177 $addParams = $this->assertDBNotNull('CRM_Core_DAO_Address', $contactId, 'id', 'contact_id',
178 'Database check for created contact address.'
179 );
180
181 $allAddress = CRM_Core_BAO_Address::allAddress($contactId);
182
183 $this->assertEquals(count($allAddress), 2, 'Checking number of returned addresses.');
184
185 $this->contactDelete($contactId);
186 }
187
188 /**
189 * AllAddress() method ( ) with null value
190 */
191 public function testnullallAddress() {
192 $contactId = $this->individualCreate();
193
194 $fixParams = [
195 'street_address' => 'E 906N Pine Pl W',
196 'supplemental_address_1' => 'Editorial Dept',
197 'supplemental_address_2' => '',
198 'supplemental_address_3' => '',
199 'city' => 'El Paso',
200 'postal_code' => '88575',
201 'postal_code_suffix' => '',
202 'state_province_id' => '1001',
203 'country_id' => '1228',
204 'geo_code_1' => '31.694842',
205 'geo_code_2' => '-106.29998',
206 'location_type_id' => '1',
207 'is_primary' => '1',
208 'is_billing' => '0',
209 'contact_id' => $contactId,
210 ];
211
212 CRM_Core_BAO_Address::add($fixParams, $fixAddress = TRUE);
213
214 $addParams = $this->assertDBNotNull('CRM_Core_DAO_Address', $contactId, 'id', 'contact_id',
215 'Database check for created contact address.'
216 );
217
218 $contact_Id = NULL;
219
220 $allAddress = CRM_Core_BAO_Address::allAddress($contact_Id);
221
222 $this->assertEquals($allAddress, NULL, 'Checking null for returned addresses.');
223
224 $this->contactDelete($contactId);
225 }
226
227 /**
228 * GetValues() method (get Address fields)
229 */
230 public function testGetValues() {
231 $contactId = $this->individualCreate();
232
233 $params = [];
234 $params['address']['1'] = [
235 'street_address' => 'Oberoi Garden',
236 'supplemental_address_1' => 'Attn: Accounting',
237 'supplemental_address_2' => 'Powai',
238 'supplemental_address_3' => 'Somewhere',
239 'city' => 'Athens',
240 'postal_code' => '01903',
241 'state_province_id' => '1000',
242 'country_id' => '1228',
243 'geo_code_1' => '18.219023',
244 'geo_code_2' => '-105.00973',
245 'location_type_id' => '1',
246 'is_primary' => '1',
247 'is_billing' => '0',
248 ];
249
250 $params['contact_id'] = $contactId;
251
252 $fixAddress = TRUE;
253
254 CRM_Core_BAO_Address::create($params, $fixAddress, $entity = NULL);
255
256 $addressId = $this->assertDBNotNull('CRM_Core_DAO_Address', $contactId, 'id', 'contact_id',
257 'Database check for created address.'
258 );
259
260 $entityBlock = ['contact_id' => $contactId];
261 $address = CRM_Core_BAO_Address::getValues($entityBlock);
262 $this->assertEquals($address[1]['id'], $addressId);
263 $this->assertEquals($address[1]['contact_id'], $contactId);
264 $this->assertEquals($address[1]['state_province_abbreviation'], 'AL');
265 $this->assertEquals($address[1]['state_province'], 'Alabama');
266 $this->assertEquals($address[1]['country'], 'United States');
267 $this->assertEquals($address[1]['street_address'], 'Oberoi Garden');
268 $this->contactDelete($contactId);
269 }
270
271 /**
272 * Enable street address parsing.
273 *
274 * @param string $status
275 *
276 * @throws \CRM_Core_Exception
277 */
278 public function setStreetAddressParsing($status) {
279 $options = $this->callAPISuccess('Setting', 'getoptions', ['field' => 'address_options'])['values'];
280 $address_options = reset($this->callAPISuccess('Setting', 'get', ['return' => 'address_options'])['values'])['address_options'];
281 $parsingOption = array_search('Street Address Parsing', $options, TRUE);
282 $optionKey = array_search($parsingOption, $address_options, FALSE);
283 if ($status && !$optionKey) {
284 $address_options[] = $parsingOption;
285 }
286 if (!$status && $optionKey) {
287 unset($address_options[$optionKey]);
288 }
289 $this->callAPISuccess('Setting', 'create', ['address_options' => $address_options]);
290 }
291
292 /**
293 * ParseStreetAddress if enabled, otherwise, don't.
294 *
295 * @throws \CRM_Core_Exception
296 * @throws \CiviCRM_API3_Exception
297 */
298 public function testParseStreetAddressIfEnabled() {
299 // Turn off address standardization. Parsing should work without it.
300 Civi::settings()->set('address_standardization_provider', NULL);
301
302 // Ensure street parsing happens if enabled.
303 $this->setStreetAddressParsing(TRUE);
304
305 $contactId = $this->individualCreate();
306 $street_address = '54 Excelsior Ave.';
307 $params = [
308 'contact_id' => $contactId,
309 'street_address' => $street_address,
310 'location_type_id' => 1,
311 ];
312
313 $result = civicrm_api3('Address', 'create', $params);
314 $value = array_pop($result['values']);
315 $street_number = $value['street_number'] ?? NULL;
316 $this->assertEquals($street_number, '54');
317
318 // Ensure street parsing does not happen if disabled.
319 $this->setStreetAddressParsing(FALSE);
320 $result = civicrm_api3('Address', 'create', $params);
321 $value = array_pop($result['values']);
322 $street_number = $value['street_number'] ?? NULL;
323 $this->assertEmpty($street_number);
324
325 }
326
327 /**
328 * ParseStreetAddress() method (get street address parsed)
329 */
330 public function testParseStreetAddress() {
331
332 // valid Street address to be parsed ( without locale )
333 $street_address = "54A Excelsior Ave. Apt 1C";
334 $parsedStreetAddress = CRM_Core_BAO_Address::parseStreetAddress($street_address);
335 $this->assertEquals($parsedStreetAddress['street_name'], 'Excelsior Ave.');
336 $this->assertEquals($parsedStreetAddress['street_unit'], 'Apt 1C');
337 $this->assertEquals($parsedStreetAddress['street_number'], '54');
338 $this->assertEquals($parsedStreetAddress['street_number_suffix'], 'A');
339
340 // Out-of-range street number to be parsed.
341 $street_address = '505050505050 Main St';
342 $parsedStreetAddress = CRM_Core_BAO_Address::parseStreetAddress($street_address);
343 $this->assertEquals($parsedStreetAddress['street_name'], '');
344 $this->assertEquals($parsedStreetAddress['street_unit'], '');
345 $this->assertEquals($parsedStreetAddress['street_number'], '');
346 $this->assertEquals($parsedStreetAddress['street_number_suffix'], '');
347
348 // valid Street address to be parsed ( $locale = 'en_US' )
349 $street_address = "54A Excelsior Ave. Apt 1C";
350 $locale = 'en_US';
351 $parsedStreetAddress = CRM_Core_BAO_Address::parseStreetAddress($street_address, $locale);
352 $this->assertEquals($parsedStreetAddress['street_name'], 'Excelsior Ave.');
353 $this->assertEquals($parsedStreetAddress['street_unit'], 'Apt 1C');
354 $this->assertEquals($parsedStreetAddress['street_number'], '54');
355 $this->assertEquals($parsedStreetAddress['street_number_suffix'], 'A');
356
357 // invalid Street address ( $locale = 'en_US' )
358 $street_address = "West St. Apt 1";
359 $locale = 'en_US';
360 $parsedStreetAddress = CRM_Core_BAO_Address::parseStreetAddress($street_address, $locale);
361 $this->assertEquals($parsedStreetAddress['street_name'], 'West St.');
362 $this->assertEquals($parsedStreetAddress['street_unit'], 'Apt 1');
363 $this->assertNotContains('street_number', $parsedStreetAddress);
364 $this->assertNotContains('street_number_suffix', $parsedStreetAddress);
365
366 // valid Street address to be parsed ( $locale = 'fr_CA' )
367 $street_address = "2-123CA Main St";
368 $locale = 'fr_CA';
369 $parsedStreetAddress = CRM_Core_BAO_Address::parseStreetAddress($street_address, $locale);
370 $this->assertEquals($parsedStreetAddress['street_name'], 'Main St');
371 $this->assertEquals($parsedStreetAddress['street_unit'], '2');
372 $this->assertEquals($parsedStreetAddress['street_number'], '123');
373 $this->assertEquals($parsedStreetAddress['street_number_suffix'], 'CA');
374
375 // invalid Street address ( $locale = 'fr_CA' )
376 $street_address = "123 Main St";
377 $locale = 'fr_CA';
378 $parsedStreetAddress = CRM_Core_BAO_Address::parseStreetAddress($street_address, $locale);
379 $this->assertEquals($parsedStreetAddress['street_name'], 'Main St');
380 $this->assertEquals($parsedStreetAddress['street_number'], '123');
381 $this->assertNotContains('street_unit', $parsedStreetAddress);
382 $this->assertNotContains('street_number_suffix', $parsedStreetAddress);
383 }
384
385 /**
386 * @dataProvider supportedAddressParsingLocales
387 */
388 public function testIsSupportedByAddressParsingReturnTrueForSupportedLocales($locale) {
389 $isSupported = CRM_Core_BAO_Address::isSupportedParsingLocale($locale);
390 $this->assertTrue($isSupported);
391 }
392
393 /**
394 * @dataProvider supportedAddressParsingLocales
395 */
396 public function testIsSupportedByAddressParsingReturnTrueForSupportedDefaultLocales($locale) {
397 CRM_Core_Config::singleton()->lcMessages = $locale;
398 $isSupported = CRM_Core_BAO_Address::isSupportedParsingLocale();
399 $this->assertTrue($isSupported);
400
401 }
402
403 public function supportedAddressParsingLocales() {
404 return [
405 ['en_US'],
406 ['en_CA'],
407 ['fr_CA'],
408 ];
409 }
410
411 /**
412 * @dataProvider sampleOFUnsupportedAddressParsingLocales
413 */
414 public function testIsSupportedByAddressParsingReturnFalseForUnSupportedLocales($locale) {
415 $isNotSupported = CRM_Core_BAO_Address::isSupportedParsingLocale($locale);
416 $this->assertFalse($isNotSupported);
417 }
418
419 /**
420 * @dataProvider sampleOFUnsupportedAddressParsingLocales
421 */
422 public function testIsSupportedByAddressParsingReturnFalseForUnSupportedDefaultLocales($locale) {
423 CRM_Core_Config::singleton()->lcMessages = $locale;
424 $isNotSupported = CRM_Core_BAO_Address::isSupportedParsingLocale();
425 $this->assertFalse($isNotSupported);
426 }
427
428 public function sampleOFUnsupportedAddressParsingLocales() {
429 return [
430 ['en_GB'],
431 ['af_ZA'],
432 ['da_DK'],
433 ];
434 }
435
436 /**
437 * CRM-21214 - Ensure all child addresses are updated correctly - 1.
438 * 1. First, create three contacts: A, B, and C
439 * 2. Create an address for contact A
440 * 3. Use contact A's address for contact B
441 * 4. Use contact B's address for contact C
442 * 5. Change contact A's address
443 * Address of Contact C should reflect contact A's address change
444 * Also, Contact C's address' master_id should be Contact A's address id.
445 */
446 public function testSharedAddressChaining1() {
447 $contactIdA = $this->individualCreate([], 0);
448 $contactIdB = $this->individualCreate([], 1);
449 $contactIdC = $this->individualCreate([], 2);
450
451 $addressParamsA = [
452 'street_address' => '123 Fake St.',
453 'location_type_id' => '1',
454 'is_primary' => '1',
455 'contact_id' => $contactIdA,
456 ];
457 $addAddressA = CRM_Core_BAO_Address::add($addressParamsA, FALSE);
458
459 $addressParamsB = [
460 'street_address' => '123 Fake St.',
461 'location_type_id' => '1',
462 'is_primary' => '1',
463 'master_id' => $addAddressA->id,
464 'contact_id' => $contactIdB,
465 ];
466 $addAddressB = CRM_Core_BAO_Address::add($addressParamsB, FALSE);
467
468 $addressParamsC = [
469 'street_address' => '123 Fake St.',
470 'location_type_id' => '1',
471 'is_primary' => '1',
472 'master_id' => $addAddressB->id,
473 'contact_id' => $contactIdC,
474 ];
475 $addAddressC = CRM_Core_BAO_Address::add($addressParamsC, FALSE);
476
477 $updatedAddressParamsA = [
478 'id' => $addAddressA->id,
479 'street_address' => '1313 New Address Lane',
480 'location_type_id' => '1',
481 'is_primary' => '1',
482 'contact_id' => $contactIdA,
483 ];
484 $updatedAddressA = CRM_Core_BAO_Address::add($updatedAddressParamsA, FALSE);
485
486 // CRM-21214 - Has Address C been updated with Address A's new values?
487 $newAddressC = new CRM_Core_DAO_Address();
488 $newAddressC->id = $addAddressC->id;
489 $newAddressC->find(TRUE);
490 $newAddressC->fetch(TRUE);
491
492 $this->assertEquals($updatedAddressA->street_address, $newAddressC->street_address);
493 $this->assertEquals($updatedAddressA->id, $newAddressC->master_id);
494 }
495
496 /**
497 * CRM-21214 - Ensure all child addresses are updated correctly - 2.
498 * 1. First, create three contacts: A, B, and C
499 * 2. Create an address for contact A and B
500 * 3. Use contact A's address for contact C
501 * 4. Use contact B's address for contact A
502 * 5. Change contact B's address
503 * Address of Contact C should reflect contact B's address change
504 * Also, Contact C's address' master_id should be Contact B's address id.
505 */
506 public function testSharedAddressChaining2() {
507 $contactIdA = $this->individualCreate([], 0);
508 $contactIdB = $this->individualCreate([], 1);
509 $contactIdC = $this->individualCreate([], 2);
510
511 $addressParamsA = [
512 'street_address' => '123 Fake St.',
513 'location_type_id' => '1',
514 'is_primary' => '1',
515 'contact_id' => $contactIdA,
516 ];
517 $addAddressA = CRM_Core_BAO_Address::add($addressParamsA, FALSE);
518
519 $addressParamsB = [
520 'street_address' => '123 Fake St.',
521 'location_type_id' => '1',
522 'is_primary' => '1',
523 'contact_id' => $contactIdB,
524 ];
525 $addAddressB = CRM_Core_BAO_Address::add($addressParamsB, FALSE);
526
527 $addressParamsC = [
528 'street_address' => '123 Fake St.',
529 'location_type_id' => '1',
530 'is_primary' => '1',
531 'master_id' => $addAddressA->id,
532 'contact_id' => $contactIdC,
533 ];
534 $addAddressC = CRM_Core_BAO_Address::add($addressParamsC, FALSE);
535
536 $updatedAddressParamsA = [
537 'id' => $addAddressA->id,
538 'street_address' => '123 Fake St.',
539 'location_type_id' => '1',
540 'is_primary' => '1',
541 'master_id' => $addAddressB->id,
542 'contact_id' => $contactIdA,
543 ];
544 $updatedAddressA = CRM_Core_BAO_Address::add($updatedAddressParamsA, FALSE);
545
546 $updatedAddressParamsB = [
547 'id' => $addAddressB->id,
548 'street_address' => '1313 New Address Lane',
549 'location_type_id' => '1',
550 'is_primary' => '1',
551 'contact_id' => $contactIdB,
552 ];
553 $updatedAddressB = CRM_Core_BAO_Address::add($updatedAddressParamsB, FALSE);
554
555 // CRM-21214 - Has Address C been updated with Address B's new values?
556 $newAddressC = new CRM_Core_DAO_Address();
557 $newAddressC->id = $addAddressC->id;
558 $newAddressC->find(TRUE);
559 $newAddressC->fetch(TRUE);
560
561 $this->assertEquals($updatedAddressB->street_address, $newAddressC->street_address);
562 $this->assertEquals($updatedAddressB->id, $newAddressC->master_id);
563 }
564
565 /**
566 * CRM-21214 - Ensure all child addresses are updated correctly - 3.
567 * 1. First, create a contact: A
568 * 2. Create an address for contact A
569 * 3. Use contact A's address for contact A's address
570 * An error should be given, and master_id should remain the same.
571 */
572 public function testSharedAddressChaining3() {
573 $contactIdA = $this->individualCreate([], 0);
574
575 $addressParamsA = [
576 'street_address' => '123 Fake St.',
577 'location_type_id' => '1',
578 'is_primary' => '1',
579 'contact_id' => $contactIdA,
580 ];
581 $addAddressA = CRM_Core_BAO_Address::add($addressParamsA, FALSE);
582
583 $updatedAddressParamsA = [
584 'id' => $addAddressA->id,
585 'street_address' => '123 Fake St.',
586 'location_type_id' => '1',
587 'is_primary' => '1',
588 'master_id' => $addAddressA->id,
589 'contact_id' => $contactIdA,
590 ];
591 $updatedAddressA = CRM_Core_BAO_Address::add($updatedAddressParamsA, FALSE);
592
593 // CRM-21214 - AdressA shouldn't be master of itself.
594 $this->assertEmpty($updatedAddressA->master_id);
595 }
596
597 }