CRM/Contact/Form/Contact.php

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