CRM/Contact/Form/Edit/Address.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class is used to build address block
  38  */
  39 class CRM_Contact_Form_Edit_Address {
  40
  41   /**
  42    * build form for address input fields
  43    *
  44    * @param object  $form - CRM_Core_Form (or subclass)
  45    * @param int     $addressBlockCount - the index of the address array (if multiple addresses on a page)
  46    * @param boolean $sharing - false, if we want to skip the address sharing features
  47    * @param boolean $inlineEdit true when edit used in inline edit
  48    *
  49    * @return void
  50    *
  51    * @access public
  52    * @static
  53    */
  54   static function buildQuickForm(&$form, $addressBlockCount = NULL, $sharing = TRUE, $inlineEdit = FALSE) {
  55     // passing this via the session is AWFUL. we need to fix this
  56     if (!$addressBlockCount) {
  57       $blockId = ($form->get('Address_Block_Count')) ? $form->get('Address_Block_Count') : 1;
  58     }
  59     else {
  60       $blockId = $addressBlockCount;
  61     }
  62
  63     $config = CRM_Core_Config::singleton();
  64     $countryDefault = $config->defaultContactCountry;
  65
  66     $form->applyFilter('__ALL__', 'trim');
  67
  68     $js = array();
  69     if (!$inlineEdit) {
  70       $js = array('onChange' => 'checkLocation( this.id );', 'placeholder' => NULL);
  71     }
  72
  73     //make location type required for inline edit
  74     $form->addSelect("address[$blockId][location_type_id]", array('entity' => 'address', 'class' => 'eight') + $js, $inlineEdit);
  75
  76     if (!$inlineEdit) {
  77       $js = array('id' => 'Address_' . $blockId . '_IsPrimary', 'onClick' => 'singleSelect( this.id );');
  78     }
  79
  80     $form->addElement(
  81       'checkbox',
  82       "address[$blockId][is_primary]",
  83       ts('Primary location for this contact'),
  84       ts('Primary location for this contact'),
  85       $js
  86     );
  87
  88     if (!$inlineEdit) {
  89       $js = array('id' => 'Address_' . $blockId . '_IsBilling', 'onClick' => 'singleSelect( this.id );');
  90     }
  91
  92     $form->addElement(
  93       'checkbox',
  94       "address[$blockId][is_billing]",
  95       ts('Billing location for this contact'),
  96       ts('Billing location for this contact'),
  97       $js
  98     );
  99
 100     // hidden element to store master address id
 101     $form->addElement('hidden', "address[$blockId][master_id]");
 102
 103     $addressOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 104       'address_options', TRUE, NULL, TRUE
 105     );
 106     $attributes = CRM_Core_DAO::getAttribute('CRM_Core_DAO_Address');
 107
 108     $elements = array(
 109       'address_name' => array(ts('Address Name'), $attributes['address_name'], NULL),
 110       'street_address' => array(ts('Street Address'), $attributes['street_address'], NULL),
 111       'supplemental_address_1' => array(ts('Supplemental Address 1'), $attributes['supplemental_address_1'], NULL),
 112       'supplemental_address_2' => array(ts('Supplemental Address 2'), $attributes['supplemental_address_2'], NULL),
 113       'city' => array(ts('City'), $attributes['city'], NULL),
 114       'postal_code' => array(ts('Zip / Postal Code'), array_merge($attributes['postal_code'], array('class' => 'crm_postal_code')), NULL),
 115       'postal_code_suffix' => array(ts('Postal Code Suffix'), array('size' => 4, 'maxlength' => 12, 'class' => 'crm_postal_code_suffix'), NULL),
 116       'county_id' => array(ts('County'), $attributes['county_id'], NULL),
 117       'state_province_id' => array(ts('State / Province'), $attributes['state_province_id'], NULL),
 118       'country_id' => array(ts('Country'), $attributes['country_id'], NULL),
 119       'geo_code_1' => array(ts('Latitude'), array('size' => 9, 'maxlength' => 11), NULL),
 120       'geo_code_2' => array(ts('Longitude'), array('size' => 9, 'maxlength' => 11), NULL),
 121       'street_number' => array(ts('Street Number'), $attributes['street_number'], NULL),
 122       'street_name' => array(ts('Street Name'), $attributes['street_name'], NULL),
 123       'street_unit' => array(ts('Apt/Unit/Suite'), $attributes['street_unit'], NULL),
 124     );
 125
 126     $stateCountryMap = array();
 127     foreach ($elements as $name => $v) {
 128       list($title, $attributes, $select) = $v;
 129
 130       $nameWithoutID = strpos($name, '_id') !== FALSE ? substr($name, 0, -3) : $name;
 131       if (empty($addressOptions[$nameWithoutID])) {
 132         $continue = TRUE;
 133         if (in_array($nameWithoutID, array(
 134           'street_number', 'street_name', 'street_unit')) && !empty($addressOptions['street_address_parsing'])) {
 135           $continue = FALSE;
 136         }
 137         if ($continue) {
 138           continue;
 139         }
 140       }
 141
 142       if (!$attributes) {
 143         $attributes = $attributes[$name];
 144       }
 145
 146       //build normal select if country is not present in address block
 147       if ($name == 'state_province_id' && !$addressOptions['country']) {
 148         $select = 'stateProvince';
 149       }
 150
 151       if (!$select) {
 152         if ($name == 'country_id' || $name == 'state_province_id' || $name == 'county_id') {
 153           if ($name == 'country_id') {
 154             $stateCountryMap[$blockId]['country'] = "address_{$blockId}_{$name}";
 155             $selectOptions = array('' => ts('- select -')) + CRM_Core_PseudoConstant::country();
 156           }
 157           elseif ($name == 'state_province_id') {
 158             $stateCountryMap[$blockId]['state_province'] = "address_{$blockId}_{$name}";
 159             if ($countryDefault) {
 160               $selectOptions = array('' => ts('- select -')) + CRM_Core_PseudoConstant::stateProvinceForCountry($countryDefault);
 161             }
 162             else {
 163               $selectOptions = array('' => ts('- select a country -'));
 164             }
 165           }
 166           elseif ($name == 'county_id') {
 167             $stateCountryMap[$blockId]['county'] = "address_{$blockId}_{$name}";
 168             if ($form->getSubmitValue("address[{$blockId}][state_province_id]")) {
 169               $selectOptions = array('' => ts('- select -')) + CRM_Core_PseudoConstant::countyForState($form->getSubmitValue("address[{$blockId}][state_province_id]"));
 170             }
 171             elseif ($form->getSubmitValue("address[{$blockId}][county_id]")) {
 172               $selectOptions = array('' => ts('- select -')) + CRM_Core_PseudoConstant::county();
 173             }
 174             else {
 175               $selectOptions = array('' => ts('- select a state -'));
 176             }
 177           }
 178           $form->addElement('select',
 179             "address[$blockId][$name]",
 180             $title,
 181             $selectOptions
 182           );
 183         }
 184         else {
 185           if ($name == 'address_name') {
 186             $name = 'name';
 187           }
 188
 189           $form->addElement('text',
 190             "address[$blockId][$name]",
 191             $title,
 192             $attributes
 193           );
 194         }
 195       }
 196       else {
 197         if ($name == 'state_province_id') {
 198           $stateCountryMap[$blockId]['state_province'] = "address_{$blockId}_{$name}";
 199         }
 200         $form->addElement('select',
 201           "address[$blockId][$name]",
 202           $title,
 203           array('' => ts('- select -')) + CRM_Core_PseudoConstant::$select()
 204         );
 205       }
 206     }
 207
 208     CRM_Core_BAO_Address::addStateCountryMap($stateCountryMap);
 209
 210     $entityId = NULL;
 211     if (!empty($form->_values['address']) && !empty($form->_values['address'][$blockId])) {
 212       $entityId = $form->_values['address'][$blockId]['id'];
 213     }
 214
 215     // CRM-11665 geocode override option
 216     $geoCode = FALSE;
 217     if (!empty($config->geocodeMethod)) {
 218       $geoCode = TRUE;
 219       $form->addElement('checkbox',
 220         "address[$blockId][manual_geo_code]",
 221         ts('Override automatic geocoding')
 222       );
 223     }
 224     $form->assign('geoCode', $geoCode);
 225
 226     // Process any address custom data -
 227     $groupTree = CRM_Core_BAO_CustomGroup::getTree('Address',
 228       $form,
 229       $entityId
 230     );
 231
 232     if (isset($groupTree) && is_array($groupTree)) {
 233       // use simplified formatted groupTree
 234       $groupTree = CRM_Core_BAO_CustomGroup::formatGroupTree($groupTree, 1, $form);
 235
 236       // make sure custom fields are added /w element-name in the format - 'address[$blockId][custom-X]'
 237       foreach ($groupTree as $id => $group) {
 238         foreach ($group['fields'] as $fldId => $field) {
 239           $groupTree[$id]['fields'][$fldId]['element_custom_name'] = $field['element_name'];
 240           $groupTree[$id]['fields'][$fldId]['element_name'] = "address[$blockId][{$field['element_name']}]";
 241         }
 242       }
 243
 244       $defaults = array();
 245       CRM_Core_BAO_CustomGroup::setDefaults($groupTree, $defaults);
 246
 247       // since we change element name for address custom data, we need to format the setdefault values
 248       $addressDefaults = array();
 249       foreach ($defaults as $key => $val) {
 250         if ( empty( $val ) ) {
 251           continue;
 252         }
 253
 254         // inorder to set correct defaults for checkbox custom data, we need to converted flat key to array
 255         // this works for all types custom data
 256         $keyValues = explode('[', str_replace(']', '', $key));
 257         $addressDefaults[$keyValues[0]][$keyValues[1]][$keyValues[2]] = $val;
 258       }
 259
 260       $form->setDefaults($addressDefaults);
 261
 262       // we setting the prefix to 'dnc_' below, so that we don't overwrite smarty's grouptree var.
 263       // And we can't set it to 'address_' because we want to set it in a slightly different format.
 264       CRM_Core_BAO_CustomGroup::buildQuickForm($form, $groupTree, FALSE, 'dnc_');
 265
 266       // during contact editing : if no address is filled
 267       // required custom data must not produce 'required' form rule error
 268       // more handling done in formRule func
 269       if (!$inlineEdit) {
 270         CRM_Contact_Form_Edit_Address::storeRequiredCustomDataInfo($form, $groupTree);
 271       }
 272
 273       $template     = CRM_Core_Smarty::singleton();
 274       $tplGroupTree = $template->get_template_vars('address_groupTree');
 275       $tplGroupTree = empty($tplGroupTree) ? array(
 276         ) : $tplGroupTree;
 277
 278       $form->assign('address_groupTree', $tplGroupTree + array($blockId => $groupTree));
 279       // unset the temp smarty var that got created
 280       $form->assign('dnc_groupTree', NULL);
 281     }
 282     // address custom data processing ends ..
 283
 284     if ($sharing) {
 285       // shared address
 286       $form->addElement('checkbox', "address[$blockId][use_shared_address]", NULL, ts('Use another contact\'s address'));
 287
 288       // Override the default profile links to add address form
 289       $profileLinks = CRM_Core_BAO_UFGroup::getCreateLinks(array('new_individual', 'new_organization', 'new_household'), 'shared_address');
 290       $form->addEntityRef("address[$blockId][master_contact_id]", ts('Share With'), array('create' => $profileLinks));
 291     }
 292   }
 293
 294   /**
 295    * check for correct state / country mapping.
 296    *
 297    * @param array reference $fields - submitted form values.
 298    * @param array reference $errors - if any errors found add to this array. please.
 299    *
 300    * @return true if no errors
 301    *         array of errors if any present.
 302    *
 303    * @access public
 304    * @static
 305    */
 306   static function formRule($fields, $files, $self) {
 307     $errors = array();
 308
 309     $customDataRequiredFields = array();
 310     if ($self && property_exists($self, '_addressRequireOmission')) {
 311       $customDataRequiredFields = explode(',', $self->_addressRequireOmission);
 312     }
 313
 314     // check for state/county match if not report error to user.
 315     if (!empty($fields['address']) && is_array($fields['address'])) {
 316       foreach ($fields['address'] as $instance => $addressValues) {
 317
 318         if (CRM_Utils_System::isNull($addressValues)) {
 319           // DETACH 'required' form rule error to
 320           // custom data only if address data not exists upon submission
 321           if (!empty($customDataRequiredFields)) {
 322             foreach($customDataRequiredFields as $customElementName) {
 323               $elementName = "address[$instance][$customElementName]";
 324               if ($self->getElementError($elementName)) {
 325                 // set element error to none
 326                 $self->setElementError($elementName, NULL);
 327               }
 328             }
 329           }
 330           continue;
 331         }
 332
 333         // DETACH 'required' form rule error to
 334         // custom data only if address data not exists upon submission
 335         if (!empty($customDataRequiredFields) && !CRM_Core_BAO_Address::dataExists($addressValues)) {
 336           foreach($customDataRequiredFields as $customElementName) {
 337             $elementName = "address[$instance][$customElementName]";
 338             if ($self->getElementError($elementName)) {
 339               // set element error to none
 340               $self->setElementError($elementName, NULL);
 341             }
 342           }
 343         }
 344
 345         $countryId = CRM_Utils_Array::value('country_id', $addressValues);
 346
 347         $stateProvinceId = CRM_Utils_Array::value('state_province_id', $addressValues);
 348
 349         //do check for mismatch countries
 350         if ($stateProvinceId && $countryId) {
 351           $stateProvinceDAO = new CRM_Core_DAO_StateProvince();
 352           $stateProvinceDAO->id = $stateProvinceId;
 353           $stateProvinceDAO->find(TRUE);
 354           if ($stateProvinceDAO->country_id != $countryId) {
 355             // countries mismatch hence display error
 356             $stateProvinces = CRM_Core_PseudoConstant::stateProvince();
 357             $countries = CRM_Core_PseudoConstant::country();
 358             $errors["address[$instance][state_province_id]"] = ts('State/Province %1 is not part of %2. It belongs to %3.',
 359               array(
 360                 1 => $stateProvinces[$stateProvinceId],
 361                 2 => $countries[$countryId],
 362                 3 => $countries[$stateProvinceDAO->country_id]
 363               )
 364             );
 365           }
 366         }
 367
 368         $countyId = CRM_Utils_Array::value('county_id', $addressValues);
 369
 370         //state county validation
 371         if ($stateProvinceId && $countyId) {
 372           $countyDAO = new CRM_Core_DAO_County();
 373           $countyDAO->id = $countyId;
 374           $countyDAO->find(TRUE);
 375           if ($countyDAO->state_province_id != $stateProvinceId) {
 376             $counties = CRM_Core_PseudoConstant::county();
 377             $errors["address[$instance][county_id]"] = ts('County %1 is not part of %2. It belongs to %3.',
 378               array(
 379                 1 => $counties[$countyId],
 380                 2 => $stateProvinces[$stateProvinceId],
 381                 3 => $stateProvinces[$countyDAO->state_province_id]
 382               )
 383             );
 384           }
 385         }
 386
 387         if (!empty($addressValues['use_shared_address']) && empty($addressValues['master_id'])) {
 388           $errors["address[$instance][use_shared_address]"] = ts('Please select valid shared contact or a contact with valid address.');
 389         }
 390       }
 391     }
 392
 393     return empty($errors) ? TRUE : $errors;
 394   }
 395
 396   static function fixStateSelect(&$form,
 397     $countryElementName,
 398     $stateElementName,
 399     $countyElementName,
 400     $countryDefaultValue,
 401     $stateDefaultValue = NULL
 402   ) {
 403     $countryID = $stateID = NULL;
 404     if (isset($form->_elementIndex[$countryElementName])) {
 405       //get the country id to load states -
 406       //first check for submitted value,
 407       //then check for user passed value.
 408       //finally check for element default val.
 409       $submittedVal = $form->getSubmitValue($countryElementName);
 410       if ($submittedVal) {
 411         $countryID = $submittedVal;
 412       }
 413       elseif ($countryDefaultValue) {
 414         $countryID = $countryDefaultValue;
 415       }
 416       else {
 417         $countryID = CRM_Utils_Array::value(0, $form->getElementValue($countryElementName));
 418       }
 419     }
 420     $stateTitle = ts('State/Province');
 421     if (isset($form->_fields[$stateElementName]['title'])) {
 422       $stateTitle = $form->_fields[$stateElementName]['title'];
 423     }
 424
 425     if (isset($form->_elementIndex[$stateElementName])) {
 426       $submittedValState = $form->getSubmitValue($stateElementName);
 427       if ($submittedValState) {
 428         $stateID = $submittedValState;
 429       }
 430       elseif ($stateDefaultValue) {
 431         $stateID = $stateDefaultValue;
 432       }
 433       else {
 434         $stateID = CRM_Utils_Array::value(0, $form->getElementValue($stateElementName));
 435       }
 436     }
 437
 438     if (isset($form->_elementIndex[$stateElementName])) {
 439       if ($countryID) {
 440         $stateProvinces = CRM_Core_PseudoConstant::stateProvinceForCountry($countryID);
 441       }
 442       else {
 443         $stateProvinces = CRM_Core_PseudoConstant::stateProvince();
 444       }
 445
 446       $stateSelect = & $form->addElement('select', $stateElementName, $stateTitle,
 447         array('' => ts('- select -')) + $stateProvinces);
 448     }
 449
 450     if (isset($form->_elementIndex[$stateElementName]) && isset($form->_elementIndex[$countyElementName])) {
 451       if ($stateID) {
 452         $counties = CRM_Core_PseudoConstant::countyForState($stateID);
 453       }
 454       else {
 455         $counties = CRM_Core_PseudoConstant::county();
 456       }
 457
 458       $form->addElement('select', $countyElementName, ts('County'), array('' => ts('- select -')) + $counties);
 459     }
 460
 461     // CRM-7296 freeze the select for state if address is shared with household
 462     // CRM-9070 freeze the select for state if it is view only
 463     if (isset($form->_fields) && !empty($form->_fields[$stateElementName]) &&
 464       (!empty($form->_fields[$stateElementName]['is_shared']) || !empty($form->_fields[$stateElementName]['is_view']))
 465     ) {
 466       $stateSelect->freeze();
 467     }
 468   }
 469
 470   /**
 471    * function to set default values for address block
 472    *
 473    * @param array  $defaults  defaults associated array
 474    * @param object $form     form object
 475    *
 476    * @static
 477    * @access public
 478    */
 479   static function setDefaultValues( &$defaults, &$form ) {
 480     $addressValues = array();
 481     if (isset($defaults['address']) && is_array($defaults['address']) &&
 482       !CRM_Utils_System::isNull($defaults['address'])
 483     ) {
 484
 485       // start of contact shared adddress defaults
 486       $sharedAddresses = array();
 487       $masterAddress = array();
 488
 489       // get contact name of shared contact names
 490       $shareAddressContactNames = CRM_Contact_BAO_Contact_Utils::getAddressShareContactNames($defaults['address']);
 491
 492       foreach ($defaults['address'] as $key => $addressValue) {
 493         if (!empty($addressValue['master_id']) && !$shareAddressContactNames[$addressValue['master_id']]['is_deleted']) {
 494           $sharedAddresses[$key]['shared_address_display'] = array(
 495             'address' => $addressValue['display'],
 496             'name' => $shareAddressContactNames[$addressValue['master_id']]['name'],
 497           );
 498         }
 499         else {
 500           $defaults['address'][$key]['use_shared_address'] = 0;
 501         }
 502
 503         //check if any address is shared by any other contacts
 504         $masterAddress[$key] = CRM_Core_BAO_Address::checkContactSharedAddress($addressValue['id']);
 505       }
 506
 507       $form->assign('sharedAddresses', $sharedAddresses);
 508       $form->assign('masterAddress', $masterAddress);
 509       // end of shared address defaults
 510
 511       // start of parse address functionality
 512       // build street address, CRM-5450.
 513       if ($form->_parseStreetAddress) {
 514         $parseFields = array('street_address', 'street_number', 'street_name', 'street_unit');
 515         foreach ($defaults['address'] as $cnt => & $address) {
 516           $streetAddress = NULL;
 517           foreach (array(
 518             'street_number', 'street_number_suffix', 'street_name', 'street_unit') as $fld) {
 519             if (in_array($fld, array(
 520               'street_name', 'street_unit'))) {
 521               $streetAddress .= ' ';
 522             }
 523             $streetAddress .= CRM_Utils_Array::value($fld, $address);
 524           }
 525           $streetAddress = trim($streetAddress);
 526           if (!empty($streetAddress)) {
 527             $address['street_address'] = $streetAddress;
 528           }
 529           if (isset($address['street_number'])) {
 530             $address['street_number'] .= CRM_Utils_Array::value('street_number_suffix', $address);
 531           }
 532
 533           // build array for set default.
 534           foreach ($parseFields as $field) {
 535             $addressValues["{$field}_{$cnt}"] = CRM_Utils_Array::value($field, $address);
 536           }
 537           // don't load fields, use js to populate.
 538           foreach (array('street_number', 'street_name', 'street_unit') as $f) {
 539             if (isset($address[$f])) {
 540               unset($address[$f]);
 541             }
 542           }
 543         }
 544         $form->assign('allAddressFieldValues', json_encode($addressValues));
 545
 546         //hack to handle show/hide address fields.
 547         $parsedAddress = array();
 548         if ($form->_contactId && !empty($_POST['address']) && is_array($_POST['address'])
 549         ) {
 550           foreach ($_POST['address'] as $cnt => $values) {
 551             $showField = 'streetAddress';
 552             foreach (array('street_number', 'street_name', 'street_unit') as $fld) {
 553               if (!empty($values[$fld])) {
 554                 $showField = 'addressElements';
 555                 break;
 556               }
 557             }
 558             $parsedAddress[$cnt] = $showField;
 559           }
 560         }
 561         $form->assign('showHideAddressFields', $parsedAddress);
 562         $form->assign('loadShowHideAddressFields', empty($parsedAddress) ? FALSE : TRUE);
 563       }
 564       // end of parse address functionality
 565     }
 566   }
 567
 568
 569   static function storeRequiredCustomDataInfo(&$form, $groupTree) {
 570     if (CRM_Utils_System::getClassName($form) == 'CRM_Contact_Form_Contact') {
 571       $requireOmission = NULL;
 572       foreach ($groupTree as $csId => $csVal) {
 573         // only process Address entity fields
 574         if ($csVal['extends'] != 'Address') {
 575           continue;
 576         }
 577
 578         foreach ($csVal['fields'] as $cdId => $cdVal) {
 579           if ($cdVal['is_required']) {
 580             $elementName = $cdVal['element_name'];
 581             if (in_array($elementName, $form->_required)) {
 582               // store the omitted rule for a element, to be used later on
 583               $requireOmission .= $cdVal['element_custom_name'] . ',';
 584             }
 585           }
 586         }
 587       }
 588
 589       $form->_addressRequireOmission = rtrim($requireOmission, ',');
 590     }
 591   }
 592 }