tests/phpunit/CRM/Core/BAO/AddressTest.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * Class CRM_Core_BAO_AddressTest
  30  * @group headless
  31  */
  32 class CRM_Core_BAO_AddressTest extends CiviUnitTestCase {
  33   public function setUp() {
  34     parent::setUp();
  35
  36     $this->quickCleanup(array('civicrm_contact', 'civicrm_address'));
  37   }
  38
  39   /**
  40    * Create() method (create and update modes)
  41    */
  42   public function testCreate() {
  43     $contactId = $this->individualCreate();
  44
  45     $params = array();
  46     $params['address']['1'] = array(
  47       'street_address' => 'Oberoi Garden',
  48       'supplemental_address_1' => 'Attn: Accounting',
  49       'supplemental_address_2' => 'Powai',
  50       'supplemental_address_3' => 'Somewhere',
  51       'city' => 'Athens',
  52       'postal_code' => '01903',
  53       'state_province_id' => '1000',
  54       'country_id' => '1228',
  55       'geo_code_1' => '18.219023',
  56       'geo_code_2' => '-105.00973',
  57       'location_type_id' => '1',
  58       'is_primary' => '1',
  59       'is_billing' => '0',
  60     );
  61
  62     $params['contact_id'] = $contactId;
  63
  64     $fixAddress = TRUE;
  65
  66     CRM_Core_BAO_Address::create($params, $fixAddress, $entity = NULL);
  67     $addressId = $this->assertDBNotNull('CRM_Core_DAO_Address', 'Oberoi Garden', 'id', 'street_address',
  68       'Database check for created address.'
  69     );
  70
  71     // Now call add() to modify an existing  address
  72
  73     $params = array();
  74     $params['address']['1'] = array(
  75       'id' => $addressId,
  76       'street_address' => '120 Terminal Road',
  77       'supplemental_address_1' => 'A-wing:3037',
  78       'supplemental_address_2' => 'Bandra',
  79       'supplemental_address_3' => 'Somewhere',
  80       'city' => 'Athens',
  81       'postal_code' => '01903',
  82       'state_province_id' => '1000',
  83       'country_id' => '1228',
  84       'geo_code_1' => '18.219023',
  85       'geo_code_2' => '-105.00973',
  86       'location_type_id' => '1',
  87       'is_primary' => '1',
  88       'is_billing' => '0',
  89     );
  90     $params['contact_id'] = $contactId;
  91
  92     $block = CRM_Core_BAO_Address::create($params, $fixAddress, $entity = NULL);
  93
  94     $this->assertDBNotNull('CRM_Core_DAO_Address', $contactId, 'id', 'contact_id',
  95       'Database check for updated address by contactId.'
  96     );
  97     $this->assertDBNotNull('CRM_Core_DAO_Address', '120 Terminal Road', 'id', 'street_address',
  98       'Database check for updated address by street_name.'
  99     );
 100     $this->contactDelete($contactId);
 101   }
 102
 103   /**
 104    * Add() method ( )
 105    */
 106   public function testAdd() {
 107     $contactId = $this->individualCreate();
 108
 109     $fixParams = array(
 110       'street_address' => 'E 906N Pine Pl W',
 111       'supplemental_address_1' => 'Editorial Dept',
 112       'supplemental_address_2' => '',
 113       'supplemental_address_3' => '',
 114       'city' => 'El Paso',
 115       'postal_code' => '88575',
 116       'postal_code_suffix' => '',
 117       'state_province_id' => '1001',
 118       'country_id' => '1228',
 119       'geo_code_1' => '31.694842',
 120       'geo_code_2' => '-106.29998',
 121       'location_type_id' => '1',
 122       'is_primary' => '1',
 123       'is_billing' => '0',
 124       'contact_id' => $contactId,
 125     );
 126
 127     $addAddress = CRM_Core_BAO_Address::add($fixParams, $fixAddress = TRUE);
 128
 129     $addParams = $this->assertDBNotNull('CRM_Core_DAO_Address', $contactId, 'id', 'contact_id',
 130       'Database check for created contact address.'
 131     );
 132
 133     $this->assertEquals($addAddress->street_address, 'E 906N Pine Pl W', 'In line' . __LINE__);
 134     $this->assertEquals($addAddress->supplemental_address_1, 'Editorial Dept', 'In line' . __LINE__);
 135     $this->assertEquals($addAddress->city, 'El Paso', 'In line' . __LINE__);
 136     $this->assertEquals($addAddress->postal_code, '88575', 'In line' . __LINE__);
 137     $this->assertEquals($addAddress->geo_code_1, '31.694842', 'In line' . __LINE__);
 138     $this->assertEquals($addAddress->geo_code_2, '-106.29998', 'In line' . __LINE__);
 139     $this->assertEquals($addAddress->country_id, '1228', 'In line' . __LINE__);
 140     $this->contactDelete($contactId);
 141   }
 142
 143   /**
 144    * AllAddress() method ( )
 145    */
 146   public function testallAddress() {
 147     $contactId = $this->individualCreate();
 148
 149     $fixParams = array(
 150       'street_address' => 'E 906N Pine Pl W',
 151       'supplemental_address_1' => 'Editorial Dept',
 152       'supplemental_address_2' => '',
 153       'supplemental_address_3' => '',
 154       'city' => 'El Paso',
 155       'postal_code' => '88575',
 156       'postal_code_suffix' => '',
 157       'state_province_id' => '1001',
 158       'country_id' => '1228',
 159       'geo_code_1' => '31.694842',
 160       'geo_code_2' => '-106.29998',
 161       'location_type_id' => '1',
 162       'is_primary' => '1',
 163       'is_billing' => '0',
 164       'contact_id' => $contactId,
 165     );
 166
 167     CRM_Core_BAO_Address::add($fixParams, $fixAddress = TRUE);
 168
 169     $addParams = $this->assertDBNotNull('CRM_Core_DAO_Address', $contactId, 'id', 'contact_id',
 170       'Database check for created contact address.'
 171     );
 172     $fixParams = array(
 173       'street_address' => 'SW 719B Beech Dr NW',
 174       'supplemental_address_1' => 'C/o OPDC',
 175       'supplemental_address_2' => '',
 176       'supplemental_address_3' => '',
 177       'city' => 'Neillsville',
 178       'postal_code' => '54456',
 179       'postal_code_suffix' => '',
 180       'state_province_id' => '1001',
 181       'country_id' => '1228',
 182       'geo_code_1' => '44.553719',
 183       'geo_code_2' => '-90.61457',
 184       'location_type_id' => '2',
 185       'is_primary' => '',
 186       'is_billing' => '1',
 187       'contact_id' => $contactId,
 188     );
 189
 190     CRM_Core_BAO_Address::add($fixParams, $fixAddress = TRUE);
 191
 192     $addParams = $this->assertDBNotNull('CRM_Core_DAO_Address', $contactId, 'id', 'contact_id',
 193       'Database check for created contact address.'
 194     );
 195
 196     $allAddress = CRM_Core_BAO_Address::allAddress($contactId);
 197
 198     $this->assertEquals(count($allAddress), 2, 'Checking number of returned addresses.');
 199
 200     $this->contactDelete($contactId);
 201   }
 202
 203   /**
 204    * AllAddress() method ( ) with null value
 205    */
 206   public function testnullallAddress() {
 207     $contactId = $this->individualCreate();
 208
 209     $fixParams = array(
 210       'street_address' => 'E 906N Pine Pl W',
 211       'supplemental_address_1' => 'Editorial Dept',
 212       'supplemental_address_2' => '',
 213       'supplemental_address_3' => '',
 214       'city' => 'El Paso',
 215       'postal_code' => '88575',
 216       'postal_code_suffix' => '',
 217       'state_province_id' => '1001',
 218       'country_id' => '1228',
 219       'geo_code_1' => '31.694842',
 220       'geo_code_2' => '-106.29998',
 221       'location_type_id' => '1',
 222       'is_primary' => '1',
 223       'is_billing' => '0',
 224       'contact_id' => $contactId,
 225     );
 226
 227     CRM_Core_BAO_Address::add($fixParams, $fixAddress = TRUE);
 228
 229     $addParams = $this->assertDBNotNull('CRM_Core_DAO_Address', $contactId, 'id', 'contact_id',
 230       'Database check for created contact address.'
 231     );
 232
 233     $contact_Id = NULL;
 234
 235     $allAddress = CRM_Core_BAO_Address::allAddress($contact_Id);
 236
 237     $this->assertEquals($allAddress, NULL, 'Checking null for returned addresses.');
 238
 239     $this->contactDelete($contactId);
 240   }
 241
 242   /**
 243    * GetValues() method (get Address fields)
 244    */
 245   public function testGetValues() {
 246     $contactId = $this->individualCreate();
 247
 248     $params = array();
 249     $params['address']['1'] = array(
 250       'street_address' => 'Oberoi Garden',
 251       'supplemental_address_1' => 'Attn: Accounting',
 252       'supplemental_address_2' => 'Powai',
 253       'supplemental_address_3' => 'Somewhere',
 254       'city' => 'Athens',
 255       'postal_code' => '01903',
 256       'state_province_id' => '1000',
 257       'country_id' => '1228',
 258       'geo_code_1' => '18.219023',
 259       'geo_code_2' => '-105.00973',
 260       'location_type_id' => '1',
 261       'is_primary' => '1',
 262       'is_billing' => '0',
 263     );
 264
 265     $params['contact_id'] = $contactId;
 266
 267     $fixAddress = TRUE;
 268
 269     CRM_Core_BAO_Address::create($params, $fixAddress, $entity = NULL);
 270
 271     $addressId = $this->assertDBNotNull('CRM_Core_DAO_Address', $contactId, 'id', 'contact_id',
 272       'Database check for created address.'
 273     );
 274
 275     $entityBlock = array('contact_id' => $contactId);
 276     $address = CRM_Core_BAO_Address::getValues($entityBlock);
 277     $this->assertEquals($address[1]['id'], $addressId);
 278     $this->assertEquals($address[1]['contact_id'], $contactId);
 279     $this->assertEquals($address[1]['street_address'], 'Oberoi Garden');
 280     $this->contactDelete($contactId);
 281   }
 282
 283   /**
 284    * ParseStreetAddress() method (get street address parsed)
 285    */
 286   public function testParseStreetAddress() {
 287
 288     // valid Street address to be parsed ( without locale )
 289     $street_address = "54A Excelsior Ave. Apt 1C";
 290     $parsedStreetAddress = CRM_Core_BAO_Address::parseStreetAddress($street_address);
 291     $this->assertEquals($parsedStreetAddress['street_name'], 'Excelsior Ave.');
 292     $this->assertEquals($parsedStreetAddress['street_unit'], 'Apt 1C');
 293     $this->assertEquals($parsedStreetAddress['street_number'], '54');
 294     $this->assertEquals($parsedStreetAddress['street_number_suffix'], 'A');
 295
 296     // valid Street address to be parsed ( $locale = 'en_US' )
 297     $street_address = "54A Excelsior Ave. Apt 1C";
 298     $locale = 'en_US';
 299     $parsedStreetAddress = CRM_Core_BAO_Address::parseStreetAddress($street_address, $locale);
 300     $this->assertEquals($parsedStreetAddress['street_name'], 'Excelsior Ave.');
 301     $this->assertEquals($parsedStreetAddress['street_unit'], 'Apt 1C');
 302     $this->assertEquals($parsedStreetAddress['street_number'], '54');
 303     $this->assertEquals($parsedStreetAddress['street_number_suffix'], 'A');
 304
 305     // invalid Street address ( $locale = 'en_US' )
 306     $street_address = "West St. Apt 1";
 307     $locale = 'en_US';
 308     $parsedStreetAddress = CRM_Core_BAO_Address::parseStreetAddress($street_address, $locale);
 309     $this->assertEquals($parsedStreetAddress['street_name'], 'West St.');
 310     $this->assertEquals($parsedStreetAddress['street_unit'], 'Apt 1');
 311     $this->assertNotContains('street_number', $parsedStreetAddress);
 312     $this->assertNotContains('street_number_suffix', $parsedStreetAddress);
 313
 314     // valid Street address to be parsed ( $locale = 'fr_CA' )
 315     $street_address = "2-123CA Main St";
 316     $locale = 'fr_CA';
 317     $parsedStreetAddress = CRM_Core_BAO_Address::parseStreetAddress($street_address, $locale);
 318     $this->assertEquals($parsedStreetAddress['street_name'], 'Main St');
 319     $this->assertEquals($parsedStreetAddress['street_unit'], '2');
 320     $this->assertEquals($parsedStreetAddress['street_number'], '123');
 321     $this->assertEquals($parsedStreetAddress['street_number_suffix'], 'CA');
 322
 323     // invalid Street address ( $locale = 'fr_CA' )
 324     $street_address = "123 Main St";
 325     $locale = 'fr_CA';
 326     $parsedStreetAddress = CRM_Core_BAO_Address::parseStreetAddress($street_address, $locale);
 327     $this->assertEquals($parsedStreetAddress['street_name'], 'Main St');
 328     $this->assertEquals($parsedStreetAddress['street_number'], '123');
 329     $this->assertNotContains('street_unit', $parsedStreetAddress);
 330     $this->assertNotContains('street_number_suffix', $parsedStreetAddress);
 331   }
 332
 333 }