CRM/Contact/Form/Contact.php

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