3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2018
35 * This class generates form components generic to all the contact types.
37 * It delegates the work to lower level subclasses and integrates the changes
38 * back in. It also uses a lot of functionality with the CRM API's, so any change
39 * made here could potentially affect the API etc. Be careful, be aware, use unit tests.
42 class CRM_Contact_Form_Contact
extends CRM_Core_Form
{
45 * The contact type of the form.
52 * The contact type of the form.
56 public $_contactSubType;
59 * The contact id, used when editing the form
66 * The default group id passed in via the url.
73 * The default tag id passed in via the url.
80 * Name of de-dupe button
84 protected $_dedupeButtonName;
87 * Name of optional save duplicate button.
91 protected $_duplicateButtonName;
93 protected $_editOptions = array();
95 protected $_oldSubtypes = array();
99 public $_values = array();
103 public $_customValueCount;
105 * The array of greetings with option group and filed names.
112 * Do we want to parse street address.
114 public $_parseStreetAddress;
117 * Check contact has a subtype or not.
119 public $_isContactSubType;
122 * Lets keep a cache of all the values that we retrieved.
123 * THis is an attempt to avoid the number of update statements
124 * during the write phase
126 public $_preEditValues;
129 * Explicitly declare the entity api name.
131 public function getDefaultEntity() {
136 * Explicitly declare the form context.
138 public function getDefaultContext() {
143 * Build all the data structures needed to build the form.
145 public function preProcess() {
146 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, 'add');
148 $this->_dedupeButtonName
= $this->getButtonName('refresh', 'dedupe');
149 $this->_duplicateButtonName
= $this->getButtonName('upload', 'duplicate');
151 CRM_Core_Resources
::singleton()
152 ->addStyleFile('civicrm', 'css/contactSummary.css', 2, 'html-header');
154 $session = CRM_Core_Session
::singleton();
155 if ($this->_action
== CRM_Core_Action
::ADD
) {
156 // check for add contacts permissions
157 if (!CRM_Core_Permission
::check('add contacts')) {
158 CRM_Utils_System
::permissionDenied();
159 CRM_Utils_System
::civiExit();
161 $this->_contactType
= CRM_Utils_Request
::retrieve('ct', 'String',
162 $this, TRUE, NULL, 'REQUEST'
164 if (!in_array($this->_contactType
,
165 array('Individual', 'Household', 'Organization')
168 CRM_Core_Error
::statusBounce(ts('Could not get a contact id and/or contact type'));
171 $this->_isContactSubType
= FALSE;
172 if ($this->_contactSubType
= CRM_Utils_Request
::retrieve('cst', 'String', $this)) {
173 $this->_isContactSubType
= TRUE;
177 $this->_contactSubType
&&
178 !(CRM_Contact_BAO_ContactType
::isExtendsContactType($this->_contactSubType
, $this->_contactType
, TRUE))
180 CRM_Core_Error
::statusBounce(ts("Could not get a valid contact subtype for contact type '%1'", array(1 => $this->_contactType
)));
183 $this->_gid
= CRM_Utils_Request
::retrieve('gid', 'Integer',
184 CRM_Core_DAO
::$_nullObject,
187 $this->_tid
= CRM_Utils_Request
::retrieve('tid', 'Integer',
188 CRM_Core_DAO
::$_nullObject,
191 $typeLabel = CRM_Contact_BAO_ContactType
::contactTypePairs(TRUE, $this->_contactSubType ?
192 $this->_contactSubType
: $this->_contactType
194 $typeLabel = implode(' / ', $typeLabel);
196 CRM_Utils_System
::setTitle(ts('New %1', array(1 => $typeLabel)));
197 $session->pushUserContext(CRM_Utils_System
::url('civicrm/dashboard', 'reset=1'));
198 $this->_contactId
= NULL;
202 if (!$this->_contactId
) {
203 $this->_contactId
= CRM_Utils_Request
::retrieve('cid', 'Positive', $this, TRUE);
206 if ($this->_contactId
) {
208 $params = array('id' => $this->_contactId
);
209 $returnProperities = array('id', 'contact_type', 'contact_sub_type', 'modified_date', 'is_deceased');
210 CRM_Core_DAO
::commonRetrieve('CRM_Contact_DAO_Contact', $params, $defaults, $returnProperities);
212 if (empty($defaults['id'])) {
213 CRM_Core_Error
::statusBounce(ts('A Contact with that ID does not exist: %1', array(1 => $this->_contactId
)));
216 $this->_contactType
= CRM_Utils_Array
::value('contact_type', $defaults);
217 $this->_contactSubType
= CRM_Utils_Array
::value('contact_sub_type', $defaults);
219 // check for permissions
220 $session = CRM_Core_Session
::singleton();
221 if (!CRM_Contact_BAO_Contact_Permission
::allow($this->_contactId
, CRM_Core_Permission
::EDIT
)) {
222 CRM_Core_Error
::statusBounce(ts('You do not have the necessary permission to edit this contact.'));
225 $displayName = CRM_Contact_BAO_Contact
::displayName($this->_contactId
);
226 if ($defaults['is_deceased']) {
227 $displayName .= ' <span class="crm-contact-deceased">(deceased)</span>';
229 $displayName = ts('Edit %1', array(1 => $displayName));
231 // Check if this is default domain contact CRM-10482
232 if (CRM_Contact_BAO_Contact
::checkDomainContact($this->_contactId
)) {
233 $displayName .= ' (' . ts('default organization') . ')';
236 // omitting contactImage from title for now since the summary overlay css doesn't work outside of our crm-container
237 CRM_Utils_System
::setTitle($displayName);
238 $context = CRM_Utils_Request
::retrieve('context', 'String', $this);
239 $qfKey = CRM_Utils_Request
::retrieve('key', 'String', $this);
241 $urlParams = 'reset=1&cid=' . $this->_contactId
;
243 $urlParams .= "&context=$context";
246 if (CRM_Utils_Rule
::qfKey($qfKey)) {
248 $urlParams .= "&key=$qfKey";
251 $session->pushUserContext(CRM_Utils_System
::url('civicrm/contact/view', $urlParams));
253 $values = $this->get('values');
254 // get contact values.
255 if (!empty($values)) {
256 $this->_values
= $values;
260 'id' => $this->_contactId
,
261 'contact_id' => $this->_contactId
,
262 'noRelationships' => TRUE,
267 $contact = CRM_Contact_BAO_Contact
::retrieve($params, $this->_values
, TRUE);
268 $this->set('values', $this->_values
);
272 CRM_Core_Error
::statusBounce(ts('Could not get a contact_id and/or contact_type'));
276 // parse street address, CRM-5450
277 $this->_parseStreetAddress
= $this->get('parseStreetAddress');
278 if (!isset($this->_parseStreetAddress
)) {
279 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
282 $this->_parseStreetAddress
= FALSE;
283 if (!empty($addressOptions['street_address']) && !empty($addressOptions['street_address_parsing'])) {
284 $this->_parseStreetAddress
= TRUE;
286 $this->set('parseStreetAddress', $this->_parseStreetAddress
);
288 $this->assign('parseStreetAddress', $this->_parseStreetAddress
);
290 $this->_editOptions
= $this->get('contactEditOptions');
291 if (CRM_Utils_System
::isNull($this->_editOptions
)) {
292 $this->_editOptions
= CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
293 'contact_edit_options', TRUE, NULL,
294 FALSE, 'name', TRUE, 'AND v.filter = 0'
296 $this->set('contactEditOptions', $this->_editOptions
);
299 // build demographics only for Individual contact type
300 if ($this->_contactType
!= 'Individual' &&
301 array_key_exists('Demographics', $this->_editOptions
)
303 unset($this->_editOptions
['Demographics']);
306 // in update mode don't show notes
307 if ($this->_contactId
&& array_key_exists('Notes', $this->_editOptions
)) {
308 unset($this->_editOptions
['Notes']);
311 $this->assign('editOptions', $this->_editOptions
);
312 $this->assign('contactType', $this->_contactType
);
313 $this->assign('contactSubType', $this->_contactSubType
);
315 // get the location blocks.
316 $this->_blocks
= $this->get('blocks');
317 if (CRM_Utils_System
::isNull($this->_blocks
)) {
318 $this->_blocks
= CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
319 'contact_edit_options', TRUE, NULL,
320 FALSE, 'name', TRUE, 'AND v.filter = 1'
322 $this->set('blocks', $this->_blocks
);
324 $this->assign('blocks', $this->_blocks
);
326 // this is needed for custom data.
327 $this->assign('entityID', $this->_contactId
);
329 // also keep the convention.
330 $this->assign('contactId', $this->_contactId
);
333 CRM_Contact_Form_Location
::preProcess($this);
335 // retain the multiple count custom fields value
336 if (!empty($_POST['hidden_custom'])) {
337 $customGroupCount = CRM_Utils_Array
::value('hidden_custom_group_count', $_POST);
339 if ($contactSubType = CRM_Utils_Array
::value('contact_sub_type', $_POST)) {
340 $paramSubType = implode(',', $contactSubType);
343 $this->_getCachedTree
= FALSE;
344 unset($customGroupCount[0]);
345 foreach ($customGroupCount as $groupID => $groupCount) {
346 if ($groupCount > 1) {
347 $this->set('groupID', $groupID);
349 for ($i = 0; $i <= $groupCount; $i++
) {
350 CRM_Custom_Form_CustomData
::preProcess($this, NULL, $contactSubType,
351 $i, $this->_contactType
, $this->_contactId
353 CRM_Contact_Form_Edit_CustomData
::buildQuickForm($this);
358 //reset all the ajax stuff, for normal processing
359 if (isset($this->_groupTree
)) {
360 $this->_groupTree
= NULL;
362 $this->set('groupID', NULL);
363 $this->_getCachedTree
= TRUE;
366 // execute preProcess dynamically by js else execute normal preProcess
367 if (array_key_exists('CustomData', $this->_editOptions
)) {
368 //assign a parameter to pass for sub type multivalue
369 //custom field to load
370 if ($this->_contactSubType ||
isset($paramSubType)) {
371 $paramSubType = (isset($paramSubType)) ?
$paramSubType :
372 str_replace(CRM_Core_DAO
::VALUE_SEPARATOR
, ',', trim($this->_contactSubType
, CRM_Core_DAO
::VALUE_SEPARATOR
));
374 $this->assign('paramSubType', $paramSubType);
377 if (CRM_Utils_Request
::retrieve('type', 'String')) {
378 CRM_Contact_Form_Edit_CustomData
::preProcess($this);
381 $contactSubType = $this->_contactSubType
;
382 // need contact sub type to build related grouptree array during post process
383 if (!empty($_POST['contact_sub_type'])) {
384 $contactSubType = $_POST['contact_sub_type'];
386 //only custom data has preprocess hence directly call it
387 CRM_Custom_Form_CustomData
::preProcess($this, NULL, $contactSubType,
388 1, $this->_contactType
, $this->_contactId
390 $this->assign('customValueCount', $this->_customValueCount
);
396 * Set default values for the form.
398 * Note that in edit/view mode the default values are retrieved from the database
400 public function setDefaultValues() {
401 $defaults = $this->_values
;
403 if ($this->_action
& CRM_Core_Action
::ADD
) {
404 if (array_key_exists('TagsAndGroups', $this->_editOptions
)) {
405 // set group and tag defaults if any
407 $defaults['group'][] = $this->_gid
;
410 $defaults['tag'][$this->_tid
] = 1;
413 if ($this->_contactSubType
) {
414 $defaults['contact_sub_type'] = $this->_contactSubType
;
418 foreach ($defaults['email'] as $dontCare => & $val) {
419 if (isset($val['signature_text'])) {
420 $val['signature_text_hidden'] = $val['signature_text'];
422 if (isset($val['signature_html'])) {
423 $val['signature_html_hidden'] = $val['signature_html'];
427 if (!empty($defaults['contact_sub_type'])) {
428 $defaults['contact_sub_type'] = $this->_oldSubtypes
;
431 // set defaults for blocks ( custom data, address, communication preference, notes, tags and groups )
432 foreach ($this->_editOptions
as $name => $label) {
433 if (!in_array($name, array('Address', 'Notes'))) {
434 $className = 'CRM_Contact_Form_Edit_' . $name;
435 $className::setDefaultValues($this, $defaults);
439 //set address block defaults
440 CRM_Contact_Form_Edit_Address
::setDefaultValues($defaults, $this);
442 if (!empty($defaults['image_URL'])) {
443 $this->assign("imageURL", CRM_Utils_File
::getImageURL($defaults['image_URL']));
446 //set location type and country to default for each block
447 $this->blockSetDefaults($defaults);
449 $this->_preEditValues
= $defaults;
454 * Do the set default related to location type id, primary location, default country.
456 * @param array $defaults
458 public function blockSetDefaults(&$defaults) {
459 $locationTypeKeys = array_filter(array_keys(CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id')), 'is_int');
460 sort($locationTypeKeys);
462 // get the default location type
463 $locationType = CRM_Core_BAO_LocationType
::getDefault();
465 // unset primary location type
466 $primaryLocationTypeIdKey = CRM_Utils_Array
::key($locationType->id
, $locationTypeKeys);
467 unset($locationTypeKeys[$primaryLocationTypeIdKey]);
469 // reset the array sequence
470 $locationTypeKeys = array_values($locationTypeKeys);
472 // get default phone and im provider id.
473 $defPhoneTypeId = key(CRM_Core_OptionGroup
::values('phone_type', FALSE, FALSE, FALSE, ' AND is_default = 1'));
474 $defIMProviderId = key(CRM_Core_OptionGroup
::values('instant_messenger_service',
475 FALSE, FALSE, FALSE, ' AND is_default = 1'
477 $defWebsiteTypeId = key(CRM_Core_OptionGroup
::values('website_type',
478 FALSE, FALSE, FALSE, ' AND is_default = 1'
481 $allBlocks = $this->_blocks
;
482 if (array_key_exists('Address', $this->_editOptions
)) {
483 $allBlocks['Address'] = $this->_editOptions
['Address'];
486 $config = CRM_Core_Config
::singleton();
487 foreach ($allBlocks as $blockName => $label) {
488 $name = strtolower($blockName);
489 $hasPrimary = $updateMode = FALSE;
491 // user is in update mode.
492 if (array_key_exists($name, $defaults) &&
493 !CRM_Utils_System
::isNull($defaults[$name])
498 for ($instance = 1; $instance <= $this->get($blockName . '_Block_Count'); $instance++
) {
499 // make we require one primary block, CRM-5505
502 $hasPrimary = CRM_Utils_Array
::value(
504 CRM_Utils_Array
::value($instance, $defaults[$name])
510 //set location to primary for first one.
511 if ($instance == 1) {
513 $defaults[$name][$instance]['is_primary'] = TRUE;
514 $defaults[$name][$instance]['location_type_id'] = $locationType->id
;
517 $locTypeId = isset($locationTypeKeys[$instance - 1]) ?
$locationTypeKeys[$instance - 1] : $locationType->id
;
518 $defaults[$name][$instance]['location_type_id'] = $locTypeId;
521 //set default country
522 if ($name == 'address' && $config->defaultContactCountry
) {
523 $defaults[$name][$instance]['country_id'] = $config->defaultContactCountry
;
526 //set default state/province
527 if ($name == 'address' && $config->defaultContactStateProvince
) {
528 $defaults[$name][$instance]['state_province_id'] = $config->defaultContactStateProvince
;
531 //set default phone type.
532 if ($name == 'phone' && $defPhoneTypeId) {
533 $defaults[$name][$instance]['phone_type_id'] = $defPhoneTypeId;
535 //set default website type.
536 if ($name == 'website' && $defWebsiteTypeId) {
537 $defaults[$name][$instance]['website_type_id'] = $defWebsiteTypeId;
540 //set default im provider.
541 if ($name == 'im' && $defIMProviderId) {
542 $defaults[$name][$instance]['provider_id'] = $defIMProviderId;
547 $defaults[$name][1]['is_primary'] = TRUE;
553 * add the rules (mainly global rules) for form.
554 * All local rules are added near the element
558 public function addRules() {
559 // skip adding formRules when custom data is build
560 if ($this->_addBlockName ||
($this->_action
& CRM_Core_Action
::DELETE
)) {
564 $this->addFormRule(array('CRM_Contact_Form_Edit_' . $this->_contactType
, 'formRule'), $this->_contactId
);
566 // Call Locking check if editing existing contact
567 if ($this->_contactId
) {
568 $this->addFormRule(array('CRM_Contact_Form_Edit_Lock', 'formRule'), $this->_contactId
);
571 if (array_key_exists('Address', $this->_editOptions
)) {
572 $this->addFormRule(array('CRM_Contact_Form_Edit_Address', 'formRule'), $this);
575 if (array_key_exists('CommunicationPreferences', $this->_editOptions
)) {
576 $this->addFormRule(array('CRM_Contact_Form_Edit_CommunicationPreferences', 'formRule'), $this);
581 * Global validation rules for the form.
583 * @param array $fields
584 * Posted values of the form.
585 * @param array $errors
586 * List of errors to be posted back to the form.
587 * @param int $contactId
588 * Contact id if doing update.
593 public static function formRule($fields, &$errors, $contactId, $contactType) {
594 $config = CRM_Core_Config
::singleton();
597 //1. for each block only single value can be marked as is_primary = true.
598 //2. location type id should be present if block data present.
599 //3. check open id across db and other each block for duplicate.
600 //4. at least one location should be primary.
601 //5. also get primaryID from email or open id block.
603 // take the location blocks.
604 $blocks = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
605 'contact_edit_options', TRUE, NULL,
606 FALSE, 'name', TRUE, 'AND v.filter = 1'
609 $otherEditOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
610 'contact_edit_options', TRUE, NULL,
611 FALSE, 'name', TRUE, 'AND v.filter = 0'
613 //get address block inside.
614 if (array_key_exists('Address', $otherEditOptions)) {
615 $blocks['Address'] = $otherEditOptions['Address'];
620 foreach ($blocks as $name => $label) {
621 $hasData = $hasPrimary = array();
622 $name = strtolower($name);
623 if (!empty($fields[$name]) && is_array($fields[$name])) {
624 foreach ($fields[$name] as $instance => $blockValues) {
625 $dataExists = self
::blockDataExists($blockValues);
627 if (!$dataExists && $name == 'address') {
628 $dataExists = CRM_Utils_Array
::value('use_shared_address', $fields['address'][$instance]);
632 // skip remaining checks for website
633 if ($name == 'website') {
637 $hasData[] = $instance;
638 if (!empty($blockValues['is_primary'])) {
639 $hasPrimary[] = $instance;
641 in_array($name, array(
644 )) && !empty($blockValues[$name])
646 $primaryID = $blockValues[$name];
650 if (empty($blockValues['location_type_id'])) {
651 $errors["{$name}[$instance][location_type_id]"] = ts('The Location Type should be set if there is %1 information.', array(1 => $label));
655 if ($name == 'openid' && !empty($blockValues[$name])) {
656 $oid = new CRM_Core_DAO_OpenID();
657 $oid->openid
= $openIds[$instance] = CRM_Utils_Array
::value($name, $blockValues);
658 $cid = isset($contactId) ?
$contactId : 0;
659 if ($oid->find(TRUE) && ($oid->contact_id
!= $cid)) {
660 $errors["{$name}[$instance][openid]"] = ts('%1 already exist.', array(1 => $blocks['OpenID']));
665 if (empty($hasPrimary) && !empty($hasData)) {
666 $errors["{$name}[1][is_primary]"] = ts('One %1 should be marked as primary.', array(1 => $label));
669 if (count($hasPrimary) > 1) {
670 $errors["{$name}[" . array_pop($hasPrimary) . "][is_primary]"] = ts('Only one %1 can be marked as primary.',
677 //do validations for all opend ids they should be distinct.
678 if (!empty($openIds) && (count(array_unique($openIds)) != count($openIds))) {
679 foreach ($openIds as $instance => $value) {
680 if (!array_key_exists($instance, array_unique($openIds))) {
681 $errors["openid[$instance][openid]"] = ts('%1 already used.', array(1 => $blocks['OpenID']));
686 // street number should be digit + suffix, CRM-5450
687 $parseStreetAddress = CRM_Utils_Array
::value('street_address_parsing',
688 CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
692 if ($parseStreetAddress) {
693 if (isset($fields['address']) &&
694 is_array($fields['address'])
696 $invalidStreetNumbers = array();
697 foreach ($fields['address'] as $cnt => $address) {
698 if ($streetNumber = CRM_Utils_Array
::value('street_number', $address)) {
699 $parsedAddress = CRM_Core_BAO_Address
::parseStreetAddress($address['street_number']);
700 if (empty($parsedAddress['street_number'])) {
701 $invalidStreetNumbers[] = $cnt;
706 if (!empty($invalidStreetNumbers)) {
707 $first = $invalidStreetNumbers[0];
708 foreach ($invalidStreetNumbers as & $num) {
709 $num = CRM_Contact_Form_Contact
::ordinalNumber($num);
711 $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)));
716 // Check for duplicate contact if it wasn't already handled by ajax or disabled
717 if (!Civi
::settings()->get('contact_ajax_check_similar')) {
718 self
::checkDuplicateContacts($fields, $errors, $contactId, $contactType);
725 * Build the form object.
727 public function buildQuickForm() {
728 //load form for child blocks
729 if ($this->_addBlockName
) {
730 $className = 'CRM_Contact_Form_Edit_' . $this->_addBlockName
;
731 return $className::buildQuickForm($this);
734 if ($this->_action
== CRM_Core_Action
::UPDATE
) {
735 $deleteExtra = json_encode(ts('Are you sure you want to delete contact image.'));
737 CRM_Core_Action
::DELETE
=> array(
738 'name' => ts('Delete Contact Image'),
739 'url' => 'civicrm/contact/image',
740 'qs' => 'reset=1&cid=%%id%%&action=delete',
741 'extra' => 'onclick = "' . htmlspecialchars("if (confirm($deleteExtra)) this.href+='&confirmed=1'; else return false;") . '"',
744 $deleteURL = CRM_Core_Action
::formLink($deleteURL,
745 CRM_Core_Action
::DELETE
,
747 'id' => $this->_contactId
,
751 'contact.image.delete',
755 $this->assign('deleteURL', $deleteURL);
758 //build contact type specific fields
759 $className = 'CRM_Contact_Form_Edit_' . $this->_contactType
;
760 $className::buildQuickForm($this);
762 // Ajax duplicate checking
763 $checkSimilar = $this->_action
== CRM_Core_Action
::ADD
&& Civi
::settings()->get('contact_ajax_check_similar');
764 $this->assign('checkSimilar', $checkSimilar);
765 if ($checkSimilar == 1) {
766 $ruleParams = array('used' => 'Supervised', 'contact_type' => $this->_contactType
);
767 $this->assign('ruleFields', CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams));
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";
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 $this->addField('contact_sub_type', array(
780 'label' => ts('Contact Type'),
781 'options' => $subtypes,
782 'class' => $buildCustomData,
783 'multiple' => 'multiple',
784 'option_url' => NULL,
788 // build edit blocks ( custom data, demographics, communication preference, notes, tags and groups )
789 foreach ($this->_editOptions
as $name => $label) {
790 if ($name == 'Address') {
791 $this->_blocks
['Address'] = $this->_editOptions
['Address'];
794 if ($name == 'TagsAndGroups') {
797 $className = 'CRM_Contact_Form_Edit_' . $name;
798 $className::buildQuickForm($this);
801 // build tags and groups
802 CRM_Contact_Form_Edit_TagsAndGroups
::buildQuickForm($this, 0, CRM_Contact_Form_Edit_TagsAndGroups
::ALL
,
803 FALSE, NULL, 'Group(s)', 'Tag(s)', NULL, 'select');
805 // build location blocks.
806 CRM_Contact_Form_Edit_Lock
::buildQuickForm($this);
807 CRM_Contact_Form_Location
::buildQuickForm($this);
810 $this->addField('image_URL', array('maxlength' => '255', 'label' => ts('Browse/Upload Image')));
812 // add the dedupe button
813 $this->addElement('submit',
814 $this->_dedupeButtonName
,
815 ts('Check for Matching Contact(s)')
817 $this->addElement('submit',
818 $this->_duplicateButtonName
,
819 ts('Save Matching Contact')
821 $this->addElement('submit',
822 $this->getButtonName('next', 'sharedHouseholdDuplicate'),
823 ts('Save With Duplicate Household')
829 'name' => ts('Save'),
834 if (CRM_Core_Permission
::check('add contacts')) {
837 'name' => ts('Save and New'),
838 'spacing' => ' ',
844 'name' => ts('Cancel'),
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
)
852 $this->assign('oldSubtypes', json_encode($this->_oldSubtypes
));
854 $this->addButtons($buttons);
858 * Form submission of new/edit contact is processed.
860 public function postProcess() {
861 // check if dedupe button, if so return.
862 $buttonName = $this->controller
->getButtonName();
863 if ($buttonName == $this->_dedupeButtonName
) {
867 //get the submitted values in an array
868 $params = $this->controller
->exportValues($this->_name
);
869 if (!isset($params['preferred_communication_method'])) {
870 // If this field is empty QF will trim it so we have to add it in.
871 $params['preferred_communication_method'] = 'null';
874 $group = CRM_Utils_Array
::value('group', $params);
875 if (!empty($group) && is_array($group)) {
876 unset($params['group']);
877 foreach ($group as $key => $value) {
878 $params['group'][$value] = 1;
882 if (!empty($params['image_URL'])) {
883 CRM_Contact_BAO_Contact
::processImageParams($params);
886 if (is_numeric(CRM_Utils_Array
::value('current_employer_id', $params)) && !empty($params['current_employer'])) {
887 $params['current_employer'] = $params['current_employer_id'];
890 // don't carry current_employer_id field,
891 // since we don't want to directly update DAO object without
892 // handling related business logic ( eg related membership )
893 if (isset($params['current_employer_id'])) {
894 unset($params['current_employer_id']);
897 $params['contact_type'] = $this->_contactType
;
898 if (empty($params['contact_sub_type']) && $this->_isContactSubType
) {
899 $params['contact_sub_type'] = array($this->_contactSubType
);
902 if ($this->_contactId
) {
903 $params['contact_id'] = $this->_contactId
;
906 //make deceased date null when is_deceased = false
907 if ($this->_contactType
== 'Individual' && !empty($this->_editOptions
['Demographics']) && empty($params['is_deceased'])) {
908 $params['is_deceased'] = FALSE;
909 $params['deceased_date'] = NULL;
912 if (isset($params['contact_id'])) {
913 // process membership status for deceased contact
914 $deceasedParams = array(
915 'contact_id' => CRM_Utils_Array
::value('contact_id', $params),
916 'is_deceased' => CRM_Utils_Array
::value('is_deceased', $params, FALSE),
917 'deceased_date' => CRM_Utils_Array
::value('deceased_date', $params, NULL),
919 $updateMembershipMsg = $this->updateMembershipStatus($deceasedParams);
922 // action is taken depending upon the mode
923 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
924 CRM_Utils_Hook
::pre('edit', $params['contact_type'], $params['contact_id'], $params);
927 CRM_Utils_Hook
::pre('create', $params['contact_type'], NULL, $params);
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'];
934 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess($params,
939 if ($this->_contactId
&& !empty($this->_oldSubtypes
)) {
940 CRM_Contact_BAO_ContactType
::deleteCustomSetForSubtypeMigration($this->_contactId
,
941 $params['contact_type'],
943 $params['contact_sub_type']
947 if (array_key_exists('CommunicationPreferences', $this->_editOptions
)) {
948 // this is a chekbox, so mark false if we dont get a POST value
949 $params['is_opt_out'] = CRM_Utils_Array
::value('is_opt_out', $params, FALSE);
952 // process shared contact address.
953 CRM_Contact_BAO_Contact_Utils
::processSharedAddress($params['address']);
955 if (!array_key_exists('TagsAndGroups', $this->_editOptions
)) {
956 unset($params['group']);
958 elseif (!empty($params['contact_id']) && ($this->_action
& CRM_Core_Action
::UPDATE
)) {
959 // figure out which all groups are intended to be removed
960 $contactGroupList = CRM_Contact_BAO_GroupContact
::getContactGroup($params['contact_id'], 'Added');
961 if (is_array($contactGroupList)) {
962 foreach ($contactGroupList as $key) {
963 if ((!array_key_exists($key['group_id'], $params['group']) ||
$params['group'][$key['group_id']] != 1) && empty($key['is_hidden'])) {
964 $params['group'][$key['group_id']] = -1;
970 // parse street address, CRM-5450
971 $parseStatusMsg = NULL;
972 if ($this->_parseStreetAddress
) {
973 $parseResult = self
::parseAddress($params);
974 $parseStatusMsg = self
::parseAddressStatusMsg($parseResult);
977 $blocks = array('email', 'phone', 'im', 'openid', 'address', 'website');
978 foreach ($blocks as $block) {
979 if (!empty($this->_preEditValues
[$block]) && is_array($this->_preEditValues
[$block])) {
980 foreach ($this->_preEditValues
[$block] as $count => $value) {
981 if (!empty($value['id'])) {
982 $params[$block][$count]['id'] = $value['id'];
983 $params[$block]['isIdSet'] = TRUE;
989 // Allow un-setting of location info, CRM-5969
990 $params['updateBlankLocInfo'] = TRUE;
992 $contact = CRM_Contact_BAO_Contact
::create($params, TRUE, FALSE, TRUE);
995 if ($this->_contactId
) {
996 $message = ts('%1 has been updated.', array(1 => $contact->display_name
));
999 $message = ts('%1 has been created.', array(1 => $contact->display_name
));
1002 // set the contact ID
1003 $this->_contactId
= $contact->id
;
1005 if (array_key_exists('TagsAndGroups', $this->_editOptions
)) {
1006 //add contact to tags
1007 if (isset($params['tag']) && !empty($params['tag'])) {
1008 $params['tag'] = array_flip(explode(',', $params['tag']));
1009 CRM_Core_BAO_EntityTag
::create($params['tag'], 'civicrm_contact', $params['contact_id']);
1013 if (isset($params['contact_taglist']) && !empty($params['contact_taglist'])) {
1014 CRM_Core_Form_Tag
::postProcess($params['contact_taglist'], $params['contact_id'], 'civicrm_contact', $this);
1018 if (!empty($parseStatusMsg)) {
1019 $message .= "<br />$parseStatusMsg";
1021 if (!empty($updateMembershipMsg)) {
1022 $message .= "<br />$updateMembershipMsg";
1025 $session = CRM_Core_Session
::singleton();
1026 $session->setStatus($message, ts('Contact Saved'), 'success');
1028 // add the recently viewed contact
1029 $recentOther = array();
1030 if (($session->get('userID') == $contact->id
) ||
1031 CRM_Contact_BAO_Contact_Permission
::allow($contact->id
, CRM_Core_Permission
::EDIT
)
1033 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/contact/add', 'reset=1&action=update&cid=' . $contact->id
);
1036 if (($session->get('userID') != $this->_contactId
) && CRM_Core_Permission
::check('delete contacts')) {
1037 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/contact/view/delete', 'reset=1&delete=1&cid=' . $contact->id
);
1040 CRM_Utils_Recent
::add($contact->display_name
,
1041 CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&cid=' . $contact->id
),
1043 $this->_contactType
,
1045 $contact->display_name
,
1049 // here we replace the user context with the url to view this contact
1050 $buttonName = $this->controller
->getButtonName();
1051 if ($buttonName == $this->getButtonName('upload', 'new')) {
1052 $contactSubTypes = array_filter(explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $this->_contactSubType
));
1053 $resetStr = "reset=1&ct={$contact->contact_type}";
1054 $resetStr .= (count($contactSubTypes) == 1) ?
"&cst=" . array_pop($contactSubTypes) : '';
1055 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/add', $resetStr));
1058 $context = CRM_Utils_Request
::retrieve('context', 'String', $this);
1059 $qfKey = CRM_Utils_Request
::retrieve('key', 'String', $this);
1060 //validate the qfKey
1061 $urlParams = 'reset=1&cid=' . $contact->id
;
1063 $urlParams .= "&context=$context";
1065 if (CRM_Utils_Rule
::qfKey($qfKey)) {
1066 $urlParams .= "&key=$qfKey";
1069 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view', $urlParams));
1072 // now invoke the post hook
1073 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
1074 CRM_Utils_Hook
::post('edit', $params['contact_type'], $contact->id
, $contact);
1077 CRM_Utils_Hook
::post('create', $params['contact_type'], $contact->id
, $contact);
1082 * Is there any real significant data in the hierarchical location array.
1084 * @param array $fields
1085 * The hierarchical value representation of this location.
1088 * true if data exists, false otherwise
1090 public static function blockDataExists(&$fields) {
1091 if (!is_array($fields)) {
1095 static $skipFields = array(
1104 foreach ($fields as $name => $value) {
1106 foreach ($skipFields as $skip) {
1107 if (strpos("[$skip]", $name) !== FALSE) {
1108 if ($name == 'phone') {
1118 if (is_array($value)) {
1119 if (self
::blockDataExists($value)) {
1124 if (!empty($value)) {
1134 * That checks for duplicate contacts.
1136 * @param array $fields
1137 * Fields array which are submitted.
1139 * @param int $contactID
1141 * @param string $contactType
1144 public static function checkDuplicateContacts(&$fields, &$errors, $contactID, $contactType) {
1145 // if this is a forced save, ignore find duplicate rule
1146 if (empty($fields['_qf_Contact_upload_duplicate'])) {
1148 $ids = CRM_Contact_BAO_Contact
::getDuplicateContacts($fields, $contactType, 'Supervised', array($contactID));
1151 $contactLinks = CRM_Contact_BAO_Contact_Utils
::formatContactIDSToLinks($ids, TRUE, TRUE, $contactID);
1153 $duplicateContactsLinks = '<div class="matching-contacts-found">';
1154 $duplicateContactsLinks .= ts('One matching contact was found. ', array(
1155 'count' => count($contactLinks['rows']),
1156 'plural' => '%count matching contacts were found.<br />',
1158 if ($contactLinks['msg'] == 'view') {
1159 $duplicateContactsLinks .= ts('You can View the existing contact', array(
1160 'count' => count($contactLinks['rows']),
1161 'plural' => 'You can View the existing contacts',
1165 $duplicateContactsLinks .= ts('You can View or Edit the existing contact', array(
1166 'count' => count($contactLinks['rows']),
1167 'plural' => 'You can View or Edit the existing contacts',
1170 if ($contactLinks['msg'] == 'merge') {
1171 // We should also get a merge link if this is for an existing contact
1172 $duplicateContactsLinks .= ts(', or Merge this contact with an existing contact');
1174 $duplicateContactsLinks .= '.';
1175 $duplicateContactsLinks .= '</div>';
1176 $duplicateContactsLinks .= '<table class="matching-contacts-actions">';
1178 for ($i = 0; $i < count($contactLinks['rows']); $i++
) {
1180 $row .= ' <td class="matching-contacts-name"> ';
1181 $row .= CRM_Utils_Array
::value('display_name', $contactLinks['rows'][$i]);
1183 $row .= ' <td class="matching-contacts-email"> ';
1184 $row .= CRM_Utils_Array
::value('primary_email', $contactLinks['rows'][$i]);
1186 $row .= ' <td class="action-items"> ';
1187 $row .= CRM_Utils_Array
::value('view', $contactLinks['rows'][$i]);
1188 $row .= CRM_Utils_Array
::value('edit', $contactLinks['rows'][$i]);
1189 $row .= CRM_Utils_Array
::value('merge', $contactLinks['rows'][$i]);
1194 $duplicateContactsLinks .= $row . '</table>';
1195 $duplicateContactsLinks .= ts("If you're sure this record is not a duplicate, click the 'Save Matching Contact' button below.");
1197 $errors['_qf_default'] = $duplicateContactsLinks;
1199 // let smarty know that there are duplicates
1200 $template = CRM_Core_Smarty
::singleton();
1201 $template->assign('isDuplicate', 1);
1203 elseif (!empty($fields['_qf_Contact_refresh_dedupe'])) {
1204 // add a session message for no matching contacts
1205 CRM_Core_Session
::setStatus(ts('No matching contact found.'), ts('None Found'), 'info');
1211 * Use the form name to create the tpl file name.
1215 public function getTemplateFileName() {
1216 if ($this->_contactSubType
) {
1217 $templateFile = "CRM/Contact/Form/Edit/SubType/{$this->_contactSubType}.tpl";
1218 $template = CRM_Core_Form
::getTemplate();
1219 if ($template->template_exists($templateFile)) {
1220 return $templateFile;
1223 return parent
::getTemplateFileName();
1227 * Parse all address blocks present in given params
1228 * and return parse result for all address blocks,
1229 * This function either parse street address in to child
1230 * elements or build street address from child elements.
1232 * @param array $params
1233 * of key value consist of address blocks.
1236 * as array of success/fails for each address block
1238 public function parseAddress(&$params) {
1239 $parseSuccess = $parsedFields = array();
1240 if (!is_array($params['address']) ||
1241 CRM_Utils_System
::isNull($params['address'])
1243 return $parseSuccess;
1246 foreach ($params['address'] as $instance => & $address) {
1247 $buildStreetAddress = FALSE;
1248 $parseFieldName = 'street_address';
1254 if (!empty($address[$fld])) {
1255 $parseFieldName = 'street_number';
1256 $buildStreetAddress = TRUE;
1261 // main parse string.
1262 $parseString = CRM_Utils_Array
::value($parseFieldName, $address);
1264 // parse address field.
1265 $parsedFields = CRM_Core_BAO_Address
::parseStreetAddress($parseString);
1267 if ($buildStreetAddress) {
1268 //hack to ignore spaces between number and suffix.
1269 //here user gives input as street_number so it has to
1270 //be street_number and street_number_suffix, but
1271 //due to spaces though preg detect string as street_name
1272 //consider it as 'street_number_suffix'.
1273 $suffix = $parsedFields['street_number_suffix'];
1275 $suffix = $parsedFields['street_name'];
1277 $address['street_number_suffix'] = $suffix;
1278 $address['street_number'] = $parsedFields['street_number'];
1280 $streetAddress = NULL;
1283 'street_number_suffix',
1287 if (in_array($fld, array(
1291 $streetAddress .= ' ';
1293 // CRM-17619 - if the street number suffix begins with a number, add a space
1294 $thesuffix = CRM_Utils_Array
::value('street_number_suffix', $address);
1295 if ($fld === 'street_number_suffix' && $thesuffix) {
1296 if (ctype_digit(substr($thesuffix, 0, 1))) {
1297 $streetAddress .= ' ';
1300 $streetAddress .= CRM_Utils_Array
::value($fld, $address);
1302 $address['street_address'] = trim($streetAddress);
1303 $parseSuccess[$instance] = TRUE;
1307 // consider address is automatically parseable,
1308 // when we should found street_number and street_name
1309 if (empty($parsedFields['street_name']) ||
empty($parsedFields['street_number'])) {
1313 // check for original street address string.
1314 if (empty($parseString)) {
1318 $parseSuccess[$instance] = $success;
1320 // we do not reset element values, but keep what we've parsed
1321 // in case of partial matches: CRM-8378
1323 // merge parse address in to main address block.
1324 $address = array_merge($address, $parsedFields);
1328 return $parseSuccess;
1332 * Check parse result and if some address block fails then this
1333 * function return the status message for all address blocks.
1335 * @param array $parseResult
1336 * An array of address blk instance and its status.
1338 * @return null|string
1339 * $statusMsg string status message for all address blocks.
1341 public static function parseAddressStatusMsg($parseResult) {
1343 if (!is_array($parseResult) ||
empty($parseResult)) {
1347 $parseFails = array();
1348 foreach ($parseResult as $instance => $success) {
1350 $parseFails[] = self
::ordinalNumber($instance);
1354 if (!empty($parseFails)) {
1355 $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.",
1356 array(1 => implode(', ', $parseFails))
1364 * Convert normal number to ordinal number format.
1365 * like 1 => 1st, 2 => 2nd and so on...
1367 * @param int $number
1368 * number to convert in to ordinal number.
1371 * ordinal number for given number.
1373 public static function ordinalNumber($number) {
1374 if (empty($number)) {
1379 switch (floor($number / 10) %
10) {
1382 switch ($number %
10) {
1397 return "$number$str";
1401 * Update membership status to deceased.
1402 * function return the status message for updated membership.
1404 * @param array $deceasedParams
1405 * having contact id and deceased value.
1407 * @return null|string
1408 * $updateMembershipMsg string status message for updated membership.
1410 public function updateMembershipStatus($deceasedParams) {
1411 $updateMembershipMsg = NULL;
1412 $contactId = CRM_Utils_Array
::value('contact_id', $deceasedParams);
1413 $deceasedDate = CRM_Utils_Array
::value('deceased_date', $deceasedParams);
1415 // process to set membership status to deceased for both active/inactive membership
1417 $this->_contactType
== 'Individual' && !empty($deceasedParams['is_deceased'])
1420 $session = CRM_Core_Session
::singleton();
1421 $userId = $session->get('userID');
1423 $userId = $contactId;
1426 // get deceased status id
1427 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
1428 $deceasedStatusId = array_search('Deceased', $allStatus);
1429 if (!$deceasedStatusId) {
1430 return $updateMembershipMsg;
1434 if ($deceasedDate && strtotime($deceasedDate) > $today) {
1435 return $updateMembershipMsg;
1438 // get non deceased membership
1439 $dao = new CRM_Member_DAO_Membership();
1440 $dao->contact_id
= $contactId;
1441 $dao->whereAdd("status_id != $deceasedStatusId");
1443 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, FALSE, FALSE, 'name');
1444 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
1446 while ($dao->fetch()) {
1447 // update status to deceased (for both active/inactive membership )
1448 CRM_Core_DAO
::setFieldValue('CRM_Member_DAO_Membership', $dao->id
,
1449 'status_id', $deceasedStatusId
1452 // add membership log
1453 $membershipLog = array(
1454 'membership_id' => $dao->id
,
1455 'status_id' => $deceasedStatusId,
1456 'start_date' => CRM_Utils_Date
::isoToMysql($dao->start_date
),
1457 'end_date' => CRM_Utils_Date
::isoToMysql($dao->end_date
),
1458 'modified_id' => $userId,
1459 'modified_date' => date('Ymd'),
1460 'membership_type_id' => $dao->membership_type_id
,
1461 'max_related' => $dao->max_related
,
1464 CRM_Member_BAO_MembershipLog
::add($membershipLog);
1466 //create activity when membership status is changed
1467 $activityParam = array(
1468 'subject' => "Status changed from {$allStatus[$dao->status_id]} to {$allStatus[$deceasedStatusId]}",
1469 'source_contact_id' => $userId,
1470 'target_contact_id' => $dao->contact_id
,
1471 'source_record_id' => $dao->id
,
1472 'activity_type_id' => array_search('Change Membership Status', $activityTypes),
1476 'activity_date_time' => date('Y-m-d H:i:s'),
1478 'is_current_revision' => 1,
1481 $activityResult = civicrm_api('activity', 'create', $activityParam);
1488 $updateMembershipMsg = ts("%1 Current membership(s) for this contact have been set to 'Deceased' status.",
1489 array(1 => $memCount)
1494 return $updateMembershipMsg;