3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
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
87 protected $_dedupeButtonName;
90 * name of optional save duplicate button
95 protected $_duplicateButtonName;
97 protected $_editOptions = array();
99 protected $_oldSubtypes = array();
103 public $_values = array();
107 public $_customValueCount;
109 * The array of greetings with option group and filed names
116 * Do we want to parse street address.
118 public $_parseStreetAddress;
121 * check contact has a subtype or not
123 public $_isContactSubType;
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
130 public $_preEditValues;
133 * build all the data structures needed to build the form
138 function preProcess() {
139 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, 'add');
141 $this->_dedupeButtonName
= $this->getButtonName('refresh', 'dedupe');
142 $this->_duplicateButtonName
= $this->getButtonName('upload', 'duplicate');
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();
151 $this->_contactType
= CRM_Utils_Request
::retrieve('ct', 'String',
152 $this, TRUE, NULL, 'REQUEST'
154 if (!in_array($this->_contactType
,
155 array('Individual', 'Household', 'Organization')
157 CRM_Core_Error
::statusBounce(ts('Could not get a contact id and/or contact type'));
160 $this->_isContactSubType
= FALSE;
161 if ($this->_contactSubType
= CRM_Utils_Request
::retrieve('cst', 'String', $this)) {
162 $this->_isContactSubType
= TRUE;
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
)));
171 $this->_gid
= CRM_Utils_Request
::retrieve('gid', 'Integer',
172 CRM_Core_DAO
::$_nullObject,
175 $this->_tid
= CRM_Utils_Request
::retrieve('tid', 'Integer',
176 CRM_Core_DAO
::$_nullObject,
179 $typeLabel = CRM_Contact_BAO_ContactType
::contactTypePairs(TRUE, $this->_contactSubType ?
180 $this->_contactSubType
: $this->_contactType
182 $typeLabel = implode(' / ', $typeLabel);
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;
190 if (!$this->_contactId
) {
191 $this->_contactId
= CRM_Utils_Request
::retrieve('cid', 'Positive', $this, TRUE);
194 if ($this->_contactId
) {
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);
200 if (empty($defaults['id'])) {
201 CRM_Core_Error
::statusBounce(ts('A Contact with that ID does not exist: %1', array(1 => $this->_contactId
)));
204 $this->_contactType
= CRM_Utils_Array
::value('contact_type', $defaults);
205 $this->_contactSubType
= CRM_Utils_Array
::value('contact_sub_type', $defaults);
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.'));
213 $displayName = CRM_Contact_BAO_Contact
::displayName($this->_contactId
);
214 $displayName = ts('Edit %1', array(1 => $displayName));
216 // Check if this is default domain contact CRM-10482
217 if (CRM_Contact_BAO_Contact
::checkDomainContact($this->_contactId
)) {
218 $displayName .= ' (' . ts('default organization') . ')';
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);
226 $urlParams = 'reset=1&cid=' . $this->_contactId
;
228 $urlParams .= "&context=$context";
231 if (CRM_Utils_Rule
::qfKey($qfKey)) {
233 $urlParams .= "&key=$qfKey";
236 $session->pushUserContext(CRM_Utils_System
::url('civicrm/contact/view', $urlParams));
238 $values = $this->get('values');
239 // get contact values.
240 if (!empty($values)) {
241 $this->_values
= $values;
245 'id' => $this->_contactId
,
246 'contact_id' => $this->_contactId
,
247 'noRelationships' => TRUE,
252 $contact = CRM_Contact_BAO_Contact
::retrieve($params, $this->_values
, TRUE);
253 $this->set('values', $this->_values
);
257 CRM_Core_Error
::statusBounce(ts('Could not get a contact_id and/or contact_type'));
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
,
267 $this->_parseStreetAddress
= FALSE;
268 if (!empty($addressOptions['street_address']) && !empty($addressOptions['street_address_parsing'])) {
269 $this->_parseStreetAddress
= TRUE;
271 $this->set('parseStreetAddress', $this->_parseStreetAddress
);
273 $this->assign('parseStreetAddress', $this->_parseStreetAddress
);
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'
281 $this->set('contactEditOptions', $this->_editOptions
);
284 // build demographics only for Individual contact type
285 if ($this->_contactType
!= 'Individual' &&
286 array_key_exists('Demographics', $this->_editOptions
)
288 unset($this->_editOptions
['Demographics']);
291 // in update mode don't show notes
292 if ($this->_contactId
&& array_key_exists('Notes', $this->_editOptions
)) {
293 unset($this->_editOptions
['Notes']);
296 $this->assign('editOptions', $this->_editOptions
);
297 $this->assign('contactType', $this->_contactType
);
298 $this->assign('contactSubType', $this->_contactSubType
);
300 //build contact subtype form element, CRM-6864
301 $buildContactSubType = TRUE;
302 if ($this->_contactSubType
&& ($this->_action
& CRM_Core_Action
::ADD
)) {
303 $buildContactSubType = FALSE;
305 $this->assign('buildContactSubType', $buildContactSubType);
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'
314 $this->set('blocks', $this->_blocks
);
316 $this->assign('blocks', $this->_blocks
);
318 // this is needed for custom data.
319 $this->assign('entityID', $this->_contactId
);
321 // also keep the convention.
322 $this->assign('contactId', $this->_contactId
);
325 CRM_Contact_Form_Location
::preProcess($this);
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);
331 if ($contactSubType = CRM_Utils_Array
::value( 'contact_sub_type', $_POST)) {
332 $paramSubType = implode(',', $contactSubType);
335 $this->_getCachedTree
= FALSE;
336 unset($customGroupCount[0]);
337 foreach ($customGroupCount as $groupID => $groupCount) {
338 if ($groupCount > 1) {
339 $this->set('groupID', $groupID);
341 for ($i = 0; $i <= $groupCount; $i++
) {
342 CRM_Custom_Form_CustomData
::preProcess($this, NULL, $contactSubType,
343 $i, $this->_contactType
345 CRM_Contact_Form_Edit_CustomData
::buildQuickForm($this);
350 //reset all the ajax stuff, for normal processing
351 if (isset($this->_groupTree
)) {
352 $this->_groupTree
= NULL;
354 $this->set('groupID', NULL);
355 $this->_getCachedTree
= TRUE;
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
));
366 $this->assign('paramSubType', $paramSubType);
369 if (CRM_Utils_Request
::retrieve('type', 'String', CRM_Core_DAO
::$_nullObject)) {
370 CRM_Contact_Form_Edit_CustomData
::preProcess($this);
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'];
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
382 $this->assign('customValueCount', $this->_customValueCount
);
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
395 function setDefaultValues() {
396 $defaults = $this->_values
;
399 if ($this->_action
& CRM_Core_Action
::ADD
) {
400 if (array_key_exists('TagsAndGroups', $this->_editOptions
)) {
401 // set group and tag defaults if any
403 $defaults['group'][] = $this->_gid
;
406 $defaults['tag'][$this->_tid
] = 1;
409 if ($this->_contactSubType
) {
410 $defaults['contact_sub_type'] = $this->_contactSubType
;
414 foreach ($defaults['email'] as $dontCare => & $val) {
415 if (isset($val['signature_text'])) {
416 $val['signature_text_hidden'] = $val['signature_text'];
418 if (isset($val['signature_html'])) {
419 $val['signature_html_hidden'] = $val['signature_html'];
423 if (!empty($defaults['contact_sub_type'])) {
424 $defaults['contact_sub_type'] = $this->_oldSubtypes
;
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);
435 //set address block defaults
436 CRM_Contact_Form_Edit_Address
::setDefaultValues( $defaults, $this );
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']);
448 //set location type and country to default for each block
449 $this->blockSetDefaults($defaults);
451 $this->_preEditValues
= $defaults;
456 * do the set default related to location type id,
457 * primary location, default country
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);
464 // get the default location type
465 $locationType = CRM_Core_BAO_LocationType
::getDefault();
467 // unset primary location type
468 $primaryLocationTypeIdKey = CRM_Utils_Array
::key($locationType->id
, $locationTypeKeys);
469 unset($locationTypeKeys[$primaryLocationTypeIdKey]);
471 // reset the array sequence
472 $locationTypeKeys = array_values($locationTypeKeys);
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'
479 $defWebsiteTypeId = key(CRM_Core_OptionGroup
::values('website_type',
480 FALSE, FALSE, FALSE, ' AND is_default = 1'
483 $allBlocks = $this->_blocks
;
484 if (array_key_exists('Address', $this->_editOptions
)) {
485 $allBlocks['Address'] = $this->_editOptions
['Address'];
488 $config = CRM_Core_Config
::singleton();
489 foreach ($allBlocks as $blockName => $label) {
490 $name = strtolower($blockName);
491 $hasPrimary = $updateMode = FALSE;
493 // user is in update mode.
494 if (array_key_exists($name, $defaults) &&
495 !CRM_Utils_System
::isNull($defaults[$name])
500 for ($instance = 1; $instance <= $this->get($blockName . '_Block_Count'); $instance++
) {
501 // make we require one primary block, CRM-5505
505 CRM_Utils_Array
::value(
507 CRM_Utils_Array
::value($instance, $defaults[$name])
513 //set location to primary for first one.
514 if ($instance == 1) {
516 $defaults[$name][$instance]['is_primary'] = TRUE;
517 $defaults[$name][$instance]['location_type_id'] = $locationType->id
;
520 $locTypeId = isset($locationTypeKeys[$instance - 1]) ?
$locationTypeKeys[$instance - 1] : $locationType->id
;
521 $defaults[$name][$instance]['location_type_id'] = $locTypeId;
524 //set default country
525 if ($name == 'address' && $config->defaultContactCountry
) {
526 $defaults[$name][$instance]['country_id'] = $config->defaultContactCountry
;
529 //set default state/province
530 if ($name == 'address' && $config->defaultContactStateProvince
) {
531 $defaults[$name][$instance]['state_province_id'] = $config->defaultContactStateProvince
;
534 //set default phone type.
535 if ($name == 'phone' && $defPhoneTypeId) {
536 $defaults[$name][$instance]['phone_type_id'] = $defPhoneTypeId;
538 //set default website type.
539 if ($name == 'website' && $defWebsiteTypeId) {
540 $defaults[$name][$instance]['website_type_id'] = $defWebsiteTypeId;
543 //set default im provider.
544 if ($name == 'im' && $defIMProviderId) {
545 $defaults[$name][$instance]['provider_id'] = $defIMProviderId;
550 $defaults[$name][1]['is_primary'] = TRUE;
554 // set defaults for country-state widget
555 if (!empty($defaults['address']) && is_array($defaults['address'])) {
556 foreach ($defaults['address'] as $blockId => $values) {
557 CRM_Contact_Form_Edit_Address
::fixStateSelect($this,
558 "address[$blockId][country_id]",
559 "address[$blockId][state_province_id]",
560 "address[$blockId][county_id]",
561 CRM_Utils_Array
::value('country_id',
562 $values, $config->defaultContactCountry
564 CRM_Utils_Array
::value('state_province_id',
565 $values, $config->defaultContactStateProvince
573 * This function is used to add the rules (mainly global rules) for form.
574 * All local rules are added near the element
580 function addRules() {
581 // skip adding formRules when custom data is build
582 if ($this->_addBlockName ||
($this->_action
& CRM_Core_Action
::DELETE
)) {
586 $this->addFormRule(array('CRM_Contact_Form_Edit_' . $this->_contactType
, 'formRule'), $this->_contactId
);
588 // Call Locking check if editing existing contact
589 if ($this->_contactId
) {
590 $this->addFormRule(array('CRM_Contact_Form_Edit_Lock', 'formRule'), $this->_contactId
);
593 if (array_key_exists('Address', $this->_editOptions
)) {
594 $this->addFormRule(array('CRM_Contact_Form_Edit_Address', 'formRule'), $this);
597 if (array_key_exists('CommunicationPreferences', $this->_editOptions
)) {
598 $this->addFormRule(array('CRM_Contact_Form_Edit_CommunicationPreferences', 'formRule'), $this);
603 * global validation rules for the form
605 * @param array $fields posted values of the form
606 * @param array $errors list of errors to be posted back to the form
607 * @param int $contactId contact id if doing update.
609 * @return $primaryID email/openId
613 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(
662 'email', 'openid')) && !empty($blockValues[$name])) {
663 $primaryID = $blockValues[$name];
667 if (empty($blockValues['location_type_id'])) {
668 $errors["{$name}[$instance][location_type_id]"] = ts('The Location Type should be set if there is %1 information.', array(1 => $label));
672 if ($name == 'openid' && !empty($blockValues[$name])) {
673 $oid = new CRM_Core_DAO_OpenID();
674 $oid->openid
= $openIds[$instance] = CRM_Utils_Array
::value($name, $blockValues);
675 $cid = isset($contactId) ?
$contactId : 0;
676 if ($oid->find(TRUE) && ($oid->contact_id
!= $cid)) {
677 $errors["{$name}[$instance][openid]"] = ts('%1 already exist.', array(1 => $blocks['OpenID']));
682 if (empty($hasPrimary) && !empty($hasData)) {
683 $errors["{$name}[1][is_primary]"] = ts('One %1 should be marked as primary.', array(1 => $label));
686 if (count($hasPrimary) > 1) {
687 $errors["{$name}[" . array_pop($hasPrimary) . "][is_primary]"] = ts('Only one %1 can be marked as primary.',
694 //do validations for all opend ids they should be distinct.
695 if (!empty($openIds) && (count(array_unique($openIds)) != count($openIds))) {
696 foreach ($openIds as $instance => $value) {
697 if (!array_key_exists($instance, array_unique($openIds))) {
698 $errors["openid[$instance][openid]"] = ts('%1 already used.', array(1 => $blocks['OpenID']));
703 // street number should be digit + suffix, CRM-5450
704 $parseStreetAddress = CRM_Utils_Array
::value('street_address_parsing',
705 CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
709 if ($parseStreetAddress) {
710 if (isset($fields['address']) &&
711 is_array($fields['address'])
713 $invalidStreetNumbers = array();
714 foreach ($fields['address'] as $cnt => $address) {
715 if ($streetNumber = CRM_Utils_Array
::value('street_number', $address)) {
716 $parsedAddress = CRM_Core_BAO_Address
::parseStreetAddress($address['street_number']);
717 if (empty($parsedAddress['street_number'])) {
718 $invalidStreetNumbers[] = $cnt;
723 if (!empty($invalidStreetNumbers)) {
724 $first = $invalidStreetNumbers[0];
725 foreach ($invalidStreetNumbers as & $num) $num = CRM_Contact_Form_Contact
::ordinalNumber($num);
726 $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)));
735 * Function to actually build the form
740 public function buildQuickForm() {
741 //load form for child blocks
742 if ($this->_addBlockName
) {
743 $className = 'CRM_Contact_Form_Edit_' . $this->_addBlockName
;
744 return $className::buildQuickForm($this);
747 if ($this->_action
== CRM_Core_Action
::UPDATE
) {
748 $deleteExtra = ts('Are you sure you want to delete contact image.');
750 CRM_Core_Action
::DELETE
=>
752 'name' => ts('Delete Contact Image'),
753 'url' => 'civicrm/contact/image',
754 'qs' => 'reset=1&cid=%%id%%&action=delete',
756 'onclick = "if (confirm( \'' . $deleteExtra . '\' ) ) this.href+=\'&confirmed=1\'; else return false;"',
759 $deleteURL = CRM_Core_Action
::formLink($deleteURL,
760 CRM_Core_Action
::DELETE
,
762 'id' => $this->_contactId
,
766 'contact.image.delete',
770 $this->assign('deleteURL', $deleteURL);
773 //build contact type specific fields
774 $className = 'CRM_Contact_Form_Edit_' . $this->_contactType
;
775 $className::buildQuickForm($this);
777 // build Custom data if Custom data present in edit option
778 $buildCustomData = 'noCustomDataPresent';
779 if (array_key_exists('CustomData', $this->_editOptions
)) {
780 $buildCustomData = "customDataPresent";
783 // subtype is a common field. lets keep it here
784 $subtypes = CRM_Contact_BAO_Contact
::buildOptions('contact_sub_type', 'create', array('contact_type' => $this->_contactType
));
785 if (!empty($subtypes)) {
786 $sel = $this->add('select', 'contact_sub_type', ts('Contact Type'),
789 'id' => 'contact_sub_type',
790 'multiple' => 'multiple',
791 'class' => $buildCustomData . ' crm-select2',
796 // build edit blocks ( custom data, demographics, communication preference, notes, tags and groups )
797 foreach ($this->_editOptions
as $name => $label) {
798 if ($name == 'Address') {
799 $this->_blocks
['Address'] = $this->_editOptions
['Address'];
802 if ($name == 'TagsAndGroups') {
805 $className = 'CRM_Contact_Form_Edit_' . $name;
806 $className::buildQuickForm($this);
809 // build tags and groups
810 CRM_Contact_Form_Edit_TagsAndGroups
::buildQuickForm($this, 0, CRM_Contact_Form_Edit_TagsAndGroups
::ALL
,
811 FALSE, NULL, 'Group(s)', 'Tag(s)', NULL, 'select');
813 // build location blocks.
814 CRM_Contact_Form_Edit_Lock
::buildQuickForm($this);
815 CRM_Contact_Form_Location
::buildQuickForm($this);
818 $this->addElement('file', 'image_URL', ts('Browse/Upload Image'), 'size=30 maxlength=60');
819 $this->addUploadElement('image_URL');
821 // add the dedupe button
822 $this->addElement('submit',
823 $this->_dedupeButtonName
,
824 ts('Check for Matching Contact(s)')
826 $this->addElement('submit',
827 $this->_duplicateButtonName
,
828 ts('Save Matching Contact')
830 $this->addElement('submit',
831 $this->getButtonName('next', 'sharedHouseholdDuplicate'),
832 ts('Save With Duplicate Household')
838 'name' => ts('Save'),
844 'name' => ts('Save and New'),
845 'spacing' => ' ',
850 'name' => ts('Cancel'),
854 if (!empty($this->_values
['contact_sub_type'])) {
855 $this->_oldSubtypes
= explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
856 trim($this->_values
['contact_sub_type'], CRM_Core_DAO
::VALUE_SEPARATOR
)
859 $this->assign('oldSubtypes', json_encode($this->_oldSubtypes
));
861 $this->addButtons($buttons);
865 * Form submission of new/edit contact is processed.
871 public function postProcess() {
872 // check if dedupe button, if so return.
873 $buttonName = $this->controller
->getButtonName();
874 if ($buttonName == $this->_dedupeButtonName
) {
878 //get the submitted values in an array
879 $params = $this->controller
->exportValues($this->_name
);
881 $group = CRM_Utils_Array
::value('group', $params);
882 if ($group && is_array($group)) {
883 unset($params['group']);
884 foreach ($group as $key => $value) {
885 $params['group'][$value] = 1;
889 CRM_Contact_BAO_Contact_Optimizer
::edit( $params, $this->_preEditValues
);
891 if (!empty($params['image_URL'])) {
892 CRM_Contact_BAO_Contact
::processImageParams($params);
895 if (is_numeric(CRM_Utils_Array
::value('current_employer_id', $params)) && !empty($params['current_employer'])) {
896 $params['current_employer'] = $params['current_employer_id'];
899 // don't carry current_employer_id field,
900 // since we don't want to directly update DAO object without
901 // handling related business logic ( eg related membership )
902 if (isset($params['current_employer_id'])) {
903 unset($params['current_employer_id']);
906 $params['contact_type'] = $this->_contactType
;
907 if (empty($params['contact_sub_type']) && $this->_isContactSubType
) {
908 $params['contact_sub_type'] = array($this->_contactSubType
);
911 if ($this->_contactId
) {
912 $params['contact_id'] = $this->_contactId
;
915 //make deceased date null when is_deceased = false
916 if ($this->_contactType
== 'Individual' && !empty($this->_editOptions
['Demographics']) && empty($params['is_deceased'])) {
917 $params['is_deceased'] = FALSE;
918 $params['deceased_date'] = NULL;
921 if (isset($params['contact_id'])) {
922 // process membership status for deceased contact
923 $deceasedParams = array('contact_id' => CRM_Utils_Array
::value('contact_id', $params),
924 'is_deceased' => CRM_Utils_Array
::value('is_deceased', $params, FALSE),
925 'deceased_date' => CRM_Utils_Array
::value('deceased_date', $params, NULL),
927 $updateMembershipMsg = $this->updateMembershipStatus($deceasedParams);
930 // action is taken depending upon the mode
931 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
932 CRM_Utils_Hook
::pre('edit', $params['contact_type'], $params['contact_id'], $params);
935 CRM_Utils_Hook
::pre('create', $params['contact_type'], NULL, $params);
938 $customFields = CRM_Core_BAO_CustomField
::getFields($params['contact_type'], FALSE, TRUE);
941 //if subtype is set, send subtype as extend to validate subtype customfield
942 $customFieldExtends = (CRM_Utils_Array
::value('contact_sub_type', $params)) ?
$params['contact_sub_type'] : $params['contact_type'];
944 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess($params,
950 if ($this->_contactId
&& !empty($this->_oldSubtypes
)) {
951 CRM_Contact_BAO_ContactType
::deleteCustomSetForSubtypeMigration($this->_contactId
,
952 $params['contact_type'],
954 $params['contact_sub_type']
958 if (array_key_exists('CommunicationPreferences', $this->_editOptions
)) {
959 // this is a chekbox, so mark false if we dont get a POST value
960 $params['is_opt_out'] = CRM_Utils_Array
::value('is_opt_out', $params, FALSE);
963 // process shared contact address.
964 CRM_Contact_BAO_Contact_Utils
::processSharedAddress($params['address']);
966 if (!array_key_exists('TagsAndGroups', $this->_editOptions
)) {
967 unset($params['group']);
970 if (!empty($params['contact_id']) && ($this->_action
& CRM_Core_Action
::UPDATE
)) {
971 // figure out which all groups are intended to be removed
972 $contactGroupList = CRM_Contact_BAO_GroupContact
::getContactGroup($params['contact_id'], 'Added');
973 if (is_array($contactGroupList)) {
974 foreach ($contactGroupList as $key) {
975 if ((!array_key_exists($key['group_id'], $params['group']) ||
$params['group'][$key['group_id']] != 1) && empty($key['is_hidden'])) {
976 $params['group'][$key['group_id']] = -1;
982 // parse street address, CRM-5450
983 $parseStatusMsg = NULL;
984 if ($this->_parseStreetAddress
) {
985 $parseResult = self
::parseAddress($params);
986 $parseStatusMsg = self
::parseAddressStatusMsg($parseResult);
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 CRM_Core_BAO_EntityTag
::create($params['tag'], 'civicrm_contact', $params['contact_id']);
1010 if (isset($params['contact_taglist']) && !empty($params['contact_taglist'])) {
1011 CRM_Core_Form_Tag
::postProcess($params['contact_taglist'], $params['contact_id'], 'civicrm_contact', $this);
1015 if (!empty($parseStatusMsg)) {
1016 $message .= "<br />$parseStatusMsg";
1018 if (!empty($updateMembershipMsg)) {
1019 $message .= "<br />$updateMembershipMsg";
1022 $session = CRM_Core_Session
::singleton();
1023 $session->setStatus($message, ts('Contact Saved'), 'success');
1025 // add the recently viewed contact
1026 $recentOther = array();
1027 if (($session->get('userID') == $contact->id
) ||
1028 CRM_Contact_BAO_Contact_Permission
::allow($contact->id
, CRM_Core_Permission
::EDIT
)
1030 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/contact/add', 'reset=1&action=update&cid=' . $contact->id
);
1033 if (($session->get('userID') != $this->_contactId
) && CRM_Core_Permission
::check('delete contacts')) {
1034 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/contact/view/delete', 'reset=1&delete=1&cid=' . $contact->id
);
1037 CRM_Utils_Recent
::add($contact->display_name
,
1038 CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&cid=' . $contact->id
),
1040 $this->_contactType
,
1042 $contact->display_name
,
1046 // here we replace the user context with the url to view this contact
1047 $buttonName = $this->controller
->getButtonName();
1048 if ($buttonName == $this->getButtonName('upload', 'new')) {
1049 $resetStr = "reset=1&ct={$contact->contact_type}";
1050 $resetStr .= $this->_contactSubType ?
"&cst={$this->_contactSubType}" : '';
1051 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/add', $resetStr));
1054 $context = CRM_Utils_Request
::retrieve('context', 'String', $this);
1055 $qfKey = CRM_Utils_Request
::retrieve('key', 'String', $this);
1056 //validate the qfKey
1057 $urlParams = 'reset=1&cid=' . $contact->id
;
1059 $urlParams .= "&context=$context";
1061 if (CRM_Utils_Rule
::qfKey($qfKey)) {
1062 $urlParams .= "&key=$qfKey";
1065 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view', $urlParams));
1068 // now invoke the post hook
1069 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
1070 CRM_Utils_Hook
::post('edit', $params['contact_type'], $contact->id
, $contact);
1073 CRM_Utils_Hook
::post('create', $params['contact_type'], $contact->id
, $contact);
1078 * is there any real significant data in the hierarchical location array
1080 * @param array $fields the hierarchical value representation of this location
1082 * @return boolean true if data exists, false otherwise
1086 static function blockDataExists(&$fields) {
1087 if (!is_array($fields)) {
1091 static $skipFields = array('location_type_id', 'is_primary', 'phone_type_id', 'provider_id', 'country_id', 'website_type_id', 'master_id');
1092 foreach ($fields as $name => $value) {
1094 foreach ($skipFields as $skip) {
1095 if (strpos("[$skip]", $name) !== FALSE) {
1096 if ($name == 'phone') {
1106 if (is_array($value)) {
1107 if (self
::blockDataExists($value)) {
1112 if (!empty($value)) {
1122 * Function to that checks for duplicate contacts
1124 * @param array $fields fields array which are submitted
1125 * @param array $error error message array
1126 * @param int $contactID contact id
1127 * @param string $contactType contact type
1129 static function checkDuplicateContacts(&$fields, &$errors, $contactID, $contactType) {
1130 // if this is a forced save, ignore find duplicate rule
1131 if (empty($fields['_qf_Contact_upload_duplicate'])) {
1133 $dedupeParams = CRM_Dedupe_Finder
::formatParams($fields, $contactType);
1134 $ids = CRM_Dedupe_Finder
::dupesByParams($dedupeParams, $contactType, 'Supervised', array($contactID));
1137 $contactLinks = CRM_Contact_BAO_Contact_Utils
::formatContactIDSToLinks($ids, TRUE, TRUE, $contactID);
1139 $duplicateContactsLinks = '<div class="matching-contacts-found">';
1140 $duplicateContactsLinks .= ts('One matching contact was found. ', array('count' => count($contactLinks['rows']), 'plural' => '%count matching contacts were found.<br />'));
1141 if ($contactLinks['msg'] == 'view') {
1142 $duplicateContactsLinks .= ts('You can View the existing contact', array('count' => count($contactLinks['rows']), 'plural' => 'You can View the existing contacts'));
1145 $duplicateContactsLinks .= ts('You can View or Edit the existing contact', array('count' => count($contactLinks['rows']), 'plural' => 'You can View or Edit the existing contacts'));
1147 if ($contactLinks['msg'] == 'merge') {
1148 // We should also get a merge link if this is for an existing contact
1149 $duplicateContactsLinks .= ts(', or Merge this contact with an existing contact');
1151 $duplicateContactsLinks .= '.';
1152 $duplicateContactsLinks .= '</div>';
1153 $duplicateContactsLinks .= '<table class="matching-contacts-actions">';
1155 for ($i = 0; $i < count($contactLinks['rows']); $i++
) {
1157 $row .= ' <td class="matching-contacts-name"> ';
1158 $row .= $contactLinks['rows'][$i]['display_name'];
1160 $row .= ' <td class="matching-contacts-email"> ';
1161 $row .= $contactLinks['rows'][$i]['primary_email'];
1163 $row .= ' <td class="action-items"> ';
1164 $row .= $contactLinks['rows'][$i]['view'];
1165 $row .= $contactLinks['rows'][$i]['edit'];
1166 $row .= CRM_Utils_Array
::value('merge', $contactLinks['rows'][$i]);
1171 $duplicateContactsLinks .= $row . '</table>';
1172 $duplicateContactsLinks .= ts("If you're sure this record is not a duplicate, click the 'Save Matching Contact' button below.");
1174 $errors['_qf_default'] = $duplicateContactsLinks;
1178 // let smarty know that there are duplicates
1179 $template = CRM_Core_Smarty
::singleton();
1180 $template->assign('isDuplicate', 1);
1182 elseif (!empty($fields['_qf_Contact_refresh_dedupe'])) {
1183 // add a session message for no matching contacts
1184 CRM_Core_Session
::setStatus(ts('No matching contact found.'), ts('None Found'), 'info');
1189 function getTemplateFileName() {
1190 if ($this->_contactSubType
) {
1191 $templateFile = "CRM/Contact/Form/Edit/SubType/{$this->_contactSubType}.tpl";
1192 $template = CRM_Core_Form
::getTemplate();
1193 if ($template->template_exists($templateFile)) {
1194 return $templateFile;
1197 return parent
::getTemplateFileName();
1201 * Parse all address blocks present in given params
1202 * and return parse result for all address blocks,
1203 * This function either parse street address in to child
1204 * elements or build street address from child elements.
1206 * @params $params an array of key value consist of address blocks.
1208 * @return $parseSuccess as array of sucess/fails for each address block
1211 function parseAddress(&$params) {
1212 $parseSuccess = $parsedFields = array();
1213 if (!is_array($params['address']) ||
1214 CRM_Utils_System
::isNull($params['address'])
1216 return $parseSuccess;
1219 foreach ($params['address'] as $instance => & $address) {
1220 $buildStreetAddress = FALSE;
1221 $parseFieldName = 'street_address';
1223 'street_number', 'street_name', 'street_unit') as $fld) {
1224 if (!empty($address[$fld])) {
1225 $parseFieldName = 'street_number';
1226 $buildStreetAddress = TRUE;
1231 // main parse string.
1232 $parseString = CRM_Utils_Array
::value($parseFieldName, $address);
1234 // parse address field.
1235 $parsedFields = CRM_Core_BAO_Address
::parseStreetAddress($parseString);
1237 if ($buildStreetAddress) {
1238 //hack to ignore spaces between number and suffix.
1239 //here user gives input as street_number so it has to
1240 //be street_number and street_number_suffix, but
1241 //due to spaces though preg detect string as street_name
1242 //consider it as 'street_number_suffix'.
1243 $suffix = $parsedFields['street_number_suffix'];
1245 $suffix = $parsedFields['street_name'];
1247 $address['street_number_suffix'] = $suffix;
1248 $address['street_number'] = $parsedFields['street_number'];
1250 $streetAddress = NULL;
1252 'street_number', 'street_number_suffix', 'street_name', 'street_unit') as $fld) {
1253 if (in_array($fld, array(
1254 'street_name', 'street_unit'))) {
1255 $streetAddress .= ' ';
1257 $streetAddress .= CRM_Utils_Array
::value($fld, $address);
1259 $address['street_address'] = trim($streetAddress);
1260 $parseSuccess[$instance] = TRUE;
1264 // consider address is automatically parseable,
1265 // when we should found street_number and street_name
1266 if (empty($parsedFields['street_name']) ||
empty($parsedFields['street_number'])) {
1270 // check for original street address string.
1271 if (empty($parseString)) {
1275 $parseSuccess[$instance] = $success;
1277 // we do not reset element values, but keep what we've parsed
1278 // in case of partial matches: CRM-8378
1280 // merge parse address in to main address block.
1281 $address = array_merge($address, $parsedFields);
1285 return $parseSuccess;
1289 * check parse result and if some address block fails then this
1290 * function return the status message for all address blocks.
1292 * @param $parseResult an array of address blk instance and its status.
1294 * @return $statusMsg string status message for all address blocks.
1297 static function parseAddressStatusMsg($parseResult) {
1299 if (!is_array($parseResult) ||
empty($parseResult)) {
1303 $parseFails = array();
1304 foreach ($parseResult as $instance => $success) {
1306 $parseFails[] = self
::ordinalNumber($instance);
1310 if (!empty($parseFails)) {
1311 $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.",
1312 array(1 => implode(', ', $parseFails))
1320 * Convert normal number to ordinal number format.
1321 * like 1 => 1st, 2 => 2nd and so on...
1323 * @param $number int number to convert in to ordinal number.
1325 * @return ordinal number for given number.
1328 static function ordinalNumber($number) {
1329 if (empty($number)) {
1334 switch (floor($number / 10) %
10) {
1337 switch ($number %
10) {
1352 return "$number$str";
1356 * Update membership status to deceased
1357 * function return the status message for updated membership.
1359 * @param $deceasedParams array having contact id and deceased value.
1361 * @return $updateMembershipMsg string status message for updated membership.
1363 function updateMembershipStatus($deceasedParams) {
1364 $updateMembershipMsg = NULL;
1365 $contactId = CRM_Utils_Array
::value('contact_id', $deceasedParams);
1366 $deceasedDate = CRM_Utils_Array
::value('deceased_date', $deceasedParams);
1368 // process to set membership status to deceased for both active/inactive membership
1370 $this->_contactType
== 'Individual' && !empty($deceasedParams['is_deceased'])) {
1372 $session = CRM_Core_Session
::singleton();
1373 $userId = $session->get('userID');
1375 $userId = $contactId;
1379 // get deceased status id
1380 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
1381 $deceasedStatusId = array_search('Deceased', $allStatus);
1382 if (!$deceasedStatusId) {
1383 return $updateMembershipMsg;
1387 if ($deceasedDate && strtotime($deceasedDate) > $today) {
1388 return $updateMembershipMsg;
1391 // get non deceased membership
1392 $dao = new CRM_Member_DAO_Membership();
1393 $dao->contact_id
= $contactId;
1394 $dao->whereAdd("status_id != $deceasedStatusId");
1396 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, FALSE, FALSE, 'name');
1397 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
1399 while ($dao->fetch()) {
1400 // update status to deceased (for both active/inactive membership )
1401 CRM_Core_DAO
::setFieldValue('CRM_Member_DAO_Membership', $dao->id
,
1402 'status_id', $deceasedStatusId
1405 // add membership log
1406 $membershipLog = array(
1407 'membership_id' => $dao->id
,
1408 'status_id' => $deceasedStatusId,
1409 'start_date' => CRM_Utils_Date
::isoToMysql($dao->start_date
),
1410 'end_date' => CRM_Utils_Date
::isoToMysql($dao->end_date
),
1411 'modified_id' => $userId,
1412 'modified_date' => date('Ymd'),
1413 'membership_type_id' => $dao->membership_type_id
,
1414 'max_related' => $dao->max_related
,
1418 CRM_Member_BAO_MembershipLog
::add($membershipLog, CRM_Core_DAO
::$_nullArray);
1420 //create activity when membership status is changed
1421 $activityParam = array(
1422 'subject' => "Status changed from {$allStatus[$dao->status_id]} to {$allStatus[$deceasedStatusId]}",
1423 'source_contact_id' => $userId,
1424 'target_contact_id' => $dao->contact_id
,
1425 'source_record_id' => $dao->id
,
1426 'activity_type_id' => array_search('Change Membership Status', $activityTypes),
1430 'activity_date_time' => date('Y-m-d H:i:s'),
1432 'is_current_revision' => 1,
1435 $activityResult = civicrm_api('activity', 'create', $activityParam);
1442 $updateMembershipMsg = ts("%1 Current membership(s) for this contact have been set to 'Deceased' status.",
1443 array(1 => $memCount)
1448 return $updateMembershipMsg;