CRM/Contact/Form/Contact.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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 generates form components generic to all the contact types.
  38  *
  39  * It delegates the work to lower level subclasses and integrates the changes
  40  * back in. It also uses a lot of functionality with the CRM API's, so any change
  41  * made here could potentially affect the API etc. Be careful, be aware, use unit tests.
  42  *
  43  */
  44 class CRM_Contact_Form_Contact extends CRM_Core_Form {
  45
  46   /**
  47    * The contact type of the form
  48    *
  49    * @var string
  50    */
  51   public $_contactType;
  52
  53   /**
  54    * The contact type of the form
  55    *
  56    * @var string
  57    */
  58   public $_contactSubType;
  59
  60   /**
  61    * The contact id, used when editing the form
  62    *
  63    * @var int
  64    */
  65   public $_contactId;
  66
  67   /**
  68    * The default group id passed in via the url
  69    *
  70    * @var int
  71    */
  72   public $_gid;
  73
  74   /**
  75    * The default tag id passed in via the url
  76    *
  77    * @var int
  78    */
  79   public $_tid;
  80
  81   /**
  82    * Name of de-dupe button
  83    *
  84    * @var string
  85    */
  86   protected $_dedupeButtonName;
  87
  88   /**
  89    * Name of optional save duplicate button
  90    *
  91    * @var string
  92    */
  93   protected $_duplicateButtonName;
  94
  95   protected $_editOptions = array();
  96
  97   protected $_oldSubtypes = array();
  98
  99   public $_blocks;
 100
 101   public $_values = array();
 102
 103   public $_action;
 104
 105   public $_customValueCount;
 106   /**
 107    * The array of greetings with option group and filed names
 108    *
 109    * @var array
 110    */
 111   public $_greetings;
 112
 113   /**
 114    * Do we want to parse street address.
 115    */
 116   public $_parseStreetAddress;
 117
 118   /**
 119    * Check contact has a subtype or not
 120    */
 121   public $_isContactSubType;
 122
 123   /**
 124    * Lets keep a cache of all the values that we retrieved.
 125    * THis is an attempt to avoid the number of update statements
 126    * during the write phase
 127    */
 128   public $_preEditValues;
 129
 130   /**
 131    * Build all the data structures needed to build the form
 132    *
 133    * @return void
 134    */
 135   public function preProcess() {
 136     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'add');
 137
 138     $this->_dedupeButtonName = $this->getButtonName('refresh', 'dedupe');
 139     $this->_duplicateButtonName = $this->getButtonName('upload', 'duplicate');
 140
 141     $session = CRM_Core_Session::singleton();
 142     if ($this->_action == CRM_Core_Action::ADD) {
 143       // check for add contacts permissions
 144       if (!CRM_Core_Permission::check('add contacts')) {
 145         CRM_Utils_System::permissionDenied();
 146         CRM_Utils_System::civiExit();
 147       }
 148       $this->_contactType = CRM_Utils_Request::retrieve('ct', 'String',
 149         $this, TRUE, NULL, 'REQUEST'
 150       );
 151       if (!in_array($this->_contactType,
 152         array('Individual', 'Household', 'Organization')
 153       )
 154       ) {
 155         CRM_Core_Error::statusBounce(ts('Could not get a contact id and/or contact type'));
 156       }
 157
 158       $this->_isContactSubType = FALSE;
 159       if ($this->_contactSubType = CRM_Utils_Request::retrieve('cst', 'String', $this)) {
 160         $this->_isContactSubType = TRUE;
 161       }
 162
 163       if (
 164         $this->_contactSubType &&
 165         !(CRM_Contact_BAO_ContactType::isExtendsContactType($this->_contactSubType, $this->_contactType, TRUE))
 166       ) {
 167         CRM_Core_Error::statusBounce(ts("Could not get a valid contact subtype for contact type '%1'", array(1 => $this->_contactType)));
 168       }
 169
 170       $this->_gid = CRM_Utils_Request::retrieve('gid', 'Integer',
 171         CRM_Core_DAO::$_nullObject,
 172         FALSE, NULL, 'GET'
 173       );
 174       $this->_tid = CRM_Utils_Request::retrieve('tid', 'Integer',
 175         CRM_Core_DAO::$_nullObject,
 176         FALSE, NULL, 'GET'
 177       );
 178       $typeLabel = CRM_Contact_BAO_ContactType::contactTypePairs(TRUE, $this->_contactSubType ?
 179           $this->_contactSubType : $this->_contactType
 180       );
 181       $typeLabel = implode(' / ', $typeLabel);
 182
 183       CRM_Utils_System::setTitle(ts('New %1', array(1 => $typeLabel)));
 184       $session->pushUserContext(CRM_Utils_System::url('civicrm/dashboard', 'reset=1'));
 185       $this->_contactId = NULL;
 186     }
 187     else {
 188       //update mode
 189       if (!$this->_contactId) {
 190         $this->_contactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);
 191       }
 192
 193       if ($this->_contactId) {
 194         $defaults = array();
 195         $params = array('id' => $this->_contactId);
 196         $returnProperities = array('id', 'contact_type', 'contact_sub_type', 'modified_date');
 197         CRM_Core_DAO::commonRetrieve('CRM_Contact_DAO_Contact', $params, $defaults, $returnProperities);
 198
 199         if (empty($defaults['id'])) {
 200           CRM_Core_Error::statusBounce(ts('A Contact with that ID does not exist: %1', array(1 => $this->_contactId)));
 201         }
 202
 203         $this->_contactType = CRM_Utils_Array::value('contact_type', $defaults);
 204         $this->_contactSubType = CRM_Utils_Array::value('contact_sub_type', $defaults);
 205
 206         // check for permissions
 207         $session = CRM_Core_Session::singleton();
 208         if (!CRM_Contact_BAO_Contact_Permission::allow($this->_contactId, CRM_Core_Permission::EDIT)) {
 209           CRM_Core_Error::statusBounce(ts('You do not have the necessary permission to edit this contact.'));
 210         }
 211
 212         $displayName = CRM_Contact_BAO_Contact::displayName($this->_contactId);
 213         $displayName = ts('Edit %1', array(1 => $displayName));
 214
 215         // Check if this is default domain contact CRM-10482
 216         if (CRM_Contact_BAO_Contact::checkDomainContact($this->_contactId)) {
 217           $displayName .= ' (' . ts('default organization') . ')';
 218         }
 219
 220         // omitting contactImage from title for now since the summary overlay css doesn't work outside of our crm-container
 221         CRM_Utils_System::setTitle($displayName);
 222         $context = CRM_Utils_Request::retrieve('context', 'String', $this);
 223         $qfKey = CRM_Utils_Request::retrieve('key', 'String', $this);
 224
 225         $urlParams = 'reset=1&cid=' . $this->_contactId;
 226         if ($context) {
 227           $urlParams .= "&context=$context";
 228         }
 229
 230         if (CRM_Utils_Rule::qfKey($qfKey)) {
 231
 232           $urlParams .= "&key=$qfKey";
 233
 234         }
 235         $session->pushUserContext(CRM_Utils_System::url('civicrm/contact/view', $urlParams));
 236
 237         $values = $this->get('values');
 238         // get contact values.
 239         if (!empty($values)) {
 240           $this->_values = $values;
 241         }
 242         else {
 243           $params = array(
 244             'id' => $this->_contactId,
 245             'contact_id' => $this->_contactId,
 246             'noRelationships' => TRUE,
 247             'noNotes' => TRUE,
 248             'noGroups' => TRUE,
 249           );
 250
 251           $contact = CRM_Contact_BAO_Contact::retrieve($params, $this->_values, TRUE);
 252           $this->set('values', $this->_values);
 253         }
 254       }
 255       else {
 256         CRM_Core_Error::statusBounce(ts('Could not get a contact_id and/or contact_type'));
 257       }
 258     }
 259
 260     // parse street address, CRM-5450
 261     $this->_parseStreetAddress = $this->get('parseStreetAddress');
 262     if (!isset($this->_parseStreetAddress)) {
 263       $addressOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 264         'address_options'
 265       );
 266       $this->_parseStreetAddress = FALSE;
 267       if (!empty($addressOptions['street_address']) && !empty($addressOptions['street_address_parsing'])) {
 268         $this->_parseStreetAddress = TRUE;
 269       }
 270       $this->set('parseStreetAddress', $this->_parseStreetAddress);
 271     }
 272     $this->assign('parseStreetAddress', $this->_parseStreetAddress);
 273
 274     $this->_editOptions = $this->get('contactEditOptions');
 275     if (CRM_Utils_System::isNull($this->_editOptions)) {
 276       $this->_editOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 277         'contact_edit_options', TRUE, NULL,
 278         FALSE, 'name', TRUE, 'AND v.filter = 0'
 279       );
 280       $this->set('contactEditOptions', $this->_editOptions);
 281     }
 282
 283     // build demographics only for Individual contact type
 284     if ($this->_contactType != 'Individual' &&
 285       array_key_exists('Demographics', $this->_editOptions)
 286     ) {
 287       unset($this->_editOptions['Demographics']);
 288     }
 289
 290     // in update mode don't show notes
 291     if ($this->_contactId && array_key_exists('Notes', $this->_editOptions)) {
 292       unset($this->_editOptions['Notes']);
 293     }
 294
 295     $this->assign('editOptions', $this->_editOptions);
 296     $this->assign('contactType', $this->_contactType);
 297     $this->assign('contactSubType', $this->_contactSubType);
 298
 299     //build contact subtype form element, CRM-6864
 300     $buildContactSubType = TRUE;
 301     if ($this->_contactSubType && ($this->_action & CRM_Core_Action::ADD)) {
 302       $buildContactSubType = FALSE;
 303     }
 304     $this->assign('buildContactSubType', $buildContactSubType);
 305
 306     // get the location blocks.
 307     $this->_blocks = $this->get('blocks');
 308     if (CRM_Utils_System::isNull($this->_blocks)) {
 309       $this->_blocks = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 310         'contact_edit_options', TRUE, NULL,
 311         FALSE, 'name', TRUE, 'AND v.filter = 1'
 312       );
 313       $this->set('blocks', $this->_blocks);
 314     }
 315     $this->assign('blocks', $this->_blocks);
 316
 317     // this is needed for custom data.
 318     $this->assign('entityID', $this->_contactId);
 319
 320     // also keep the convention.
 321     $this->assign('contactId', $this->_contactId);
 322
 323     // location blocks.
 324     CRM_Contact_Form_Location::preProcess($this);
 325
 326     // retain the multiple count custom fields value
 327     if (!empty($_POST['hidden_custom'])) {
 328       $customGroupCount = CRM_Utils_Array::value('hidden_custom_group_count', $_POST);
 329
 330       if ($contactSubType = CRM_Utils_Array::value('contact_sub_type', $_POST)) {
 331         $paramSubType = implode(',', $contactSubType);
 332       }
 333
 334       $this->_getCachedTree = FALSE;
 335       unset($customGroupCount[0]);
 336       foreach ($customGroupCount as $groupID => $groupCount) {
 337         if ($groupCount > 1) {
 338           $this->set('groupID', $groupID);
 339           //loop the group
 340           for ($i = 0; $i <= $groupCount; $i++) {
 341             CRM_Custom_Form_CustomData::preProcess($this, NULL, $contactSubType,
 342               $i, $this->_contactType
 343             );
 344             CRM_Contact_Form_Edit_CustomData::buildQuickForm($this);
 345           }
 346         }
 347       }
 348
 349       //reset all the ajax stuff, for normal processing
 350       if (isset($this->_groupTree)) {
 351         $this->_groupTree = NULL;
 352       }
 353       $this->set('groupID', NULL);
 354       $this->_getCachedTree = TRUE;
 355     }
 356
 357     // execute preProcess dynamically by js else execute normal preProcess
 358     if (array_key_exists('CustomData', $this->_editOptions)) {
 359       //assign a parameter to pass for sub type multivalue
 360       //custom field to load
 361       if ($this->_contactSubType || isset($paramSubType)) {
 362         $paramSubType = (isset($paramSubType)) ? $paramSubType :
 363           str_replace(CRM_Core_DAO::VALUE_SEPARATOR, ',', trim($this->_contactSubType, CRM_Core_DAO::VALUE_SEPARATOR));
 364
 365         $this->assign('paramSubType', $paramSubType);
 366       }
 367
 368       if (CRM_Utils_Request::retrieve('type', 'String', CRM_Core_DAO::$_nullObject)) {
 369         CRM_Contact_Form_Edit_CustomData::preProcess($this);
 370       }
 371       else {
 372         $contactSubType = $this->_contactSubType;
 373         // need contact sub type to build related grouptree array during post process
 374         if (!empty($_POST['contact_sub_type'])) {
 375           $contactSubType = $_POST['contact_sub_type'];
 376         }
 377         //only custom data has preprocess hence directly call it
 378         CRM_Custom_Form_CustomData::preProcess($this, NULL, $contactSubType,
 379           1, $this->_contactType, $this->_contactId
 380         );
 381         $this->assign('customValueCount', $this->_customValueCount);
 382       }
 383     }
 384   }
 385
 386   /**
 387    * Set default values for the form. Note that in edit/view mode
 388    * the default values are retrieved from the database
 389    *
 390    *
 391    * @return void
 392    */
 393   public function setDefaultValues() {
 394     $defaults = $this->_values;
 395     $params = array();
 396
 397     if ($this->_action & CRM_Core_Action::ADD) {
 398       if (array_key_exists('TagsAndGroups', $this->_editOptions)) {
 399         // set group and tag defaults if any
 400         if ($this->_gid) {
 401           $defaults['group'][] = $this->_gid;
 402         }
 403         if ($this->_tid) {
 404           $defaults['tag'][$this->_tid] = 1;
 405         }
 406       }
 407       if ($this->_contactSubType) {
 408         $defaults['contact_sub_type'] = $this->_contactSubType;
 409       }
 410     }
 411     else {
 412       foreach ($defaults['email'] as $dontCare => & $val) {
 413         if (isset($val['signature_text'])) {
 414           $val['signature_text_hidden'] = $val['signature_text'];
 415         }
 416         if (isset($val['signature_html'])) {
 417           $val['signature_html_hidden'] = $val['signature_html'];
 418         }
 419       }
 420
 421       if (!empty($defaults['contact_sub_type'])) {
 422         $defaults['contact_sub_type'] = $this->_oldSubtypes;
 423       }
 424     }
 425     // set defaults for blocks ( custom data, address, communication preference, notes, tags and groups )
 426     foreach ($this->_editOptions as $name => $label) {
 427       if (!in_array($name, array('Address', 'Notes'))) {
 428         $className = 'CRM_Contact_Form_Edit_' . $name;
 429         $className::setDefaultValues($this, $defaults);
 430       }
 431     }
 432
 433     //set address block defaults
 434     CRM_Contact_Form_Edit_Address::setDefaultValues($defaults, $this);
 435
 436
 437     if (!empty($defaults['image_URL'])) {
 438       list($imageWidth, $imageHeight) = getimagesize(CRM_Utils_String::unstupifyUrl($defaults['image_URL']));
 439       list($imageThumbWidth, $imageThumbHeight) = CRM_Contact_BAO_Contact::getThumbSize($imageWidth, $imageHeight);
 440       $this->assign('imageWidth', $imageWidth);
 441       $this->assign('imageHeight', $imageHeight);
 442       $this->assign('imageThumbWidth', $imageThumbWidth);
 443       $this->assign('imageThumbHeight', $imageThumbHeight);
 444       $this->assign('imageURL', $defaults['image_URL']);
 445     }
 446
 447     //set location type and country to default for each block
 448     $this->blockSetDefaults($defaults);
 449
 450     $this->_preEditValues = $defaults;
 451     return $defaults;
 452   }
 453
 454   /**
 455    * Do the set default related to location type id,
 456    * primary location,  default country
 457    */
 458   public function blockSetDefaults(&$defaults) {
 459     $locationTypeKeys = array_filter(array_keys(CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id')), 'is_int');
 460     sort($locationTypeKeys);
 461
 462     // get the default location type
 463     $locationType = CRM_Core_BAO_LocationType::getDefault();
 464
 465     // unset primary location type
 466     $primaryLocationTypeIdKey = CRM_Utils_Array::key($locationType->id, $locationTypeKeys);
 467     unset($locationTypeKeys[$primaryLocationTypeIdKey]);
 468
 469     // reset the array sequence
 470     $locationTypeKeys = array_values($locationTypeKeys);
 471
 472     // get default phone and im provider id.
 473     $defPhoneTypeId = key(CRM_Core_OptionGroup::values('phone_type', FALSE, FALSE, FALSE, ' AND is_default = 1'));
 474     $defIMProviderId = key(CRM_Core_OptionGroup::values('instant_messenger_service',
 475       FALSE, FALSE, FALSE, ' AND is_default = 1'
 476     ));
 477     $defWebsiteTypeId = key(CRM_Core_OptionGroup::values('website_type',
 478       FALSE, FALSE, FALSE, ' AND is_default = 1'
 479     ));
 480
 481     $allBlocks = $this->_blocks;
 482     if (array_key_exists('Address', $this->_editOptions)) {
 483       $allBlocks['Address'] = $this->_editOptions['Address'];
 484     }
 485
 486     $config = CRM_Core_Config::singleton();
 487     foreach ($allBlocks as $blockName => $label) {
 488       $name = strtolower($blockName);
 489       $hasPrimary = $updateMode = FALSE;
 490
 491       // user is in update mode.
 492       if (array_key_exists($name, $defaults) &&
 493         !CRM_Utils_System::isNull($defaults[$name])
 494       ) {
 495         $updateMode = TRUE;
 496       }
 497
 498       for ($instance = 1; $instance <= $this->get($blockName . '_Block_Count'); $instance++) {
 499         // make we require one primary block, CRM-5505
 500         if ($updateMode) {
 501           if (!$hasPrimary) {
 502             $hasPrimary =
 503               CRM_Utils_Array::value(
 504                 'is_primary',
 505                 CRM_Utils_Array::value($instance, $defaults[$name])
 506               );
 507           }
 508           continue;
 509         }
 510
 511         //set location to primary for first one.
 512         if ($instance == 1) {
 513           $hasPrimary = TRUE;
 514           $defaults[$name][$instance]['is_primary'] = TRUE;
 515           $defaults[$name][$instance]['location_type_id'] = $locationType->id;
 516         }
 517         else {
 518           $locTypeId = isset($locationTypeKeys[$instance - 1]) ? $locationTypeKeys[$instance - 1] : $locationType->id;
 519           $defaults[$name][$instance]['location_type_id'] = $locTypeId;
 520         }
 521
 522         //set default country
 523         if ($name == 'address' && $config->defaultContactCountry) {
 524           $defaults[$name][$instance]['country_id'] = $config->defaultContactCountry;
 525         }
 526
 527         //set default state/province
 528         if ($name == 'address' && $config->defaultContactStateProvince) {
 529           $defaults[$name][$instance]['state_province_id'] = $config->defaultContactStateProvince;
 530         }
 531
 532         //set default phone type.
 533         if ($name == 'phone' && $defPhoneTypeId) {
 534           $defaults[$name][$instance]['phone_type_id'] = $defPhoneTypeId;
 535         }
 536         //set default website type.
 537         if ($name == 'website' && $defWebsiteTypeId) {
 538           $defaults[$name][$instance]['website_type_id'] = $defWebsiteTypeId;
 539         }
 540
 541         //set default im provider.
 542         if ($name == 'im' && $defIMProviderId) {
 543           $defaults[$name][$instance]['provider_id'] = $defIMProviderId;
 544         }
 545       }
 546
 547       if (!$hasPrimary) {
 548         $defaults[$name][1]['is_primary'] = TRUE;
 549       }
 550     }
 551   }
 552
 553   /**
 554    * add the rules (mainly global rules) for form.
 555    * All local rules are added near the element
 556    *
 557    * @return void
 558    * @see valid_date
 559    */
 560   public function addRules() {
 561     // skip adding formRules when custom data is build
 562     if ($this->_addBlockName || ($this->_action & CRM_Core_Action::DELETE)) {
 563       return;
 564     }
 565
 566     $this->addFormRule(array('CRM_Contact_Form_Edit_' . $this->_contactType, 'formRule'), $this->_contactId);
 567
 568     // Call Locking check if editing existing contact
 569     if ($this->_contactId) {
 570       $this->addFormRule(array('CRM_Contact_Form_Edit_Lock', 'formRule'), $this->_contactId);
 571     }
 572
 573     if (array_key_exists('Address', $this->_editOptions)) {
 574       $this->addFormRule(array('CRM_Contact_Form_Edit_Address', 'formRule'), $this);
 575     }
 576
 577     if (array_key_exists('CommunicationPreferences', $this->_editOptions)) {
 578       $this->addFormRule(array('CRM_Contact_Form_Edit_CommunicationPreferences', 'formRule'), $this);
 579     }
 580   }
 581
 582   /**
 583    * Global validation rules for the form
 584    *
 585    * @param array $fields
 586    *   Posted values of the form.
 587    * @param array $errors
 588    *   List of errors to be posted back to the form.
 589    * @param int $contactId
 590    *   Contact id if doing update.
 591    *
 592    * @return bool
 593    *   email/openId
 594    * @static
 595    */
 596   public static function formRule($fields, &$errors, $contactId = NULL) {
 597     $config = CRM_Core_Config::singleton();
 598
 599     // validations.
 600     //1. for each block only single value can be marked as is_primary = true.
 601     //2. location type id should be present if block data present.
 602     //3. check open id across db and other each block for duplicate.
 603     //4. at least one location should be primary.
 604     //5. also get primaryID from email or open id block.
 605
 606     // take the location blocks.
 607     $blocks = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 608       'contact_edit_options', TRUE, NULL,
 609       FALSE, 'name', TRUE, 'AND v.filter = 1'
 610     );
 611
 612     $otherEditOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 613       'contact_edit_options', TRUE, NULL,
 614       FALSE, 'name', TRUE, 'AND v.filter = 0'
 615     );
 616     //get address block inside.
 617     if (array_key_exists('Address', $otherEditOptions)) {
 618       $blocks['Address'] = $otherEditOptions['Address'];
 619     }
 620
 621     $openIds = array();
 622     $primaryID = FALSE;
 623     foreach ($blocks as $name => $label) {
 624       $hasData = $hasPrimary = array();
 625       $name = strtolower($name);
 626       if (!empty($fields[$name]) && is_array($fields[$name])) {
 627         foreach ($fields[$name] as $instance => $blockValues) {
 628           $dataExists = self::blockDataExists($blockValues);
 629
 630           if (!$dataExists && $name == 'address') {
 631             $dataExists = CRM_Utils_Array::value('use_shared_address', $fields['address'][$instance]);
 632           }
 633
 634           if ($dataExists) {
 635             // skip remaining checks for website
 636             if ($name == 'website') {
 637               continue;
 638             }
 639
 640             $hasData[] = $instance;
 641             if (!empty($blockValues['is_primary'])) {
 642               $hasPrimary[] = $instance;
 643               if (!$primaryID &&
 644                 in_array($name, array(
 645                   'email',
 646                   'openid'
 647                 )) && !empty($blockValues[$name])
 648               ) {
 649                 $primaryID = $blockValues[$name];
 650               }
 651             }
 652
 653             if (empty($blockValues['location_type_id'])) {
 654               $errors["{$name}[$instance][location_type_id]"] = ts('The Location Type should be set if there is  %1 information.', array(1 => $label));
 655             }
 656           }
 657
 658           if ($name == 'openid' && !empty($blockValues[$name])) {
 659             $oid = new CRM_Core_DAO_OpenID();
 660             $oid->openid = $openIds[$instance] = CRM_Utils_Array::value($name, $blockValues);
 661             $cid = isset($contactId) ? $contactId : 0;
 662             if ($oid->find(TRUE) && ($oid->contact_id != $cid)) {
 663               $errors["{$name}[$instance][openid]"] = ts('%1 already exist.', array(1 => $blocks['OpenID']));
 664             }
 665           }
 666         }
 667
 668         if (empty($hasPrimary) && !empty($hasData)) {
 669           $errors["{$name}[1][is_primary]"] = ts('One %1 should be marked as primary.', array(1 => $label));
 670         }
 671
 672         if (count($hasPrimary) > 1) {
 673           $errors["{$name}[" . array_pop($hasPrimary) . "][is_primary]"] = ts('Only one %1 can be marked as primary.',
 674             array(1 => $label)
 675           );
 676         }
 677       }
 678     }
 679
 680     //do validations for all opend ids they should be distinct.
 681     if (!empty($openIds) && (count(array_unique($openIds)) != count($openIds))) {
 682       foreach ($openIds as $instance => $value) {
 683         if (!array_key_exists($instance, array_unique($openIds))) {
 684           $errors["openid[$instance][openid]"] = ts('%1 already used.', array(1 => $blocks['OpenID']));
 685         }
 686       }
 687     }
 688
 689     // street number should be digit + suffix, CRM-5450
 690     $parseStreetAddress = CRM_Utils_Array::value('street_address_parsing',
 691       CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 692         'address_options'
 693       )
 694     );
 695     if ($parseStreetAddress) {
 696       if (isset($fields['address']) &&
 697         is_array($fields['address'])
 698       ) {
 699         $invalidStreetNumbers = array();
 700         foreach ($fields['address'] as $cnt => $address) {
 701           if ($streetNumber = CRM_Utils_Array::value('street_number', $address)) {
 702             $parsedAddress = CRM_Core_BAO_Address::parseStreetAddress($address['street_number']);
 703             if (empty($parsedAddress['street_number'])) {
 704               $invalidStreetNumbers[] = $cnt;
 705             }
 706           }
 707         }
 708
 709         if (!empty($invalidStreetNumbers)) {
 710           $first = $invalidStreetNumbers[0];
 711           foreach ($invalidStreetNumbers as & $num) {
 712             $num = CRM_Contact_Form_Contact::ordinalNumber($num);
 713           }
 714           $errors["address[$first][street_number]"] = ts('The street number you entered for the %1 address block(s) is not in an expected format. Street numbers may include numeric digit(s) followed by other characters. You can still enter the complete street address (unparsed) by clicking "Edit Complete Street Address".', array(1 => implode(', ', $invalidStreetNumbers)));
 715         }
 716       }
 717     }
 718
 719     return $primaryID;
 720   }
 721
 722   /**
 723    * Build the form object
 724    *
 725    * @return void
 726    */
 727   public function buildQuickForm() {
 728     //load form for child blocks
 729     if ($this->_addBlockName) {
 730       $className = 'CRM_Contact_Form_Edit_' . $this->_addBlockName;
 731       return $className::buildQuickForm($this);
 732     }
 733
 734     if ($this->_action == CRM_Core_Action::UPDATE) {
 735       $deleteExtra = ts('Are you sure you want to delete contact image.');
 736       $deleteURL = array(
 737         CRM_Core_Action::DELETE =>
 738           array(
 739             'name' => ts('Delete Contact Image'),
 740             'url' => 'civicrm/contact/image',
 741             'qs' => 'reset=1&cid=%%id%%&action=delete',
 742             'extra' =>
 743               'onclick = "if (confirm( \'' . $deleteExtra . '\' ) ) this.href+=\'&amp;confirmed=1\'; else return false;"',
 744           ),
 745       );
 746       $deleteURL = CRM_Core_Action::formLink($deleteURL,
 747         CRM_Core_Action::DELETE,
 748         array(
 749           'id' => $this->_contactId,
 750         ),
 751         ts('more'),
 752         FALSE,
 753         'contact.image.delete',
 754         'Contact',
 755         $this->_contactId
 756       );
 757       $this->assign('deleteURL', $deleteURL);
 758     }
 759
 760     //build contact type specific fields
 761     $className = 'CRM_Contact_Form_Edit_' . $this->_contactType;
 762     $className::buildQuickForm($this);
 763
 764     // build Custom data if Custom data present in edit option
 765     $buildCustomData = 'noCustomDataPresent';
 766     if (array_key_exists('CustomData', $this->_editOptions)) {
 767       $buildCustomData = "customDataPresent";
 768     }
 769
 770     // subtype is a common field. lets keep it here
 771     $subtypes = CRM_Contact_BAO_Contact::buildOptions('contact_sub_type', 'create', array('contact_type' => $this->_contactType));
 772     if (!empty($subtypes)) {
 773       $sel = $this->add('select', 'contact_sub_type', ts('Contact Type'),
 774         $subtypes, FALSE,
 775         array(
 776           'id' => 'contact_sub_type',
 777           'multiple' => 'multiple',
 778           'class' => $buildCustomData . ' crm-select2',
 779         )
 780       );
 781     }
 782
 783     // build edit blocks ( custom data, demographics, communication preference, notes, tags and groups )
 784     foreach ($this->_editOptions as $name => $label) {
 785       if ($name == 'Address') {
 786         $this->_blocks['Address'] = $this->_editOptions['Address'];
 787         continue;
 788       }
 789       if ($name == 'TagsAndGroups') {
 790         continue;
 791       }
 792       $className = 'CRM_Contact_Form_Edit_' . $name;
 793       $className::buildQuickForm($this);
 794     }
 795
 796     // build tags and groups
 797     CRM_Contact_Form_Edit_TagsAndGroups::buildQuickForm($this, 0, CRM_Contact_Form_Edit_TagsAndGroups::ALL,
 798       FALSE, NULL, 'Group(s)', 'Tag(s)', NULL, 'select');
 799
 800     // build location blocks.
 801     CRM_Contact_Form_Edit_Lock::buildQuickForm($this);
 802     CRM_Contact_Form_Location::buildQuickForm($this);
 803
 804     // add attachment
 805     $this->addElement('file', 'image_URL', ts('Browse/Upload Image'), 'size=30 maxlength=60');
 806     $this->addUploadElement('image_URL');
 807
 808     // add the dedupe button
 809     $this->addElement('submit',
 810       $this->_dedupeButtonName,
 811       ts('Check for Matching Contact(s)')
 812     );
 813     $this->addElement('submit',
 814       $this->_duplicateButtonName,
 815       ts('Save Matching Contact')
 816     );
 817     $this->addElement('submit',
 818       $this->getButtonName('next', 'sharedHouseholdDuplicate'),
 819       ts('Save With Duplicate Household')
 820     );
 821
 822     $buttons = array(
 823       array(
 824         'type' => 'upload',
 825         'name' => ts('Save'),
 826         'subName' => 'view',
 827         'isDefault' => TRUE,
 828       ),
 829     );
 830     if (CRM_Core_Permission::check('add contacts')) {
 831       $buttons[] = array(
 832         'type' => 'upload',
 833         'name' => ts('Save and New'),
 834         'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 835         'subName' => 'new',
 836       );
 837     }
 838     $buttons[] = array(
 839       'type' => 'cancel',
 840       'name' => ts('Cancel'),
 841     );
 842
 843     if (!empty($this->_values['contact_sub_type'])) {
 844       $this->_oldSubtypes = explode(CRM_Core_DAO::VALUE_SEPARATOR,
 845         trim($this->_values['contact_sub_type'], CRM_Core_DAO::VALUE_SEPARATOR)
 846       );
 847     }
 848     $this->assign('oldSubtypes', json_encode($this->_oldSubtypes));
 849
 850     $this->addButtons($buttons);
 851   }
 852
 853   /**
 854    * Form submission of new/edit contact is processed.
 855    *
 856    *
 857    * @return void
 858    */
 859   public function postProcess() {
 860     // check if dedupe button, if so return.
 861     $buttonName = $this->controller->getButtonName();
 862     if ($buttonName == $this->_dedupeButtonName) {
 863       return;
 864     }
 865
 866     //get the submitted values in an array
 867     $params = $this->controller->exportValues($this->_name);
 868
 869     $group = CRM_Utils_Array::value('group', $params);
 870     if ($group && is_array($group)) {
 871       unset($params['group']);
 872       foreach ($group as $key => $value) {
 873         $params['group'][$value] = 1;
 874       }
 875     }
 876
 877     CRM_Contact_BAO_Contact_Optimizer::edit($params, $this->_preEditValues);
 878
 879     if (!empty($params['image_URL'])) {
 880       CRM_Contact_BAO_Contact::processImageParams($params);
 881     }
 882
 883     if (is_numeric(CRM_Utils_Array::value('current_employer_id', $params)) && !empty($params['current_employer'])) {
 884       $params['current_employer'] = $params['current_employer_id'];
 885     }
 886
 887     // don't carry current_employer_id field,
 888     // since we don't want to directly update DAO object without
 889     // handling related business logic ( eg related membership )
 890     if (isset($params['current_employer_id'])) {
 891       unset($params['current_employer_id']);
 892     }
 893
 894     $params['contact_type'] = $this->_contactType;
 895     if (empty($params['contact_sub_type']) && $this->_isContactSubType) {
 896       $params['contact_sub_type'] = array($this->_contactSubType);
 897     }
 898
 899     if ($this->_contactId) {
 900       $params['contact_id'] = $this->_contactId;
 901     }
 902
 903     //make deceased date null when is_deceased = false
 904     if ($this->_contactType == 'Individual' && !empty($this->_editOptions['Demographics']) && empty($params['is_deceased'])) {
 905       $params['is_deceased'] = FALSE;
 906       $params['deceased_date'] = NULL;
 907     }
 908
 909     if (isset($params['contact_id'])) {
 910       // process membership status for deceased contact
 911       $deceasedParams = array(
 912         'contact_id' => CRM_Utils_Array::value('contact_id', $params),
 913         'is_deceased' => CRM_Utils_Array::value('is_deceased', $params, FALSE),
 914         'deceased_date' => CRM_Utils_Array::value('deceased_date', $params, NULL),
 915       );
 916       $updateMembershipMsg = $this->updateMembershipStatus($deceasedParams);
 917     }
 918
 919     // action is taken depending upon the mode
 920     if ($this->_action & CRM_Core_Action::UPDATE) {
 921       CRM_Utils_Hook::pre('edit', $params['contact_type'], $params['contact_id'], $params);
 922     }
 923     else {
 924       CRM_Utils_Hook::pre('create', $params['contact_type'], NULL, $params);
 925     }
 926
 927     $customFields = CRM_Core_BAO_CustomField::getFields($params['contact_type'], FALSE, TRUE);
 928
 929     //CRM-5143
 930     //if subtype is set, send subtype as extend to validate subtype customfield
 931     $customFieldExtends = (CRM_Utils_Array::value('contact_sub_type', $params)) ? $params['contact_sub_type'] : $params['contact_type'];
 932
 933     $params['custom'] = CRM_Core_BAO_CustomField::postProcess($params,
 934       $customFields,
 935       $this->_contactId,
 936       $customFieldExtends,
 937       TRUE
 938     );
 939     if ($this->_contactId && !empty($this->_oldSubtypes)) {
 940       CRM_Contact_BAO_ContactType::deleteCustomSetForSubtypeMigration($this->_contactId,
 941         $params['contact_type'],
 942         $this->_oldSubtypes,
 943         $params['contact_sub_type']
 944       );
 945     }
 946
 947     if (array_key_exists('CommunicationPreferences', $this->_editOptions)) {
 948       // this is a chekbox, so mark false if we dont get a POST value
 949       $params['is_opt_out'] = CRM_Utils_Array::value('is_opt_out', $params, FALSE);
 950     }
 951
 952     // process shared contact address.
 953     CRM_Contact_BAO_Contact_Utils::processSharedAddress($params['address']);
 954
 955     if (!array_key_exists('TagsAndGroups', $this->_editOptions)) {
 956       unset($params['group']);
 957     }
 958
 959     if (!empty($params['contact_id']) && ($this->_action & CRM_Core_Action::UPDATE)) {
 960       // figure out which all groups are intended to be removed
 961       $contactGroupList = CRM_Contact_BAO_GroupContact::getContactGroup($params['contact_id'], 'Added');
 962       if (is_array($contactGroupList)) {
 963         foreach ($contactGroupList as $key) {
 964           if ((!array_key_exists($key['group_id'], $params['group']) || $params['group'][$key['group_id']] != 1) && empty($key['is_hidden'])) {
 965             $params['group'][$key['group_id']] = -1;
 966           }
 967         }
 968       }
 969     }
 970
 971     // parse street address, CRM-5450
 972     $parseStatusMsg = NULL;
 973     if ($this->_parseStreetAddress) {
 974       $parseResult = self::parseAddress($params);
 975       $parseStatusMsg = self::parseAddressStatusMsg($parseResult);
 976     }
 977
 978     // Allow un-setting of location info, CRM-5969
 979     $params['updateBlankLocInfo'] = TRUE;
 980
 981     $contact = CRM_Contact_BAO_Contact::create($params, TRUE, FALSE, TRUE);
 982
 983     // status message
 984     if ($this->_contactId) {
 985       $message = ts('%1 has been updated.', array(1 => $contact->display_name));
 986     }
 987     else {
 988       $message = ts('%1 has been created.', array(1 => $contact->display_name));
 989     }
 990
 991     // set the contact ID
 992     $this->_contactId = $contact->id;
 993
 994     if (array_key_exists('TagsAndGroups', $this->_editOptions)) {
 995       //add contact to tags
 996       CRM_Core_BAO_EntityTag::create($params['tag'], 'civicrm_contact', $params['contact_id']);
 997
 998       //save free tags
 999       if (isset($params['contact_taglist']) && !empty($params['contact_taglist'])) {
1000         CRM_Core_Form_Tag::postProcess($params['contact_taglist'], $params['contact_id'], 'civicrm_contact', $this);
1001       }
1002     }
1003
1004     if (!empty($parseStatusMsg)) {
1005       $message .= "<br />$parseStatusMsg";
1006     }
1007     if (!empty($updateMembershipMsg)) {
1008       $message .= "<br />$updateMembershipMsg";
1009     }
1010
1011     $session = CRM_Core_Session::singleton();
1012     $session->setStatus($message, ts('Contact Saved'), 'success');
1013
1014     // add the recently viewed contact
1015     $recentOther = array();
1016     if (($session->get('userID') == $contact->id) ||
1017       CRM_Contact_BAO_Contact_Permission::allow($contact->id, CRM_Core_Permission::EDIT)
1018     ) {
1019       $recentOther['editUrl'] = CRM_Utils_System::url('civicrm/contact/add', 'reset=1&action=update&cid=' . $contact->id);
1020     }
1021
1022     if (($session->get('userID') != $this->_contactId) && CRM_Core_Permission::check('delete contacts')) {
1023       $recentOther['deleteUrl'] = CRM_Utils_System::url('civicrm/contact/view/delete', 'reset=1&delete=1&cid=' . $contact->id);
1024     }
1025
1026     CRM_Utils_Recent::add($contact->display_name,
1027       CRM_Utils_System::url('civicrm/contact/view', 'reset=1&cid=' . $contact->id),
1028       $contact->id,
1029       $this->_contactType,
1030       $contact->id,
1031       $contact->display_name,
1032       $recentOther
1033     );
1034
1035     // here we replace the user context with the url to view this contact
1036     $buttonName = $this->controller->getButtonName();
1037     if ($buttonName == $this->getButtonName('upload', 'new')) {
1038       $resetStr = "reset=1&ct={$contact->contact_type}";
1039       $resetStr .= $this->_contactSubType ? "&cst={$this->_contactSubType}" : '';
1040       $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/add', $resetStr));
1041     }
1042     else {
1043       $context = CRM_Utils_Request::retrieve('context', 'String', $this);
1044       $qfKey = CRM_Utils_Request::retrieve('key', 'String', $this);
1045       //validate the qfKey
1046       $urlParams = 'reset=1&cid=' . $contact->id;
1047       if ($context) {
1048         $urlParams .= "&context=$context";
1049       }
1050       if (CRM_Utils_Rule::qfKey($qfKey)) {
1051         $urlParams .= "&key=$qfKey";
1052       }
1053
1054       $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view', $urlParams));
1055     }
1056
1057     // now invoke the post hook
1058     if ($this->_action & CRM_Core_Action::UPDATE) {
1059       CRM_Utils_Hook::post('edit', $params['contact_type'], $contact->id, $contact);
1060     }
1061     else {
1062       CRM_Utils_Hook::post('create', $params['contact_type'], $contact->id, $contact);
1063     }
1064   }
1065
1066   /**
1067    * Is there any real significant data in the hierarchical location array
1068    *
1069    * @param array $fields
1070    *   The hierarchical value representation of this location.
1071    *
1072    * @return boolean
1073    *   true if data exists, false otherwise
1074    * @static
1075    */
1076   public static function blockDataExists(&$fields) {
1077     if (!is_array($fields)) {
1078       return FALSE;
1079     }
1080
1081     static $skipFields = array(
1082       'location_type_id',
1083       'is_primary',
1084       'phone_type_id',
1085       'provider_id',
1086       'country_id',
1087       'website_type_id',
1088       'master_id'
1089     );
1090     foreach ($fields as $name => $value) {
1091       $skipField = FALSE;
1092       foreach ($skipFields as $skip) {
1093         if (strpos("[$skip]", $name) !== FALSE) {
1094           if ($name == 'phone') {
1095             continue;
1096           }
1097           $skipField = TRUE;
1098           break;
1099         }
1100       }
1101       if ($skipField) {
1102         continue;
1103       }
1104       if (is_array($value)) {
1105         if (self::blockDataExists($value)) {
1106           return TRUE;
1107         }
1108       }
1109       else {
1110         if (!empty($value)) {
1111           return TRUE;
1112         }
1113       }
1114     }
1115
1116     return FALSE;
1117   }
1118
1119   /**
1120    * That checks for duplicate contacts
1121    *
1122    * @param array $fields
1123    *   Fields array which are submitted.
1124    * @param $errors
1125    * @param int $contactID
1126    *   Contact id.
1127    * @param string $contactType
1128    *   Contact type.
1129    */
1130   public static function checkDuplicateContacts(&$fields, &$errors, $contactID, $contactType) {
1131     // if this is a forced save, ignore find duplicate rule
1132     if (empty($fields['_qf_Contact_upload_duplicate'])) {
1133
1134       $dedupeParams = CRM_Dedupe_Finder::formatParams($fields, $contactType);
1135       $ids = CRM_Dedupe_Finder::dupesByParams($dedupeParams, $contactType, 'Supervised', array($contactID));
1136       if ($ids) {
1137
1138         $contactLinks = CRM_Contact_BAO_Contact_Utils::formatContactIDSToLinks($ids, TRUE, TRUE, $contactID);
1139
1140         $duplicateContactsLinks = '<div class="matching-contacts-found">';
1141         $duplicateContactsLinks .= ts('One matching contact was found. ', array(
1142             'count' => count($contactLinks['rows']),
1143             'plural' => '%count matching contacts were found.<br />'
1144           ));
1145         if ($contactLinks['msg'] == 'view') {
1146           $duplicateContactsLinks .= ts('You can View the existing contact', array(
1147               'count' => count($contactLinks['rows']),
1148               'plural' => 'You can View the existing contacts'
1149             ));
1150         }
1151         else {
1152           $duplicateContactsLinks .= ts('You can View or Edit the existing contact', array(
1153               'count' => count($contactLinks['rows']),
1154               'plural' => 'You can View or Edit the existing contacts'
1155             ));
1156         }
1157         if ($contactLinks['msg'] == 'merge') {
1158           // We should also get a merge link if this is for an existing contact
1159           $duplicateContactsLinks .= ts(', or Merge this contact with an existing contact');
1160         }
1161         $duplicateContactsLinks .= '.';
1162         $duplicateContactsLinks .= '</div>';
1163         $duplicateContactsLinks .= '<table class="matching-contacts-actions">';
1164         $row = '';
1165         for ($i = 0; $i < count($contactLinks['rows']); $i++) {
1166           $row .= '  <tr>   ';
1167           $row .= '    <td class="matching-contacts-name"> ';
1168           $row .= $contactLinks['rows'][$i]['display_name'];
1169           $row .= '    </td>';
1170           $row .= '    <td class="matching-contacts-email"> ';
1171           $row .= $contactLinks['rows'][$i]['primary_email'];
1172           $row .= '    </td>';
1173           $row .= '    <td class="action-items"> ';
1174           $row .= $contactLinks['rows'][$i]['view'];
1175           $row .= $contactLinks['rows'][$i]['edit'];
1176           $row .= CRM_Utils_Array::value('merge', $contactLinks['rows'][$i]);
1177           $row .= '    </td>';
1178           $row .= '  </tr>   ';
1179         }
1180
1181         $duplicateContactsLinks .= $row . '</table>';
1182         $duplicateContactsLinks .= ts("If you're sure this record is not a duplicate, click the 'Save Matching Contact' button below.");
1183
1184         $errors['_qf_default'] = $duplicateContactsLinks;
1185
1186
1187         // let smarty know that there are duplicates
1188         $template = CRM_Core_Smarty::singleton();
1189         $template->assign('isDuplicate', 1);
1190       }
1191       elseif (!empty($fields['_qf_Contact_refresh_dedupe'])) {
1192         // add a session message for no matching contacts
1193         CRM_Core_Session::setStatus(ts('No matching contact found.'), ts('None Found'), 'info');
1194       }
1195     }
1196   }
1197
1198   /**
1199    * Use the form name to create the tpl file name
1200    *
1201    * @return string
1202    */
1203   public function getTemplateFileName() {
1204     if ($this->_contactSubType) {
1205       $templateFile = "CRM/Contact/Form/Edit/SubType/{$this->_contactSubType}.tpl";
1206       $template = CRM_Core_Form::getTemplate();
1207       if ($template->template_exists($templateFile)) {
1208         return $templateFile;
1209       }
1210     }
1211     return parent::getTemplateFileName();
1212   }
1213
1214   /**
1215    * Parse all address blocks present in given params
1216    * and return parse result for all address blocks,
1217    * This function either parse street address in to child
1218    * elements or build street address from child elements.
1219    *
1220    * @param array $params
1221    *   of key value consist of address blocks.
1222    *
1223    * @return array
1224    *   as array of sucess/fails for each address block
1225    * @static
1226    */
1227   public function parseAddress(&$params) {
1228     $parseSuccess = $parsedFields = array();
1229     if (!is_array($params['address']) ||
1230       CRM_Utils_System::isNull($params['address'])
1231     ) {
1232       return $parseSuccess;
1233     }
1234
1235     foreach ($params['address'] as $instance => & $address) {
1236       $buildStreetAddress = FALSE;
1237       $parseFieldName = 'street_address';
1238       foreach (array(
1239                  'street_number',
1240                  'street_name',
1241                  'street_unit'
1242                ) as $fld) {
1243         if (!empty($address[$fld])) {
1244           $parseFieldName = 'street_number';
1245           $buildStreetAddress = TRUE;
1246           break;
1247         }
1248       }
1249
1250       // main parse string.
1251       $parseString = CRM_Utils_Array::value($parseFieldName, $address);
1252
1253       // parse address field.
1254       $parsedFields = CRM_Core_BAO_Address::parseStreetAddress($parseString);
1255
1256       if ($buildStreetAddress) {
1257         //hack to ignore spaces between number and suffix.
1258         //here user gives input as street_number so it has to
1259         //be street_number and street_number_suffix, but
1260         //due to spaces though preg detect string as street_name
1261         //consider it as 'street_number_suffix'.
1262         $suffix = $parsedFields['street_number_suffix'];
1263         if (!$suffix) {
1264           $suffix = $parsedFields['street_name'];
1265         }
1266         $address['street_number_suffix'] = $suffix;
1267         $address['street_number'] = $parsedFields['street_number'];
1268
1269         $streetAddress = NULL;
1270         foreach (array(
1271                    'street_number',
1272                    'street_number_suffix',
1273                    'street_name',
1274                    'street_unit'
1275                  ) as $fld) {
1276           if (in_array($fld, array(
1277             'street_name',
1278             'street_unit'
1279           ))) {
1280             $streetAddress .= ' ';
1281           }
1282           $streetAddress .= CRM_Utils_Array::value($fld, $address);
1283         }
1284         $address['street_address'] = trim($streetAddress);
1285         $parseSuccess[$instance] = TRUE;
1286       }
1287       else {
1288         $success = TRUE;
1289         // consider address is automatically parseable,
1290         // when we should found street_number and street_name
1291         if (empty($parsedFields['street_name']) || empty($parsedFields['street_number'])) {
1292           $success = FALSE;
1293         }
1294
1295         // check for original street address string.
1296         if (empty($parseString)) {
1297           $success = TRUE;
1298         }
1299
1300         $parseSuccess[$instance] = $success;
1301
1302         // we do not reset element values, but keep what we've parsed
1303         // in case of partial matches: CRM-8378
1304
1305         // merge parse address in to main address block.
1306         $address = array_merge($address, $parsedFields);
1307       }
1308     }
1309
1310     return $parseSuccess;
1311   }
1312
1313   /**
1314    * Check parse result and if some address block fails then this
1315    * function return the status message for all address blocks.
1316    *
1317    * @param array $parseResult
1318    *   An array of address blk instance and its status.
1319    *
1320    * @return null|string
1321    *   $statusMsg   string status message for all address blocks.
1322    * @static
1323    */
1324   public static function parseAddressStatusMsg($parseResult) {
1325     $statusMsg = NULL;
1326     if (!is_array($parseResult) || empty($parseResult)) {
1327       return $statusMsg;
1328     }
1329
1330     $parseFails = array();
1331     foreach ($parseResult as $instance => $success) {
1332       if (!$success) {
1333         $parseFails[] = self::ordinalNumber($instance);
1334       }
1335     }
1336
1337     if (!empty($parseFails)) {
1338       $statusMsg = ts("Complete street address(es) have been saved. However we were unable to split the address in the %1 address block(s) into address elements (street number, street name, street unit) due to an unrecognized address format. You can set the address elements manually by clicking 'Edit Address Elements' next to the Street Address field while in edit mode.",
1339         array(1 => implode(', ', $parseFails))
1340       );
1341     }
1342
1343     return $statusMsg;
1344   }
1345
1346   /**
1347    * Convert normal number to ordinal number format.
1348    * like 1 => 1st, 2 => 2nd and so on...
1349    *
1350    * @param int $number
1351    *   number to convert in to ordinal number.
1352    *
1353    * @return string
1354    *   ordinal number for given number.
1355    * @static
1356    */
1357   public static function ordinalNumber($number) {
1358     if (empty($number)) {
1359       return NULL;
1360     }
1361
1362     $str = 'th';
1363     switch (floor($number / 10) % 10) {
1364       case 1:
1365       default:
1366         switch ($number % 10) {
1367           case 1:
1368             $str = 'st';
1369             break;
1370
1371           case 2:
1372             $str = 'nd';
1373             break;
1374
1375           case 3:
1376             $str = 'rd';
1377             break;
1378         }
1379     }
1380
1381     return "$number$str";
1382   }
1383
1384   /**
1385    * Update membership status to deceased
1386    * function return the status message for updated membership.
1387    *
1388    * @param array $deceasedParams
1389    *   having contact id and deceased value.
1390    *
1391    * @return null|string
1392    *   $updateMembershipMsg string  status message for updated membership.
1393    */
1394   public function updateMembershipStatus($deceasedParams) {
1395     $updateMembershipMsg = NULL;
1396     $contactId = CRM_Utils_Array::value('contact_id', $deceasedParams);
1397     $deceasedDate = CRM_Utils_Array::value('deceased_date', $deceasedParams);
1398
1399     // process to set membership status to deceased for both active/inactive membership
1400     if ($contactId &&
1401       $this->_contactType == 'Individual' && !empty($deceasedParams['is_deceased'])
1402     ) {
1403
1404       $session = CRM_Core_Session::singleton();
1405       $userId = $session->get('userID');
1406       if (!$userId) {
1407         $userId = $contactId;
1408       }
1409
1410
1411       // get deceased status id
1412       $allStatus = CRM_Member_PseudoConstant::membershipStatus();
1413       $deceasedStatusId = array_search('Deceased', $allStatus);
1414       if (!$deceasedStatusId) {
1415         return $updateMembershipMsg;
1416       }
1417
1418       $today = time();
1419       if ($deceasedDate && strtotime($deceasedDate) > $today) {
1420         return $updateMembershipMsg;
1421       }
1422
1423       // get non deceased membership
1424       $dao = new CRM_Member_DAO_Membership();
1425       $dao->contact_id = $contactId;
1426       $dao->whereAdd("status_id != $deceasedStatusId");
1427       $dao->find();
1428       $activityTypes = CRM_Core_PseudoConstant::activityType(TRUE, FALSE, FALSE, 'name');
1429       $allStatus = CRM_Member_PseudoConstant::membershipStatus();
1430       $memCount = 0;
1431       while ($dao->fetch()) {
1432         // update status to deceased (for both active/inactive membership )
1433         CRM_Core_DAO::setFieldValue('CRM_Member_DAO_Membership', $dao->id,
1434           'status_id', $deceasedStatusId
1435         );
1436
1437         // add membership log
1438         $membershipLog = array(
1439           'membership_id' => $dao->id,
1440           'status_id' => $deceasedStatusId,
1441           'start_date' => CRM_Utils_Date::isoToMysql($dao->start_date),
1442           'end_date' => CRM_Utils_Date::isoToMysql($dao->end_date),
1443           'modified_id' => $userId,
1444           'modified_date' => date('Ymd'),
1445           'membership_type_id' => $dao->membership_type_id,
1446           'max_related' => $dao->max_related,
1447         );
1448
1449
1450         CRM_Member_BAO_MembershipLog::add($membershipLog, CRM_Core_DAO::$_nullArray);
1451
1452         //create activity when membership status is changed
1453         $activityParam = array(
1454           'subject' => "Status changed from {$allStatus[$dao->status_id]} to {$allStatus[$deceasedStatusId]}",
1455           'source_contact_id' => $userId,
1456           'target_contact_id' => $dao->contact_id,
1457           'source_record_id' => $dao->id,
1458           'activity_type_id' => array_search('Change Membership Status', $activityTypes),
1459           'status_id' => 2,
1460           'version' => 3,
1461           'priority_id' => 2,
1462           'activity_date_time' => date('Y-m-d H:i:s'),
1463           'is_auto' => 0,
1464           'is_current_revision' => 1,
1465           'is_deleted' => 0,
1466         );
1467         $activityResult = civicrm_api('activity', 'create', $activityParam);
1468
1469         $memCount++;
1470       }
1471
1472       // set status msg
1473       if ($memCount) {
1474         $updateMembershipMsg = ts("%1 Current membership(s) for this contact have been set to 'Deceased' status.",
1475           array(1 => $memCount)
1476         );
1477       }
1478     }
1479
1480     return $updateMembershipMsg;
1481   }
1482 }