3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2015
37 * This class generates form components 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 * @var array details of the UFGroup used on this page
72 protected $_ufGroup = array('name' => 'unknown');
75 * The group id that we are passing in url.
82 * Name of button for saving matching contacts.
85 protected $_duplicateButtonName;
87 * The title of the category we are editing.
94 * The fields needed to build this form.
101 * store contact details.
108 * Do we allow updates of the contact.
112 public $_isUpdateDupe = 0;
115 * Dedupe using a specific rule (CRM-6131).
116 * Not currently exposed in profile settings, but can be set in a buildForm hook.
118 public $_ruleGroupID = NULL;
120 public $_isAddCaptcha = FALSE;
122 protected $_isPermissionedChecksum = FALSE;
125 * THe context from which we came from, allows us to go there if redirect not set
132 * THe contact type for registration case.
136 protected $_ctype = NULL;
138 protected $_defaults = NULL;
141 * Store profile ids if multiple profile ids are passed using comma separated.
142 * Currently lets implement this functionality only for dialog mode
144 protected $_profileIds = array();
147 * Contact profile having activity fields?
151 protected $_isContactActivityProfile = FALSE;
154 * Activity Id connected to the profile.
158 protected $_activityId = NULL;
161 protected $_multiRecordFields = NULL;
163 protected $_recordId = NULL;
166 * Action for multi record profile (create/edit/delete)
170 protected $_multiRecord = NULL;
172 protected $_multiRecordProfile = FALSE;
174 protected $_recordExists = TRUE;
176 protected $_customGroupTitle = NULL;
178 protected $_deleteButtonName = NULL;
180 protected $_customGroupId = NULL;
182 protected $_currentUserID = NULL;
183 protected $_session = NULL;
186 * Explicitly declare the entity api name.
188 public function getDefaultEntity() {
193 * Pre processing work done here.
195 * gets session variables for table name, id of entity in table, type of entity and stores them.
201 public function preProcess() {
202 $this->_id
= $this->get('id');
203 $this->_profileIds
= $this->get('profileIds');
204 $this->_grid
= CRM_Utils_Request
::retrieve('grid', 'Integer', $this);
205 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this);
207 //unset from session when $_GET doesn't have it
208 //except when the form is submitted
210 if (!array_key_exists('multiRecord', $_GET)) {
211 $this->set('multiRecord', NULL);
213 if (!array_key_exists('recordId', $_GET)) {
214 $this->set('recordId', NULL);
218 $this->_session
= CRM_Core_Session
::singleton();
219 $this->_currentUserID
= $this->_session
->get('userID');
221 if ($this->_mode
== self
::MODE_EDIT
) {
222 //specifies the action being done on a multi record field
223 $multiRecordAction = CRM_Utils_Request
::retrieve('multiRecord', 'String', $this);
224 $this->_multiRecord
= (!is_numeric($multiRecordAction)) ? CRM_Core_Action
::resolve($multiRecordAction) : $multiRecordAction;
225 if ($this->_multiRecord
) {
226 $this->set('multiRecord', $this->_multiRecord
);
229 if ($this->_multiRecord
&&
230 !in_array($this->_multiRecord
, array(CRM_Core_Action
::UPDATE
, CRM_Core_Action
::ADD
, CRM_Core_Action
::DELETE
))
232 CRM_Core_Error
::fatal(ts('Proper action not specified for this custom value record profile'));
235 $this->_duplicateButtonName
= $this->getButtonName('upload', 'duplicate');
237 $gids = explode(',', CRM_Utils_Request
::retrieve('gid', 'String', CRM_Core_DAO
::$_nullObject, FALSE, 0));
239 if ((count($gids) > 1) && !$this->_profileIds
&& empty($this->_profileIds
)) {
241 foreach ($gids as $pfId) {
242 $this->_profileIds
[] = CRM_Utils_Type
::escape($pfId, 'Positive');
246 // check if we are rendering mixed profiles
247 if (CRM_Core_BAO_UFGroup
::checkForMixProfiles($this->_profileIds
)) {
248 CRM_Core_Error
::fatal(ts('You cannot combine profiles of multiple types.'));
251 // for now consider 1'st profile as primary profile and validate it
252 // i.e check for profile type etc.
253 // FIX ME: validations for other than primary
254 $this->_gid
= $this->_profileIds
[0];
255 $this->set('gid', $this->_gid
);
256 $this->set('profileIds', $this->_profileIds
);
260 $this->_gid
= CRM_Utils_Request
::retrieve('gid', 'Positive', $this, FALSE, 0);
261 $this->set('gid', $this->_gid
);
264 $this->_activityId
= CRM_Utils_Request
::retrieve('aid', 'Positive', $this, FALSE, 0, 'GET');
265 if (is_numeric($this->_activityId
)) {
266 $latestRevisionId = CRM_Activity_BAO_Activity
::getLatestActivityId($this->_activityId
);
267 if ($latestRevisionId) {
268 $this->_activityId
= $latestRevisionId;
271 $this->_isContactActivityProfile
= CRM_Core_BAO_UFField
::checkContactActivityProfileType($this->_gid
);
273 //get values for ufGroupName, captch and dupe update.
275 $dao = new CRM_Core_DAO_UFGroup();
276 $dao->id
= $this->_gid
;
277 if ($dao->find(TRUE)) {
278 $this->_isUpdateDupe
= $dao->is_update_dupe
;
279 $this->_isAddCaptcha
= $dao->add_captcha
;
280 $this->_ufGroup
= (array) $dao;
284 if (!CRM_Utils_Array
::value('is_active', $this->_ufGroup
)) {
285 CRM_Core_Error
::fatal(ts('The requested profile (gid=%1) is inactive or does not exist.', array(
290 $this->assign('ufGroupName', $this->_ufGroup
['name']);
292 $gids = empty($this->_profileIds
) ?
$this->_gid
: $this->_profileIds
;
294 // if we dont have a gid use the default, else just use that specific gid
295 if (($this->_mode
== self
::MODE_REGISTER ||
$this->_mode
== self
::MODE_CREATE
) && !$this->_gid
) {
296 $this->_ctype
= CRM_Utils_Request
::retrieve('ctype', 'String', $this, FALSE, 'Individual', 'REQUEST');
297 $this->_fields
= CRM_Core_BAO_UFGroup
::getRegistrationFields($this->_action
, $this->_mode
, $this->_ctype
);
299 elseif ($this->_mode
== self
::MODE_SEARCH
) {
300 $this->_fields
= CRM_Core_BAO_UFGroup
::getListingFields($this->_action
,
301 CRM_Core_BAO_UFGroup
::PUBLIC_VISIBILITY | CRM_Core_BAO_UFGroup
::LISTINGS_VISIBILITY
,
305 $this->_skipPermission
,
306 CRM_Core_Permission
::SEARCH
310 $this->_fields
= CRM_Core_BAO_UFGroup
::getFields($gids, FALSE, NULL,
313 $this->_skipPermission
,
315 ($this->_action
== CRM_Core_Action
::ADD
) ? CRM_Core_Permission
::CREATE
: CRM_Core_Permission
::EDIT
317 $multiRecordFieldListing = FALSE;
318 //using selector for listing of multirecord fields
319 if ($this->_mode
== self
::MODE_EDIT
&& $this->_gid
) {
320 CRM_Core_BAO_UFGroup
::shiftMultiRecordFields($this->_fields
, $this->_multiRecordFields
);
322 if ($this->_multiRecord
) {
323 if ($this->_multiRecord
!= CRM_Core_Action
::ADD
) {
324 $this->_recordId
= CRM_Utils_Request
::retrieve('recordId', 'Positive', $this);
327 $this->_recordId
= NULL;
328 $this->set('recordId', NULL);
330 //record id is necessary for _multiRecord view and update/edit action
331 if (!$this->_recordId
332 && ($this->_multiRecord
== CRM_Core_Action
::UPDATE ||
$this->_multiRecord
== CRM_Core_Action
::DELETE
)
334 CRM_Core_Error
::fatal(ts('The requested Profile (gid=%1) requires record id while performing this action',
335 array(1 => $this->_gid
)
338 elseif (empty($this->_multiRecordFields
)) {
339 CRM_Core_Error
::fatal(ts('No Multi-Record Fields configured for this profile (gid=%1)',
340 array(1 => $this->_gid
)
344 $fieldId = CRM_Core_BAO_CustomField
::getKeyID(key($this->_multiRecordFields
));
345 $customGroupDetails = CRM_Core_BAO_CustomGroup
::getGroupTitles(array($fieldId));
346 $this->_customGroupTitle
= $customGroupDetails[$fieldId]['groupTitle'];
347 $this->_customGroupId
= $customGroupDetails[$fieldId]['groupID'];
349 if ($this->_multiRecord
== CRM_Core_Action
::UPDATE ||
$this->_multiRecord
== CRM_Core_Action
::DELETE
) {
350 //record exists check
351 foreach ($this->_multiRecordFields
as $key => $field) {
352 $fieldIds[] = CRM_Core_BAO_CustomField
::getKeyID($key);
354 $getValues = CRM_Core_BAO_CustomValueTable
::getEntityValues($this->_id
, NULL, $fieldIds, TRUE);
356 if (array_key_exists($this->_recordId
, $getValues)) {
357 $this->_recordExists
= TRUE;
360 $this->_recordExists
= FALSE;
361 if ($this->_multiRecord
& CRM_Core_Action
::UPDATE
) {
362 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');
366 if ($this->_multiRecord
& CRM_Core_Action
::ADD
) {
367 $this->_maxRecordLimit
= CRM_Core_BAO_CustomGroup
::hasReachedMaxLimit($customGroupDetails[$fieldId]['groupID'], $this->_id
);
368 if ($this->_maxRecordLimit
) {
369 CRM_Core_Session
::setStatus(ts('You cannot add a new record as maximum allowed limit is reached'), ts('Sorry'), 'error');
374 elseif (!empty($this->_multiRecordFields
)
375 && (!$this->_multiRecord ||
!in_array($this->_multiRecord
, array(
376 CRM_Core_Action
::DELETE
,
377 CRM_Core_Action
::UPDATE
,
380 CRM_Core_Resources
::singleton()->addScriptFile('civicrm', 'js/crm.livePage.js', 1, 'html-header');
381 //multirecord listing page
382 $multiRecordFieldListing = TRUE;
383 $page = new CRM_Profile_Page_MultipleRecordFieldsListing();
384 $cs = $this->get('cs');
385 $page->set('pageCheckSum', $cs);
386 $page->set('contactId', $this->_id
);
387 $page->set('profileId', $this->_gid
);
388 $page->set('action', CRM_Core_Action
::BROWSE
);
389 $page->set('multiRecordFieldListing', $multiRecordFieldListing);
393 $this->assign('multiRecordFieldListing', $multiRecordFieldListing);
395 // is profile double-opt in?
396 if (!empty($this->_fields
['group']) &&
397 CRM_Core_BAO_UFGroup
::isProfileDoubleOptin()
400 foreach ($this->_fields
as $name => $values) {
401 if (substr($name, 0, 6) == 'email-') {
407 $status = ts("Email field should be included in profile if you want to use Group(s) when Profile double-opt in process is enabled.");
408 $this->_session
->setStatus($status);
412 //transferring all the multi-record custom fields in _fields
413 if ($this->_multiRecord
&& !empty($this->_multiRecordFields
)) {
414 $this->_fields
= $this->_multiRecordFields
;
415 $this->_multiRecordProfile
= TRUE;
417 elseif ($this->_multiRecord
&& empty($this->_multiRecordFields
)) {
418 CRM_Core_Session
::setStatus(ts('This feature is not currently available.'), ts('Sorry'), 'error');
419 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm', 'reset=1'));
423 if (!is_array($this->_fields
)) {
424 CRM_Core_Session
::setStatus(ts('This feature is not currently available.'), ts('Sorry'), 'error');
425 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm', 'reset=1'));
430 * Set default values for the form. Note that in edit/view mode
431 * the default values are retrieved from the database
436 public function setDefaultsValues() {
437 $this->_defaults
= array();
438 if ($this->_multiRecordProfile
&& ($this->_multiRecord
== CRM_Core_Action
::DELETE
)) {
442 if ($this->_mode
!= self
::MODE_SEARCH
) {
443 // set default values for country / state to start with
444 CRM_Core_BAO_UFGroup
::setRegisterDefaults($this->_fields
, $this->_defaults
);
447 if ($this->_id
&& !$this->_multiRecordProfile
) {
448 if ($this->_isContactActivityProfile
) {
449 $contactFields = $activityFields = array();
450 foreach ($this->_fields
as $fieldName => $field) {
451 if (CRM_Utils_Array
::value('field_type', $field) == 'Activity') {
452 $activityFields[$fieldName] = $field;
455 $contactFields[$fieldName] = $field;
459 CRM_Core_BAO_UFGroup
::setProfileDefaults($this->_id
, $contactFields, $this->_defaults
, TRUE);
460 if ($this->_activityId
) {
461 CRM_Core_BAO_UFGroup
::setComponentDefaults($activityFields, $this->_activityId
, 'Activity', $this->_defaults
, TRUE);
465 CRM_Core_BAO_UFGroup
::setProfileDefaults($this->_id
, $this->_fields
, $this->_defaults
, TRUE);
469 //set custom field defaults
470 if ($this->_multiRecordProfile
) {
471 foreach ($this->_multiRecordFields
as $key => $field) {
472 $fieldIds[] = CRM_Core_BAO_CustomField
::getKeyID($key);
475 $defaultValues = array();
476 if ($this->_multiRecord
&& $this->_multiRecord
== CRM_Core_Action
::UPDATE
) {
477 $defaultValues = CRM_Core_BAO_CustomValueTable
::getEntityValues($this->_id
, NULL, $fieldIds, TRUE);
478 if ($this->_recordExists
== TRUE) {
479 $defaultValues = $defaultValues[$this->_recordId
];
482 $defaultValues = NULL;
486 if (!empty($defaultValues)) {
487 foreach ($defaultValues as $key => $value) {
488 $name = "custom_{$key}";
489 $htmlType = $this->_multiRecordFields
[$name]['html_type'];
490 if ($htmlType != 'File') {
492 CRM_Core_BAO_CustomField
::setProfileDefaults($key,
501 $this->_defaults
[$name] = "";
505 if ($htmlType == 'File') {
506 $entityId = $this->_id
;
507 if (CRM_Utils_Array
::value('field_type', $field) == 'Activity' &&
510 $entityId = $this->_activityId
;
512 $url = CRM_Core_BAO_CustomField
::getFileURL($entityId, $key);
515 $customFiles[$name]['displayURL'] = ts("Attached File") . ": {$url['file_url']}";
517 $deleteExtra = ts("Are you sure you want to delete attached file?");
518 $fileId = $url['file_id'];
519 $deleteURL = CRM_Utils_System
::url('civicrm/file',
520 "reset=1&id={$fileId}&eid=$entityId&fid={$key}&action=delete"
522 $text = ts("Delete Attached File");
523 $customFiles[$field['name']]['deleteURL'] = "<a href=\"{$deleteURL}\" onclick = \"if (confirm( ' $deleteExtra ' )) this.href+='&confirmed=1'; else return false;\">$text</a>";
525 // also delete the required rule that we've set on the form element
526 $this->removeFileRequiredRules($name);
533 foreach ($this->_fields
as $name => $field) {
534 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($name)) {
535 $htmlType = $field['html_type'];
536 if ((!isset($this->_defaults
[$name]) ||
$htmlType == 'File') &&
537 (CRM_Utils_Array
::value('field_type', $field) != 'Activity')
539 CRM_Core_BAO_CustomField
::setProfileDefaults($customFieldID,
547 if ($htmlType == 'File') {
548 $entityId = $this->_id
;
549 if (CRM_Utils_Array
::value('field_type', $field) == 'Activity' && $this->_activityId
) {
550 $entityId = $this->_activityId
;
552 $url = CRM_Core_BAO_CustomField
::getFileURL($entityId, $customFieldID);
555 $customFiles[$field['name']]['displayURL'] = ts("Attached File") . ": {$url['file_url']}";
557 $deleteExtra = ts("Are you sure you want to delete attached file?");
558 $fileId = $url['file_id'];
559 $deleteURL = CRM_Utils_System
::url('civicrm/file',
560 "reset=1&id={$fileId}&eid=$entityId&fid={$customFieldID}&action=delete"
562 $text = ts("Delete Attached File");
563 $customFiles[$field['name']]['deleteURL'] = "<a href=\"{$deleteURL}\" onclick = \"if (confirm( ' $deleteExtra ' )) this.href+='&confirmed=1'; else return false;\">$text</a>";
565 // also delete the required rule that we've set on the form element
566 $this->removeFileRequiredRules($field['name']);
572 if (isset($customFiles)) {
573 $this->assign('customFiles', $customFiles);
576 if ($this->_multiRecordProfile
) {
577 $this->setDefaults($this->_defaults
);
581 if (!empty($this->_defaults
['image_URL'])) {
582 list($imageWidth, $imageHeight) = getimagesize(CRM_Utils_String
::unstupifyUrl($this->_defaults
['image_URL']));
583 list($imageThumbWidth, $imageThumbHeight) = CRM_Contact_BAO_Contact
::getThumbSize($imageWidth, $imageHeight);
584 $this->assign("imageWidth", $imageWidth);
585 $this->assign("imageHeight", $imageHeight);
586 $this->assign("imageThumbWidth", $imageThumbWidth);
587 $this->assign("imageThumbHeight", $imageThumbHeight);
588 $this->assign("imageURL", $this->_defaults
['image_URL']);
589 $this->removeFileRequiredRules('image_URL');
592 if (array_key_exists('contact_sub_type', $this->_defaults
) &&
593 !empty($this->_defaults
['contact_sub_type'])
595 $this->_defaults
['contact_sub_type'] = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
596 trim($this->_defaults
['contact_sub_type'], CRM_Core_DAO
::VALUE_SEPARATOR
)
600 $this->setDefaults($this->_defaults
);
604 * Build the form object.
608 public function buildQuickForm() {
609 $this->add('hidden', 'gid', $this->_gid
);
611 switch ($this->_mode
) {
612 case self
::MODE_CREATE
:
613 case self
::MODE_EDIT
:
614 case self
::MODE_REGISTER
:
615 CRM_Utils_Hook
::buildProfile($this->_ufGroup
['name']);
618 case self
::MODE_SEARCH
:
619 CRM_Utils_Hook
::searchProfile($this->_ufGroup
['name']);
625 //lets have single status message, CRM-4363
627 $statusMessage = NULL;
628 if (($this->_multiRecord
& CRM_Core_Action
::ADD
) && $this->_maxRecordLimit
) {
632 if (($this->_multiRecord
& CRM_Core_Action
::DELETE
)) {
633 if (!$this->_recordExists
) {
634 CRM_Core_Session
::setStatus(ts('The record %1 doesnot exists', array(1 => $this->_recordId
)), ts('Record doesnot exists'), 'alert');
637 $this->assign('deleteRecord', TRUE);
642 CRM_Core_BAO_Address
::checkContactSharedAddressFields($this->_fields
, $this->_id
);
644 // we should not allow component and mix profiles in search mode
645 if ($this->_mode
!= self
::MODE_REGISTER
) {
646 //check for mix profile fields (eg: individual + other contact type)
647 if (CRM_Core_BAO_UFField
::checkProfileType($this->_gid
)) {
648 if (($this->_mode
& self
::MODE_EDIT
) && $this->_isContactActivityProfile
) {
649 $errors = self
::validateContactActivityProfile($this->_activityId
, $this->_id
, $this->_gid
);
650 if (!empty($errors)) {
651 $statusMessage = array_pop($errors);
656 $statusMessage = ts('Profile search, view and edit are not supported for Profiles which include fields for more than one record type.');
661 $profileType = CRM_Core_BAO_UFField
::getProfileType($this->_gid
);
664 $contactTypes = CRM_Contact_BAO_Contact
::getContactTypes($this->_id
);
665 $contactType = $contactTypes[0];
667 array_shift($contactTypes);
668 $contactSubtypes = $contactTypes;
670 $profileSubType = FALSE;
671 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
672 $profileSubType = $profileType;
673 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
677 ($profileType != 'Contact' && !$this->_isContactActivityProfile
) &&
678 (($profileSubType && !empty($contactSubtypes) && (!in_array($profileSubType, $contactSubtypes))) ||
679 ($profileType != $contactType))
682 if (!$statusMessage) {
683 $statusMessage = ts("This profile is configured for contact type '%1'. It cannot be used to edit contacts of other types.",
684 array(1 => $profileSubType ?
$profileSubType : $profileType));
692 array("Membership", "Participant", "Contribution")
696 if (!$statusMessage) {
697 $statusMessage = ts('Profile is not configured for the selected action.');
702 //lets have single status message,
703 $this->assign('statusMessage', $statusMessage);
708 $this->assign('id', $this->_id
);
709 $this->assign('mode', $this->_mode
);
710 $this->assign('action', $this->_action
);
711 $this->assign('fields', $this->_fields
);
712 $this->assign('fieldset', (isset($this->_fieldset
)) ?
$this->_fieldset
: "");
714 // should we restrict what we display
716 if ($this->_mode
== self
::MODE_EDIT
) {
718 // show all fields that are visibile:
719 // if we are a admin OR the same user OR acl-user with access to the profile
720 // or we have checksum access to this contact (i.e. the user without a login) - CRM-5909
722 CRM_Core_Permission
::check('administer users') ||
723 $this->_id
== $this->_currentUserID ||
724 $this->_isPermissionedChecksum ||
728 CRM_Core_Permission
::EDIT
,
731 CRM_Core_PseudoConstant
::get('CRM_Core_DAO_UFField', 'uf_group_id')
739 // if false, user is not logged-in.
741 if (!$this->_currentUserID
) {
742 $defaultLocationType = CRM_Core_BAO_LocationType
::getDefault();
743 $primaryLocationType = $defaultLocationType->id
;
746 $this->assign('anonUser', $anonUser);
748 $addCaptcha = array();
749 $emailPresent = FALSE;
751 // add the form elements
752 foreach ($this->_fields
as $name => $field) {
753 // make sure that there is enough permission to expose this field
754 if (!$admin && $field['visibility'] == 'User and User Admin Only') {
755 unset($this->_fields
[$name]);
759 // since the CMS manages the email field, suppress the email display if in
760 // register mode which occur within the CMS form
761 if ($this->_mode
== self
::MODE_REGISTER
&& substr($name, 0, 5) == 'email') {
762 unset($this->_fields
[$name]);
766 list($prefixName, $index) = CRM_Utils_System
::explode('-', $name, 2);
768 CRM_Core_BAO_UFGroup
::buildProfile($this, $field, $this->_mode
);
770 if ($field['add_to_group_id']) {
771 $addToGroupId = $field['add_to_group_id'];
774 //build array for captcha
775 if ($field['add_captcha']) {
776 $addCaptcha[$field['group_id']] = $field['add_captcha'];
779 if (($name == 'email-Primary') ||
($name == 'email-' . isset($primaryLocationType) ?
$primaryLocationType : "")) {
780 $emailPresent = TRUE;
781 $this->_mail
= $name;
785 // add captcha only for create mode.
786 if ($this->_mode
== self
::MODE_CREATE
) {
787 // suppress captcha for logged in users only
788 if ($this->_currentUserID
) {
789 $this->_isAddCaptcha
= FALSE;
791 elseif (!$this->_isAddCaptcha
&& !empty($addCaptcha)) {
792 $this->_isAddCaptcha
= TRUE;
796 $dao = new CRM_Core_DAO_UFGroup();
797 $dao->id
= $this->_gid
;
799 $dao->addSelect('is_update_dupe');
800 if ($dao->find(TRUE)) {
801 if ($dao->is_update_dupe
) {
802 $this->_isUpdateDupe
= $dao->is_update_dupe
;
808 $this->_isAddCaptcha
= FALSE;
811 //finally add captcha to form.
812 if ($this->_isAddCaptcha
) {
813 $captcha = CRM_Utils_ReCAPTCHA
::singleton();
814 $captcha->add($this);
816 $this->assign("isCaptcha", $this->_isAddCaptcha
);
818 if ($this->_mode
!= self
::MODE_SEARCH
) {
819 if (isset($addToGroupId)) {
820 $this->_ufGroup
['add_to_group_id'] = $addToGroupId;
824 //let's do set defaults for the profile
825 $this->setDefaultsValues();
827 $action = CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, NULL);
828 if ($this->_mode
== self
::MODE_CREATE
) {
829 CRM_Core_BAO_CMSUser
::buildForm($this, $this->_gid
, $emailPresent, $action);
832 $this->assign('showCMS', FALSE);
835 $this->assign('groupId', $this->_gid
);
837 // if view mode pls freeze it with the done button.
838 if ($this->_action
& CRM_Core_Action
::VIEW
) {
842 if ($this->_context
== 'dialog') {
845 $this->_duplicateButtonName
,
846 ts('Save Matching Contact')
852 * Validate profile and provided activity Id.
854 * @param int $activityId
855 * @param int $contactId
860 public static function validateContactActivityProfile($activityId, $contactId, $gid) {
863 $errors[] = 'Profile is using one or more activity fields, and is missing the activity Id (aid) in the URL.';
867 $activityDetails = array();
868 $activityParams = array('id' => $activityId);
869 CRM_Activity_BAO_Activity
::retrieve($activityParams, $activityDetails);
871 if (empty($activityDetails)) {
872 $errors[] = 'Invalid Activity Id (aid).';
876 $profileActivityTypes = CRM_Core_BAO_UFGroup
::groupTypeValues($gid, 'Activity');
878 if ((!empty($profileActivityTypes['Activity']) &&
879 !in_array($activityDetails['activity_type_id'], $profileActivityTypes['Activity'])
881 (!in_array($contactId, $activityDetails['assignee_contact']) &&
882 !in_array($contactId, $activityDetails['target_contact'])
885 $errors[] = 'This activity cannot be edited or viewed via this profile.';
894 * @param array $fields
895 * The input form values.
896 * @param array $files
897 * The uploaded files if any.
898 * @param CRM_Core_Form $form
902 * true if no errors, else array of errors
904 public static function formRule($fields, $files, $form) {
905 CRM_Utils_Hook
::validateProfile($form->_ufGroup
['name']);
908 // if no values, return
909 if (empty($fields)) {
915 // hack we use a -1 in options to indicate that its registration
917 $form->_isUpdateDupe
= 1;
920 if ($form->_mode
== CRM_Profile_Form
::MODE_REGISTER
) {
924 // dont check for duplicates during registration validation: CRM-375
925 if (!$register && empty($fields['_qf_Edit_upload_duplicate'])) {
927 if (!empty($fields['email-Primary'])) {
928 $fields['email'] = CRM_Utils_Array
::value('email-Primary', $fields);
932 if (!empty($fields['phone-Primary-1']) && empty($fields['phone-Primary'])) {
933 $fields['phone-Primary'] = $fields['phone-Primary-1'];
936 $ctype = CRM_Core_BAO_UFGroup
::getContactType($form->_gid
);
937 // If all profile fields is of Contact Type then consider
938 // profile is of Individual type(default).
940 $ctype = 'Individual';
942 $dedupeParams = CRM_Dedupe_Finder
::formatParams($fields, $ctype);
943 if ($form->_mode
== CRM_Profile_Form
::MODE_CREATE
) {
945 $exceptions = array();
948 // for edit mode we need to allow our own record to be a dupe match!
949 $exceptions = array($form->_session
->get('userID'));
952 // for dialog mode we should always use fuzzy rule.
953 $ruleType = 'Unsupervised';
954 if ($form->_context
== 'dialog') {
955 $ruleType = 'Supervised';
958 $dedupeParams['check_permission'] = FALSE;
959 $ids = CRM_Dedupe_Finder
::dupesByParams($dedupeParams,
966 if ($form->_isUpdateDupe
== 2) {
967 CRM_Core_Session
::setStatus(ts('Note: this contact may be a duplicate of an existing record.'), ts('Possible Duplicate Detected'), 'alert');
969 elseif ($form->_isUpdateDupe
== 1) {
971 $form->_id
= $ids[0];
975 if ($form->_context
== 'dialog') {
976 $contactLinks = CRM_Contact_BAO_Contact_Utils
::formatContactIDSToLinks($ids, TRUE, TRUE);
978 $duplicateContactsLinks = '<div class="matching-contacts-found">';
979 $duplicateContactsLinks .= ts('One matching contact was found. ', array(
980 'count' => count($contactLinks['rows']),
981 'plural' => '%count matching contacts were found.<br />',
983 if ($contactLinks['msg'] == 'view') {
984 $duplicateContactsLinks .= ts('You can View the existing contact.', array(
985 'count' => count($contactLinks['rows']),
986 'plural' => 'You can View the existing contacts.',
990 $duplicateContactsLinks .= ts('You can View or Edit the existing contact.', array(
991 'count' => count($contactLinks['rows']),
992 'plural' => 'You can View or Edit the existing contacts.',
995 $duplicateContactsLinks .= '</div>';
996 $duplicateContactsLinks .= '<table class="matching-contacts-actions">';
998 for ($i = 0; $i < count($contactLinks['rows']); $i++
) {
1000 $row .= ' <td class="matching-contacts-name"> ';
1001 $row .= $contactLinks['rows'][$i]['display_name'];
1003 $row .= ' <td class="matching-contacts-email"> ';
1004 $row .= $contactLinks['rows'][$i]['primary_email'];
1006 $row .= ' <td class="action-items"> ';
1007 $row .= $contactLinks['rows'][$i]['view'] . ' ';
1008 $row .= $contactLinks['rows'][$i]['edit'];
1013 $duplicateContactsLinks .= $row . '</table>';
1014 $duplicateContactsLinks .= "If you're sure this record is not a duplicate, click the 'Save Matching Contact' button below.";
1016 $errors['_qf_default'] = $duplicateContactsLinks;
1018 // let smarty know that there are duplicates
1019 $template = CRM_Core_Smarty
::singleton();
1020 $template->assign('isDuplicate', 1);
1023 $errors['_qf_default'] = ts('A record already exists with the same information.');
1029 foreach ($fields as $key => $value) {
1030 list($fieldName, $locTypeId, $phoneTypeId) = CRM_Utils_System
::explode('-', $key, 3);
1031 if ($fieldName == 'state_province' && !empty($fields["country-{$locTypeId}"])) {
1032 // Validate Country - State list
1033 $countryId = $fields["country-{$locTypeId}"];
1034 $stateProvinceId = $value;
1036 if ($stateProvinceId && $countryId) {
1037 $stateProvinceDAO = new CRM_Core_DAO_StateProvince();
1038 $stateProvinceDAO->id
= $stateProvinceId;
1039 $stateProvinceDAO->find(TRUE);
1041 if ($stateProvinceDAO->country_id
!= $countryId) {
1042 // country mismatch hence display error
1043 $stateProvinces = CRM_Core_PseudoConstant
::stateProvince();
1044 $countries = CRM_Core_PseudoConstant
::country();
1045 $errors[$key] = "State/Province " . $stateProvinces[$stateProvinceId] . " is not part of " . $countries[$countryId] . ". It belongs to " . $countries[$stateProvinceDAO->country_id
] . ".";
1050 if ($fieldName == 'county' && $fields["state_province-{$locTypeId}"]) {
1051 // Validate County - State list
1052 $stateProvinceId = $fields["state_province-{$locTypeId}"];
1055 if ($countyId && $stateProvinceId) {
1056 $countyDAO = new CRM_Core_DAO_County();
1057 $countyDAO->id
= $countyId;
1058 $countyDAO->find(TRUE);
1060 if ($countyDAO->state_province_id
!= $stateProvinceId) {
1061 // state province mismatch hence display error
1062 $stateProvinces = CRM_Core_PseudoConstant
::stateProvince();
1063 $counties = CRM_Core_PseudoConstant
::county();
1064 $errors[$key] = "County " . $counties[$countyId] . " is not part of " . $stateProvinces[$stateProvinceId] . ". It belongs to " . $stateProvinces[$countyDAO->state_province_id
] . ".";
1069 foreach (CRM_Contact_BAO_Contact
::$_greetingTypes as $greeting) {
1070 if ($greetingType = CRM_Utils_Array
::value($greeting, $fields)) {
1071 $customizedValue = CRM_Core_OptionGroup
::getValue($greeting, 'Customized', 'name');
1072 if ($customizedValue == $greetingType && empty($fields[$greeting . '_custom'])) {
1073 $errors[$greeting . '_custom'] = ts('Custom %1 is a required field if %1 is of type Customized.',
1074 array(1 => ucwords(str_replace('_', ' ', $greeting)))
1080 return empty($errors) ?
TRUE : $errors;
1084 * Process the user submitted custom data values.
1089 public function postProcess() {
1090 $params = $this->controller
->exportValues($this->_name
);
1092 //if the delete record button is clicked
1093 if ($this->_deleteButtonName
) {
1094 if (!empty($_POST[$this->_deleteButtonName
]) && $this->_recordId
) {
1095 $filterParams['id'] = $this->_customGroupId
;
1096 $returnProperties = array('is_multiple', 'table_name');
1097 CRM_Core_DAO
::commonRetrieve("CRM_Core_DAO_CustomGroup", $filterParams, $returnValues, $returnProperties);
1098 if (!empty($returnValues['is_multiple'])) {
1099 if ($tableName = CRM_Utils_Array
::value('table_name', $returnValues)) {
1100 $sql = "DELETE FROM {$tableName} WHERE id = %1 AND entity_id = %2";
1102 1 => array($this->_recordId
, 'Integer'),
1103 2 => array($this->_id
, 'Integer'),
1105 CRM_Core_DAO
::executeQuery($sql, $sqlParams);
1106 CRM_Core_Session
::setStatus(ts('Your record has been deleted.'), ts('Deleted'), 'success');
1112 CRM_Utils_Hook
::processProfile($this->_ufGroup
['name']);
1113 if (!empty($params['image_URL'])) {
1114 CRM_Contact_BAO_Contact
::processImageParams($params);
1117 $greetingTypes = array(
1118 'addressee' => 'addressee_id',
1119 'email_greeting' => 'email_greeting_id',
1120 'postal_greeting' => 'postal_greeting_id',
1125 $contactDetails = CRM_Contact_BAO_Contact
::getHierContactDetails($this->_id
,
1128 $details = $contactDetails[0][$this->_id
];
1130 if (!(!empty($details['addressee_id']) ||
!empty($details['email_greeting_id']) ||
1131 CRM_Utils_Array
::value('postal_greeting_id', $details)
1135 $profileType = CRM_Core_BAO_UFField
::getProfileType($this->_gid
);
1136 //Though Profile type is contact we need
1137 //Individual/Household/Organization for setting Greetings.
1138 if ($profileType == 'Contact') {
1139 $profileType = 'Individual';
1140 //if we editing Household/Organization.
1142 $profileType = CRM_Contact_BAO_Contact
::getContactType($this->_id
);
1145 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
1146 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
1149 foreach ($greetingTypes as $key => $value) {
1150 if (!array_key_exists($key, $params)) {
1151 $params[$key] = CRM_Contact_BAO_Contact_Utils
::defaultGreeting($profileType, $key);
1156 $transaction = new CRM_Core_Transaction();
1158 //used to send subscribe mail to the group which user want.
1159 //if the profile double option in is enabled
1160 $mailingType = array();
1163 foreach ($params as $name => $values) {
1164 if (substr($name, 0, 6) == 'email-') {
1165 $result['email'] = $values;
1169 //array of group id, subscribed by contact
1170 $contactGroup = array();
1171 if (!empty($params['group']) &&
1172 CRM_Core_BAO_UFGroup
::isProfileDoubleOptin()
1174 $groupSubscribed = array();
1175 if (!empty($result['email'])) {
1177 $contactGroups = new CRM_Contact_DAO_GroupContact();
1178 $contactGroups->contact_id
= $this->_id
;
1179 $contactGroups->status
= 'Added';
1180 $contactGroups->find();
1181 $contactGroup = array();
1182 while ($contactGroups->fetch()) {
1183 $contactGroup[] = $contactGroups->group_id
;
1184 $groupSubscribed[$contactGroups->group_id
] = 1;
1187 foreach ($params['group'] as $key => $val) {
1189 unset($params['group'][$key]);
1192 $groupTypes = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group',
1193 $key, 'group_type', 'id'
1195 $groupType = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1196 substr($groupTypes, 1, -1)
1198 //filter group of mailing type and unset it from params
1199 if (in_array(2, $groupType)) {
1200 //if group is already subscribed , ignore it
1201 $groupExist = CRM_Utils_Array
::key($key, $contactGroup);
1202 if (!isset($groupExist)) {
1203 $mailingType[] = $key;
1204 unset($params['group'][$key]);
1211 $addToGroupId = CRM_Utils_Array
::value('add_to_group_id', $this->_ufGroup
);
1212 if (!empty($addToGroupId)) {
1213 //run same check whether group is a mailing list
1214 $groupTypes = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group',
1215 $addToGroupId, 'group_type', 'id'
1217 $groupType = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1218 substr($groupTypes, 1, -1)
1220 //filter group of mailing type and unset it from params
1221 if (in_array(2, $groupType) && !empty($result['email']) &&
1222 CRM_Core_BAO_UFGroup
::isProfileAddToGroupDoubleOptin()
1224 if (!count($contactGroup)) {
1225 //array of group id, subscribed by contact
1226 $contactGroup = array();
1228 $contactGroups = new CRM_Contact_DAO_GroupContact();
1229 $contactGroups->contact_id
= $this->_id
;
1230 $contactGroups->status
= 'Added';
1231 $contactGroups->find();
1232 $contactGroup = array();
1233 while ($contactGroups->fetch()) {
1234 $contactGroup[] = $contactGroups->group_id
;
1235 $groupSubscribed[$contactGroups->group_id
] = 1;
1239 //if group is already subscribed , ignore it
1240 $groupExist = CRM_Utils_Array
::key($addToGroupId, $contactGroup);
1241 if (!isset($groupExist)) {
1242 $mailingType[] = $addToGroupId;
1243 $addToGroupId = NULL;
1247 // since we are directly adding contact to group lets unset it from mailing
1248 if ($key = array_search($addToGroupId, $mailingType)) {
1249 unset($mailingType[$key]);
1255 $params['group'] = $groupSubscribed;
1258 // commenting below code, since we potentially
1259 // triggered maximum name field formatting cases during CRM-4430.
1261 // $params['preserveDBName'] = true;
1263 $profileFields = $this->_fields
;
1264 if (($this->_mode
& self
::MODE_EDIT
) && $this->_activityId
&& $this->_isContactActivityProfile
) {
1265 $profileFields = $activityParams = array();
1266 foreach ($this->_fields
as $fieldName => $field) {
1267 if (CRM_Utils_Array
::value('field_type', $field) == 'Activity') {
1268 if (isset($params[$fieldName])) {
1269 $activityParams[$fieldName] = $params[$fieldName];
1271 if (isset($params['activity_date_time'])) {
1272 $activityParams['activity_date_time'] = CRM_Utils_Date
::processDate($params['activity_date_time'], $params['activity_date_time_time']);
1274 if (!empty($params[$fieldName]) && isset($params["{$fieldName}_id"])) {
1275 $activityParams[$fieldName] = $params["{$fieldName}_id"];
1279 $profileFields[$fieldName] = $field;
1283 if (!empty($activityParams)) {
1284 $activityParams['version'] = 3;
1285 $activityParams['id'] = $this->_activityId
;
1286 $activityParams['skipRecentView'] = TRUE;
1287 civicrm_api('Activity', 'create', $activityParams);
1291 if ($this->_multiRecord
&& $this->_recordId
&& $this->_multiRecordFields
&& $this->_recordExists
) {
1292 $params['customRecordValues'][$this->_recordId
] = array_keys($this->_multiRecordFields
);
1295 $this->_id
= CRM_Contact_BAO_Contact
::createProfileContact(
1305 //mailing type group
1306 if (!empty($mailingType)) {
1307 // we send in the contactID so we match the same groups and are exact, rather than relying on email
1309 CRM_Mailing_Event_BAO_Subscribe
::commonSubscribe($mailingType, $result, $this->_id
, 'profile');
1312 $ufGroups = array();
1314 $ufGroups[$this->_gid
] = 1;
1316 elseif ($this->_mode
== self
::MODE_REGISTER
) {
1317 $ufGroups = CRM_Core_BAO_UFGroup
::getModuleUFGroup('User Registration');
1320 foreach ($ufGroups as $gId => $val) {
1321 if ($notify = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $gId, 'notify')) {
1322 $values = CRM_Core_BAO_UFGroup
::checkFieldsEmptyValues($gId, $this->_id
, NULL);
1323 CRM_Core_BAO_UFGroup
::commonSendMail($this->_id
, $values);
1327 //create CMS user (if CMS user option is selected in profile)
1328 if (!empty($params['cms_create_account']) &&
1329 $this->_mode
== self
::MODE_CREATE
1331 $params['contactID'] = $this->_id
;
1332 if (!CRM_Core_BAO_CMSUser
::create($params, $this->_mail
)) {
1333 CRM_Core_Session
::setStatus(ts('Your profile is not saved and Account is not created.'), ts('Profile Error'), 'error');
1334 CRM_Core_Error
::debug_log_message("Rolling back transaction as CMSUser Create failed in Profile_Form for contact " . $params['contactID']);
1335 $transaction->rollback();
1336 return CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/profile/create',
1337 'reset=1&gid=' . $this->_gid
1342 $transaction->commit();
1346 * @param null $suffix
1348 * @return null|string
1350 public function checkTemplateFileExists($suffix = NULL) {
1352 $templateFile = "CRM/Profile/Form/{$this->_gid}/{$this->_name}.{$suffix}tpl";
1353 $template = CRM_Core_Form
::getTemplate();
1354 if ($template->template_exists($templateFile)) {
1355 return $templateFile;
1358 // lets see if we have customized by name
1359 $ufGroupName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $this->_gid
, 'name');
1361 $templateFile = "CRM/Profile/Form/{$ufGroupName}/{$this->_name}.{$suffix}tpl";
1362 if ($template->template_exists($templateFile)) {
1363 return $templateFile;
1371 * Use the form name to create the tpl file name.
1378 public function getTemplateFileName() {
1379 $fileName = $this->checkTemplateFileExists();
1380 return $fileName ?
$fileName : parent
::getTemplateFileName();
1384 * Default extra tpl file basically just replaces .tpl with .extra.tpl
1385 * i.e. we dont override
1392 public function overrideExtraTemplateFileName() {
1393 $fileName = $this->checkTemplateFileExists('extra.');
1394 return $fileName ?
$fileName : parent
::overrideExtraTemplateFileName();