3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
37 * This class generates form components generic to all the contact types.
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.
44 class CRM_Contact_Form_Contact
extends CRM_Core_Form
{
47 * The contact type of the form.
54 * The contact type of the form.
58 public $_contactSubType;
61 * The contact id, used when editing the form
68 * The default group id passed in via the url.
75 * The default tag id passed in via the url.
82 * Name of de-dupe button
86 protected $_dedupeButtonName;
89 * Name of optional save duplicate button.
93 protected $_duplicateButtonName;
95 protected $_editOptions = array();
97 protected $_oldSubtypes = array();
101 public $_values = array();
105 public $_customValueCount;
107 * The array of greetings with option group and filed names.
114 * Do we want to parse street address.
116 public $_parseStreetAddress;
119 * Check contact has a subtype or not.
121 public $_isContactSubType;
124 * Lets keep a cache of all the values that we retrieved.
125 * THis is an attempt to avoid the number of update statements
126 * during the write phase
128 public $_preEditValues;
131 * Explicitly declare the entity api name.
133 public function getDefaultEntity() {
138 * Explicitly declare the form context.
140 public function getDefaultContext() {
145 * Build all the data structures needed to build the form.
149 public function preProcess() {
150 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, 'add');
152 $this->_dedupeButtonName
= $this->getButtonName('refresh', 'dedupe');
153 $this->_duplicateButtonName
= $this->getButtonName('upload', 'duplicate');
155 CRM_Core_Resources
::singleton()
156 ->addStyleFile('civicrm', 'css/contactSummary.css', 2, 'html-header');
158 $session = CRM_Core_Session
::singleton();
159 if ($this->_action
== CRM_Core_Action
::ADD
) {
160 // check for add contacts permissions
161 if (!CRM_Core_Permission
::check('add contacts')) {
162 CRM_Utils_System
::permissionDenied();
163 CRM_Utils_System
::civiExit();
165 $this->_contactType
= CRM_Utils_Request
::retrieve('ct', 'String',
166 $this, TRUE, NULL, 'REQUEST'
168 if (!in_array($this->_contactType
,
169 array('Individual', 'Household', 'Organization')
172 CRM_Core_Error
::statusBounce(ts('Could not get a contact id and/or contact type'));
175 $this->_isContactSubType
= FALSE;
176 if ($this->_contactSubType
= CRM_Utils_Request
::retrieve('cst', 'String', $this)) {
177 $this->_isContactSubType
= TRUE;
181 $this->_contactSubType
&&
182 !(CRM_Contact_BAO_ContactType
::isExtendsContactType($this->_contactSubType
, $this->_contactType
, TRUE))
184 CRM_Core_Error
::statusBounce(ts("Could not get a valid contact subtype for contact type '%1'", array(1 => $this->_contactType
)));
187 $this->_gid
= CRM_Utils_Request
::retrieve('gid', 'Integer',
188 CRM_Core_DAO
::$_nullObject,
191 $this->_tid
= CRM_Utils_Request
::retrieve('tid', 'Integer',
192 CRM_Core_DAO
::$_nullObject,
195 $typeLabel = CRM_Contact_BAO_ContactType
::contactTypePairs(TRUE, $this->_contactSubType ?
196 $this->_contactSubType
: $this->_contactType
198 $typeLabel = implode(' / ', $typeLabel);
200 CRM_Utils_System
::setTitle(ts('New %1', array(1 => $typeLabel)));
201 $session->pushUserContext(CRM_Utils_System
::url('civicrm/dashboard', 'reset=1'));
202 $this->_contactId
= NULL;
206 if (!$this->_contactId
) {
207 $this->_contactId
= CRM_Utils_Request
::retrieve('cid', 'Positive', $this, TRUE);
210 if ($this->_contactId
) {
212 $params = array('id' => $this->_contactId
);
213 $returnProperities = array('id', 'contact_type', 'contact_sub_type', 'modified_date', 'is_deceased');
214 CRM_Core_DAO
::commonRetrieve('CRM_Contact_DAO_Contact', $params, $defaults, $returnProperities);
216 if (empty($defaults['id'])) {
217 CRM_Core_Error
::statusBounce(ts('A Contact with that ID does not exist: %1', array(1 => $this->_contactId
)));
220 $this->_contactType
= CRM_Utils_Array
::value('contact_type', $defaults);
221 $this->_contactSubType
= CRM_Utils_Array
::value('contact_sub_type', $defaults);
223 // check for permissions
224 $session = CRM_Core_Session
::singleton();
225 if (!CRM_Contact_BAO_Contact_Permission
::allow($this->_contactId
, CRM_Core_Permission
::EDIT
)) {
226 CRM_Core_Error
::statusBounce(ts('You do not have the necessary permission to edit this contact.'));
229 $displayName = CRM_Contact_BAO_Contact
::displayName($this->_contactId
);
230 if ($defaults['is_deceased']) {
231 $displayName .= ' <span class="crm-contact-deceased">(deceased)</span>';
233 $displayName = ts('Edit %1', array(1 => $displayName));
235 // Check if this is default domain contact CRM-10482
236 if (CRM_Contact_BAO_Contact
::checkDomainContact($this->_contactId
)) {
237 $displayName .= ' (' . ts('default organization') . ')';
240 // omitting contactImage from title for now since the summary overlay css doesn't work outside of our crm-container
241 CRM_Utils_System
::setTitle($displayName);
242 $context = CRM_Utils_Request
::retrieve('context', 'String', $this);
243 $qfKey = CRM_Utils_Request
::retrieve('key', 'String', $this);
245 $urlParams = 'reset=1&cid=' . $this->_contactId
;
247 $urlParams .= "&context=$context";
250 if (CRM_Utils_Rule
::qfKey($qfKey)) {
252 $urlParams .= "&key=$qfKey";
255 $session->pushUserContext(CRM_Utils_System
::url('civicrm/contact/view', $urlParams));
257 $values = $this->get('values');
258 // get contact values.
259 if (!empty($values)) {
260 $this->_values
= $values;
264 'id' => $this->_contactId
,
265 'contact_id' => $this->_contactId
,
266 'noRelationships' => TRUE,
271 $contact = CRM_Contact_BAO_Contact
::retrieve($params, $this->_values
, TRUE);
272 $this->set('values', $this->_values
);
276 CRM_Core_Error
::statusBounce(ts('Could not get a contact_id and/or contact_type'));
280 // parse street address, CRM-5450
281 $this->_parseStreetAddress
= $this->get('parseStreetAddress');
282 if (!isset($this->_parseStreetAddress
)) {
283 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
286 $this->_parseStreetAddress
= FALSE;
287 if (!empty($addressOptions['street_address']) && !empty($addressOptions['street_address_parsing'])) {
288 $this->_parseStreetAddress
= TRUE;
290 $this->set('parseStreetAddress', $this->_parseStreetAddress
);
292 $this->assign('parseStreetAddress', $this->_parseStreetAddress
);
294 $this->_editOptions
= $this->get('contactEditOptions');
295 if (CRM_Utils_System
::isNull($this->_editOptions
)) {
296 $this->_editOptions
= CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
297 'contact_edit_options', TRUE, NULL,
298 FALSE, 'name', TRUE, 'AND v.filter = 0'
300 $this->set('contactEditOptions', $this->_editOptions
);
303 // build demographics only for Individual contact type
304 if ($this->_contactType
!= 'Individual' &&
305 array_key_exists('Demographics', $this->_editOptions
)
307 unset($this->_editOptions
['Demographics']);
310 // in update mode don't show notes
311 if ($this->_contactId
&& array_key_exists('Notes', $this->_editOptions
)) {
312 unset($this->_editOptions
['Notes']);
315 $this->assign('editOptions', $this->_editOptions
);
316 $this->assign('contactType', $this->_contactType
);
317 $this->assign('contactSubType', $this->_contactSubType
);
319 //build contact subtype form element, CRM-6864
320 $buildContactSubType = TRUE;
321 if ($this->_contactSubType
&& ($this->_action
& CRM_Core_Action
::ADD
)) {
322 $buildContactSubType = FALSE;
324 $this->assign('buildContactSubType', $buildContactSubType);
326 // get the location blocks.
327 $this->_blocks
= $this->get('blocks');
328 if (CRM_Utils_System
::isNull($this->_blocks
)) {
329 $this->_blocks
= CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
330 'contact_edit_options', TRUE, NULL,
331 FALSE, 'name', TRUE, 'AND v.filter = 1'
333 $this->set('blocks', $this->_blocks
);
335 $this->assign('blocks', $this->_blocks
);
337 // this is needed for custom data.
338 $this->assign('entityID', $this->_contactId
);
340 // also keep the convention.
341 $this->assign('contactId', $this->_contactId
);
344 CRM_Contact_Form_Location
::preProcess($this);
346 // retain the multiple count custom fields value
347 if (!empty($_POST['hidden_custom'])) {
348 $customGroupCount = CRM_Utils_Array
::value('hidden_custom_group_count', $_POST);
350 if ($contactSubType = CRM_Utils_Array
::value('contact_sub_type', $_POST)) {
351 $paramSubType = implode(',', $contactSubType);
354 $this->_getCachedTree
= FALSE;
355 unset($customGroupCount[0]);
356 foreach ($customGroupCount as $groupID => $groupCount) {
357 if ($groupCount > 1) {
358 $this->set('groupID', $groupID);
360 for ($i = 0; $i <= $groupCount; $i++
) {
361 CRM_Custom_Form_CustomData
::preProcess($this, NULL, $contactSubType,
362 $i, $this->_contactType
364 CRM_Contact_Form_Edit_CustomData
::buildQuickForm($this);
369 //reset all the ajax stuff, for normal processing
370 if (isset($this->_groupTree
)) {
371 $this->_groupTree
= NULL;
373 $this->set('groupID', NULL);
374 $this->_getCachedTree
= TRUE;
377 // execute preProcess dynamically by js else execute normal preProcess
378 if (array_key_exists('CustomData', $this->_editOptions
)) {
379 //assign a parameter to pass for sub type multivalue
380 //custom field to load
381 if ($this->_contactSubType ||
isset($paramSubType)) {
382 $paramSubType = (isset($paramSubType)) ?
$paramSubType :
383 str_replace(CRM_Core_DAO
::VALUE_SEPARATOR
, ',', trim($this->_contactSubType
, CRM_Core_DAO
::VALUE_SEPARATOR
));
385 $this->assign('paramSubType', $paramSubType);
388 if (CRM_Utils_Request
::retrieve('type', 'String', CRM_Core_DAO
::$_nullObject)) {
389 CRM_Contact_Form_Edit_CustomData
::preProcess($this);
392 $contactSubType = $this->_contactSubType
;
393 // need contact sub type to build related grouptree array during post process
394 if (!empty($_POST['contact_sub_type'])) {
395 $contactSubType = $_POST['contact_sub_type'];
397 //only custom data has preprocess hence directly call it
398 CRM_Custom_Form_CustomData
::preProcess($this, NULL, $contactSubType,
399 1, $this->_contactType
, $this->_contactId
401 $this->assign('customValueCount', $this->_customValueCount
);
407 * Set default values for the form. Note that in edit/view mode
408 * the default values are retrieved from the database
413 public function setDefaultValues() {
414 $defaults = $this->_values
;
417 if ($this->_action
& CRM_Core_Action
::ADD
) {
418 if (array_key_exists('TagsAndGroups', $this->_editOptions
)) {
419 // set group and tag defaults if any
421 $defaults['group'][] = $this->_gid
;
424 $defaults['tag'][$this->_tid
] = 1;
427 if ($this->_contactSubType
) {
428 $defaults['contact_sub_type'] = $this->_contactSubType
;
432 foreach ($defaults['email'] as $dontCare => & $val) {
433 if (isset($val['signature_text'])) {
434 $val['signature_text_hidden'] = $val['signature_text'];
436 if (isset($val['signature_html'])) {
437 $val['signature_html_hidden'] = $val['signature_html'];
441 if (!empty($defaults['contact_sub_type'])) {
442 $defaults['contact_sub_type'] = $this->_oldSubtypes
;
445 // set defaults for blocks ( custom data, address, communication preference, notes, tags and groups )
446 foreach ($this->_editOptions
as $name => $label) {
447 if (!in_array($name, array('Address', 'Notes'))) {
448 $className = 'CRM_Contact_Form_Edit_' . $name;
449 $className::setDefaultValues($this, $defaults);
453 //set address block defaults
454 CRM_Contact_Form_Edit_Address
::setDefaultValues($defaults, $this);
456 if (!empty($defaults['image_URL'])) {
457 list($imageWidth, $imageHeight) = getimagesize(CRM_Utils_String
::unstupifyUrl($defaults['image_URL']));
458 list($imageThumbWidth, $imageThumbHeight) = CRM_Contact_BAO_Contact
::getThumbSize($imageWidth, $imageHeight);
459 $this->assign('imageWidth', $imageWidth);
460 $this->assign('imageHeight', $imageHeight);
461 $this->assign('imageThumbWidth', $imageThumbWidth);
462 $this->assign('imageThumbHeight', $imageThumbHeight);
463 $this->assign('imageURL', $defaults['image_URL']);
466 //set location type and country to default for each block
467 $this->blockSetDefaults($defaults);
469 $this->_preEditValues
= $defaults;
474 * Do the set default related to location type id,
475 * primary location, default country
477 public function blockSetDefaults(&$defaults) {
478 $locationTypeKeys = array_filter(array_keys(CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id')), 'is_int');
479 sort($locationTypeKeys);
481 // get the default location type
482 $locationType = CRM_Core_BAO_LocationType
::getDefault();
484 // unset primary location type
485 $primaryLocationTypeIdKey = CRM_Utils_Array
::key($locationType->id
, $locationTypeKeys);
486 unset($locationTypeKeys[$primaryLocationTypeIdKey]);
488 // reset the array sequence
489 $locationTypeKeys = array_values($locationTypeKeys);
491 // get default phone and im provider id.
492 $defPhoneTypeId = key(CRM_Core_OptionGroup
::values('phone_type', FALSE, FALSE, FALSE, ' AND is_default = 1'));
493 $defIMProviderId = key(CRM_Core_OptionGroup
::values('instant_messenger_service',
494 FALSE, FALSE, FALSE, ' AND is_default = 1'
496 $defWebsiteTypeId = key(CRM_Core_OptionGroup
::values('website_type',
497 FALSE, FALSE, FALSE, ' AND is_default = 1'
500 $allBlocks = $this->_blocks
;
501 if (array_key_exists('Address', $this->_editOptions
)) {
502 $allBlocks['Address'] = $this->_editOptions
['Address'];
505 $config = CRM_Core_Config
::singleton();
506 foreach ($allBlocks as $blockName => $label) {
507 $name = strtolower($blockName);
508 $hasPrimary = $updateMode = FALSE;
510 // user is in update mode.
511 if (array_key_exists($name, $defaults) &&
512 !CRM_Utils_System
::isNull($defaults[$name])
517 for ($instance = 1; $instance <= $this->get($blockName . '_Block_Count'); $instance++
) {
518 // make we require one primary block, CRM-5505
521 $hasPrimary = CRM_Utils_Array
::value(
523 CRM_Utils_Array
::value($instance, $defaults[$name])
529 //set location to primary for first one.
530 if ($instance == 1) {
532 $defaults[$name][$instance]['is_primary'] = TRUE;
533 $defaults[$name][$instance]['location_type_id'] = $locationType->id
;
536 $locTypeId = isset($locationTypeKeys[$instance - 1]) ?
$locationTypeKeys[$instance - 1] : $locationType->id
;
537 $defaults[$name][$instance]['location_type_id'] = $locTypeId;
540 //set default country
541 if ($name == 'address' && $config->defaultContactCountry
) {
542 $defaults[$name][$instance]['country_id'] = $config->defaultContactCountry
;
545 //set default state/province
546 if ($name == 'address' && $config->defaultContactStateProvince
) {
547 $defaults[$name][$instance]['state_province_id'] = $config->defaultContactStateProvince
;
550 //set default phone type.
551 if ($name == 'phone' && $defPhoneTypeId) {
552 $defaults[$name][$instance]['phone_type_id'] = $defPhoneTypeId;
554 //set default website type.
555 if ($name == 'website' && $defWebsiteTypeId) {
556 $defaults[$name][$instance]['website_type_id'] = $defWebsiteTypeId;
559 //set default im provider.
560 if ($name == 'im' && $defIMProviderId) {
561 $defaults[$name][$instance]['provider_id'] = $defIMProviderId;
566 $defaults[$name][1]['is_primary'] = TRUE;
572 * add the rules (mainly global rules) for form.
573 * All local rules are added near the element
578 public function addRules() {
579 // skip adding formRules when custom data is build
580 if ($this->_addBlockName ||
($this->_action
& CRM_Core_Action
::DELETE
)) {
584 $this->addFormRule(array('CRM_Contact_Form_Edit_' . $this->_contactType
, 'formRule'), $this->_contactId
);
586 // Call Locking check if editing existing contact
587 if ($this->_contactId
) {
588 $this->addFormRule(array('CRM_Contact_Form_Edit_Lock', 'formRule'), $this->_contactId
);
591 if (array_key_exists('Address', $this->_editOptions
)) {
592 $this->addFormRule(array('CRM_Contact_Form_Edit_Address', 'formRule'), $this);
595 if (array_key_exists('CommunicationPreferences', $this->_editOptions
)) {
596 $this->addFormRule(array('CRM_Contact_Form_Edit_CommunicationPreferences', 'formRule'), $this);
601 * Global validation rules for the form.
603 * @param array $fields
604 * Posted values of the form.
605 * @param array $errors
606 * List of errors to be posted back to the form.
607 * @param int $contactId
608 * Contact id if doing update.
613 public static function formRule($fields, &$errors, $contactId = NULL) {
614 $config = CRM_Core_Config
::singleton();
617 //1. for each block only single value can be marked as is_primary = true.
618 //2. location type id should be present if block data present.
619 //3. check open id across db and other each block for duplicate.
620 //4. at least one location should be primary.
621 //5. also get primaryID from email or open id block.
623 // take the location blocks.
624 $blocks = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
625 'contact_edit_options', TRUE, NULL,
626 FALSE, 'name', TRUE, 'AND v.filter = 1'
629 $otherEditOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
630 'contact_edit_options', TRUE, NULL,
631 FALSE, 'name', TRUE, 'AND v.filter = 0'
633 //get address block inside.
634 if (array_key_exists('Address', $otherEditOptions)) {
635 $blocks['Address'] = $otherEditOptions['Address'];
640 foreach ($blocks as $name => $label) {
641 $hasData = $hasPrimary = array();
642 $name = strtolower($name);
643 if (!empty($fields[$name]) && is_array($fields[$name])) {
644 foreach ($fields[$name] as $instance => $blockValues) {
645 $dataExists = self
::blockDataExists($blockValues);
647 if (!$dataExists && $name == 'address') {
648 $dataExists = CRM_Utils_Array
::value('use_shared_address', $fields['address'][$instance]);
652 // skip remaining checks for website
653 if ($name == 'website') {
657 $hasData[] = $instance;
658 if (!empty($blockValues['is_primary'])) {
659 $hasPrimary[] = $instance;
661 in_array($name, array(
664 )) && !empty($blockValues[$name])
666 $primaryID = $blockValues[$name];
670 if (empty($blockValues['location_type_id'])) {
671 $errors["{$name}[$instance][location_type_id]"] = ts('The Location Type should be set if there is %1 information.', array(1 => $label));
675 if ($name == 'openid' && !empty($blockValues[$name])) {
676 $oid = new CRM_Core_DAO_OpenID();
677 $oid->openid
= $openIds[$instance] = CRM_Utils_Array
::value($name, $blockValues);
678 $cid = isset($contactId) ?
$contactId : 0;
679 if ($oid->find(TRUE) && ($oid->contact_id
!= $cid)) {
680 $errors["{$name}[$instance][openid]"] = ts('%1 already exist.', array(1 => $blocks['OpenID']));
685 if (empty($hasPrimary) && !empty($hasData)) {
686 $errors["{$name}[1][is_primary]"] = ts('One %1 should be marked as primary.', array(1 => $label));
689 if (count($hasPrimary) > 1) {
690 $errors["{$name}[" . array_pop($hasPrimary) . "][is_primary]"] = ts('Only one %1 can be marked as primary.',
697 //do validations for all opend ids they should be distinct.
698 if (!empty($openIds) && (count(array_unique($openIds)) != count($openIds))) {
699 foreach ($openIds as $instance => $value) {
700 if (!array_key_exists($instance, array_unique($openIds))) {
701 $errors["openid[$instance][openid]"] = ts('%1 already used.', array(1 => $blocks['OpenID']));
706 // street number should be digit + suffix, CRM-5450
707 $parseStreetAddress = CRM_Utils_Array
::value('street_address_parsing',
708 CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
712 if ($parseStreetAddress) {
713 if (isset($fields['address']) &&
714 is_array($fields['address'])
716 $invalidStreetNumbers = array();
717 foreach ($fields['address'] as $cnt => $address) {
718 if ($streetNumber = CRM_Utils_Array
::value('street_number', $address)) {
719 $parsedAddress = CRM_Core_BAO_Address
::parseStreetAddress($address['street_number']);
720 if (empty($parsedAddress['street_number'])) {
721 $invalidStreetNumbers[] = $cnt;
726 if (!empty($invalidStreetNumbers)) {
727 $first = $invalidStreetNumbers[0];
728 foreach ($invalidStreetNumbers as & $num) {
729 $num = CRM_Contact_Form_Contact
::ordinalNumber($num);
731 $errors["address[$first][street_number]"] = ts('The street number you entered for the %1 address block(s) is not in an expected format. Street numbers may include numeric digit(s) followed by other characters. You can still enter the complete street address (unparsed) by clicking "Edit Complete Street Address".', array(1 => implode(', ', $invalidStreetNumbers)));
740 * Build the form object.
744 public function buildQuickForm() {
745 //load form for child blocks
746 if ($this->_addBlockName
) {
747 $className = 'CRM_Contact_Form_Edit_' . $this->_addBlockName
;
748 return $className::buildQuickForm($this);
751 if ($this->_action
== CRM_Core_Action
::UPDATE
) {
752 $deleteExtra = json_encode(ts('Are you sure you want to delete contact image.'));
754 CRM_Core_Action
::DELETE
=> array(
755 'name' => ts('Delete Contact Image'),
756 'url' => 'civicrm/contact/image',
757 'qs' => 'reset=1&cid=%%id%%&action=delete',
758 'extra' => 'onclick = "' . htmlspecialchars("if (confirm($deleteExtra)) this.href+='&confirmed=1'; else return false;") . '"',
761 $deleteURL = CRM_Core_Action
::formLink($deleteURL,
762 CRM_Core_Action
::DELETE
,
764 'id' => $this->_contactId
,
768 'contact.image.delete',
772 $this->assign('deleteURL', $deleteURL);
775 //build contact type specific fields
776 $className = 'CRM_Contact_Form_Edit_' . $this->_contactType
;
777 $className::buildQuickForm($this);
779 // build Custom data if Custom data present in edit option
780 $buildCustomData = 'noCustomDataPresent';
781 if (array_key_exists('CustomData', $this->_editOptions
)) {
782 $buildCustomData = "customDataPresent";
785 // subtype is a common field. lets keep it here
786 $subtypes = CRM_Contact_BAO_Contact
::buildOptions('contact_sub_type', 'create', array('contact_type' => $this->_contactType
));
787 if (!empty($subtypes)) {
788 $this->addField('contact_sub_type', array(
789 'label' => ts('Contact Type'),
790 'options' => $subtypes,
791 'class' => $buildCustomData,
792 'multiple' => 'multiple',
793 'options-url' => FALSE,
798 // build edit blocks ( custom data, demographics, communication preference, notes, tags and groups )
799 foreach ($this->_editOptions
as $name => $label) {
800 if ($name == 'Address') {
801 $this->_blocks
['Address'] = $this->_editOptions
['Address'];
804 if ($name == 'TagsAndGroups') {
807 $className = 'CRM_Contact_Form_Edit_' . $name;
808 $className::buildQuickForm($this);
811 // build tags and groups
812 CRM_Contact_Form_Edit_TagsAndGroups
::buildQuickForm($this, 0, CRM_Contact_Form_Edit_TagsAndGroups
::ALL
,
813 FALSE, NULL, 'Group(s)', 'Tag(s)', NULL, 'select');
815 // build location blocks.
816 CRM_Contact_Form_Edit_Lock
::buildQuickForm($this);
817 CRM_Contact_Form_Location
::buildQuickForm($this);
820 $this->addField('image_URL', array('maxlength' => '60', 'label' => ts('Browse/Upload Image')));
822 // add the dedupe button
823 $this->addElement('submit',
824 $this->_dedupeButtonName
,
825 ts('Check for Matching Contact(s)')
827 $this->addElement('submit',
828 $this->_duplicateButtonName
,
829 ts('Save Matching Contact')
831 $this->addElement('submit',
832 $this->getButtonName('next', 'sharedHouseholdDuplicate'),
833 ts('Save With Duplicate Household')
839 'name' => ts('Save'),
844 if (CRM_Core_Permission
::check('add contacts')) {
847 'name' => ts('Save and New'),
848 'spacing' => ' ',
854 'name' => ts('Cancel'),
857 if (!empty($this->_values
['contact_sub_type'])) {
858 $this->_oldSubtypes
= explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
859 trim($this->_values
['contact_sub_type'], CRM_Core_DAO
::VALUE_SEPARATOR
)
862 $this->assign('oldSubtypes', json_encode($this->_oldSubtypes
));
864 $this->addButtons($buttons);
868 * Form submission of new/edit contact is processed.
873 public function postProcess() {
874 // check if dedupe button, if so return.
875 $buttonName = $this->controller
->getButtonName();
876 if ($buttonName == $this->_dedupeButtonName
) {
880 //get the submitted values in an array
881 $params = $this->controller
->exportValues($this->_name
);
883 $group = CRM_Utils_Array
::value('group', $params);
884 if (!empty($group) && is_array($group)) {
885 unset($params['group']);
886 foreach ($group as $key => $value) {
887 $params['group'][$value] = 1;
891 CRM_Contact_BAO_Contact_Optimizer
::edit($params, $this->_preEditValues
);
893 if (!empty($params['image_URL'])) {
894 CRM_Contact_BAO_Contact
::processImageParams($params);
897 if (is_numeric(CRM_Utils_Array
::value('current_employer_id', $params)) && !empty($params['current_employer'])) {
898 $params['current_employer'] = $params['current_employer_id'];
901 // don't carry current_employer_id field,
902 // since we don't want to directly update DAO object without
903 // handling related business logic ( eg related membership )
904 if (isset($params['current_employer_id'])) {
905 unset($params['current_employer_id']);
908 $params['contact_type'] = $this->_contactType
;
909 if (empty($params['contact_sub_type']) && $this->_isContactSubType
) {
910 $params['contact_sub_type'] = array($this->_contactSubType
);
913 if ($this->_contactId
) {
914 $params['contact_id'] = $this->_contactId
;
917 //make deceased date null when is_deceased = false
918 if ($this->_contactType
== 'Individual' && !empty($this->_editOptions
['Demographics']) && empty($params['is_deceased'])) {
919 $params['is_deceased'] = FALSE;
920 $params['deceased_date'] = NULL;
923 if (isset($params['contact_id'])) {
924 // process membership status for deceased contact
925 $deceasedParams = array(
926 'contact_id' => CRM_Utils_Array
::value('contact_id', $params),
927 'is_deceased' => CRM_Utils_Array
::value('is_deceased', $params, FALSE),
928 'deceased_date' => CRM_Utils_Array
::value('deceased_date', $params, NULL),
930 $updateMembershipMsg = $this->updateMembershipStatus($deceasedParams);
933 // action is taken depending upon the mode
934 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
935 CRM_Utils_Hook
::pre('edit', $params['contact_type'], $params['contact_id'], $params);
938 CRM_Utils_Hook
::pre('create', $params['contact_type'], NULL, $params);
941 $customFields = CRM_Core_BAO_CustomField
::getFields($params['contact_type'], FALSE, TRUE);
944 //if subtype is set, send subtype as extend to validate subtype customfield
945 $customFieldExtends = (CRM_Utils_Array
::value('contact_sub_type', $params)) ?
$params['contact_sub_type'] : $params['contact_type'];
947 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess($params,
952 if ($this->_contactId
&& !empty($this->_oldSubtypes
)) {
953 CRM_Contact_BAO_ContactType
::deleteCustomSetForSubtypeMigration($this->_contactId
,
954 $params['contact_type'],
956 $params['contact_sub_type']
960 if (array_key_exists('CommunicationPreferences', $this->_editOptions
)) {
961 // this is a chekbox, so mark false if we dont get a POST value
962 $params['is_opt_out'] = CRM_Utils_Array
::value('is_opt_out', $params, FALSE);
965 // process shared contact address.
966 CRM_Contact_BAO_Contact_Utils
::processSharedAddress($params['address']);
968 if (!array_key_exists('TagsAndGroups', $this->_editOptions
) && !empty($params['group'])) {
969 unset($params['group']);
972 if (!empty($params['contact_id']) && ($this->_action
& CRM_Core_Action
::UPDATE
) && !empty($params['group'])) {
973 // figure out which all groups are intended to be removed
974 $contactGroupList = CRM_Contact_BAO_GroupContact
::getContactGroup($params['contact_id'], 'Added');
975 if (is_array($contactGroupList)) {
976 foreach ($contactGroupList as $key) {
977 if ((!array_key_exists($key['group_id'], $params['group']) ||
$params['group'][$key['group_id']] != 1) && empty($key['is_hidden'])) {
978 $params['group'][$key['group_id']] = -1;
984 // parse street address, CRM-5450
985 $parseStatusMsg = NULL;
986 if ($this->_parseStreetAddress
) {
987 $parseResult = self
::parseAddress($params);
988 $parseStatusMsg = self
::parseAddressStatusMsg($parseResult);
991 // Allow un-setting of location info, CRM-5969
992 $params['updateBlankLocInfo'] = TRUE;
994 $contact = CRM_Contact_BAO_Contact
::create($params, TRUE, FALSE, TRUE);
997 if ($this->_contactId
) {
998 $message = ts('%1 has been updated.', array(1 => $contact->display_name
));
1001 $message = ts('%1 has been created.', array(1 => $contact->display_name
));
1004 // set the contact ID
1005 $this->_contactId
= $contact->id
;
1007 if (array_key_exists('TagsAndGroups', $this->_editOptions
)) {
1008 //add contact to tags
1009 CRM_Core_BAO_EntityTag
::create($params['tag'], 'civicrm_contact', $params['contact_id']);
1012 if (isset($params['contact_taglist']) && !empty($params['contact_taglist'])) {
1013 CRM_Core_Form_Tag
::postProcess($params['contact_taglist'], $params['contact_id'], 'civicrm_contact', $this);
1017 if (!empty($parseStatusMsg)) {
1018 $message .= "<br />$parseStatusMsg";
1020 if (!empty($updateMembershipMsg)) {
1021 $message .= "<br />$updateMembershipMsg";
1024 $session = CRM_Core_Session
::singleton();
1025 $session->setStatus($message, ts('Contact Saved'), 'success');
1027 // add the recently viewed contact
1028 $recentOther = array();
1029 if (($session->get('userID') == $contact->id
) ||
1030 CRM_Contact_BAO_Contact_Permission
::allow($contact->id
, CRM_Core_Permission
::EDIT
)
1032 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/contact/add', 'reset=1&action=update&cid=' . $contact->id
);
1035 if (($session->get('userID') != $this->_contactId
) && CRM_Core_Permission
::check('delete contacts')) {
1036 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/contact/view/delete', 'reset=1&delete=1&cid=' . $contact->id
);
1039 CRM_Utils_Recent
::add($contact->display_name
,
1040 CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&cid=' . $contact->id
),
1042 $this->_contactType
,
1044 $contact->display_name
,
1048 // here we replace the user context with the url to view this contact
1049 $buttonName = $this->controller
->getButtonName();
1050 if ($buttonName == $this->getButtonName('upload', 'new')) {
1051 $contactSubTypes = array_filter(explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $this->_contactSubType
));
1052 $resetStr = "reset=1&ct={$contact->contact_type}";
1053 $resetStr .= (count($contactSubTypes) == 1) ?
"&cst=" . array_pop($contactSubTypes) : '';
1054 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/add', $resetStr));
1057 $context = CRM_Utils_Request
::retrieve('context', 'String', $this);
1058 $qfKey = CRM_Utils_Request
::retrieve('key', 'String', $this);
1059 //validate the qfKey
1060 $urlParams = 'reset=1&cid=' . $contact->id
;
1062 $urlParams .= "&context=$context";
1064 if (CRM_Utils_Rule
::qfKey($qfKey)) {
1065 $urlParams .= "&key=$qfKey";
1068 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view', $urlParams));
1071 // now invoke the post hook
1072 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
1073 CRM_Utils_Hook
::post('edit', $params['contact_type'], $contact->id
, $contact);
1076 CRM_Utils_Hook
::post('create', $params['contact_type'], $contact->id
, $contact);
1081 * Is there any real significant data in the hierarchical location array.
1083 * @param array $fields
1084 * The hierarchical value representation of this location.
1087 * true if data exists, false otherwise
1089 public static function blockDataExists(&$fields) {
1090 if (!is_array($fields)) {
1094 static $skipFields = array(
1103 foreach ($fields as $name => $value) {
1105 foreach ($skipFields as $skip) {
1106 if (strpos("[$skip]", $name) !== FALSE) {
1107 if ($name == 'phone') {
1117 if (is_array($value)) {
1118 if (self
::blockDataExists($value)) {
1123 if (!empty($value)) {
1133 * That checks for duplicate contacts.
1135 * @param array $fields
1136 * Fields array which are submitted.
1138 * @param int $contactID
1140 * @param string $contactType
1143 public static function checkDuplicateContacts(&$fields, &$errors, $contactID, $contactType) {
1144 // if this is a forced save, ignore find duplicate rule
1145 if (empty($fields['_qf_Contact_upload_duplicate'])) {
1147 $dedupeParams = CRM_Dedupe_Finder
::formatParams($fields, $contactType);
1148 $ids = CRM_Dedupe_Finder
::dupesByParams($dedupeParams, $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 .= $contactLinks['rows'][$i]['display_name'];
1183 $row .= ' <td class="matching-contacts-email"> ';
1184 $row .= $contactLinks['rows'][$i]['primary_email'];
1186 $row .= ' <td class="action-items"> ';
1187 $row .= $contactLinks['rows'][$i]['view'];
1188 $row .= $contactLinks['rows'][$i]['edit'];
1189 $row .= CRM_Utils_Array
::value('merge', $contactLinks['rows'][$i]);
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 $streetAddress .= CRM_Utils_Array
::value($fld, $address);
1295 $address['street_address'] = trim($streetAddress);
1296 $parseSuccess[$instance] = TRUE;
1300 // consider address is automatically parseable,
1301 // when we should found street_number and street_name
1302 if (empty($parsedFields['street_name']) ||
empty($parsedFields['street_number'])) {
1306 // check for original street address string.
1307 if (empty($parseString)) {
1311 $parseSuccess[$instance] = $success;
1313 // we do not reset element values, but keep what we've parsed
1314 // in case of partial matches: CRM-8378
1316 // merge parse address in to main address block.
1317 $address = array_merge($address, $parsedFields);
1321 return $parseSuccess;
1325 * Check parse result and if some address block fails then this
1326 * function return the status message for all address blocks.
1328 * @param array $parseResult
1329 * An array of address blk instance and its status.
1331 * @return null|string
1332 * $statusMsg string status message for all address blocks.
1334 public static function parseAddressStatusMsg($parseResult) {
1336 if (!is_array($parseResult) ||
empty($parseResult)) {
1340 $parseFails = array();
1341 foreach ($parseResult as $instance => $success) {
1343 $parseFails[] = self
::ordinalNumber($instance);
1347 if (!empty($parseFails)) {
1348 $statusMsg = ts("Complete street address(es) have been saved. However we were unable to split the address in the %1 address block(s) into address elements (street number, street name, street unit) due to an unrecognized address format. You can set the address elements manually by clicking 'Edit Address Elements' next to the Street Address field while in edit mode.",
1349 array(1 => implode(', ', $parseFails))
1357 * Convert normal number to ordinal number format.
1358 * like 1 => 1st, 2 => 2nd and so on...
1360 * @param int $number
1361 * number to convert in to ordinal number.
1364 * ordinal number for given number.
1366 public static function ordinalNumber($number) {
1367 if (empty($number)) {
1372 switch (floor($number / 10) %
10) {
1375 switch ($number %
10) {
1390 return "$number$str";
1394 * Update membership status to deceased.
1395 * function return the status message for updated membership.
1397 * @param array $deceasedParams
1398 * having contact id and deceased value.
1400 * @return null|string
1401 * $updateMembershipMsg string status message for updated membership.
1403 public function updateMembershipStatus($deceasedParams) {
1404 $updateMembershipMsg = NULL;
1405 $contactId = CRM_Utils_Array
::value('contact_id', $deceasedParams);
1406 $deceasedDate = CRM_Utils_Array
::value('deceased_date', $deceasedParams);
1408 // process to set membership status to deceased for both active/inactive membership
1410 $this->_contactType
== 'Individual' && !empty($deceasedParams['is_deceased'])
1413 $session = CRM_Core_Session
::singleton();
1414 $userId = $session->get('userID');
1416 $userId = $contactId;
1419 // get deceased status id
1420 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
1421 $deceasedStatusId = array_search('Deceased', $allStatus);
1422 if (!$deceasedStatusId) {
1423 return $updateMembershipMsg;
1427 if ($deceasedDate && strtotime($deceasedDate) > $today) {
1428 return $updateMembershipMsg;
1431 // get non deceased membership
1432 $dao = new CRM_Member_DAO_Membership();
1433 $dao->contact_id
= $contactId;
1434 $dao->whereAdd("status_id != $deceasedStatusId");
1436 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, FALSE, FALSE, 'name');
1437 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
1439 while ($dao->fetch()) {
1440 // update status to deceased (for both active/inactive membership )
1441 CRM_Core_DAO
::setFieldValue('CRM_Member_DAO_Membership', $dao->id
,
1442 'status_id', $deceasedStatusId
1445 // add membership log
1446 $membershipLog = array(
1447 'membership_id' => $dao->id
,
1448 'status_id' => $deceasedStatusId,
1449 'start_date' => CRM_Utils_Date
::isoToMysql($dao->start_date
),
1450 'end_date' => CRM_Utils_Date
::isoToMysql($dao->end_date
),
1451 'modified_id' => $userId,
1452 'modified_date' => date('Ymd'),
1453 'membership_type_id' => $dao->membership_type_id
,
1454 'max_related' => $dao->max_related
,
1457 CRM_Member_BAO_MembershipLog
::add($membershipLog, CRM_Core_DAO
::$_nullArray);
1459 //create activity when membership status is changed
1460 $activityParam = array(
1461 'subject' => "Status changed from {$allStatus[$dao->status_id]} to {$allStatus[$deceasedStatusId]}",
1462 'source_contact_id' => $userId,
1463 'target_contact_id' => $dao->contact_id
,
1464 'source_record_id' => $dao->id
,
1465 'activity_type_id' => array_search('Change Membership Status', $activityTypes),
1469 'activity_date_time' => date('Y-m-d H:i:s'),
1471 'is_current_revision' => 1,
1474 $activityResult = civicrm_api('activity', 'create', $activityParam);
1481 $updateMembershipMsg = ts("%1 Current membership(s) for this contact have been set to 'Deceased' status.",
1482 array(1 => $memCount)
1487 return $updateMembershipMsg;