CRM/Contact/Form/Contact.php

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