3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
37 * This class generates form components for custom data
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_Profile_Form
extends CRM_Core_Form
{
53 protected $_skipPermission = FALSE;
56 * The contact id that we are editing
63 * The group id that we are editing
70 * The group id that we are editing
74 protected $_ufGroupName = 'unknown';
77 * The group id that we are passing in url
84 * The title of the category we are editing
91 * the fields needed to build this form
98 * to store contact details
105 * to store group_id of the group which is to be assigned to the contact
109 protected $_addToGroupID;
112 * Do we allow updates of the contact
116 public $_isUpdateDupe = 0;
118 public $_isAddCaptcha = FALSE;
120 protected $_isPermissionedChecksum = FALSE;
123 * THe context from which we came from, allows us to go there if redirect not set
130 * THe contact type for registration case
134 protected $_ctype = NULL;
136 protected $_defaults = NULL;
139 * Store profile ids if multiple profile ids are passed using comma separated.
140 * Currently lets implement this functionality only for dialog mode
142 protected $_profileIds = array();
145 * Contact profile having activity fields?
149 protected $_isContactActivityProfile = FALSE;
152 * Activity Id connected to the profile
156 protected $_activityId = NULL;
159 protected $_multiRecordFields = NULL;
161 protected $_recordId = NULL;
164 * action for multi record profile (create/edit/delete)
168 protected $_multiRecord = NULL;
170 protected $_multiRecordProfile = FALSE;
172 protected $_recordExists = TRUE;
174 protected $_customGroupTitle = NULL;
176 protected $_deleteButtonName = NULL;
178 protected $_customGroupId = NULL;
180 protected $_currentUserID = NULL;
181 protected $_session = NULL;
184 * pre processing work done here.
186 * gets session variables for table name, id of entity in table, type of entity and stores them.
194 function preProcess() {
195 $this->_id
= $this->get('id');
196 $this->_gid
= $this->get('gid');
197 $this->_profileIds
= $this->get('profileIds');
198 $this->_grid
= CRM_Utils_Request
::retrieve('grid', 'Integer', $this);
199 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this);
201 //unset from session when $_GET doesn't have it
202 //except when the form is submitted
204 if (!array_key_exists('multiRecord', $_GET)) {
205 $this->set('multiRecord', NULL);
207 if (!array_key_exists('recordId', $_GET)) {
208 $this->set('recordId', NULL);
212 $this->_session
= CRM_Core_Session
::singleton();
213 $this->_currentUserID
= $this->_session
->get('userID');
215 if ($this->_mode
== self
::MODE_EDIT
) {
216 //specifies the action being done on a multi record field
217 $multiRecordAction = CRM_Utils_Request
::retrieve('multiRecord', 'String', $this);
218 $this->_multiRecord
= (!is_numeric($multiRecordAction)) ?
219 CRM_Core_Action
::resolve($multiRecordAction) : $multiRecordAction;
220 if ($this->_multiRecord
) {
221 $this->set('multiRecord', $this->_multiRecord
);
224 if ($this->_multiRecord
&&
225 !in_array($this->_multiRecord
, array(CRM_Core_Action
::UPDATE
, CRM_Core_Action
::ADD
, CRM_Core_Action
::DELETE
))) {
226 CRM_Core_Error
::fatal(ts('Proper action not specified for this custom value record profile'));
229 $this->_duplicateButtonName
= $this->getButtonName('upload', 'duplicate');
231 $gids = explode(',', CRM_Utils_Request
::retrieve('gid', 'String', CRM_Core_DAO
::$_nullObject, FALSE, 0, 'GET'));
233 if ((count($gids) > 1) && !$this->_profileIds
&& empty($this->_profileIds
)) {
235 foreach ($gids as $pfId) {
236 $this->_profileIds
[] = CRM_Utils_Type
::escape($pfId, 'Positive');
240 // check if we are rendering mixed profiles
241 if (CRM_Core_BAO_UFGroup
::checkForMixProfiles($this->_profileIds
)) {
242 CRM_Core_Error
::fatal(ts('You cannot combine profiles of multiple types.'));
245 // for now consider 1'st profile as primary profile and validate it
246 // i.e check for profile type etc.
247 // FIX ME: validations for other than primary
248 $this->_gid
= $this->_profileIds
[0];
249 $this->set('gid', $this->_gid
);
250 $this->set('profileIds', $this->_profileIds
);
254 $this->_gid
= CRM_Utils_Request
::retrieve('gid', 'Positive', $this, FALSE, 0, 'GET');
257 $this->_activityId
= CRM_Utils_Request
::retrieve('aid', 'Positive', $this, FALSE, 0, 'GET');
258 if (is_numeric($this->_activityId
)) {
259 $latestRevisionId = CRM_Activity_BAO_Activity
::getLatestActivityId($this->_activityId
);
260 if ($latestRevisionId) {
261 $this->_activityId
= $latestRevisionId;
264 $this->_isContactActivityProfile
= CRM_Core_BAO_UFField
::checkContactActivityProfileType($this->_gid
);
266 //get values for ufGroupName, captch and dupe update.
268 $dao = new CRM_Core_DAO_UFGroup();
269 $dao->id
= $this->_gid
;
270 if ($dao->find(TRUE)) {
271 $this->_isUpdateDupe
= $dao->is_update_dupe
;
272 $this->_isAddCaptcha
= $dao->add_captcha
;
273 if (!empty($dao->name
)) {
274 $this->_ufGroupName
= $dao->name
;
279 $this->assign('ufGroupName', $this->_ufGroupName
);
281 $gids = empty($this->_profileIds
) ?
$this->_gid
: $this->_profileIds
;
283 // if we dont have a gid use the default, else just use that specific gid
284 if (($this->_mode
== self
::MODE_REGISTER ||
$this->_mode
== self
::MODE_CREATE
) && !$this->_gid
) {
285 $this->_ctype
= CRM_Utils_Request
::retrieve('ctype', 'String', $this, FALSE, 'Individual', 'REQUEST');
286 $this->_fields
= CRM_Core_BAO_UFGroup
::getRegistrationFields($this->_action
, $this->_mode
, $this->_ctype
);
288 elseif ($this->_mode
== self
::MODE_SEARCH
) {
289 $this->_fields
= CRM_Core_BAO_UFGroup
::getListingFields($this->_action
,
290 CRM_Core_BAO_UFGroup
::PUBLIC_VISIBILITY | CRM_Core_BAO_UFGroup
::LISTINGS_VISIBILITY
,
294 $this->_skipPermission
,
295 CRM_Core_Permission
::SEARCH
299 $this->_fields
= CRM_Core_BAO_UFGroup
::getFields($gids, FALSE, NULL,
302 $this->_skipPermission
,
304 ($this->_action
== CRM_Core_Action
::ADD
) ? CRM_Core_Permission
::CREATE
: CRM_Core_Permission
::EDIT
306 $multiRecordFieldListing = FALSE;
307 //using selector for listing of multirecord fields
308 if ($this->_mode
== self
::MODE_EDIT
&& $this->_gid
) {
309 CRM_Core_BAO_UFGroup
::shiftMultiRecordFields($this->_fields
, $this->_multiRecordFields
);
311 if ($this->_multiRecord
) {
312 if ($this->_multiRecord
!= CRM_Core_Action
::ADD
) {
313 $this->_recordId
= CRM_Utils_Request
::retrieve('recordId', 'Positive', $this);
315 $this->_recordId
= NULL;
316 $this->set('recordId', NULL);
318 //record id is neccessary for _multiRecord view and update/edit action
319 if (!$this->_recordId
320 && ($this->_multiRecord
== CRM_Core_Action
::UPDATE ||
$this->_multiRecord
== CRM_Core_Action
::DELETE
)) {
321 CRM_Core_Error
::fatal(ts('The requested Profile (gid=%1) requires record id while performing this action',
322 array(1 => $this->_gid
)
324 } elseif (empty($this->_multiRecordFields
)) {
325 CRM_Core_Error
::fatal(ts('No Multi-Record Fields configured for this profile (gid=%1)',
326 array(1 => $this->_gid
)
330 $fieldId = CRM_Core_BAO_CustomField
::getKeyID(key($this->_multiRecordFields
));
331 $customGroupDetails = CRM_Core_BAO_CustomGroup
::getGroupTitles(array($fieldId));
332 $this->_customGroupTitle
= $customGroupDetails[$fieldId]['groupTitle'];
333 $this->_customGroupId
= $customGroupDetails[$fieldId]['groupID'];
335 if ($this->_multiRecord
== CRM_Core_Action
::UPDATE ||
$this->_multiRecord
== CRM_Core_Action
::DELETE
) {
336 //record exists check
337 foreach ($this->_multiRecordFields
as $key => $field) {
338 $fieldIds[] = CRM_Core_BAO_CustomField
::getKeyID($key);
340 $getValues = CRM_Core_BAO_CustomValueTable
::getEntityValues($this->_id
, NULL, $fieldIds, TRUE);
342 if (array_key_exists($this->_recordId
, $getValues)) {
343 $this->_recordExists
= TRUE;
345 $this->_recordExists
= FALSE;
346 if ($this->_multiRecord
& CRM_Core_Action
::UPDATE
) {
347 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');
351 if ($this->_multiRecord
& CRM_Core_Action
::ADD
) {
352 $this->_maxRecordLimit
= CRM_Core_BAO_CustomGroup
::hasReachedMaxLimit($customGroupDetails[$fieldId]['groupID'], $this->_id
);
353 if ($this->_maxRecordLimit
) {
354 CRM_Core_Session
::setStatus(ts('You cannot add a new record as maximum allowed limit is reached'), ts('Sorry'), 'error');
358 } elseif (!empty($this->_multiRecordFields
)
359 && (!$this->_multiRecord ||
!in_array($this->_multiRecord
, array(CRM_Core_Action
::DELETE
, CRM_Core_Action
::UPDATE
)) )) {
360 //multirecord listing page
361 $multiRecordFieldListing = TRUE;
362 $page = new CRM_Profile_Page_MultipleRecordFieldsListing();
363 $cs = $this->get('cs');
364 $page->set('pageCheckSum', $cs);
365 $page->set('contactId', $this->_id
);
366 $page->set('profileId', $this->_gid
);
367 $page->set('action', CRM_Core_Action
::BROWSE
);
368 $page->set('multiRecordFieldListing', $multiRecordFieldListing);
372 $this->assign('multiRecordFieldListing', $multiRecordFieldListing);
374 // is profile double-opt in?
375 if (CRM_Utils_Array
::value('group', $this->_fields
) &&
376 CRM_Core_BAO_UFGroup
::isProfileDoubleOptin()
379 foreach ($this->_fields
as $name => $values) {
380 if (substr($name, 0, 6) == 'email-') {
386 $status = ts("Email field should be included in profile if you want to use Group(s) when Profile double-opt in process is enabled.");
387 $this->_session
->setStatus($status);
391 //transfering all the multirecord custom fields in _fields
392 if ($this->_multiRecord
&& !empty($this->_multiRecordFields
)) {
393 $this->_fields
= $this->_multiRecordFields
;
394 $this->_multiRecordProfile
= TRUE;
395 } elseif ($this->_multiRecord
&& empty($this->_multiRecordFields
)) {
396 CRM_Core_Session
::setStatus(ts('This feature is not currently available.'), ts('Sorry'), 'error');
397 return CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm', 'reset=1'));
401 if (!is_array($this->_fields
)) {
402 CRM_Core_Session
::setStatus(ts('This feature is not currently available.'), ts('Sorry'), 'error');
403 return CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm', 'reset=1'));
408 * This function sets the default values for the form. Note that in edit/view mode
409 * the default values are retrieved from the database
415 function setDefaultsValues() {
416 $this->_defaults
= array();
417 if ($this->_multiRecordProfile
&& ($this->_multiRecord
== CRM_Core_Action
::DELETE
)) {
421 if ($this->_mode
!= self
::MODE_SEARCH
) {
422 // set default values for country / state to start with
423 CRM_Core_BAO_UFGroup
::setRegisterDefaults($this->_fields
, $this->_defaults
);
426 if ($this->_id
&& !$this->_multiRecordProfile
) {
427 if ($this->_isContactActivityProfile
) {
428 $contactFields = $activityFields = array();
429 foreach ($this->_fields
as $fieldName => $field) {
430 if (CRM_Utils_Array
::value('field_type', $field) == 'Activity') {
431 $activityFields[$fieldName] = $field;
434 $contactFields[$fieldName] = $field;
438 CRM_Core_BAO_UFGroup
::setProfileDefaults($this->_id
, $contactFields, $this->_defaults
, TRUE);
439 if ($this->_activityId
) {
440 CRM_Core_BAO_UFGroup
::setComponentDefaults($activityFields, $this->_activityId
, 'Activity', $this->_defaults
, TRUE);
444 CRM_Core_BAO_UFGroup
::setProfileDefaults($this->_id
, $this->_fields
, $this->_defaults
, TRUE);
448 //set custom field defaults
449 if ($this->_multiRecordProfile
) {
450 foreach ($this->_multiRecordFields
as $key => $field) {
451 $fieldIds[] = CRM_Core_BAO_CustomField
::getKeyID($key);
454 $defaultValues = array( );
455 if ($this->_multiRecord
&& $this->_multiRecord
== CRM_Core_Action
::UPDATE
) {
456 $defaultValues = CRM_Core_BAO_CustomValueTable
::getEntityValues($this->_id
, NULL, $fieldIds, TRUE);
457 if ($this->_recordExists
== TRUE) {
458 $defaultValues = $defaultValues[$this->_recordId
];
460 $defaultValues = NULL;
464 if (!empty($defaultValues)) {
465 foreach ($defaultValues as $key => $value) {
466 $name = "custom_{$key}";
467 $htmlType = $this->_multiRecordFields
[$name]['html_type'];
468 if ($htmlType != 'File') {
470 CRM_Core_BAO_CustomField
::setProfileDefaults($key,
478 $this->_defaults
[$name] = "";
482 if ($htmlType == 'File') {
483 $entityId = $this->_id
;
484 if (CRM_Utils_Array
::value('field_type', $field) == 'Activity' &&
487 $entityId = $this->_activityId
;
489 $url = CRM_Core_BAO_CustomField
::getFileURL($entityId, $key);
492 $customFiles[$name]['displayURL'] = ts("Attached File") . ": {$url['file_url']}";
494 $deleteExtra = ts("Are you sure you want to delete attached file?");
495 $fileId = $url['file_id'];
496 $deleteURL = CRM_Utils_System
::url('civicrm/file',
497 "reset=1&id={$fileId}&eid=$entityId&fid={$key}&action=delete"
499 $text = ts("Delete Attached File");
500 $customFiles[$field['name']]['deleteURL'] = "<a href=\"{$deleteURL}\" onclick = \"if (confirm( ' $deleteExtra ' )) this.href+='&confirmed=1'; else return false;\">$text</a>";
502 // also delete the required rule that we've set on the form element
503 $this->removeFileRequiredRules($name);
509 foreach ($this->_fields
as $name => $field) {
510 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($name)) {
511 $htmlType = $field['html_type'];
512 if ((!isset($this->_defaults
[$name]) ||
$htmlType == 'File') &&
513 (CRM_Utils_Array
::value('field_type', $field) != 'Activity')
515 CRM_Core_BAO_CustomField
::setProfileDefaults($customFieldID,
523 if ($htmlType == 'File') {
524 $entityId = $this->_id
;
525 if (CRM_Utils_Array
::value('field_type', $field) == 'Activity' &&
528 $entityId = $this->_activityId
;
530 $url = CRM_Core_BAO_CustomField
::getFileURL($entityId, $customFieldID);
533 $customFiles[$field['name']]['displayURL'] = ts("Attached File") . ": {$url['file_url']}";
535 $deleteExtra = ts("Are you sure you want to delete attached file?");
536 $fileId = $url['file_id'];
537 $deleteURL = CRM_Utils_System
::url('civicrm/file',
538 "reset=1&id={$fileId}&eid=$entityId&fid={$customFieldID}&action=delete"
540 $text = ts("Delete Attached File");
541 $customFiles[$field['name']]['deleteURL'] = "<a href=\"{$deleteURL}\" onclick = \"if (confirm( ' $deleteExtra ' )) this.href+='&confirmed=1'; else return false;\">$text</a>";
543 // also delete the required rule that we've set on the form element
544 $this->removeFileRequiredRules($field['name']);
550 if (isset($customFiles)) {
551 $this->assign('customFiles', $customFiles);
554 if ($this->_multiRecordProfile
) {
555 $this->setDefaults($this->_defaults
);
559 if (CRM_Utils_Array
::value('image_URL', $this->_defaults
)) {
560 list($imageWidth, $imageHeight) = getimagesize($this->_defaults
['image_URL']);
561 list($imageThumbWidth, $imageThumbHeight) = CRM_Contact_BAO_Contact
::getThumbSize($imageWidth, $imageHeight);
562 $this->assign("imageWidth", $imageWidth);
563 $this->assign("imageHeight", $imageHeight);
564 $this->assign("imageThumbWidth", $imageThumbWidth);
565 $this->assign("imageThumbHeight", $imageThumbHeight);
566 $this->assign("imageURL", $this->_defaults
['image_URL']);
569 if (array_key_exists('contact_sub_type', $this->_defaults
) &&
570 !empty($this->_defaults
['contact_sub_type'])
572 $this->_defaults
['contact_sub_type'] = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
573 trim($this->_defaults
['contact_sub_type'], CRM_Core_DAO
::VALUE_SEPARATOR
)
577 $this->setDefaults($this->_defaults
);
581 * Function to actually build the form
586 public function buildQuickForm() {
587 switch ($this->_mode
) {
588 case self
::MODE_CREATE
:
589 case self
::MODE_EDIT
:
590 case self
::MODE_REGISTER
:
591 CRM_Utils_Hook
::buildProfile($this->_ufGroupName
);
593 case self
::MODE_SEARCH
:
594 CRM_Utils_Hook
::searchProfile($this->_ufGroupName
);
599 //lets have single status message, CRM-4363
601 $statusMessage = NULL;
602 if (($this->_multiRecord
& CRM_Core_Action
::ADD
) && $this->_maxRecordLimit
) {
606 if (($this->_multiRecord
& CRM_Core_Action
::DELETE
)) {
607 if (!$this->_recordExists
) {
608 CRM_Core_Session
::setStatus(ts('The record %1 doesnot exists', array(1 => $this->_recordId
)), ts('Record doesnot exists'), 'alert');
611 $this->assign('deleteRecord', TRUE);
616 CRM_Core_BAO_Address
::checkContactSharedAddressFields($this->_fields
, $this->_id
);
618 // we should not allow component and mix profiles in search mode
619 if ($this->_mode
!= self
::MODE_REGISTER
) {
620 //check for mix profile fields (eg: individual + other contact type)
621 if (CRM_Core_BAO_UFField
::checkProfileType($this->_gid
)) {
622 if (($this->_mode
& self
::MODE_EDIT
) && $this->_isContactActivityProfile
) {
623 $errors = self
::validateContactActivityProfile($this->_activityId
, $this->_id
, $this->_gid
);
624 if (!empty($errors)) {
625 $statusMessage = array_pop($errors);
630 $statusMessage = ts('Profile search, view and edit are not supported for Profiles which include fields for more than one record type.');
635 $profileType = CRM_Core_BAO_UFField
::getProfileType($this->_gid
);
638 $contactTypes = CRM_Contact_BAO_Contact
::getContactTypes($this->_id
);
639 $contactType = $contactTypes[0];
641 array_shift($contactTypes);
642 $contactSubtypes = $contactTypes;
644 $profileSubType = FALSE;
645 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
646 $profileSubType = $profileType;
647 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
651 ($profileType != 'Contact' && !$this->_isContactActivityProfile
) &&
652 (($profileSubType && !empty($contactSubtypes) && (!in_array($profileSubType,$contactSubtypes))) ||
653 ($profileType != $contactType))
656 if (!$statusMessage) {
658 ts("This profile is configured for contact type '%1'. It cannot be used to edit contacts of other types.",
659 array(1 => $profileSubType ?
$profileSubType : $profileType));
667 array("Membership", "Participant", "Contribution")
671 if (!$statusMessage) {
672 $statusMessage = ts('Profile is not configured for the selected action.');
677 //lets have sigle status message,
678 $this->assign('statusMessage', $statusMessage);
683 $this->assign('id', $this->_id
);
684 $this->assign('mode', $this->_mode
);
685 $this->assign('action', $this->_action
);
686 $this->assign('fields', $this->_fields
);
687 $this->assign('fieldset', (isset($this->_fieldset
)) ?
$this->_fieldset
: "");
689 // should we restrict what we display
691 if ($this->_mode
== self
::MODE_EDIT
) {
693 // show all fields that are visibile:
694 // if we are a admin OR the same user OR acl-user with access to the profile
695 // or we have checksum access to this contact (i.e. the user without a login) - CRM-5909
697 CRM_Core_Permission
::check('administer users') ||
698 $this->_id
== $this->_currentUserID ||
699 $this->_isPermissionedChecksum ||
703 CRM_Core_Permission
::EDIT
,
706 CRM_Core_PseudoConstant
::get('CRM_Core_DAO_UFField', 'uf_group_id')
714 // if false, user is not logged-in.
716 if (!$this->_currentUserID
) {
717 $defaultLocationType = CRM_Core_BAO_LocationType
::getDefault();
718 $primaryLocationType = $defaultLocationType->id
;
721 $this->assign('anonUser', $anonUser);
723 $addCaptcha = array();
724 $emailPresent = FALSE;
726 // cache the state country fields. based on the results, we could use our javascript solution
727 // in create or register mode
728 $stateCountryMap = array();
730 // add the form elements
731 foreach ($this->_fields
as $name => $field) {
732 // make sure that there is enough permission to expose this field
733 if (!$admin && $field['visibility'] == 'User and User Admin Only') {
734 unset($this->_fields
[$name]);
738 // since the CMS manages the email field, suppress the email display if in
739 // register mode which occur within the CMS form
740 if ($this->_mode
== self
::MODE_REGISTER
&& substr($name, 0, 5) == 'email') {
741 unset($this->_fields
[$name]);
745 list($prefixName, $index) = CRM_Utils_System
::explode('-', $name, 2);
746 if ($prefixName == 'state_province' ||
$prefixName == 'country' ||
$prefixName == 'county') {
747 if (!array_key_exists($index, $stateCountryMap)) {
748 $stateCountryMap[$index] = array();
750 $stateCountryMap[$index][$prefixName] = $name;
753 CRM_Core_BAO_UFGroup
::buildProfile($this, $field, $this->_mode
);
755 if ($field['add_to_group_id']) {
756 $addToGroupId = $field['add_to_group_id'];
759 //build array for captcha
760 if ($field['add_captcha']) {
761 $addCaptcha[$field['group_id']] = $field['add_captcha'];
764 if (($name == 'email-Primary') ||
($name == 'email-' . isset($primaryLocationType) ?
$primaryLocationType : "")) {
765 $emailPresent = TRUE;
766 $this->_mail
= $name;
770 // add captcha only for create mode.
771 if ($this->_mode
== self
::MODE_CREATE
) {
772 // suppress captcha for logged in users only
773 if ($this->_currentUserID
) {
774 $this->_isAddCaptcha
= FALSE;
776 else if (!$this->_isAddCaptcha
&& !empty($addCaptcha)) {
777 $this->_isAddCaptcha
= TRUE;
781 $dao = new CRM_Core_DAO_UFGroup();
782 $dao->id
= $this->_gid
;
784 $dao->addSelect('is_update_dupe');
785 if ($dao->find(TRUE)) {
786 if ($dao->is_update_dupe
) {
787 $this->_isUpdateDupe
= $dao->is_update_dupe
;
793 $this->_isAddCaptcha
= FALSE;
796 //finally add captcha to form.
797 if ($this->_isAddCaptcha
) {
798 $captcha = CRM_Utils_ReCAPTCHA
::singleton();
799 $captcha->add($this);
801 $this->assign("isCaptcha", $this->_isAddCaptcha
);
803 if ($this->_mode
!= self
::MODE_SEARCH
) {
804 if (isset($addToGroupId)) {
805 $this->add('hidden', "add_to_group", $addToGroupId);
806 $this->_addToGroupID
= $addToGroupId;
810 // lets do the defaults, so we can use it for the below state country routines
811 $this->setDefaultsValues();
813 // also do state country js
814 CRM_Core_BAO_Address
::addStateCountryMap($stateCountryMap, $this->_defaults
);
816 $action = CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, NULL);
817 if ($this->_mode
== self
::MODE_CREATE
) {
818 CRM_Core_BAO_CMSUser
::buildForm($this, $this->_gid
, $emailPresent, $action);
821 $this->assign('showCMS', FALSE);
824 $this->assign('groupId', $this->_gid
);
826 // now fix all state country selectors
827 CRM_Core_BAO_Address
::fixAllStateSelects($this, $this->_defaults
);
829 // if view mode pls freeze it with the done button.
830 if ($this->_action
& CRM_Core_Action
::VIEW
) {
834 if ($this->_context
== 'dialog') {
837 $this->_duplicateButtonName
,
838 ts('Save Matching Contact')
844 * Function to validate profile and provided activity Id
846 * @params Integer $activityId Activity Id
847 * @params Integer $gid Profile Id
849 * @return Array $errors Errors ( if any ).
851 static function validateContactActivityProfile($activityId, $contactId, $gid) {
854 $errors[] = 'Profile is using one or more activity fields, and is missing the activity Id (aid) in the URL.';
858 $activityDetails = array();
859 $activityParams = array('id' => $activityId);
860 CRM_Activity_BAO_Activity
::retrieve($activityParams, $activityDetails);
862 if (empty($activityDetails)) {
863 $errors[] = 'Invalid Activity Id (aid).';
867 $profileActivityTypes = CRM_Core_BAO_UFGroup
::groupTypeValues($gid, 'Activity');
869 if ((CRM_Utils_Array
::value('Activity', $profileActivityTypes) &&
870 !in_array($activityDetails['activity_type_id'], $profileActivityTypes['Activity'])
872 (!in_array($contactId, $activityDetails['assignee_contact']) &&
873 !in_array($contactId, $activityDetails['target_contact'])
876 $errors[] = 'This activity cannot be edited or viewed via this profile.';
885 * @param array $fields the input form values
886 * @param array $files the uploaded files if any
887 * @param object $form the form object
889 * @return true if no errors, else array of errors
893 static function formRule($fields, $files, $form) {
894 CRM_Utils_Hook
::validateProfile($form->_ufGroupName
);
897 // if no values, return
898 if (empty($fields)) {
904 // hack we use a -1 in options to indicate that its registration
906 $form->_isUpdateDupe
= 1;
909 if ($form->_mode
== CRM_Profile_Form
::MODE_REGISTER
) {
913 // dont check for duplicates during registration validation: CRM-375
914 if (!$register && !CRM_Utils_Array
::value('_qf_Edit_upload_duplicate', $fields)) {
916 if (CRM_Utils_Array
::value('email-Primary', $fields)) {
917 $fields['email'] = CRM_Utils_Array
::value('email-Primary', $fields);
921 if (CRM_Utils_Array
::value('phone-Primary-1', $fields) &&
922 !CRM_Utils_Array
::value('phone-Primary', $fields)
924 $fields['phone-Primary'] = $fields['phone-Primary-1'];
927 $ctype = CRM_Core_BAO_UFGroup
::getContactType($form->_gid
);
928 // If all profile fields is of Contact Type then consider
929 // profile is of Individual type(default).
931 $ctype = 'Individual';
933 $dedupeParams = CRM_Dedupe_Finder
::formatParams($fields, $ctype);
934 if ($form->_mode
== CRM_Profile_Form
::MODE_CREATE
) {
936 $exceptions = array();
939 // for edit mode we need to allow our own record to be a dupe match!
940 $exceptions = array($form->_session
->get('userID'));
943 // for dialog mode we should always use fuzzy rule.
944 $ruleType = 'Unsupervised';
945 if ($form->_context
== 'dialog') {
946 $ruleType = 'Supervised';
949 $dedupeParams['check_permission'] = FALSE;
950 $ids = CRM_Dedupe_Finder
::dupesByParams($dedupeParams,
956 if ($form->_isUpdateDupe
== 2) {
957 CRM_Core_Session
::setStatus(ts('Note: this contact may be a duplicate of an existing record.'), ts('Possible Duplicate Detected'), 'alert');
959 elseif ($form->_isUpdateDupe
== 1) {
961 $form->_id
= $ids[0];
965 if ($form->_context
== 'dialog') {
966 $contactLinks = CRM_Contact_BAO_Contact_Utils
::formatContactIDSToLinks($ids, TRUE, TRUE);
968 $duplicateContactsLinks = '<div class="matching-contacts-found">';
969 $duplicateContactsLinks .= ts('One matching contact was found. ', array('count' => count($contactLinks['rows']), 'plural' => '%count matching contacts were found.<br />'));
970 if ($contactLinks['msg'] == 'view') {
971 $duplicateContactsLinks .= ts('You can View the existing contact.', array('count' => count($contactLinks['rows']), 'plural' => 'You can View the existing contacts.'));
974 $duplicateContactsLinks .= ts('You can View or Edit the existing contact.', array('count' => count($contactLinks['rows']), 'plural' => 'You can View or Edit the existing contacts.'));
976 $duplicateContactsLinks .= '</div>';
977 $duplicateContactsLinks .= '<table class="matching-contacts-actions">';
979 for ($i = 0; $i < sizeof($contactLinks['rows']); $i++
) {
981 $row .= ' <td class="matching-contacts-name"> ';
982 $row .= $contactLinks['rows'][$i]['display_name'];
984 $row .= ' <td class="matching-contacts-email"> ';
985 $row .= $contactLinks['rows'][$i]['primary_email'];
987 $row .= ' <td class="action-items"> ';
988 $row .= $contactLinks['rows'][$i]['view'] . ' ';
989 $row .= $contactLinks['rows'][$i]['edit'];
994 $duplicateContactsLinks .= $row . '</table>';
995 $duplicateContactsLinks .= "If you're sure this record is not a duplicate, click the 'Save Matching Contact' button below.";
997 $errors['_qf_default'] = $duplicateContactsLinks;
999 // let smarty know that there are duplicates
1000 $template = CRM_Core_Smarty
::singleton();
1001 $template->assign('isDuplicate', 1);
1004 $errors['_qf_default'] = ts('A record already exists with the same information.');
1010 foreach ($fields as $key => $value) {
1011 list($fieldName, $locTypeId, $phoneTypeId) = CRM_Utils_System
::explode('-', $key, 3);
1012 if ($fieldName == 'state_province' && !empty($fields["country-{$locTypeId}"])) {
1013 // Validate Country - State list
1014 $countryId = $fields["country-{$locTypeId}"];
1015 $stateProvinceId = $value;
1017 if ($stateProvinceId && $countryId) {
1018 $stateProvinceDAO = new CRM_Core_DAO_StateProvince();
1019 $stateProvinceDAO->id
= $stateProvinceId;
1020 $stateProvinceDAO->find(TRUE);
1022 if ($stateProvinceDAO->country_id
!= $countryId) {
1023 // country mismatch hence display error
1024 $stateProvinces = CRM_Core_PseudoConstant
::stateProvince();
1025 $countries = CRM_Core_PseudoConstant
::country();
1026 $errors[$key] = "State/Province " . $stateProvinces[$stateProvinceId] . " is not part of " . $countries[$countryId] . ". It belongs to " . $countries[$stateProvinceDAO->country_id
] . ".";
1031 if ($fieldName == 'county' && $fields["state_province-{$locTypeId}"]) {
1032 // Validate County - State list
1033 $stateProvinceId = $fields["state_province-{$locTypeId}"];
1036 if ($countyId && $stateProvinceId) {
1037 $countyDAO = new CRM_Core_DAO_County();
1038 $countyDAO->id
= $countyId;
1039 $countyDAO->find(TRUE);
1041 if ($countyDAO->state_province_id
!= $stateProvinceId) {
1042 // state province mismatch hence display error
1043 $stateProvinces = CRM_Core_PseudoConstant
::stateProvince();
1044 $counties = CRM_Core_PseudoConstant
::county();
1045 $errors[$key] = "County " . $counties[$countyId] . " is not part of " . $stateProvinces[$stateProvinceId] . ". It belongs to " . $stateProvinces[$countyDAO->state_province_id
] . ".";
1050 foreach (CRM_Contact_BAO_Contact
::$_greetingTypes as $greeting) {
1051 if ($greetingType = CRM_Utils_Array
::value($greeting, $fields)) {
1052 $customizedValue = CRM_Core_OptionGroup
::getValue($greeting, 'Customized', 'name');
1053 if ($customizedValue == $greetingType && empty($fields[$greeting . '_custom'])) {
1054 $errors[$greeting . '_custom'] = ts('Custom %1 is a required field if %1 is of type Customized.',
1055 array(1 => ucwords(str_replace('_', ' ', $greeting)))
1061 return empty($errors) ?
TRUE : $errors;
1065 * Process the user submitted custom data values.
1071 public function postProcess() {
1072 $params = $this->controller
->exportValues($this->_name
);
1074 //if the delete record button is clicked
1075 if ($this->_deleteButtonName
) {
1076 if (CRM_Utils_Array
::value($this->_deleteButtonName
, $_POST) && $this->_recordId
) {
1077 $filterParams['id'] = $this->_customGroupId
;
1078 $returnProperities = array('is_multiple', 'table_name');
1079 CRM_Core_DAO
::commonRetrieve("CRM_Core_DAO_CustomGroup", $filterParams, $returnValues, $returnProperities);
1080 if (CRM_Utils_Array
::value('is_multiple', $returnValues)) {
1081 if ($tableName = CRM_Utils_Array
::value('table_name', $returnValues)) {
1082 $sql = "DELETE FROM {$tableName} WHERE id = %1 AND entity_id = %2";
1084 1 => array($this->_recordId
, 'Integer'),
1085 2 => array($this->_id
, 'Integer')
1087 CRM_Core_DAO
::executeQuery($sql, $sqlParams);
1088 CRM_Core_Session
::setStatus(ts('Your record has been deleted.'), ts('Deleted'), 'success');
1094 CRM_Utils_Hook
::processProfile($this->_ufGroupName
);
1095 if (CRM_Utils_Array
::value('image_URL', $params)) {
1096 CRM_Contact_BAO_Contact
::processImageParams($params);
1099 $greetingTypes = array(
1100 'addressee' => 'addressee_id',
1101 'email_greeting' => 'email_greeting_id',
1102 'postal_greeting' => 'postal_greeting_id',
1107 $contactDetails = CRM_Contact_BAO_Contact
::getHierContactDetails($this->_id
,
1110 $details = $contactDetails[0][$this->_id
];
1112 if (!(CRM_Utils_Array
::value('addressee_id', $details) ||
1113 CRM_Utils_Array
::value('email_greeting_id', $details) ||
1114 CRM_Utils_Array
::value('postal_greeting_id', $details)
1117 $profileType = CRM_Core_BAO_UFField
::getProfileType($this->_gid
);
1118 //Though Profile type is contact we need
1119 //Individual/Household/Organization for setting Greetings.
1120 if ($profileType == 'Contact') {
1121 $profileType = 'Individual';
1122 //if we editing Household/Organization.
1124 $profileType = CRM_Contact_BAO_Contact
::getContactType($this->_id
);
1127 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
1128 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
1131 foreach ($greetingTypes as $key => $value) {
1132 if (!array_key_exists($key, $params)) {
1133 $params[$key] = CRM_Contact_BAO_Contact_Utils
::defaultGreeting($profileType, $key);
1138 $transaction = new CRM_Core_Transaction();
1140 //used to send subcribe mail to the group which user want.
1141 //if the profile double option in is enabled
1142 $mailingType = array();
1143 $config = CRM_Core_Config
::singleton();
1146 foreach ($params as $name => $values) {
1147 if (substr($name, 0, 6) == 'email-') {
1148 $result['email'] = $values;
1152 //array of group id, subscribed by contact
1153 $contactGroup = array();
1154 if (CRM_Utils_Array
::value('group', $params) &&
1155 CRM_Core_BAO_UFGroup
::isProfileDoubleOptin()
1157 $groupSubscribed = array();
1158 if (CRM_Utils_Array
::value('email', $result)) {
1160 $contactGroups = new CRM_Contact_DAO_GroupContact();
1161 $contactGroups->contact_id
= $this->_id
;
1162 $contactGroups->status
= 'Added';
1163 $contactGroups->find();
1164 $contactGroup = array();
1165 while ($contactGroups->fetch()) {
1166 $contactGroup[] = $contactGroups->group_id
;
1167 $groupSubscribed[$contactGroups->group_id
] = 1;
1170 foreach ($params['group'] as $key => $val) {
1172 unset($params['group'][$key]);
1175 $groupTypes = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group',
1176 $key, 'group_type', 'id'
1178 $groupType = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1179 substr($groupTypes, 1, -1)
1181 //filter group of mailing type and unset it from params
1182 if (in_array(2, $groupType)) {
1183 //if group is already subscribed , ignore it
1184 $groupExist = CRM_Utils_Array
::key($key, $contactGroup);
1185 if (!isset($groupExist)) {
1186 $mailingType[] = $key;
1187 unset($params['group'][$key]);
1194 $addToGroupId = NULL;
1195 if (CRM_Utils_Array
::value('add_to_group', $params)) {
1196 $addToGroupId = $params['add_to_group'];
1198 //run same check whether group is a mailing list
1199 $groupTypes = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group',
1200 $addToGroupId, 'group_type', 'id'
1202 $groupType = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1203 substr($groupTypes, 1, -1)
1205 //filter group of mailing type and unset it from params
1206 if (in_array(2, $groupType) &&
1207 CRM_Utils_Array
::value('email', $result) &&
1208 CRM_Core_BAO_UFGroup
::isProfileAddToGroupDoubleOptin()
1210 if (!count($contactGroup)) {
1211 //array of group id, subscribed by contact
1212 $contactGroup = array();
1214 $contactGroups = new CRM_Contact_DAO_GroupContact();
1215 $contactGroups->contact_id
= $this->_id
;
1216 $contactGroups->status
= 'Added';
1217 $contactGroups->find();
1218 $contactGroup = array();
1219 while ($contactGroups->fetch()) {
1220 $contactGroup[] = $contactGroups->group_id
;
1221 $groupSubscribed[$contactGroups->group_id
] = 1;
1225 //if group is already subscribed , ignore it
1226 $groupExist = CRM_Utils_Array
::key($addToGroupId, $contactGroup);
1227 if (!isset($groupExist)) {
1228 $mailingType[] = $addToGroupId;
1229 $addToGroupId = NULL;
1233 // since we are directly adding contact to group lets unset it from mailing
1234 if ($key = array_search($addToGroupId, $mailingType)) {
1235 unset($mailingType[$key]);
1241 $params['group'] = $groupSubscribed;
1244 // commenting below code, since we potentially
1245 // triggered maximum name field formatting cases during CRM-4430.
1247 // $params['preserveDBName'] = true;
1249 $profileFields = $this->_fields
;
1250 if (($this->_mode
& self
::MODE_EDIT
) && $this->_activityId
&& $this->_isContactActivityProfile
) {
1251 $profileFields = $activityParams = array();
1252 foreach ($this->_fields
as $fieldName => $field) {
1253 if (CRM_Utils_Array
::value('field_type', $field) == 'Activity') {
1254 if (isset($params[$fieldName])) {
1255 $activityParams[$fieldName] = $params[$fieldName];
1257 if (isset($params['activity_date_time'])) {
1258 $activityParams['activity_date_time'] = CRM_Utils_Date
::processDate($params['activity_date_time'], $params['activity_date_time_time']);
1260 if (CRM_Utils_Array
::value($fieldName, $params) && isset($params["{$fieldName}_id"])) {
1261 $activityParams[$fieldName] = $params["{$fieldName}_id"];
1265 $profileFields[$fieldName] = $field;
1269 if (!empty($activityParams)) {
1270 $activityParams['version'] = 3;
1271 $activityParams['id'] = $this->_activityId
;
1272 $activityParams['skipRecentView'] = TRUE;
1273 civicrm_api('Activity', 'create', $activityParams);
1277 if ($this->_multiRecord
&& $this->_recordId
&& $this->_multiRecordFields
&& $this->_recordExists
) {
1278 $params['customRecordValues'][$this->_recordId
] = array_keys($this->_multiRecordFields
);
1281 $this->_id
= CRM_Contact_BAO_Contact
::createProfileContact(
1291 //mailing type group
1292 if (!empty($mailingType)) {
1293 // we send in the contactID so we match the same groups and are exact, rather than relying on email
1295 CRM_Mailing_Event_BAO_Subscribe
::commonSubscribe($mailingType, $result, $this->_id
, 'profile');
1298 $ufGroups = array();
1300 $ufGroups[$this->_gid
] = 1;
1302 elseif ($this->_mode
== self
::MODE_REGISTER
) {
1303 $ufGroups = CRM_Core_BAO_UFGroup
::getModuleUFGroup('User Registration');
1306 foreach ($ufGroups as $gId => $val) {
1307 if ($notify = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $gId, 'notify')) {
1308 $values = CRM_Core_BAO_UFGroup
::checkFieldsEmptyValues($gId, $this->_id
, NULL);
1309 CRM_Core_BAO_UFGroup
::commonSendMail($this->_id
, $values);
1313 //create CMS user (if CMS user option is selected in profile)
1314 if (CRM_Utils_Array
::value('cms_create_account', $params) &&
1315 $this->_mode
== self
::MODE_CREATE
1317 $params['contactID'] = $this->_id
;
1318 if (!CRM_Core_BAO_CMSUser
::create($params, $this->_mail
)) {
1319 CRM_Core_Session
::setStatus(ts('Your profile is not saved and Account is not created.'), ts('Profile Error'), 'error');
1320 $transaction->rollback();
1321 return CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/profile/create',
1322 'reset=1&gid=' . $this->_gid
1327 $transaction->commit();
1330 function checkTemplateFileExists($suffix = NULL) {
1332 $templateFile = "CRM/Profile/Form/{$this->_gid}/{$this->_name}.{$suffix}tpl";
1333 $template = CRM_Core_Form
::getTemplate();
1334 if ($template->template_exists($templateFile)) {
1335 return $templateFile;
1338 // lets see if we have customized by name
1339 $ufGroupName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $this->_gid
, 'name');
1341 $templateFile = "CRM/Profile/Form/{$ufGroupName}/{$this->_name}.{$suffix}tpl";
1342 if ($template->template_exists($templateFile)) {
1343 return $templateFile;
1350 function getTemplateFileName() {
1351 $fileName = $this->checkTemplateFileExists();
1352 return $fileName ?
$fileName : parent
::getTemplateFileName();
1355 function overrideExtraTemplateFileName() {
1356 $fileName = $this->checkTemplateFileExists('extra.');
1357 return $fileName ?
$fileName : parent
::overrideExtraTemplateFileName();