3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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-2019
36 * This class generates form components for custom data
38 * It delegates the work to lower level subclasses and integrates the changes
39 * back in. It also uses a lot of functionality with the CRM API's, so any change
40 * made here could potentially affect the API etc. Be careful, be aware, use unit tests.
43 class CRM_Profile_Form
extends CRM_Core_Form
{
52 protected $_skipPermission = FALSE;
55 * The contact id that we are editing.
62 * The group id that we are editing.
69 * @var array details of the UFGroup used on this page
71 protected $_ufGroup = array('name' => 'unknown');
74 * The group id that we are passing in url.
81 * Name of button for saving matching contacts.
84 protected $_duplicateButtonName;
86 * The title of the category we are editing.
93 * The fields needed to build this form.
100 * store contact details.
107 * Do we allow updates of the contact.
111 public $_isUpdateDupe = 0;
114 * Dedupe using a specific rule (CRM-6131).
115 * Not currently exposed in profile settings, but can be set in a buildForm hook.
117 public $_ruleGroupID = NULL;
119 public $_isAddCaptcha = FALSE;
121 protected $_isPermissionedChecksum = FALSE;
124 * THe context from which we came from, allows us to go there if redirect not set.
131 * THe contact type for registration case.
135 protected $_ctype = NULL;
138 * Store profile ids if multiple profile ids are passed using comma separated.
139 * Currently lets implement this functionality only for dialog mode.
141 protected $_profileIds = array();
144 * Contact profile having activity fields?
148 protected $_isContactActivityProfile = FALSE;
151 * Activity Id connected to the profile.
155 protected $_activityId = NULL;
158 protected $_multiRecordFields = NULL;
160 protected $_recordId = NULL;
163 * Action for multi record profile (create/edit/delete).
167 protected $_multiRecord = NULL;
169 protected $_multiRecordProfile = FALSE;
171 protected $_recordExists = TRUE;
173 protected $_customGroupTitle = NULL;
175 protected $_deleteButtonName = NULL;
177 protected $_customGroupId = NULL;
179 protected $_currentUserID = NULL;
180 protected $_session = NULL;
183 * Check for any duplicates.
185 * Depending on form settings & usage scenario we potentially use the found id,
186 * create links to found ids or add an error.
188 * @param array $errors
189 * @param array $fields
190 * @param CRM_Profile_Form $form
194 protected static function handleDuplicateChecking(&$errors, $fields, $form) {
195 if ($form->_mode
== CRM_Profile_Form
::MODE_CREATE
) {
200 // for edit mode we need to allow our own record to be a dupe match!
201 $exceptions = [$form->_session
->get('userID')];
203 $contactType = CRM_Core_BAO_UFGroup
::getContactType($form->_gid
);
204 // If all profile fields is of Contact Type then consider
205 // profile is of Individual type(default).
207 $contactType = 'Individual';
210 $ids = CRM_Contact_BAO_Contact
::getDuplicateContacts(
211 $fields, $contactType,
212 ($form->_context
=== 'dialog' ?
'Supervised' : 'Unsupervised'),
218 if ($form->_isUpdateDupe
== 2) {
219 CRM_Core_Session
::setStatus(ts('Note: this contact may be a duplicate of an existing record.'), ts('Possible Duplicate Detected'), 'alert');
221 elseif ($form->_isUpdateDupe
== 1) {
222 $form->_id
= $ids[0];
225 if ($form->_context
== 'dialog') {
226 $contactLinks = CRM_Contact_BAO_Contact_Utils
::formatContactIDSToLinks($ids, TRUE, TRUE);
228 $duplicateContactsLinks = '<div class="matching-contacts-found">';
229 $duplicateContactsLinks .= ts('One matching contact was found. ', [
230 'count' => count($contactLinks['rows']),
231 'plural' => '%count matching contacts were found.<br />',
233 if ($contactLinks['msg'] == 'view') {
234 $duplicateContactsLinks .= ts('You can View the existing contact.', [
235 'count' => count($contactLinks['rows']),
236 'plural' => 'You can View the existing contacts.',
240 $duplicateContactsLinks .= ts('You can View or Edit the existing contact.', [
241 'count' => count($contactLinks['rows']),
242 'plural' => 'You can View or Edit the existing contacts.',
245 $duplicateContactsLinks .= '</div>';
246 $duplicateContactsLinks .= '<table class="matching-contacts-actions">';
248 for ($i = 0; $i < count($contactLinks['rows']); $i++
) {
250 $row .= ' <td class="matching-contacts-name"> ';
251 $row .= $contactLinks['rows'][$i]['display_name'];
253 $row .= ' <td class="matching-contacts-email"> ';
254 $row .= $contactLinks['rows'][$i]['primary_email'];
256 $row .= ' <td class="action-items"> ';
257 $row .= $contactLinks['rows'][$i]['view'] . ' ';
258 $row .= $contactLinks['rows'][$i]['edit'];
263 $duplicateContactsLinks .= $row . '</table>';
264 $duplicateContactsLinks .= "If you're sure this record is not a duplicate, click the 'Save Matching Contact' button below.";
266 $errors['_qf_default'] = $duplicateContactsLinks;
268 // let smarty know that there are duplicates
269 $template = CRM_Core_Smarty
::singleton();
270 $template->assign('isDuplicate', 1);
273 $errors['_qf_default'] = ts('A record already exists with the same information.');
281 * Explicitly declare the entity api name.
283 public function getDefaultEntity() {
288 * Pre processing work done here.
290 * gets session variables for table name, id of entity in table, type of entity and stores them.
292 public function preProcess() {
293 $this->_id
= $this->get('id');
294 $this->_profileIds
= $this->get('profileIds');
295 $this->_grid
= CRM_Utils_Request
::retrieve('grid', 'Integer', $this);
296 $this->_context
= CRM_Utils_Request
::retrieve('context', 'Alphanumeric', $this);
298 //unset from session when $_GET doesn't have it
299 //except when the form is submitted
301 if (!array_key_exists('multiRecord', $_GET)) {
302 $this->set('multiRecord', NULL);
304 if (!array_key_exists('recordId', $_GET)) {
305 $this->set('recordId', NULL);
309 $this->_session
= CRM_Core_Session
::singleton();
310 $this->_currentUserID
= $this->_session
->get('userID');
312 if ($this->_mode
== self
::MODE_EDIT
) {
313 //specifies the action being done on a multi record field
314 $multiRecordAction = CRM_Utils_Request
::retrieve('multiRecord', 'String', $this);
315 $this->_multiRecord
= (!is_numeric($multiRecordAction)) ? CRM_Core_Action
::resolve($multiRecordAction) : $multiRecordAction;
316 if ($this->_multiRecord
) {
317 $this->set('multiRecord', $this->_multiRecord
);
320 if ($this->_multiRecord
&&
321 !in_array($this->_multiRecord
, array(CRM_Core_Action
::UPDATE
, CRM_Core_Action
::ADD
, CRM_Core_Action
::DELETE
))
323 CRM_Core_Error
::fatal(ts('Proper action not specified for this custom value record profile'));
326 $this->_duplicateButtonName
= $this->getButtonName('upload', 'duplicate');
328 $gids = explode(',', CRM_Utils_Request
::retrieve('gid', 'String', CRM_Core_DAO
::$_nullObject, FALSE, 0));
330 if ((count($gids) > 1) && !$this->_profileIds
&& empty($this->_profileIds
)) {
332 foreach ($gids as $pfId) {
333 $this->_profileIds
[] = CRM_Utils_Type
::escape($pfId, 'Positive');
337 // check if we are rendering mixed profiles
338 if (CRM_Core_BAO_UFGroup
::checkForMixProfiles($this->_profileIds
)) {
339 CRM_Core_Error
::fatal(ts('You cannot combine profiles of multiple types.'));
342 // for now consider 1'st profile as primary profile and validate it
343 // i.e check for profile type etc.
344 // FIX ME: validations for other than primary
345 $this->_gid
= $this->_profileIds
[0];
346 $this->set('gid', $this->_gid
);
347 $this->set('profileIds', $this->_profileIds
);
351 $this->_gid
= CRM_Utils_Request
::retrieve('gid', 'Positive', $this, FALSE, 0);
352 $this->set('gid', $this->_gid
);
355 $this->_activityId
= CRM_Utils_Request
::retrieve('aid', 'Positive', $this, FALSE, 0, 'GET');
356 if (is_numeric($this->_activityId
)) {
357 $latestRevisionId = CRM_Activity_BAO_Activity
::getLatestActivityId($this->_activityId
);
358 if ($latestRevisionId) {
359 $this->_activityId
= $latestRevisionId;
362 $this->_isContactActivityProfile
= CRM_Core_BAO_UFField
::checkContactActivityProfileType($this->_gid
);
364 //get values for ufGroupName, captcha and dupe update.
366 $dao = new CRM_Core_DAO_UFGroup();
367 $dao->id
= $this->_gid
;
368 if ($dao->find(TRUE)) {
369 $this->_isUpdateDupe
= $dao->is_update_dupe
;
370 $this->_isAddCaptcha
= $dao->add_captcha
;
371 $this->_ufGroup
= (array) $dao;
375 if (!CRM_Utils_Array
::value('is_active', $this->_ufGroup
)) {
376 CRM_Core_Error
::fatal(ts('The requested profile (gid=%1) is inactive or does not exist.', array(
381 $this->assign('ufGroupName', $this->_ufGroup
['name']);
383 $gids = empty($this->_profileIds
) ?
$this->_gid
: $this->_profileIds
;
385 // if we don't have a gid use the default, else just use that specific gid
386 if (($this->_mode
== self
::MODE_REGISTER ||
$this->_mode
== self
::MODE_CREATE
) && !$this->_gid
) {
387 $this->_ctype
= CRM_Utils_Request
::retrieve('ctype', 'String', $this, FALSE, 'Individual', 'REQUEST');
388 $this->_fields
= CRM_Core_BAO_UFGroup
::getRegistrationFields($this->_action
, $this->_mode
, $this->_ctype
);
390 elseif ($this->_mode
== self
::MODE_SEARCH
) {
391 $this->_fields
= CRM_Core_BAO_UFGroup
::getListingFields($this->_action
,
392 CRM_Core_BAO_UFGroup
::PUBLIC_VISIBILITY | CRM_Core_BAO_UFGroup
::LISTINGS_VISIBILITY
,
396 $this->_skipPermission
,
397 CRM_Core_Permission
::SEARCH
401 $this->_fields
= CRM_Core_BAO_UFGroup
::getFields($gids, FALSE, NULL,
404 $this->_skipPermission
,
406 ($this->_action
== CRM_Core_Action
::ADD
) ? CRM_Core_Permission
::CREATE
: CRM_Core_Permission
::EDIT
408 $multiRecordFieldListing = FALSE;
409 //using selector for listing of multi-record fields
410 if ($this->_mode
== self
::MODE_EDIT
&& $this->_gid
) {
411 CRM_Core_BAO_UFGroup
::shiftMultiRecordFields($this->_fields
, $this->_multiRecordFields
);
413 if ($this->_multiRecord
) {
414 if ($this->_multiRecord
!= CRM_Core_Action
::ADD
) {
415 $this->_recordId
= CRM_Utils_Request
::retrieve('recordId', 'Positive', $this);
418 $this->_recordId
= NULL;
419 $this->set('recordId', NULL);
421 //record id is necessary for _multiRecord view and update/edit action
422 if (!$this->_recordId
423 && ($this->_multiRecord
== CRM_Core_Action
::UPDATE ||
$this->_multiRecord
== CRM_Core_Action
::DELETE
)
425 CRM_Core_Error
::fatal(ts('The requested Profile (gid=%1) requires record id while performing this action',
426 array(1 => $this->_gid
)
429 elseif (empty($this->_multiRecordFields
)) {
430 CRM_Core_Error
::fatal(ts('No Multi-Record Fields configured for this profile (gid=%1)',
431 array(1 => $this->_gid
)
435 $fieldId = CRM_Core_BAO_CustomField
::getKeyID(key($this->_multiRecordFields
));
436 $customGroupDetails = CRM_Core_BAO_CustomGroup
::getGroupTitles(array($fieldId));
437 $this->_customGroupTitle
= $customGroupDetails[$fieldId]['groupTitle'];
438 $this->_customGroupId
= $customGroupDetails[$fieldId]['groupID'];
440 if ($this->_multiRecord
== CRM_Core_Action
::UPDATE ||
$this->_multiRecord
== CRM_Core_Action
::DELETE
) {
441 //record exists check
442 foreach ($this->_multiRecordFields
as $key => $field) {
443 $fieldIds[] = CRM_Core_BAO_CustomField
::getKeyID($key);
445 $getValues = CRM_Core_BAO_CustomValueTable
::getEntityValues($this->_id
, NULL, $fieldIds, TRUE);
447 if (array_key_exists($this->_recordId
, $getValues)) {
448 $this->_recordExists
= TRUE;
451 $this->_recordExists
= FALSE;
452 if ($this->_multiRecord
& CRM_Core_Action
::UPDATE
) {
453 CRM_Core_Session
::setStatus(ts('Note: The record %1 doesnot exists. Upon save a new record will be create', array(1 => $this->_recordId
)), ts('Record doesnot exist'), 'alert');
457 if ($this->_multiRecord
& CRM_Core_Action
::ADD
) {
458 $this->_maxRecordLimit
= CRM_Core_BAO_CustomGroup
::hasReachedMaxLimit($customGroupDetails[$fieldId]['groupID'], $this->_id
);
459 if ($this->_maxRecordLimit
) {
460 CRM_Core_Session
::setStatus(ts('You cannot add a new record as maximum allowed limit is reached'), ts('Sorry'), 'error');
465 elseif (!empty($this->_multiRecordFields
)
466 && (!$this->_multiRecord ||
!in_array($this->_multiRecord
, array(
467 CRM_Core_Action
::DELETE
,
468 CRM_Core_Action
::UPDATE
,
471 CRM_Core_Resources
::singleton()->addScriptFile('civicrm', 'js/crm.livePage.js', 1, 'html-header');
472 //multi-record listing page
473 $multiRecordFieldListing = TRUE;
474 $page = new CRM_Profile_Page_MultipleRecordFieldsListing();
475 $cs = $this->get('cs');
476 $page->set('pageCheckSum', $cs);
477 $page->set('contactId', $this->_id
);
478 $page->set('profileId', $this->_gid
);
479 $page->set('action', CRM_Core_Action
::BROWSE
);
480 $page->set('multiRecordFieldListing', $multiRecordFieldListing);
484 $this->assign('multiRecordFieldListing', $multiRecordFieldListing);
486 // is profile double-opt in?
487 if (!empty($this->_fields
['group']) &&
488 CRM_Core_BAO_UFGroup
::isProfileDoubleOptin()
491 foreach ($this->_fields
as $name => $values) {
492 if (substr($name, 0, 6) == 'email-') {
498 $status = ts("Email field should be included in profile if you want to use Group(s) when Profile double-opt in process is enabled.");
499 $this->_session
->setStatus($status);
503 //transferring all the multi-record custom fields in _fields
504 if ($this->_multiRecord
&& !empty($this->_multiRecordFields
)) {
505 $this->_fields
= $this->_multiRecordFields
;
506 $this->_multiRecordProfile
= TRUE;
508 elseif ($this->_multiRecord
&& empty($this->_multiRecordFields
)) {
509 CRM_Core_Session
::setStatus(ts('This feature is not currently available.'), ts('Sorry'), 'error');
510 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm', 'reset=1'));
514 if (!is_array($this->_fields
)) {
515 CRM_Core_Session
::setStatus(ts('This feature is not currently available.'), ts('Sorry'), 'error');
516 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm', 'reset=1'));
521 * Set default values for the form. Note that in edit/view mode
522 * the default values are retrieved from the database
525 public function setDefaultsValues() {
526 $this->_defaults
= array();
527 if ($this->_multiRecordProfile
&& ($this->_multiRecord
== CRM_Core_Action
::DELETE
)) {
531 if ($this->_mode
!= self
::MODE_SEARCH
) {
532 // set default values for country / state to start with
533 CRM_Core_BAO_UFGroup
::setRegisterDefaults($this->_fields
, $this->_defaults
);
536 if ($this->_id
&& !$this->_multiRecordProfile
) {
537 if ($this->_isContactActivityProfile
) {
538 $contactFields = $activityFields = array();
539 foreach ($this->_fields
as $fieldName => $field) {
540 if (CRM_Utils_Array
::value('field_type', $field) == 'Activity') {
541 $activityFields[$fieldName] = $field;
544 $contactFields[$fieldName] = $field;
548 CRM_Core_BAO_UFGroup
::setProfileDefaults($this->_id
, $contactFields, $this->_defaults
, TRUE);
549 if ($this->_activityId
) {
550 CRM_Core_BAO_UFGroup
::setComponentDefaults($activityFields, $this->_activityId
, 'Activity', $this->_defaults
, TRUE);
554 CRM_Core_BAO_UFGroup
::setProfileDefaults($this->_id
, $this->_fields
, $this->_defaults
, TRUE);
558 //set custom field defaults
559 if ($this->_multiRecordProfile
) {
560 foreach ($this->_multiRecordFields
as $key => $field) {
561 $fieldIds[] = CRM_Core_BAO_CustomField
::getKeyID($key);
564 $defaultValues = array();
565 if ($this->_multiRecord
&& $this->_multiRecord
== CRM_Core_Action
::UPDATE
) {
566 $defaultValues = CRM_Core_BAO_CustomValueTable
::getEntityValues($this->_id
, NULL, $fieldIds, TRUE);
567 if ($this->_recordExists
== TRUE) {
568 $defaultValues = $defaultValues[$this->_recordId
];
571 $defaultValues = NULL;
575 if (!empty($defaultValues)) {
576 foreach ($defaultValues as $key => $value) {
577 $name = "custom_{$key}";
578 $htmlType = $this->_multiRecordFields
[$name]['html_type'];
579 if ($htmlType != 'File') {
581 CRM_Core_BAO_CustomField
::setProfileDefaults($key,
590 $this->_defaults
[$name] = "";
594 if ($htmlType == 'File') {
595 $entityId = $this->_id
;
596 if (CRM_Utils_Array
::value('field_type', $field) == 'Activity' &&
599 $entityId = $this->_activityId
;
604 $url = CRM_Core_BAO_CustomField
::getFileURL($entityId, $key, $value);
608 $customFiles[$name]['displayURL'] = ts("Attached File") . ": {$url['file_url']}";
610 $deleteExtra = ts("Are you sure you want to delete attached file?");
611 $fileId = $url['file_id'];
612 $fileHash = CRM_Core_BAO_File
::generateFileHash($entityId, $fileId);
613 $deleteURL = CRM_Utils_System
::url('civicrm/file',
614 "reset=1&id={$fileId}&eid=$entityId&fid={$key}&action=delete&fcs={$fileHash}"
616 $text = ts("Delete Attached File");
617 $customFiles[$field['name']]['deleteURL'] = "<a href=\"{$deleteURL}\" onclick = \"if (confirm( ' $deleteExtra ' )) this.href+='&confirmed=1'; else return false;\">$text</a>";
619 // also delete the required rule that we've set on the form element
620 $this->removeFileRequiredRules($name);
627 foreach ($this->_fields
as $name => $field) {
628 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($name)) {
629 $htmlType = $field['html_type'];
630 if ((!isset($this->_defaults
[$name]) ||
$htmlType == 'File') &&
631 (CRM_Utils_Array
::value('field_type', $field) != 'Activity')
633 CRM_Core_BAO_CustomField
::setProfileDefaults($customFieldID,
641 if ($htmlType == 'File') {
642 $entityId = $this->_id
;
643 if (CRM_Utils_Array
::value('field_type', $field) == 'Activity' && $this->_activityId
) {
644 $entityId = $this->_activityId
;
646 $url = CRM_Core_BAO_CustomField
::getFileURL($entityId, $customFieldID);
649 $customFiles[$field['name']]['displayURL'] = ts("Attached File") . ": {$url['file_url']}";
651 $deleteExtra = ts("Are you sure you want to delete attached file?");
652 $fileId = $url['file_id'];
653 $fileHash = CRM_Core_BAO_File
::generateFileHash($entityId, $fileId); /* fieldId=$customFieldID */
654 $deleteURL = CRM_Utils_System
::url('civicrm/file',
655 "reset=1&id={$fileId}&eid=$entityId&fid={$customFieldID}&action=delete&fcs={$fileHash}"
657 $text = ts("Delete Attached File");
658 $customFiles[$field['name']]['deleteURL'] = "<a href=\"{$deleteURL}\" onclick = \"if (confirm( ' $deleteExtra ' )) this.href+='&confirmed=1'; else return false;\">$text</a>";
660 // also delete the required rule that we've set on the form element
661 $this->removeFileRequiredRules($field['name']);
667 if (isset($customFiles)) {
668 $this->assign('customFiles', $customFiles);
671 if ($this->_multiRecordProfile
) {
672 $this->setDefaults($this->_defaults
);
676 if (!empty($this->_defaults
['image_URL'])) {
677 $this->assign("imageURL", CRM_Utils_File
::getImageURL($this->_defaults
['image_URL']));
678 $this->removeFileRequiredRules('image_URL');
681 if (array_key_exists('contact_sub_type', $this->_defaults
) &&
682 !empty($this->_defaults
['contact_sub_type'])
684 $this->_defaults
['contact_sub_type'] = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
685 trim($this->_defaults
['contact_sub_type'], CRM_Core_DAO
::VALUE_SEPARATOR
)
689 $this->setDefaults($this->_defaults
);
693 * Build the form object.
696 public function buildQuickForm() {
697 $this->add('hidden', 'gid', $this->_gid
);
699 switch ($this->_mode
) {
700 case self
::MODE_CREATE
:
701 case self
::MODE_EDIT
:
702 case self
::MODE_REGISTER
:
703 CRM_Utils_Hook
::buildProfile($this->_ufGroup
['name']);
706 case self
::MODE_SEARCH
:
707 CRM_Utils_Hook
::searchProfile($this->_ufGroup
['name']);
713 //lets have single status message, CRM-4363
715 $statusMessage = NULL;
716 if (($this->_multiRecord
& CRM_Core_Action
::ADD
) && $this->_maxRecordLimit
) {
720 if (($this->_multiRecord
& CRM_Core_Action
::DELETE
)) {
721 if (!$this->_recordExists
) {
722 CRM_Core_Session
::setStatus(ts('The record %1 doesnot exists', array(1 => $this->_recordId
)), ts('Record doesnot exists'), 'alert');
725 $this->assign('deleteRecord', TRUE);
730 CRM_Core_BAO_Address
::checkContactSharedAddressFields($this->_fields
, $this->_id
);
732 // we should not allow component and mix profiles in search mode
733 if ($this->_mode
!= self
::MODE_REGISTER
) {
734 //check for mix profile fields (eg: individual + other contact type)
735 if (CRM_Core_BAO_UFField
::checkProfileType($this->_gid
)) {
736 if (($this->_mode
& self
::MODE_EDIT
) && $this->_isContactActivityProfile
) {
737 $errors = self
::validateContactActivityProfile($this->_activityId
, $this->_id
, $this->_gid
);
738 if (!empty($errors)) {
739 $statusMessage = array_pop($errors);
744 $statusMessage = ts('Profile search, view and edit are not supported for Profiles which include fields for more than one record type.');
749 $profileType = CRM_Core_BAO_UFField
::getProfileType($this->_gid
);
752 $contactTypes = CRM_Contact_BAO_Contact
::getContactTypes($this->_id
);
753 $contactType = $contactTypes[0];
755 array_shift($contactTypes);
756 $contactSubtypes = $contactTypes;
758 $profileSubType = FALSE;
759 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
760 $profileSubType = $profileType;
761 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
765 ($profileType != 'Contact' && !$this->_isContactActivityProfile
) &&
766 (($profileSubType && !empty($contactSubtypes) && (!in_array($profileSubType, $contactSubtypes))) ||
767 ($profileType != $contactType))
770 if (!$statusMessage) {
771 $statusMessage = ts("This profile is configured for contact type '%1'. It cannot be used to edit contacts of other types.",
772 array(1 => $profileSubType ?
$profileSubType : $profileType));
780 array("Membership", "Participant", "Contribution")
784 if (!$statusMessage) {
785 $statusMessage = ts('Profile is not configured for the selected action.');
790 //lets have single status message,
791 $this->assign('statusMessage', $statusMessage);
796 $this->assign('id', $this->_id
);
797 $this->assign('mode', $this->_mode
);
798 $this->assign('action', $this->_action
);
799 $this->assign('fields', $this->_fields
);
800 $this->assign('fieldset', (isset($this->_fieldset
)) ?
$this->_fieldset
: "");
802 // should we restrict what we display
804 if ($this->_mode
== self
::MODE_EDIT
) {
806 // show all fields that are visible:
807 // if we are a admin OR the same user OR acl-user with access to the profile
808 // or we have checksum access to this contact (i.e. the user without a login) - CRM-5909
810 CRM_Core_Permission
::check('administer users') ||
811 $this->_id
== $this->_currentUserID ||
812 $this->_isPermissionedChecksum ||
816 CRM_Core_Permission
::EDIT
,
819 CRM_Core_PseudoConstant
::get('CRM_Core_DAO_UFField', 'uf_group_id')
827 // if false, user is not logged-in.
829 if (!$this->_currentUserID
) {
830 $defaultLocationType = CRM_Core_BAO_LocationType
::getDefault();
831 $primaryLocationType = $defaultLocationType->id
;
834 $this->assign('anonUser', $anonUser);
836 $addCaptcha = array();
837 $emailPresent = FALSE;
839 // add the form elements
840 foreach ($this->_fields
as $name => $field) {
841 // make sure that there is enough permission to expose this field
842 if (!$admin && $field['visibility'] == 'User and User Admin Only') {
843 unset($this->_fields
[$name]);
847 // since the CMS manages the email field, suppress the email display if in
848 // register mode which occur within the CMS form
849 if ($this->_mode
== self
::MODE_REGISTER
&& substr($name, 0, 5) == 'email') {
850 unset($this->_fields
[$name]);
854 list($prefixName, $index) = CRM_Utils_System
::explode('-', $name, 2);
856 CRM_Core_BAO_UFGroup
::buildProfile($this, $field, $this->_mode
);
858 if ($field['add_to_group_id']) {
859 $addToGroupId = $field['add_to_group_id'];
862 //build array for captcha
863 if ($field['add_captcha']) {
864 $addCaptcha[$field['group_id']] = $field['add_captcha'];
867 if (($name == 'email-Primary') ||
($name == 'email-' . isset($primaryLocationType) ?
$primaryLocationType : "")) {
868 $emailPresent = TRUE;
869 $this->_mail
= $name;
873 // add captcha only for create mode.
874 if ($this->_mode
== self
::MODE_CREATE
) {
875 // suppress captcha for logged in users only
876 if ($this->_currentUserID
) {
877 $this->_isAddCaptcha
= FALSE;
879 elseif (!$this->_isAddCaptcha
&& !empty($addCaptcha)) {
880 $this->_isAddCaptcha
= TRUE;
884 $dao = new CRM_Core_DAO_UFGroup();
885 $dao->id
= $this->_gid
;
887 $dao->addSelect('is_update_dupe');
888 if ($dao->find(TRUE)) {
889 if ($dao->is_update_dupe
) {
890 $this->_isUpdateDupe
= $dao->is_update_dupe
;
896 $this->_isAddCaptcha
= FALSE;
899 //finally add captcha to form.
900 if ($this->_isAddCaptcha
) {
901 $captcha = CRM_Utils_ReCAPTCHA
::singleton();
902 $captcha->add($this);
904 $this->assign("isCaptcha", $this->_isAddCaptcha
);
906 if ($this->_mode
!= self
::MODE_SEARCH
) {
907 if (isset($addToGroupId)) {
908 $this->_ufGroup
['add_to_group_id'] = $addToGroupId;
912 //let's do set defaults for the profile
913 $this->setDefaultsValues();
915 $action = CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, NULL);
917 if ($this->_mode
== self
::MODE_CREATE ||
$this->_mode
== self
::MODE_EDIT
) {
918 CRM_Core_BAO_CMSUser
::buildForm($this, $this->_gid
, $emailPresent, $action);
921 $this->assign('showCMS', FALSE);
924 $this->assign('groupId', $this->_gid
);
926 // if view mode pls freeze it with the done button.
927 if ($this->_action
& CRM_Core_Action
::VIEW
) {
931 if ($this->_context
== 'dialog') {
934 $this->_duplicateButtonName
,
935 ts('Save Matching Contact')
941 * Validate profile and provided activity Id.
943 * @param int $activityId
944 * @param int $contactId
949 public static function validateContactActivityProfile($activityId, $contactId, $gid) {
952 $errors[] = ts('Profile is using one or more activity fields, and is missing the activity Id (aid) in the URL.');
956 $activityDetails = array();
957 $activityParams = array('id' => $activityId);
958 CRM_Activity_BAO_Activity
::retrieve($activityParams, $activityDetails);
960 if (empty($activityDetails)) {
961 $errors[] = ts('Invalid Activity Id (aid).');
965 $profileActivityTypes = CRM_Core_BAO_UFGroup
::groupTypeValues($gid, 'Activity');
967 if ((!empty($profileActivityTypes['Activity']) &&
968 !in_array($activityDetails['activity_type_id'], $profileActivityTypes['Activity'])
970 (!in_array($contactId, $activityDetails['assignee_contact']) &&
971 !in_array($contactId, $activityDetails['target_contact'])
974 $errors[] = ts('This activity cannot be edited or viewed via this profile.');
983 * @param array $fields
984 * The input form values.
985 * @param array $files
986 * The uploaded files if any.
987 * @param CRM_Core_Form $form
991 * true if no errors, else array of errors
993 public static function formRule($fields, $files, $form) {
994 CRM_Utils_Hook
::validateProfile($form->_ufGroup
['name']);
996 // if no values, return
997 if (empty($fields)) {
1004 // hack we use a -1 in options to indicate that its registration
1005 // ... and I can't remove that comment because even though it's clear as mud
1006 // perhaps someone will find it helpful in the absence of ANY OTHER EXPLANATION
1007 // as to what it means....
1009 // @todo - wonder if it ever occurred to someone that if they didn't document this param
1010 // it might not be crystal clear why we have it....
1011 $form->_isUpdateDupe
= 1;
1014 if ($form->_mode
== CRM_Profile_Form
::MODE_REGISTER
) {
1018 // don't check for duplicates during registration validation: CRM-375
1019 if (!$register && empty($fields['_qf_Edit_upload_duplicate'])) {
1021 if (!empty($fields['email-Primary'])) {
1022 $fields['email'] = CRM_Utils_Array
::value('email-Primary', $fields);
1026 if (!empty($fields['phone-Primary-1']) && empty($fields['phone-Primary'])) {
1027 $fields['phone-Primary'] = $fields['phone-Primary-1'];
1031 self
::handleDuplicateChecking($errors, $fields, $form);
1035 foreach ($fields as $key => $value) {
1036 list($fieldName, $locTypeId, $phoneTypeId) = CRM_Utils_System
::explode('-', $key, 3);
1037 if ($fieldName == 'state_province' && !empty($fields["country-{$locTypeId}"])) {
1038 // Validate Country - State list
1039 $countryId = $fields["country-{$locTypeId}"];
1040 $stateProvinceId = $value;
1042 if ($stateProvinceId && $countryId) {
1043 $stateProvinceDAO = new CRM_Core_DAO_StateProvince();
1044 $stateProvinceDAO->id
= $stateProvinceId;
1045 $stateProvinceDAO->find(TRUE);
1047 if ($stateProvinceDAO->country_id
!= $countryId) {
1048 // country mismatch hence display error
1049 $stateProvinces = CRM_Core_PseudoConstant
::stateProvince();
1050 $countries = CRM_Core_PseudoConstant
::country();
1051 $errors[$key] = "State/Province " . $stateProvinces[$stateProvinceId] . " is not part of " . $countries[$countryId] . ". It belongs to " . $countries[$stateProvinceDAO->country_id
] . ".";
1056 if ($fieldName == 'county' && $fields["state_province-{$locTypeId}"]) {
1057 // Validate County - State list
1058 $stateProvinceId = $fields["state_province-{$locTypeId}"];
1061 if ($countyId && $stateProvinceId) {
1062 $countyDAO = new CRM_Core_DAO_County();
1063 $countyDAO->id
= $countyId;
1064 $countyDAO->find(TRUE);
1066 if ($countyDAO->state_province_id
!= $stateProvinceId) {
1067 // state province mismatch hence display error
1068 $stateProvinces = CRM_Core_PseudoConstant
::stateProvince();
1069 $counties = CRM_Core_PseudoConstant
::county();
1070 $errors[$key] = "County " . $counties[$countyId] . " is not part of " . $stateProvinces[$stateProvinceId] . ". It belongs to " . $stateProvinces[$countyDAO->state_province_id
] . ".";
1075 foreach (CRM_Contact_BAO_Contact
::$_greetingTypes as $greeting) {
1076 if ($greetingType = CRM_Utils_Array
::value($greeting, $fields)) {
1077 $customizedValue = CRM_Core_PseudoConstant
::getKey('CRM_Contact_BAO_Contact', $greeting . '_id', 'Customized');
1078 if ($customizedValue == $greetingType && empty($fields[$greeting . '_custom'])) {
1079 $errors[$greeting . '_custom'] = ts('Custom %1 is a required field if %1 is of type Customized.',
1080 array(1 => ucwords(str_replace('_', ' ', $greeting)))
1086 return empty($errors) ?
TRUE : $errors;
1090 * Process the user submitted custom data values.
1093 public function postProcess() {
1094 $params = $this->controller
->exportValues($this->_name
);
1096 //if the delete record button is clicked
1097 if ($this->_deleteButtonName
) {
1098 if (!empty($_POST[$this->_deleteButtonName
]) && $this->_recordId
) {
1099 $filterParams['id'] = $this->_customGroupId
;
1100 $returnProperties = array('is_multiple', 'table_name');
1101 CRM_Core_DAO
::commonRetrieve("CRM_Core_DAO_CustomGroup", $filterParams, $returnValues, $returnProperties);
1102 if (!empty($returnValues['is_multiple'])) {
1103 if ($tableName = CRM_Utils_Array
::value('table_name', $returnValues)) {
1104 $sql = "DELETE FROM {$tableName} WHERE id = %1 AND entity_id = %2";
1106 1 => array($this->_recordId
, 'Integer'),
1107 2 => array($this->_id
, 'Integer'),
1109 CRM_Core_DAO
::executeQuery($sql, $sqlParams);
1110 CRM_Core_Session
::setStatus(ts('Your record has been deleted.'), ts('Deleted'), 'success');
1116 CRM_Utils_Hook
::processProfile($this->_ufGroup
['name']);
1117 if (!empty($params['image_URL'])) {
1118 CRM_Contact_BAO_Contact
::processImageParams($params);
1121 $greetingTypes = array(
1122 'addressee' => 'addressee_id',
1123 'email_greeting' => 'email_greeting_id',
1124 'postal_greeting' => 'postal_greeting_id',
1129 $contactDetails = CRM_Contact_BAO_Contact
::getHierContactDetails($this->_id
,
1132 $details = $contactDetails[0][$this->_id
];
1134 if (!(!empty($details['addressee_id']) ||
!empty($details['email_greeting_id']) ||
1135 CRM_Utils_Array
::value('postal_greeting_id', $details)
1139 $profileType = CRM_Core_BAO_UFField
::getProfileType($this->_gid
);
1140 //Though Profile type is contact we need
1141 //Individual/Household/Organization for setting Greetings.
1142 if ($profileType == 'Contact') {
1143 $profileType = 'Individual';
1144 //if we editing Household/Organization.
1146 $profileType = CRM_Contact_BAO_Contact
::getContactType($this->_id
);
1149 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
1150 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
1153 foreach ($greetingTypes as $key => $value) {
1154 if (!array_key_exists($key, $params)) {
1155 $params[$key] = CRM_Contact_BAO_Contact_Utils
::defaultGreeting($profileType, $key);
1160 $transaction = new CRM_Core_Transaction();
1162 //used to send subscribe mail to the group which user want.
1163 //if the profile double option in is enabled
1164 $mailingType = array();
1167 foreach ($params as $name => $values) {
1168 if (substr($name, 0, 6) == 'email-') {
1169 $result['email'] = $values;
1173 //array of group id, subscribed by contact
1174 $contactGroup = array();
1175 if (!empty($params['group']) &&
1176 CRM_Core_BAO_UFGroup
::isProfileDoubleOptin()
1178 $groupSubscribed = array();
1179 if (!empty($result['email'])) {
1181 $contactGroups = new CRM_Contact_DAO_GroupContact();
1182 $contactGroups->contact_id
= $this->_id
;
1183 $contactGroups->status
= 'Added';
1184 $contactGroups->find();
1185 $contactGroup = array();
1186 while ($contactGroups->fetch()) {
1187 $contactGroup[] = $contactGroups->group_id
;
1188 $groupSubscribed[$contactGroups->group_id
] = 1;
1191 foreach ($params['group'] as $key => $val) {
1193 unset($params['group'][$key]);
1196 $groupTypes = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group',
1197 $key, 'group_type', 'id'
1199 $groupType = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1200 substr($groupTypes, 1, -1)
1202 //filter group of mailing type and unset it from params
1203 if (in_array(2, $groupType)) {
1204 //if group is already subscribed , ignore it
1205 $groupExist = CRM_Utils_Array
::key($key, $contactGroup);
1206 if (!isset($groupExist)) {
1207 $mailingType[] = $key;
1208 unset($params['group'][$key]);
1215 $addToGroupId = CRM_Utils_Array
::value('add_to_group_id', $this->_ufGroup
);
1216 if (!empty($addToGroupId)) {
1217 //run same check whether group is a mailing list
1218 $groupTypes = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group',
1219 $addToGroupId, 'group_type', 'id'
1221 $groupType = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1222 substr($groupTypes, 1, -1)
1224 //filter group of mailing type and unset it from params
1225 if (in_array(2, $groupType) && !empty($result['email']) &&
1226 CRM_Core_BAO_UFGroup
::isProfileAddToGroupDoubleOptin()
1228 if (!count($contactGroup)) {
1229 //array of group id, subscribed by contact
1230 $contactGroup = array();
1232 $contactGroups = new CRM_Contact_DAO_GroupContact();
1233 $contactGroups->contact_id
= $this->_id
;
1234 $contactGroups->status
= 'Added';
1235 $contactGroups->find();
1236 $contactGroup = array();
1237 while ($contactGroups->fetch()) {
1238 $contactGroup[] = $contactGroups->group_id
;
1239 $groupSubscribed[$contactGroups->group_id
] = 1;
1243 //if group is already subscribed , ignore it
1244 $groupExist = CRM_Utils_Array
::key($addToGroupId, $contactGroup);
1245 if (!isset($groupExist)) {
1246 $mailingType[] = $addToGroupId;
1247 $addToGroupId = NULL;
1251 // since we are directly adding contact to group lets unset it from mailing
1252 if ($key = array_search($addToGroupId, $mailingType)) {
1253 unset($mailingType[$key]);
1259 $params['group'] = $groupSubscribed;
1262 // commenting below code, since we potentially
1263 // triggered maximum name field formatting cases during CRM-4430.
1265 // $params['preserveDBName'] = true;
1267 $profileFields = $this->_fields
;
1268 if (($this->_mode
& self
::MODE_EDIT
) && $this->_activityId
&& $this->_isContactActivityProfile
) {
1269 $profileFields = $activityParams = array();
1270 foreach ($this->_fields
as $fieldName => $field) {
1271 if (CRM_Utils_Array
::value('field_type', $field) == 'Activity') {
1272 if (isset($params[$fieldName])) {
1273 $activityParams[$fieldName] = $params[$fieldName];
1275 if (isset($params['activity_date_time'])) {
1276 $activityParams['activity_date_time'] = CRM_Utils_Date
::processDate($params['activity_date_time'], $params['activity_date_time_time']);
1278 if (!empty($params[$fieldName]) && isset($params["{$fieldName}_id"])) {
1279 $activityParams[$fieldName] = $params["{$fieldName}_id"];
1283 $profileFields[$fieldName] = $field;
1287 if (!empty($activityParams)) {
1288 $activityParams['version'] = 3;
1289 $activityParams['id'] = $this->_activityId
;
1290 $activityParams['skipRecentView'] = TRUE;
1291 civicrm_api('Activity', 'create', $activityParams);
1295 if ($this->_multiRecord
&& $this->_recordId
&& $this->_multiRecordFields
&& $this->_recordExists
) {
1296 $params['customRecordValues'][$this->_recordId
] = array_keys($this->_multiRecordFields
);
1299 $this->_id
= CRM_Contact_BAO_Contact
::createProfileContact(
1309 //mailing type group
1310 if (!empty($mailingType)) {
1311 // we send in the contactID so we match the same groups and are exact, rather than relying on email
1313 CRM_Mailing_Event_BAO_Subscribe
::commonSubscribe($mailingType, $result, $this->_id
, 'profile');
1316 $ufGroups = array();
1318 $ufGroups[$this->_gid
] = 1;
1320 elseif ($this->_mode
== self
::MODE_REGISTER
) {
1321 $ufGroups = CRM_Core_BAO_UFGroup
::getModuleUFGroup('User Registration');
1324 foreach ($ufGroups as $gId => $val) {
1325 if ($notify = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $gId, 'notify')) {
1326 $values = CRM_Core_BAO_UFGroup
::checkFieldsEmptyValues($gId, $this->_id
, NULL);
1327 CRM_Core_BAO_UFGroup
::commonSendMail($this->_id
, $values);
1331 //create CMS user (if CMS user option is selected in profile)
1332 if (!empty($params['cms_create_account']) &&
1333 ($this->_mode
== self
::MODE_CREATE ||
$this->_mode
== self
::MODE_EDIT
)
1335 $params['contactID'] = $this->_id
;
1336 if (!CRM_Core_BAO_CMSUser
::create($params, $this->_mail
)) {
1337 CRM_Core_Session
::setStatus(ts('Your profile is not saved and Account is not created.'), ts('Profile Error'), 'error');
1338 CRM_Core_Error
::debug_log_message("Rolling back transaction as CMSUser Create failed in Profile_Form for contact " . $params['contactID']);
1339 $transaction->rollback();
1340 return CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/profile/create',
1341 'reset=1&gid=' . $this->_gid
1346 $transaction->commit();
1350 * @param null $suffix
1352 * @return null|string
1354 public function checkTemplateFileExists($suffix = NULL) {
1356 $templateFile = "CRM/Profile/Form/{$this->_gid}/{$this->_name}.{$suffix}tpl";
1357 $template = CRM_Core_Form
::getTemplate();
1358 if ($template->template_exists($templateFile)) {
1359 return $templateFile;
1362 // lets see if we have customized by name
1363 $ufGroupName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $this->_gid
, 'name');
1365 $templateFile = "CRM/Profile/Form/{$ufGroupName}/{$this->_name}.{$suffix}tpl";
1366 if ($template->template_exists($templateFile)) {
1367 return $templateFile;
1375 * Use the form name to create the tpl file name.
1379 public function getTemplateFileName() {
1380 $fileName = $this->checkTemplateFileExists();
1381 return $fileName ?
$fileName : parent
::getTemplateFileName();
1385 * Default extra tpl file basically just replaces .tpl with .extra.tpl
1386 * i.e. we dont override
1390 public function overrideExtraTemplateFileName() {
1391 $fileName = $this->checkTemplateFileExists('extra.');
1392 return $fileName ?
$fileName : parent
::overrideExtraTemplateFileName();