3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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
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 * Build all the data structures needed to build the form
135 public function preProcess() {
136 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, 'add');
138 $this->_dedupeButtonName
= $this->getButtonName('refresh', 'dedupe');
139 $this->_duplicateButtonName
= $this->getButtonName('upload', 'duplicate');
141 $session = CRM_Core_Session
::singleton();
142 if ($this->_action
== CRM_Core_Action
::ADD
) {
143 // check for add contacts permissions
144 if (!CRM_Core_Permission
::check('add contacts')) {
145 CRM_Utils_System
::permissionDenied();
146 CRM_Utils_System
::civiExit();
148 $this->_contactType
= CRM_Utils_Request
::retrieve('ct', 'String',
149 $this, TRUE, NULL, 'REQUEST'
151 if (!in_array($this->_contactType
,
152 array('Individual', 'Household', 'Organization')
155 CRM_Core_Error
::statusBounce(ts('Could not get a contact id and/or contact type'));
158 $this->_isContactSubType
= FALSE;
159 if ($this->_contactSubType
= CRM_Utils_Request
::retrieve('cst', 'String', $this)) {
160 $this->_isContactSubType
= TRUE;
164 $this->_contactSubType
&&
165 !(CRM_Contact_BAO_ContactType
::isExtendsContactType($this->_contactSubType
, $this->_contactType
, TRUE))
167 CRM_Core_Error
::statusBounce(ts("Could not get a valid contact subtype for contact type '%1'", array(1 => $this->_contactType
)));
170 $this->_gid
= CRM_Utils_Request
::retrieve('gid', 'Integer',
171 CRM_Core_DAO
::$_nullObject,
174 $this->_tid
= CRM_Utils_Request
::retrieve('tid', 'Integer',
175 CRM_Core_DAO
::$_nullObject,
178 $typeLabel = CRM_Contact_BAO_ContactType
::contactTypePairs(TRUE, $this->_contactSubType ?
179 $this->_contactSubType
: $this->_contactType
181 $typeLabel = implode(' / ', $typeLabel);
183 CRM_Utils_System
::setTitle(ts('New %1', array(1 => $typeLabel)));
184 $session->pushUserContext(CRM_Utils_System
::url('civicrm/dashboard', 'reset=1'));
185 $this->_contactId
= NULL;
189 if (!$this->_contactId
) {
190 $this->_contactId
= CRM_Utils_Request
::retrieve('cid', 'Positive', $this, TRUE);
193 if ($this->_contactId
) {
195 $params = array('id' => $this->_contactId
);
196 $returnProperities = array('id', 'contact_type', 'contact_sub_type', 'modified_date');
197 CRM_Core_DAO
::commonRetrieve('CRM_Contact_DAO_Contact', $params, $defaults, $returnProperities);
199 if (empty($defaults['id'])) {
200 CRM_Core_Error
::statusBounce(ts('A Contact with that ID does not exist: %1', array(1 => $this->_contactId
)));
203 $this->_contactType
= CRM_Utils_Array
::value('contact_type', $defaults);
204 $this->_contactSubType
= CRM_Utils_Array
::value('contact_sub_type', $defaults);
206 // check for permissions
207 $session = CRM_Core_Session
::singleton();
208 if (!CRM_Contact_BAO_Contact_Permission
::allow($this->_contactId
, CRM_Core_Permission
::EDIT
)) {
209 CRM_Core_Error
::statusBounce(ts('You do not have the necessary permission to edit this contact.'));
212 $displayName = CRM_Contact_BAO_Contact
::displayName($this->_contactId
);
213 $displayName = ts('Edit %1', array(1 => $displayName));
215 // Check if this is default domain contact CRM-10482
216 if (CRM_Contact_BAO_Contact
::checkDomainContact($this->_contactId
)) {
217 $displayName .= ' (' . ts('default organization') . ')';
220 // omitting contactImage from title for now since the summary overlay css doesn't work outside of our crm-container
221 CRM_Utils_System
::setTitle($displayName);
222 $context = CRM_Utils_Request
::retrieve('context', 'String', $this);
223 $qfKey = CRM_Utils_Request
::retrieve('key', 'String', $this);
225 $urlParams = 'reset=1&cid=' . $this->_contactId
;
227 $urlParams .= "&context=$context";
230 if (CRM_Utils_Rule
::qfKey($qfKey)) {
232 $urlParams .= "&key=$qfKey";
235 $session->pushUserContext(CRM_Utils_System
::url('civicrm/contact/view', $urlParams));
237 $values = $this->get('values');
238 // get contact values.
239 if (!empty($values)) {
240 $this->_values
= $values;
244 'id' => $this->_contactId
,
245 'contact_id' => $this->_contactId
,
246 'noRelationships' => TRUE,
251 $contact = CRM_Contact_BAO_Contact
::retrieve($params, $this->_values
, TRUE);
252 $this->set('values', $this->_values
);
256 CRM_Core_Error
::statusBounce(ts('Could not get a contact_id and/or contact_type'));
260 // parse street address, CRM-5450
261 $this->_parseStreetAddress
= $this->get('parseStreetAddress');
262 if (!isset($this->_parseStreetAddress
)) {
263 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
266 $this->_parseStreetAddress
= FALSE;
267 if (!empty($addressOptions['street_address']) && !empty($addressOptions['street_address_parsing'])) {
268 $this->_parseStreetAddress
= TRUE;
270 $this->set('parseStreetAddress', $this->_parseStreetAddress
);
272 $this->assign('parseStreetAddress', $this->_parseStreetAddress
);
274 $this->_editOptions
= $this->get('contactEditOptions');
275 if (CRM_Utils_System
::isNull($this->_editOptions
)) {
276 $this->_editOptions
= CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
277 'contact_edit_options', TRUE, NULL,
278 FALSE, 'name', TRUE, 'AND v.filter = 0'
280 $this->set('contactEditOptions', $this->_editOptions
);
283 // build demographics only for Individual contact type
284 if ($this->_contactType
!= 'Individual' &&
285 array_key_exists('Demographics', $this->_editOptions
)
287 unset($this->_editOptions
['Demographics']);
290 // in update mode don't show notes
291 if ($this->_contactId
&& array_key_exists('Notes', $this->_editOptions
)) {
292 unset($this->_editOptions
['Notes']);
295 $this->assign('editOptions', $this->_editOptions
);
296 $this->assign('contactType', $this->_contactType
);
297 $this->assign('contactSubType', $this->_contactSubType
);
299 //build contact subtype form element, CRM-6864
300 $buildContactSubType = TRUE;
301 if ($this->_contactSubType
&& ($this->_action
& CRM_Core_Action
::ADD
)) {
302 $buildContactSubType = FALSE;
304 $this->assign('buildContactSubType', $buildContactSubType);
306 // get the location blocks.
307 $this->_blocks
= $this->get('blocks');
308 if (CRM_Utils_System
::isNull($this->_blocks
)) {
309 $this->_blocks
= CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
310 'contact_edit_options', TRUE, NULL,
311 FALSE, 'name', TRUE, 'AND v.filter = 1'
313 $this->set('blocks', $this->_blocks
);
315 $this->assign('blocks', $this->_blocks
);
317 // this is needed for custom data.
318 $this->assign('entityID', $this->_contactId
);
320 // also keep the convention.
321 $this->assign('contactId', $this->_contactId
);
324 CRM_Contact_Form_Location
::preProcess($this);
326 // retain the multiple count custom fields value
327 if (!empty($_POST['hidden_custom'])) {
328 $customGroupCount = CRM_Utils_Array
::value('hidden_custom_group_count', $_POST);
330 if ($contactSubType = CRM_Utils_Array
::value('contact_sub_type', $_POST)) {
331 $paramSubType = implode(',', $contactSubType);
334 $this->_getCachedTree
= FALSE;
335 unset($customGroupCount[0]);
336 foreach ($customGroupCount as $groupID => $groupCount) {
337 if ($groupCount > 1) {
338 $this->set('groupID', $groupID);
340 for ($i = 0; $i <= $groupCount; $i++
) {
341 CRM_Custom_Form_CustomData
::preProcess($this, NULL, $contactSubType,
342 $i, $this->_contactType
344 CRM_Contact_Form_Edit_CustomData
::buildQuickForm($this);
349 //reset all the ajax stuff, for normal processing
350 if (isset($this->_groupTree
)) {
351 $this->_groupTree
= NULL;
353 $this->set('groupID', NULL);
354 $this->_getCachedTree
= TRUE;
357 // execute preProcess dynamically by js else execute normal preProcess
358 if (array_key_exists('CustomData', $this->_editOptions
)) {
359 //assign a parameter to pass for sub type multivalue
360 //custom field to load
361 if ($this->_contactSubType ||
isset($paramSubType)) {
362 $paramSubType = (isset($paramSubType)) ?
$paramSubType :
363 str_replace(CRM_Core_DAO
::VALUE_SEPARATOR
, ',', trim($this->_contactSubType
, CRM_Core_DAO
::VALUE_SEPARATOR
));
365 $this->assign('paramSubType', $paramSubType);
368 if (CRM_Utils_Request
::retrieve('type', 'String', CRM_Core_DAO
::$_nullObject)) {
369 CRM_Contact_Form_Edit_CustomData
::preProcess($this);
372 $contactSubType = $this->_contactSubType
;
373 // need contact sub type to build related grouptree array during post process
374 if (!empty($_POST['contact_sub_type'])) {
375 $contactSubType = $_POST['contact_sub_type'];
377 //only custom data has preprocess hence directly call it
378 CRM_Custom_Form_CustomData
::preProcess($this, NULL, $contactSubType,
379 1, $this->_contactType
, $this->_contactId
381 $this->assign('customValueCount', $this->_customValueCount
);
387 * Set default values for the form. Note that in edit/view mode
388 * the default values are retrieved from the database
393 public function setDefaultValues() {
394 $defaults = $this->_values
;
397 if ($this->_action
& CRM_Core_Action
::ADD
) {
398 if (array_key_exists('TagsAndGroups', $this->_editOptions
)) {
399 // set group and tag defaults if any
401 $defaults['group'][] = $this->_gid
;
404 $defaults['tag'][$this->_tid
] = 1;
407 if ($this->_contactSubType
) {
408 $defaults['contact_sub_type'] = $this->_contactSubType
;
412 foreach ($defaults['email'] as $dontCare => & $val) {
413 if (isset($val['signature_text'])) {
414 $val['signature_text_hidden'] = $val['signature_text'];
416 if (isset($val['signature_html'])) {
417 $val['signature_html_hidden'] = $val['signature_html'];
421 if (!empty($defaults['contact_sub_type'])) {
422 $defaults['contact_sub_type'] = $this->_oldSubtypes
;
425 // set defaults for blocks ( custom data, address, communication preference, notes, tags and groups )
426 foreach ($this->_editOptions
as $name => $label) {
427 if (!in_array($name, array('Address', 'Notes'))) {
428 $className = 'CRM_Contact_Form_Edit_' . $name;
429 $className::setDefaultValues($this, $defaults);
433 //set address block defaults
434 CRM_Contact_Form_Edit_Address
::setDefaultValues($defaults, $this);
436 if (!empty($defaults['image_URL'])) {
437 list($imageWidth, $imageHeight) = getimagesize(CRM_Utils_String
::unstupifyUrl($defaults['image_URL']));
438 list($imageThumbWidth, $imageThumbHeight) = CRM_Contact_BAO_Contact
::getThumbSize($imageWidth, $imageHeight);
439 $this->assign('imageWidth', $imageWidth);
440 $this->assign('imageHeight', $imageHeight);
441 $this->assign('imageThumbWidth', $imageThumbWidth);
442 $this->assign('imageThumbHeight', $imageThumbHeight);
443 $this->assign('imageURL', $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,
455 * primary location, default country
457 public function blockSetDefaults(&$defaults) {
458 $locationTypeKeys = array_filter(array_keys(CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id')), 'is_int');
459 sort($locationTypeKeys);
461 // get the default location type
462 $locationType = CRM_Core_BAO_LocationType
::getDefault();
464 // unset primary location type
465 $primaryLocationTypeIdKey = CRM_Utils_Array
::key($locationType->id
, $locationTypeKeys);
466 unset($locationTypeKeys[$primaryLocationTypeIdKey]);
468 // reset the array sequence
469 $locationTypeKeys = array_values($locationTypeKeys);
471 // get default phone and im provider id.
472 $defPhoneTypeId = key(CRM_Core_OptionGroup
::values('phone_type', FALSE, FALSE, FALSE, ' AND is_default = 1'));
473 $defIMProviderId = key(CRM_Core_OptionGroup
::values('instant_messenger_service',
474 FALSE, FALSE, FALSE, ' AND is_default = 1'
476 $defWebsiteTypeId = key(CRM_Core_OptionGroup
::values('website_type',
477 FALSE, FALSE, FALSE, ' AND is_default = 1'
480 $allBlocks = $this->_blocks
;
481 if (array_key_exists('Address', $this->_editOptions
)) {
482 $allBlocks['Address'] = $this->_editOptions
['Address'];
485 $config = CRM_Core_Config
::singleton();
486 foreach ($allBlocks as $blockName => $label) {
487 $name = strtolower($blockName);
488 $hasPrimary = $updateMode = FALSE;
490 // user is in update mode.
491 if (array_key_exists($name, $defaults) &&
492 !CRM_Utils_System
::isNull($defaults[$name])
497 for ($instance = 1; $instance <= $this->get($blockName . '_Block_Count'); $instance++
) {
498 // make we require one primary block, CRM-5505
501 $hasPrimary = CRM_Utils_Array
::value(
503 CRM_Utils_Array
::value($instance, $defaults[$name])
509 //set location to primary for first one.
510 if ($instance == 1) {
512 $defaults[$name][$instance]['is_primary'] = TRUE;
513 $defaults[$name][$instance]['location_type_id'] = $locationType->id
;
516 $locTypeId = isset($locationTypeKeys[$instance - 1]) ?
$locationTypeKeys[$instance - 1] : $locationType->id
;
517 $defaults[$name][$instance]['location_type_id'] = $locTypeId;
520 //set default country
521 if ($name == 'address' && $config->defaultContactCountry
) {
522 $defaults[$name][$instance]['country_id'] = $config->defaultContactCountry
;
525 //set default state/province
526 if ($name == 'address' && $config->defaultContactStateProvince
) {
527 $defaults[$name][$instance]['state_province_id'] = $config->defaultContactStateProvince
;
530 //set default phone type.
531 if ($name == 'phone' && $defPhoneTypeId) {
532 $defaults[$name][$instance]['phone_type_id'] = $defPhoneTypeId;
534 //set default website type.
535 if ($name == 'website' && $defWebsiteTypeId) {
536 $defaults[$name][$instance]['website_type_id'] = $defWebsiteTypeId;
539 //set default im provider.
540 if ($name == 'im' && $defIMProviderId) {
541 $defaults[$name][$instance]['provider_id'] = $defIMProviderId;
546 $defaults[$name][1]['is_primary'] = TRUE;
552 * add the rules (mainly global rules) for form.
553 * 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 = NULL) {
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)));
720 * Build the form object
724 public function buildQuickForm() {
725 //load form for child blocks
726 if ($this->_addBlockName
) {
727 $className = 'CRM_Contact_Form_Edit_' . $this->_addBlockName
;
728 return $className::buildQuickForm($this);
731 if ($this->_action
== CRM_Core_Action
::UPDATE
) {
732 $deleteExtra = ts('Are you sure you want to delete contact image.');
734 CRM_Core_Action
::DELETE
=> array(
735 'name' => ts('Delete Contact Image'),
736 'url' => 'civicrm/contact/image',
737 'qs' => 'reset=1&cid=%%id%%&action=delete',
739 'onclick = "if (confirm( \'' . $deleteExtra . '\' ) ) this.href+=\'&confirmed=1\'; else return false;"',
742 $deleteURL = CRM_Core_Action
::formLink($deleteURL,
743 CRM_Core_Action
::DELETE
,
745 'id' => $this->_contactId
,
749 'contact.image.delete',
753 $this->assign('deleteURL', $deleteURL);
756 //build contact type specific fields
757 $className = 'CRM_Contact_Form_Edit_' . $this->_contactType
;
758 $className::buildQuickForm($this);
760 // build Custom data if Custom data present in edit option
761 $buildCustomData = 'noCustomDataPresent';
762 if (array_key_exists('CustomData', $this->_editOptions
)) {
763 $buildCustomData = "customDataPresent";
766 // subtype is a common field. lets keep it here
767 $subtypes = CRM_Contact_BAO_Contact
::buildOptions('contact_sub_type', 'create', array('contact_type' => $this->_contactType
));
768 if (!empty($subtypes)) {
769 $sel = $this->add('select', 'contact_sub_type', ts('Contact Type'),
772 'id' => 'contact_sub_type',
773 'multiple' => 'multiple',
774 'class' => $buildCustomData . ' crm-select2',
779 // build edit blocks ( custom data, demographics, communication preference, notes, tags and groups )
780 foreach ($this->_editOptions
as $name => $label) {
781 if ($name == 'Address') {
782 $this->_blocks
['Address'] = $this->_editOptions
['Address'];
785 if ($name == 'TagsAndGroups') {
788 $className = 'CRM_Contact_Form_Edit_' . $name;
789 $className::buildQuickForm($this);
792 // build tags and groups
793 CRM_Contact_Form_Edit_TagsAndGroups
::buildQuickForm($this, 0, CRM_Contact_Form_Edit_TagsAndGroups
::ALL
,
794 FALSE, NULL, 'Group(s)', 'Tag(s)', NULL, 'select');
796 // build location blocks.
797 CRM_Contact_Form_Edit_Lock
::buildQuickForm($this);
798 CRM_Contact_Form_Location
::buildQuickForm($this);
801 $this->addElement('file', 'image_URL', ts('Browse/Upload Image'), 'size=30 maxlength=60');
802 $this->addUploadElement('image_URL');
804 // add the dedupe button
805 $this->addElement('submit',
806 $this->_dedupeButtonName
,
807 ts('Check for Matching Contact(s)')
809 $this->addElement('submit',
810 $this->_duplicateButtonName
,
811 ts('Save Matching Contact')
813 $this->addElement('submit',
814 $this->getButtonName('next', 'sharedHouseholdDuplicate'),
815 ts('Save With Duplicate Household')
821 'name' => ts('Save'),
826 if (CRM_Core_Permission
::check('add contacts')) {
829 'name' => ts('Save and New'),
830 'spacing' => ' ',
836 'name' => ts('Cancel'),
839 if (!empty($this->_values
['contact_sub_type'])) {
840 $this->_oldSubtypes
= explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
841 trim($this->_values
['contact_sub_type'], CRM_Core_DAO
::VALUE_SEPARATOR
)
844 $this->assign('oldSubtypes', json_encode($this->_oldSubtypes
));
846 $this->addButtons($buttons);
850 * Form submission of new/edit contact is processed.
855 public function postProcess() {
856 // check if dedupe button, if so return.
857 $buttonName = $this->controller
->getButtonName();
858 if ($buttonName == $this->_dedupeButtonName
) {
862 //get the submitted values in an array
863 $params = $this->controller
->exportValues($this->_name
);
865 $group = CRM_Utils_Array
::value('group', $params);
866 if (!empty($group) && is_array($group)) {
867 unset($params['group']);
868 foreach ($group as $key => $value) {
869 $params['group'][$value] = 1;
873 CRM_Contact_BAO_Contact_Optimizer
::edit($params, $this->_preEditValues
);
875 if (!empty($params['image_URL'])) {
876 CRM_Contact_BAO_Contact
::processImageParams($params);
879 if (is_numeric(CRM_Utils_Array
::value('current_employer_id', $params)) && !empty($params['current_employer'])) {
880 $params['current_employer'] = $params['current_employer_id'];
883 // don't carry current_employer_id field,
884 // since we don't want to directly update DAO object without
885 // handling related business logic ( eg related membership )
886 if (isset($params['current_employer_id'])) {
887 unset($params['current_employer_id']);
890 $params['contact_type'] = $this->_contactType
;
891 if (empty($params['contact_sub_type']) && $this->_isContactSubType
) {
892 $params['contact_sub_type'] = array($this->_contactSubType
);
895 if ($this->_contactId
) {
896 $params['contact_id'] = $this->_contactId
;
899 //make deceased date null when is_deceased = false
900 if ($this->_contactType
== 'Individual' && !empty($this->_editOptions
['Demographics']) && empty($params['is_deceased'])) {
901 $params['is_deceased'] = FALSE;
902 $params['deceased_date'] = NULL;
905 if (isset($params['contact_id'])) {
906 // process membership status for deceased contact
907 $deceasedParams = array(
908 'contact_id' => CRM_Utils_Array
::value('contact_id', $params),
909 'is_deceased' => CRM_Utils_Array
::value('is_deceased', $params, FALSE),
910 'deceased_date' => CRM_Utils_Array
::value('deceased_date', $params, NULL),
912 $updateMembershipMsg = $this->updateMembershipStatus($deceasedParams);
915 // action is taken depending upon the mode
916 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
917 CRM_Utils_Hook
::pre('edit', $params['contact_type'], $params['contact_id'], $params);
920 CRM_Utils_Hook
::pre('create', $params['contact_type'], NULL, $params);
923 $customFields = CRM_Core_BAO_CustomField
::getFields($params['contact_type'], FALSE, TRUE);
926 //if subtype is set, send subtype as extend to validate subtype customfield
927 $customFieldExtends = (CRM_Utils_Array
::value('contact_sub_type', $params)) ?
$params['contact_sub_type'] : $params['contact_type'];
929 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess($params,
935 if ($this->_contactId
&& !empty($this->_oldSubtypes
)) {
936 CRM_Contact_BAO_ContactType
::deleteCustomSetForSubtypeMigration($this->_contactId
,
937 $params['contact_type'],
939 $params['contact_sub_type']
943 if (array_key_exists('CommunicationPreferences', $this->_editOptions
)) {
944 // this is a chekbox, so mark false if we dont get a POST value
945 $params['is_opt_out'] = CRM_Utils_Array
::value('is_opt_out', $params, FALSE);
948 // process shared contact address.
949 CRM_Contact_BAO_Contact_Utils
::processSharedAddress($params['address']);
951 if (!array_key_exists('TagsAndGroups', $this->_editOptions
) && !empty($params['group'])) {
952 unset($params['group']);
955 if (!empty($params['contact_id']) && ($this->_action
& CRM_Core_Action
::UPDATE
) && !empty($params['group'])) {
956 // figure out which all groups are intended to be removed
957 $contactGroupList = CRM_Contact_BAO_GroupContact
::getContactGroup($params['contact_id'], 'Added');
958 if (is_array($contactGroupList)) {
959 foreach ($contactGroupList as $key) {
960 if ((!array_key_exists($key['group_id'], $params['group']) ||
$params['group'][$key['group_id']] != 1) && empty($key['is_hidden'])) {
961 $params['group'][$key['group_id']] = -1;
967 // parse street address, CRM-5450
968 $parseStatusMsg = NULL;
969 if ($this->_parseStreetAddress
) {
970 $parseResult = self
::parseAddress($params);
971 $parseStatusMsg = self
::parseAddressStatusMsg($parseResult);
974 // Allow un-setting of location info, CRM-5969
975 $params['updateBlankLocInfo'] = TRUE;
977 $contact = CRM_Contact_BAO_Contact
::create($params, TRUE, FALSE, TRUE);
980 if ($this->_contactId
) {
981 $message = ts('%1 has been updated.', array(1 => $contact->display_name
));
984 $message = ts('%1 has been created.', array(1 => $contact->display_name
));
987 // set the contact ID
988 $this->_contactId
= $contact->id
;
990 if (array_key_exists('TagsAndGroups', $this->_editOptions
)) {
991 //add contact to tags
992 CRM_Core_BAO_EntityTag
::create($params['tag'], 'civicrm_contact', $params['contact_id']);
995 if (isset($params['contact_taglist']) && !empty($params['contact_taglist'])) {
996 CRM_Core_Form_Tag
::postProcess($params['contact_taglist'], $params['contact_id'], 'civicrm_contact', $this);
1000 if (!empty($parseStatusMsg)) {
1001 $message .= "<br />$parseStatusMsg";
1003 if (!empty($updateMembershipMsg)) {
1004 $message .= "<br />$updateMembershipMsg";
1007 $session = CRM_Core_Session
::singleton();
1008 $session->setStatus($message, ts('Contact Saved'), 'success');
1010 // add the recently viewed contact
1011 $recentOther = array();
1012 if (($session->get('userID') == $contact->id
) ||
1013 CRM_Contact_BAO_Contact_Permission
::allow($contact->id
, CRM_Core_Permission
::EDIT
)
1015 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/contact/add', 'reset=1&action=update&cid=' . $contact->id
);
1018 if (($session->get('userID') != $this->_contactId
) && CRM_Core_Permission
::check('delete contacts')) {
1019 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/contact/view/delete', 'reset=1&delete=1&cid=' . $contact->id
);
1022 CRM_Utils_Recent
::add($contact->display_name
,
1023 CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&cid=' . $contact->id
),
1025 $this->_contactType
,
1027 $contact->display_name
,
1031 // here we replace the user context with the url to view this contact
1032 $buttonName = $this->controller
->getButtonName();
1033 if ($buttonName == $this->getButtonName('upload', 'new')) {
1034 $resetStr = "reset=1&ct={$contact->contact_type}";
1035 $resetStr .= $this->_contactSubType ?
"&cst={$this->_contactSubType}" : '';
1036 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/add', $resetStr));
1039 $context = CRM_Utils_Request
::retrieve('context', 'String', $this);
1040 $qfKey = CRM_Utils_Request
::retrieve('key', 'String', $this);
1041 //validate the qfKey
1042 $urlParams = 'reset=1&cid=' . $contact->id
;
1044 $urlParams .= "&context=$context";
1046 if (CRM_Utils_Rule
::qfKey($qfKey)) {
1047 $urlParams .= "&key=$qfKey";
1050 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view', $urlParams));
1053 // now invoke the post hook
1054 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
1055 CRM_Utils_Hook
::post('edit', $params['contact_type'], $contact->id
, $contact);
1058 CRM_Utils_Hook
::post('create', $params['contact_type'], $contact->id
, $contact);
1063 * Is there any real significant data in the hierarchical location array
1065 * @param array $fields
1066 * The hierarchical value representation of this location.
1069 * true if data exists, false otherwise
1071 public static function blockDataExists(&$fields) {
1072 if (!is_array($fields)) {
1076 static $skipFields = array(
1085 foreach ($fields as $name => $value) {
1087 foreach ($skipFields as $skip) {
1088 if (strpos("[$skip]", $name) !== FALSE) {
1089 if ($name == 'phone') {
1099 if (is_array($value)) {
1100 if (self
::blockDataExists($value)) {
1105 if (!empty($value)) {
1115 * That checks for duplicate contacts
1117 * @param array $fields
1118 * Fields array which are submitted.
1120 * @param int $contactID
1122 * @param string $contactType
1125 public static function checkDuplicateContacts(&$fields, &$errors, $contactID, $contactType) {
1126 // if this is a forced save, ignore find duplicate rule
1127 if (empty($fields['_qf_Contact_upload_duplicate'])) {
1129 $dedupeParams = CRM_Dedupe_Finder
::formatParams($fields, $contactType);
1130 $ids = CRM_Dedupe_Finder
::dupesByParams($dedupeParams, $contactType, 'Supervised', array($contactID));
1133 $contactLinks = CRM_Contact_BAO_Contact_Utils
::formatContactIDSToLinks($ids, TRUE, TRUE, $contactID);
1135 $duplicateContactsLinks = '<div class="matching-contacts-found">';
1136 $duplicateContactsLinks .= ts('One matching contact was found. ', array(
1137 'count' => count($contactLinks['rows']),
1138 'plural' => '%count matching contacts were found.<br />',
1140 if ($contactLinks['msg'] == 'view') {
1141 $duplicateContactsLinks .= ts('You can View the existing contact', array(
1142 'count' => count($contactLinks['rows']),
1143 'plural' => 'You can View the existing contacts',
1147 $duplicateContactsLinks .= ts('You can View or Edit the existing contact', array(
1148 'count' => count($contactLinks['rows']),
1149 'plural' => 'You can View or Edit the existing contacts',
1152 if ($contactLinks['msg'] == 'merge') {
1153 // We should also get a merge link if this is for an existing contact
1154 $duplicateContactsLinks .= ts(', or Merge this contact with an existing contact');
1156 $duplicateContactsLinks .= '.';
1157 $duplicateContactsLinks .= '</div>';
1158 $duplicateContactsLinks .= '<table class="matching-contacts-actions">';
1160 for ($i = 0; $i < count($contactLinks['rows']); $i++
) {
1162 $row .= ' <td class="matching-contacts-name"> ';
1163 $row .= $contactLinks['rows'][$i]['display_name'];
1165 $row .= ' <td class="matching-contacts-email"> ';
1166 $row .= $contactLinks['rows'][$i]['primary_email'];
1168 $row .= ' <td class="action-items"> ';
1169 $row .= $contactLinks['rows'][$i]['view'];
1170 $row .= $contactLinks['rows'][$i]['edit'];
1171 $row .= CRM_Utils_Array
::value('merge', $contactLinks['rows'][$i]);
1176 $duplicateContactsLinks .= $row . '</table>';
1177 $duplicateContactsLinks .= ts("If you're sure this record is not a duplicate, click the 'Save Matching Contact' button below.");
1179 $errors['_qf_default'] = $duplicateContactsLinks;
1181 // let smarty know that there are duplicates
1182 $template = CRM_Core_Smarty
::singleton();
1183 $template->assign('isDuplicate', 1);
1185 elseif (!empty($fields['_qf_Contact_refresh_dedupe'])) {
1186 // add a session message for no matching contacts
1187 CRM_Core_Session
::setStatus(ts('No matching contact found.'), ts('None Found'), 'info');
1193 * Use the form name to create the tpl file name
1197 public function getTemplateFileName() {
1198 if ($this->_contactSubType
) {
1199 $templateFile = "CRM/Contact/Form/Edit/SubType/{$this->_contactSubType}.tpl";
1200 $template = CRM_Core_Form
::getTemplate();
1201 if ($template->template_exists($templateFile)) {
1202 return $templateFile;
1205 return parent
::getTemplateFileName();
1209 * Parse all address blocks present in given params
1210 * and return parse result for all address blocks,
1211 * This function either parse street address in to child
1212 * elements or build street address from child elements.
1214 * @param array $params
1215 * of key value consist of address blocks.
1218 * as array of sucess/fails for each address block
1220 public function parseAddress(&$params) {
1221 $parseSuccess = $parsedFields = array();
1222 if (!is_array($params['address']) ||
1223 CRM_Utils_System
::isNull($params['address'])
1225 return $parseSuccess;
1228 foreach ($params['address'] as $instance => & $address) {
1229 $buildStreetAddress = FALSE;
1230 $parseFieldName = 'street_address';
1236 if (!empty($address[$fld])) {
1237 $parseFieldName = 'street_number';
1238 $buildStreetAddress = TRUE;
1243 // main parse string.
1244 $parseString = CRM_Utils_Array
::value($parseFieldName, $address);
1246 // parse address field.
1247 $parsedFields = CRM_Core_BAO_Address
::parseStreetAddress($parseString);
1249 if ($buildStreetAddress) {
1250 //hack to ignore spaces between number and suffix.
1251 //here user gives input as street_number so it has to
1252 //be street_number and street_number_suffix, but
1253 //due to spaces though preg detect string as street_name
1254 //consider it as 'street_number_suffix'.
1255 $suffix = $parsedFields['street_number_suffix'];
1257 $suffix = $parsedFields['street_name'];
1259 $address['street_number_suffix'] = $suffix;
1260 $address['street_number'] = $parsedFields['street_number'];
1262 $streetAddress = NULL;
1265 'street_number_suffix',
1269 if (in_array($fld, array(
1273 $streetAddress .= ' ';
1275 $streetAddress .= CRM_Utils_Array
::value($fld, $address);
1277 $address['street_address'] = trim($streetAddress);
1278 $parseSuccess[$instance] = TRUE;
1282 // consider address is automatically parseable,
1283 // when we should found street_number and street_name
1284 if (empty($parsedFields['street_name']) ||
empty($parsedFields['street_number'])) {
1288 // check for original street address string.
1289 if (empty($parseString)) {
1293 $parseSuccess[$instance] = $success;
1295 // we do not reset element values, but keep what we've parsed
1296 // in case of partial matches: CRM-8378
1298 // merge parse address in to main address block.
1299 $address = array_merge($address, $parsedFields);
1303 return $parseSuccess;
1307 * Check parse result and if some address block fails then this
1308 * function return the status message for all address blocks.
1310 * @param array $parseResult
1311 * An array of address blk instance and its status.
1313 * @return null|string
1314 * $statusMsg string status message for all address blocks.
1316 public static function parseAddressStatusMsg($parseResult) {
1318 if (!is_array($parseResult) ||
empty($parseResult)) {
1322 $parseFails = array();
1323 foreach ($parseResult as $instance => $success) {
1325 $parseFails[] = self
::ordinalNumber($instance);
1329 if (!empty($parseFails)) {
1330 $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.",
1331 array(1 => implode(', ', $parseFails))
1339 * Convert normal number to ordinal number format.
1340 * like 1 => 1st, 2 => 2nd and so on...
1342 * @param int $number
1343 * number to convert in to ordinal number.
1346 * ordinal number for given number.
1348 public static function ordinalNumber($number) {
1349 if (empty($number)) {
1354 switch (floor($number / 10) %
10) {
1357 switch ($number %
10) {
1372 return "$number$str";
1376 * Update membership status to deceased
1377 * function return the status message for updated membership.
1379 * @param array $deceasedParams
1380 * having contact id and deceased value.
1382 * @return null|string
1383 * $updateMembershipMsg string status message for updated membership.
1385 public function updateMembershipStatus($deceasedParams) {
1386 $updateMembershipMsg = NULL;
1387 $contactId = CRM_Utils_Array
::value('contact_id', $deceasedParams);
1388 $deceasedDate = CRM_Utils_Array
::value('deceased_date', $deceasedParams);
1390 // process to set membership status to deceased for both active/inactive membership
1392 $this->_contactType
== 'Individual' && !empty($deceasedParams['is_deceased'])
1395 $session = CRM_Core_Session
::singleton();
1396 $userId = $session->get('userID');
1398 $userId = $contactId;
1401 // get deceased status id
1402 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
1403 $deceasedStatusId = array_search('Deceased', $allStatus);
1404 if (!$deceasedStatusId) {
1405 return $updateMembershipMsg;
1409 if ($deceasedDate && strtotime($deceasedDate) > $today) {
1410 return $updateMembershipMsg;
1413 // get non deceased membership
1414 $dao = new CRM_Member_DAO_Membership();
1415 $dao->contact_id
= $contactId;
1416 $dao->whereAdd("status_id != $deceasedStatusId");
1418 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, FALSE, FALSE, 'name');
1419 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
1421 while ($dao->fetch()) {
1422 // update status to deceased (for both active/inactive membership )
1423 CRM_Core_DAO
::setFieldValue('CRM_Member_DAO_Membership', $dao->id
,
1424 'status_id', $deceasedStatusId
1427 // add membership log
1428 $membershipLog = array(
1429 'membership_id' => $dao->id
,
1430 'status_id' => $deceasedStatusId,
1431 'start_date' => CRM_Utils_Date
::isoToMysql($dao->start_date
),
1432 'end_date' => CRM_Utils_Date
::isoToMysql($dao->end_date
),
1433 'modified_id' => $userId,
1434 'modified_date' => date('Ymd'),
1435 'membership_type_id' => $dao->membership_type_id
,
1436 'max_related' => $dao->max_related
,
1439 CRM_Member_BAO_MembershipLog
::add($membershipLog, CRM_Core_DAO
::$_nullArray);
1441 //create activity when membership status is changed
1442 $activityParam = array(
1443 'subject' => "Status changed from {$allStatus[$dao->status_id]} to {$allStatus[$deceasedStatusId]}",
1444 'source_contact_id' => $userId,
1445 'target_contact_id' => $dao->contact_id
,
1446 'source_record_id' => $dao->id
,
1447 'activity_type_id' => array_search('Change Membership Status', $activityTypes),
1451 'activity_date_time' => date('Y-m-d H:i:s'),
1453 'is_current_revision' => 1,
1456 $activityResult = civicrm_api('activity', 'create', $activityParam);
1463 $updateMembershipMsg = ts("%1 Current membership(s) for this contact have been set to 'Deceased' status.",
1464 array(1 => $memCount)
1469 return $updateMembershipMsg;