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;
114 public $_isAddCaptcha = FALSE;
116 protected $_isPermissionedChecksum = FALSE;
119 * THe context from which we came from, allows us to go there if redirect not set
126 * THe contact type for registration case.
130 protected $_ctype = NULL;
132 protected $_defaults = NULL;
135 * Store profile ids if multiple profile ids are passed using comma separated.
136 * Currently lets implement this functionality only for dialog mode
138 protected $_profileIds = array();
141 * Contact profile having activity fields?
145 protected $_isContactActivityProfile = FALSE;
148 * Activity Id connected to the profile.
152 protected $_activityId = NULL;
155 protected $_multiRecordFields = NULL;
157 protected $_recordId = NULL;
160 * Action for multi record profile (create/edit/delete)
164 protected $_multiRecord = NULL;
166 protected $_multiRecordProfile = FALSE;
168 protected $_recordExists = TRUE;
170 protected $_customGroupTitle = NULL;
172 protected $_deleteButtonName = NULL;
174 protected $_customGroupId = NULL;
176 protected $_currentUserID = NULL;
177 protected $_session = NULL;
180 * Explicitly declare the entity api name.
182 public function getDefaultEntity() {
187 * Pre processing work done here.
189 * gets session variables for table name, id of entity in table, type of entity and stores them.
195 public function preProcess() {
196 $this->_id
= $this->get('id');
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)) ? CRM_Core_Action
::resolve($multiRecordAction) : $multiRecordAction;
219 if ($this->_multiRecord
) {
220 $this->set('multiRecord', $this->_multiRecord
);
223 if ($this->_multiRecord
&&
224 !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));
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);
255 $this->set('gid', $this->_gid
);
258 $this->_activityId
= CRM_Utils_Request
::retrieve('aid', 'Positive', $this, FALSE, 0, 'GET');
259 if (is_numeric($this->_activityId
)) {
260 $latestRevisionId = CRM_Activity_BAO_Activity
::getLatestActivityId($this->_activityId
);
261 if ($latestRevisionId) {
262 $this->_activityId
= $latestRevisionId;
265 $this->_isContactActivityProfile
= CRM_Core_BAO_UFField
::checkContactActivityProfileType($this->_gid
);
267 //get values for ufGroupName, captch and dupe update.
269 $dao = new CRM_Core_DAO_UFGroup();
270 $dao->id
= $this->_gid
;
271 if ($dao->find(TRUE)) {
272 $this->_isUpdateDupe
= $dao->is_update_dupe
;
273 $this->_isAddCaptcha
= $dao->add_captcha
;
274 $this->_ufGroup
= (array) $dao;
278 if (!CRM_Utils_Array
::value('is_active', $this->_ufGroup
)) {
279 CRM_Core_Error
::fatal(ts('The requested profile (gid=%1) is inactive or does not exist.', array(
284 $this->assign('ufGroupName', $this->_ufGroup
['name']);
286 $gids = empty($this->_profileIds
) ?
$this->_gid
: $this->_profileIds
;
288 // if we dont have a gid use the default, else just use that specific gid
289 if (($this->_mode
== self
::MODE_REGISTER ||
$this->_mode
== self
::MODE_CREATE
) && !$this->_gid
) {
290 $this->_ctype
= CRM_Utils_Request
::retrieve('ctype', 'String', $this, FALSE, 'Individual', 'REQUEST');
291 $this->_fields
= CRM_Core_BAO_UFGroup
::getRegistrationFields($this->_action
, $this->_mode
, $this->_ctype
);
293 elseif ($this->_mode
== self
::MODE_SEARCH
) {
294 $this->_fields
= CRM_Core_BAO_UFGroup
::getListingFields($this->_action
,
295 CRM_Core_BAO_UFGroup
::PUBLIC_VISIBILITY | CRM_Core_BAO_UFGroup
::LISTINGS_VISIBILITY
,
299 $this->_skipPermission
,
300 CRM_Core_Permission
::SEARCH
304 $this->_fields
= CRM_Core_BAO_UFGroup
::getFields($gids, FALSE, NULL,
307 $this->_skipPermission
,
309 ($this->_action
== CRM_Core_Action
::ADD
) ? CRM_Core_Permission
::CREATE
: CRM_Core_Permission
::EDIT
311 $multiRecordFieldListing = FALSE;
312 //using selector for listing of multirecord fields
313 if ($this->_mode
== self
::MODE_EDIT
&& $this->_gid
) {
314 CRM_Core_BAO_UFGroup
::shiftMultiRecordFields($this->_fields
, $this->_multiRecordFields
);
316 if ($this->_multiRecord
) {
317 if ($this->_multiRecord
!= CRM_Core_Action
::ADD
) {
318 $this->_recordId
= CRM_Utils_Request
::retrieve('recordId', 'Positive', $this);
321 $this->_recordId
= NULL;
322 $this->set('recordId', NULL);
324 //record id is neccessary for _multiRecord view and update/edit action
325 if (!$this->_recordId
326 && ($this->_multiRecord
== CRM_Core_Action
::UPDATE ||
$this->_multiRecord
== CRM_Core_Action
::DELETE
)
328 CRM_Core_Error
::fatal(ts('The requested Profile (gid=%1) requires record id while performing this action',
329 array(1 => $this->_gid
)
332 elseif (empty($this->_multiRecordFields
)) {
333 CRM_Core_Error
::fatal(ts('No Multi-Record Fields configured for this profile (gid=%1)',
334 array(1 => $this->_gid
)
338 $fieldId = CRM_Core_BAO_CustomField
::getKeyID(key($this->_multiRecordFields
));
339 $customGroupDetails = CRM_Core_BAO_CustomGroup
::getGroupTitles(array($fieldId));
340 $this->_customGroupTitle
= $customGroupDetails[$fieldId]['groupTitle'];
341 $this->_customGroupId
= $customGroupDetails[$fieldId]['groupID'];
343 if ($this->_multiRecord
== CRM_Core_Action
::UPDATE ||
$this->_multiRecord
== CRM_Core_Action
::DELETE
) {
344 //record exists check
345 foreach ($this->_multiRecordFields
as $key => $field) {
346 $fieldIds[] = CRM_Core_BAO_CustomField
::getKeyID($key);
348 $getValues = CRM_Core_BAO_CustomValueTable
::getEntityValues($this->_id
, NULL, $fieldIds, TRUE);
350 if (array_key_exists($this->_recordId
, $getValues)) {
351 $this->_recordExists
= TRUE;
354 $this->_recordExists
= FALSE;
355 if ($this->_multiRecord
& CRM_Core_Action
::UPDATE
) {
356 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');
360 if ($this->_multiRecord
& CRM_Core_Action
::ADD
) {
361 $this->_maxRecordLimit
= CRM_Core_BAO_CustomGroup
::hasReachedMaxLimit($customGroupDetails[$fieldId]['groupID'], $this->_id
);
362 if ($this->_maxRecordLimit
) {
363 CRM_Core_Session
::setStatus(ts('You cannot add a new record as maximum allowed limit is reached'), ts('Sorry'), 'error');
368 elseif (!empty($this->_multiRecordFields
)
369 && (!$this->_multiRecord ||
!in_array($this->_multiRecord
, array(
370 CRM_Core_Action
::DELETE
,
371 CRM_Core_Action
::UPDATE
,
374 CRM_Core_Resources
::singleton()->addScriptFile('civicrm', 'js/crm.livePage.js', 1, 'html-header');
375 //multirecord listing page
376 $multiRecordFieldListing = TRUE;
377 $page = new CRM_Profile_Page_MultipleRecordFieldsListing();
378 $cs = $this->get('cs');
379 $page->set('pageCheckSum', $cs);
380 $page->set('contactId', $this->_id
);
381 $page->set('profileId', $this->_gid
);
382 $page->set('action', CRM_Core_Action
::BROWSE
);
383 $page->set('multiRecordFieldListing', $multiRecordFieldListing);
387 $this->assign('multiRecordFieldListing', $multiRecordFieldListing);
389 // is profile double-opt in?
390 if (!empty($this->_fields
['group']) &&
391 CRM_Core_BAO_UFGroup
::isProfileDoubleOptin()
394 foreach ($this->_fields
as $name => $values) {
395 if (substr($name, 0, 6) == 'email-') {
401 $status = ts("Email field should be included in profile if you want to use Group(s) when Profile double-opt in process is enabled.");
402 $this->_session
->setStatus($status);
406 //transferring all the multi-record custom fields in _fields
407 if ($this->_multiRecord
&& !empty($this->_multiRecordFields
)) {
408 $this->_fields
= $this->_multiRecordFields
;
409 $this->_multiRecordProfile
= TRUE;
411 elseif ($this->_multiRecord
&& empty($this->_multiRecordFields
)) {
412 CRM_Core_Session
::setStatus(ts('This feature is not currently available.'), ts('Sorry'), 'error');
413 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm', 'reset=1'));
417 if (!is_array($this->_fields
)) {
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'));
424 * Set default values for the form. Note that in edit/view mode
425 * the default values are retrieved from the database
430 public function setDefaultsValues() {
431 $this->_defaults
= array();
432 if ($this->_multiRecordProfile
&& ($this->_multiRecord
== CRM_Core_Action
::DELETE
)) {
436 if ($this->_mode
!= self
::MODE_SEARCH
) {
437 // set default values for country / state to start with
438 CRM_Core_BAO_UFGroup
::setRegisterDefaults($this->_fields
, $this->_defaults
);
441 if ($this->_id
&& !$this->_multiRecordProfile
) {
442 if ($this->_isContactActivityProfile
) {
443 $contactFields = $activityFields = array();
444 foreach ($this->_fields
as $fieldName => $field) {
445 if (CRM_Utils_Array
::value('field_type', $field) == 'Activity') {
446 $activityFields[$fieldName] = $field;
449 $contactFields[$fieldName] = $field;
453 CRM_Core_BAO_UFGroup
::setProfileDefaults($this->_id
, $contactFields, $this->_defaults
, TRUE);
454 if ($this->_activityId
) {
455 CRM_Core_BAO_UFGroup
::setComponentDefaults($activityFields, $this->_activityId
, 'Activity', $this->_defaults
, TRUE);
459 CRM_Core_BAO_UFGroup
::setProfileDefaults($this->_id
, $this->_fields
, $this->_defaults
, TRUE);
463 //set custom field defaults
464 if ($this->_multiRecordProfile
) {
465 foreach ($this->_multiRecordFields
as $key => $field) {
466 $fieldIds[] = CRM_Core_BAO_CustomField
::getKeyID($key);
469 $defaultValues = array();
470 if ($this->_multiRecord
&& $this->_multiRecord
== CRM_Core_Action
::UPDATE
) {
471 $defaultValues = CRM_Core_BAO_CustomValueTable
::getEntityValues($this->_id
, NULL, $fieldIds, TRUE);
472 if ($this->_recordExists
== TRUE) {
473 $defaultValues = $defaultValues[$this->_recordId
];
476 $defaultValues = NULL;
480 if (!empty($defaultValues)) {
481 foreach ($defaultValues as $key => $value) {
482 $name = "custom_{$key}";
483 $htmlType = $this->_multiRecordFields
[$name]['html_type'];
484 if ($htmlType != 'File') {
486 CRM_Core_BAO_CustomField
::setProfileDefaults($key,
495 $this->_defaults
[$name] = "";
499 if ($htmlType == 'File') {
500 $entityId = $this->_id
;
501 if (CRM_Utils_Array
::value('field_type', $field) == 'Activity' &&
504 $entityId = $this->_activityId
;
506 $url = CRM_Core_BAO_CustomField
::getFileURL($entityId, $key);
509 $customFiles[$name]['displayURL'] = ts("Attached File") . ": {$url['file_url']}";
511 $deleteExtra = ts("Are you sure you want to delete attached file?");
512 $fileId = $url['file_id'];
513 $deleteURL = CRM_Utils_System
::url('civicrm/file',
514 "reset=1&id={$fileId}&eid=$entityId&fid={$key}&action=delete"
516 $text = ts("Delete Attached File");
517 $customFiles[$field['name']]['deleteURL'] = "<a href=\"{$deleteURL}\" onclick = \"if (confirm( ' $deleteExtra ' )) this.href+='&confirmed=1'; else return false;\">$text</a>";
519 // also delete the required rule that we've set on the form element
520 $this->removeFileRequiredRules($name);
527 foreach ($this->_fields
as $name => $field) {
528 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($name)) {
529 $htmlType = $field['html_type'];
530 if ((!isset($this->_defaults
[$name]) ||
$htmlType == 'File') &&
531 (CRM_Utils_Array
::value('field_type', $field) != 'Activity')
533 CRM_Core_BAO_CustomField
::setProfileDefaults($customFieldID,
541 if ($htmlType == 'File') {
542 $entityId = $this->_id
;
543 if (CRM_Utils_Array
::value('field_type', $field) == 'Activity' && $this->_activityId
) {
544 $entityId = $this->_activityId
;
546 $url = CRM_Core_BAO_CustomField
::getFileURL($entityId, $customFieldID);
549 $customFiles[$field['name']]['displayURL'] = ts("Attached File") . ": {$url['file_url']}";
551 $deleteExtra = ts("Are you sure you want to delete attached file?");
552 $fileId = $url['file_id'];
553 $deleteURL = CRM_Utils_System
::url('civicrm/file',
554 "reset=1&id={$fileId}&eid=$entityId&fid={$customFieldID}&action=delete"
556 $text = ts("Delete Attached File");
557 $customFiles[$field['name']]['deleteURL'] = "<a href=\"{$deleteURL}\" onclick = \"if (confirm( ' $deleteExtra ' )) this.href+='&confirmed=1'; else return false;\">$text</a>";
559 // also delete the required rule that we've set on the form element
560 $this->removeFileRequiredRules($field['name']);
566 if (isset($customFiles)) {
567 $this->assign('customFiles', $customFiles);
570 if ($this->_multiRecordProfile
) {
571 $this->setDefaults($this->_defaults
);
575 if (!empty($this->_defaults
['image_URL'])) {
576 list($imageWidth, $imageHeight) = getimagesize(CRM_Utils_String
::unstupifyUrl($this->_defaults
['image_URL']));
577 list($imageThumbWidth, $imageThumbHeight) = CRM_Contact_BAO_Contact
::getThumbSize($imageWidth, $imageHeight);
578 $this->assign("imageWidth", $imageWidth);
579 $this->assign("imageHeight", $imageHeight);
580 $this->assign("imageThumbWidth", $imageThumbWidth);
581 $this->assign("imageThumbHeight", $imageThumbHeight);
582 $this->assign("imageURL", $this->_defaults
['image_URL']);
583 $this->removeFileRequiredRules('image_URL');
586 if (array_key_exists('contact_sub_type', $this->_defaults
) &&
587 !empty($this->_defaults
['contact_sub_type'])
589 $this->_defaults
['contact_sub_type'] = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
590 trim($this->_defaults
['contact_sub_type'], CRM_Core_DAO
::VALUE_SEPARATOR
)
594 $this->setDefaults($this->_defaults
);
598 * Build the form object.
602 public function buildQuickForm() {
603 $this->add('hidden', 'gid', $this->_gid
);
605 switch ($this->_mode
) {
606 case self
::MODE_CREATE
:
607 case self
::MODE_EDIT
:
608 case self
::MODE_REGISTER
:
609 CRM_Utils_Hook
::buildProfile($this->_ufGroup
['name']);
612 case self
::MODE_SEARCH
:
613 CRM_Utils_Hook
::searchProfile($this->_ufGroup
['name']);
619 //lets have single status message, CRM-4363
621 $statusMessage = NULL;
622 if (($this->_multiRecord
& CRM_Core_Action
::ADD
) && $this->_maxRecordLimit
) {
626 if (($this->_multiRecord
& CRM_Core_Action
::DELETE
)) {
627 if (!$this->_recordExists
) {
628 CRM_Core_Session
::setStatus(ts('The record %1 doesnot exists', array(1 => $this->_recordId
)), ts('Record doesnot exists'), 'alert');
631 $this->assign('deleteRecord', TRUE);
636 CRM_Core_BAO_Address
::checkContactSharedAddressFields($this->_fields
, $this->_id
);
638 // we should not allow component and mix profiles in search mode
639 if ($this->_mode
!= self
::MODE_REGISTER
) {
640 //check for mix profile fields (eg: individual + other contact type)
641 if (CRM_Core_BAO_UFField
::checkProfileType($this->_gid
)) {
642 if (($this->_mode
& self
::MODE_EDIT
) && $this->_isContactActivityProfile
) {
643 $errors = self
::validateContactActivityProfile($this->_activityId
, $this->_id
, $this->_gid
);
644 if (!empty($errors)) {
645 $statusMessage = array_pop($errors);
650 $statusMessage = ts('Profile search, view and edit are not supported for Profiles which include fields for more than one record type.');
655 $profileType = CRM_Core_BAO_UFField
::getProfileType($this->_gid
);
658 $contactTypes = CRM_Contact_BAO_Contact
::getContactTypes($this->_id
);
659 $contactType = $contactTypes[0];
661 array_shift($contactTypes);
662 $contactSubtypes = $contactTypes;
664 $profileSubType = FALSE;
665 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
666 $profileSubType = $profileType;
667 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
671 ($profileType != 'Contact' && !$this->_isContactActivityProfile
) &&
672 (($profileSubType && !empty($contactSubtypes) && (!in_array($profileSubType, $contactSubtypes))) ||
673 ($profileType != $contactType))
676 if (!$statusMessage) {
677 $statusMessage = ts("This profile is configured for contact type '%1'. It cannot be used to edit contacts of other types.",
678 array(1 => $profileSubType ?
$profileSubType : $profileType));
686 array("Membership", "Participant", "Contribution")
690 if (!$statusMessage) {
691 $statusMessage = ts('Profile is not configured for the selected action.');
696 //lets have single status message,
697 $this->assign('statusMessage', $statusMessage);
702 $this->assign('id', $this->_id
);
703 $this->assign('mode', $this->_mode
);
704 $this->assign('action', $this->_action
);
705 $this->assign('fields', $this->_fields
);
706 $this->assign('fieldset', (isset($this->_fieldset
)) ?
$this->_fieldset
: "");
708 // should we restrict what we display
710 if ($this->_mode
== self
::MODE_EDIT
) {
712 // show all fields that are visibile:
713 // if we are a admin OR the same user OR acl-user with access to the profile
714 // or we have checksum access to this contact (i.e. the user without a login) - CRM-5909
716 CRM_Core_Permission
::check('administer users') ||
717 $this->_id
== $this->_currentUserID ||
718 $this->_isPermissionedChecksum ||
722 CRM_Core_Permission
::EDIT
,
725 CRM_Core_PseudoConstant
::get('CRM_Core_DAO_UFField', 'uf_group_id')
733 // if false, user is not logged-in.
735 if (!$this->_currentUserID
) {
736 $defaultLocationType = CRM_Core_BAO_LocationType
::getDefault();
737 $primaryLocationType = $defaultLocationType->id
;
740 $this->assign('anonUser', $anonUser);
742 $addCaptcha = array();
743 $emailPresent = FALSE;
745 // add the form elements
746 foreach ($this->_fields
as $name => $field) {
747 // make sure that there is enough permission to expose this field
748 if (!$admin && $field['visibility'] == 'User and User Admin Only') {
749 unset($this->_fields
[$name]);
753 // since the CMS manages the email field, suppress the email display if in
754 // register mode which occur within the CMS form
755 if ($this->_mode
== self
::MODE_REGISTER
&& substr($name, 0, 5) == 'email') {
756 unset($this->_fields
[$name]);
760 list($prefixName, $index) = CRM_Utils_System
::explode('-', $name, 2);
762 CRM_Core_BAO_UFGroup
::buildProfile($this, $field, $this->_mode
);
764 if ($field['add_to_group_id']) {
765 $addToGroupId = $field['add_to_group_id'];
768 //build array for captcha
769 if ($field['add_captcha']) {
770 $addCaptcha[$field['group_id']] = $field['add_captcha'];
773 if (($name == 'email-Primary') ||
($name == 'email-' . isset($primaryLocationType) ?
$primaryLocationType : "")) {
774 $emailPresent = TRUE;
775 $this->_mail
= $name;
779 // add captcha only for create mode.
780 if ($this->_mode
== self
::MODE_CREATE
) {
781 // suppress captcha for logged in users only
782 if ($this->_currentUserID
) {
783 $this->_isAddCaptcha
= FALSE;
785 elseif (!$this->_isAddCaptcha
&& !empty($addCaptcha)) {
786 $this->_isAddCaptcha
= TRUE;
790 $dao = new CRM_Core_DAO_UFGroup();
791 $dao->id
= $this->_gid
;
793 $dao->addSelect('is_update_dupe');
794 if ($dao->find(TRUE)) {
795 if ($dao->is_update_dupe
) {
796 $this->_isUpdateDupe
= $dao->is_update_dupe
;
802 $this->_isAddCaptcha
= FALSE;
805 //finally add captcha to form.
806 if ($this->_isAddCaptcha
) {
807 $captcha = CRM_Utils_ReCAPTCHA
::singleton();
808 $captcha->add($this);
810 $this->assign("isCaptcha", $this->_isAddCaptcha
);
812 if ($this->_mode
!= self
::MODE_SEARCH
) {
813 if (isset($addToGroupId)) {
814 $this->_ufGroup
['add_to_group_id'] = $addToGroupId;
818 //let's do set defaults for the profile
819 $this->setDefaultsValues();
821 $action = CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, NULL);
822 if ($this->_mode
== self
::MODE_CREATE
) {
823 CRM_Core_BAO_CMSUser
::buildForm($this, $this->_gid
, $emailPresent, $action);
826 $this->assign('showCMS', FALSE);
829 $this->assign('groupId', $this->_gid
);
831 // if view mode pls freeze it with the done button.
832 if ($this->_action
& CRM_Core_Action
::VIEW
) {
836 if ($this->_context
== 'dialog') {
839 $this->_duplicateButtonName
,
840 ts('Save Matching Contact')
846 * Validate profile and provided activity Id.
848 * @param int $activityId
849 * @param int $contactId
854 public static function validateContactActivityProfile($activityId, $contactId, $gid) {
857 $errors[] = 'Profile is using one or more activity fields, and is missing the activity Id (aid) in the URL.';
861 $activityDetails = array();
862 $activityParams = array('id' => $activityId);
863 CRM_Activity_BAO_Activity
::retrieve($activityParams, $activityDetails);
865 if (empty($activityDetails)) {
866 $errors[] = 'Invalid Activity Id (aid).';
870 $profileActivityTypes = CRM_Core_BAO_UFGroup
::groupTypeValues($gid, 'Activity');
872 if ((!empty($profileActivityTypes['Activity']) &&
873 !in_array($activityDetails['activity_type_id'], $profileActivityTypes['Activity'])
875 (!in_array($contactId, $activityDetails['assignee_contact']) &&
876 !in_array($contactId, $activityDetails['target_contact'])
879 $errors[] = 'This activity cannot be edited or viewed via this profile.';
888 * @param array $fields
889 * The input form values.
890 * @param array $files
891 * The uploaded files if any.
892 * @param CRM_Core_Form $form
896 * true if no errors, else array of errors
898 public static function formRule($fields, $files, $form) {
899 CRM_Utils_Hook
::validateProfile($form->_ufGroup
['name']);
902 // if no values, return
903 if (empty($fields)) {
909 // hack we use a -1 in options to indicate that its registration
911 $form->_isUpdateDupe
= 1;
914 if ($form->_mode
== CRM_Profile_Form
::MODE_REGISTER
) {
918 // dont check for duplicates during registration validation: CRM-375
919 if (!$register && empty($fields['_qf_Edit_upload_duplicate'])) {
921 if (!empty($fields['email-Primary'])) {
922 $fields['email'] = CRM_Utils_Array
::value('email-Primary', $fields);
926 if (!empty($fields['phone-Primary-1']) && empty($fields['phone-Primary'])) {
927 $fields['phone-Primary'] = $fields['phone-Primary-1'];
930 $ctype = CRM_Core_BAO_UFGroup
::getContactType($form->_gid
);
931 // If all profile fields is of Contact Type then consider
932 // profile is of Individual type(default).
934 $ctype = 'Individual';
936 $dedupeParams = CRM_Dedupe_Finder
::formatParams($fields, $ctype);
937 if ($form->_mode
== CRM_Profile_Form
::MODE_CREATE
) {
939 $exceptions = array();
942 // for edit mode we need to allow our own record to be a dupe match!
943 $exceptions = array($form->_session
->get('userID'));
946 // for dialog mode we should always use fuzzy rule.
947 $ruleType = 'Unsupervised';
948 if ($form->_context
== 'dialog') {
949 $ruleType = 'Supervised';
952 $dedupeParams['check_permission'] = FALSE;
953 $ids = CRM_Dedupe_Finder
::dupesByParams($dedupeParams,
959 if ($form->_isUpdateDupe
== 2) {
960 CRM_Core_Session
::setStatus(ts('Note: this contact may be a duplicate of an existing record.'), ts('Possible Duplicate Detected'), 'alert');
962 elseif ($form->_isUpdateDupe
== 1) {
964 $form->_id
= $ids[0];
968 if ($form->_context
== 'dialog') {
969 $contactLinks = CRM_Contact_BAO_Contact_Utils
::formatContactIDSToLinks($ids, TRUE, TRUE);
971 $duplicateContactsLinks = '<div class="matching-contacts-found">';
972 $duplicateContactsLinks .= ts('One matching contact was found. ', array(
973 'count' => count($contactLinks['rows']),
974 'plural' => '%count matching contacts were found.<br />',
976 if ($contactLinks['msg'] == 'view') {
977 $duplicateContactsLinks .= ts('You can View the existing contact.', array(
978 'count' => count($contactLinks['rows']),
979 'plural' => 'You can View the existing contacts.',
983 $duplicateContactsLinks .= ts('You can View or Edit the existing contact.', array(
984 'count' => count($contactLinks['rows']),
985 'plural' => 'You can View or Edit the existing contacts.',
988 $duplicateContactsLinks .= '</div>';
989 $duplicateContactsLinks .= '<table class="matching-contacts-actions">';
991 for ($i = 0; $i < count($contactLinks['rows']); $i++
) {
993 $row .= ' <td class="matching-contacts-name"> ';
994 $row .= $contactLinks['rows'][$i]['display_name'];
996 $row .= ' <td class="matching-contacts-email"> ';
997 $row .= $contactLinks['rows'][$i]['primary_email'];
999 $row .= ' <td class="action-items"> ';
1000 $row .= $contactLinks['rows'][$i]['view'] . ' ';
1001 $row .= $contactLinks['rows'][$i]['edit'];
1006 $duplicateContactsLinks .= $row . '</table>';
1007 $duplicateContactsLinks .= "If you're sure this record is not a duplicate, click the 'Save Matching Contact' button below.";
1009 $errors['_qf_default'] = $duplicateContactsLinks;
1011 // let smarty know that there are duplicates
1012 $template = CRM_Core_Smarty
::singleton();
1013 $template->assign('isDuplicate', 1);
1016 $errors['_qf_default'] = ts('A record already exists with the same information.');
1022 foreach ($fields as $key => $value) {
1023 list($fieldName, $locTypeId, $phoneTypeId) = CRM_Utils_System
::explode('-', $key, 3);
1024 if ($fieldName == 'state_province' && !empty($fields["country-{$locTypeId}"])) {
1025 // Validate Country - State list
1026 $countryId = $fields["country-{$locTypeId}"];
1027 $stateProvinceId = $value;
1029 if ($stateProvinceId && $countryId) {
1030 $stateProvinceDAO = new CRM_Core_DAO_StateProvince();
1031 $stateProvinceDAO->id
= $stateProvinceId;
1032 $stateProvinceDAO->find(TRUE);
1034 if ($stateProvinceDAO->country_id
!= $countryId) {
1035 // country mismatch hence display error
1036 $stateProvinces = CRM_Core_PseudoConstant
::stateProvince();
1037 $countries = CRM_Core_PseudoConstant
::country();
1038 $errors[$key] = "State/Province " . $stateProvinces[$stateProvinceId] . " is not part of " . $countries[$countryId] . ". It belongs to " . $countries[$stateProvinceDAO->country_id
] . ".";
1043 if ($fieldName == 'county' && $fields["state_province-{$locTypeId}"]) {
1044 // Validate County - State list
1045 $stateProvinceId = $fields["state_province-{$locTypeId}"];
1048 if ($countyId && $stateProvinceId) {
1049 $countyDAO = new CRM_Core_DAO_County();
1050 $countyDAO->id
= $countyId;
1051 $countyDAO->find(TRUE);
1053 if ($countyDAO->state_province_id
!= $stateProvinceId) {
1054 // state province mismatch hence display error
1055 $stateProvinces = CRM_Core_PseudoConstant
::stateProvince();
1056 $counties = CRM_Core_PseudoConstant
::county();
1057 $errors[$key] = "County " . $counties[$countyId] . " is not part of " . $stateProvinces[$stateProvinceId] . ". It belongs to " . $stateProvinces[$countyDAO->state_province_id
] . ".";
1062 foreach (CRM_Contact_BAO_Contact
::$_greetingTypes as $greeting) {
1063 if ($greetingType = CRM_Utils_Array
::value($greeting, $fields)) {
1064 $customizedValue = CRM_Core_OptionGroup
::getValue($greeting, 'Customized', 'name');
1065 if ($customizedValue == $greetingType && empty($fields[$greeting . '_custom'])) {
1066 $errors[$greeting . '_custom'] = ts('Custom %1 is a required field if %1 is of type Customized.',
1067 array(1 => ucwords(str_replace('_', ' ', $greeting)))
1073 return empty($errors) ?
TRUE : $errors;
1077 * Process the user submitted custom data values.
1082 public function postProcess() {
1083 $params = $this->controller
->exportValues($this->_name
);
1085 //if the delete record button is clicked
1086 if ($this->_deleteButtonName
) {
1087 if (!empty($_POST[$this->_deleteButtonName
]) && $this->_recordId
) {
1088 $filterParams['id'] = $this->_customGroupId
;
1089 $returnProperties = array('is_multiple', 'table_name');
1090 CRM_Core_DAO
::commonRetrieve("CRM_Core_DAO_CustomGroup", $filterParams, $returnValues, $returnProperties);
1091 if (!empty($returnValues['is_multiple'])) {
1092 if ($tableName = CRM_Utils_Array
::value('table_name', $returnValues)) {
1093 $sql = "DELETE FROM {$tableName} WHERE id = %1 AND entity_id = %2";
1095 1 => array($this->_recordId
, 'Integer'),
1096 2 => array($this->_id
, 'Integer'),
1098 CRM_Core_DAO
::executeQuery($sql, $sqlParams);
1099 CRM_Core_Session
::setStatus(ts('Your record has been deleted.'), ts('Deleted'), 'success');
1105 CRM_Utils_Hook
::processProfile($this->_ufGroup
['name']);
1106 if (!empty($params['image_URL'])) {
1107 CRM_Contact_BAO_Contact
::processImageParams($params);
1110 $greetingTypes = array(
1111 'addressee' => 'addressee_id',
1112 'email_greeting' => 'email_greeting_id',
1113 'postal_greeting' => 'postal_greeting_id',
1118 $contactDetails = CRM_Contact_BAO_Contact
::getHierContactDetails($this->_id
,
1121 $details = $contactDetails[0][$this->_id
];
1123 if (!(!empty($details['addressee_id']) ||
!empty($details['email_greeting_id']) ||
1124 CRM_Utils_Array
::value('postal_greeting_id', $details)
1128 $profileType = CRM_Core_BAO_UFField
::getProfileType($this->_gid
);
1129 //Though Profile type is contact we need
1130 //Individual/Household/Organization for setting Greetings.
1131 if ($profileType == 'Contact') {
1132 $profileType = 'Individual';
1133 //if we editing Household/Organization.
1135 $profileType = CRM_Contact_BAO_Contact
::getContactType($this->_id
);
1138 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
1139 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
1142 foreach ($greetingTypes as $key => $value) {
1143 if (!array_key_exists($key, $params)) {
1144 $params[$key] = CRM_Contact_BAO_Contact_Utils
::defaultGreeting($profileType, $key);
1149 $transaction = new CRM_Core_Transaction();
1151 //used to send subscribe mail to the group which user want.
1152 //if the profile double option in is enabled
1153 $mailingType = array();
1156 foreach ($params as $name => $values) {
1157 if (substr($name, 0, 6) == 'email-') {
1158 $result['email'] = $values;
1162 //array of group id, subscribed by contact
1163 $contactGroup = array();
1164 if (!empty($params['group']) &&
1165 CRM_Core_BAO_UFGroup
::isProfileDoubleOptin()
1167 $groupSubscribed = array();
1168 if (!empty($result['email'])) {
1170 $contactGroups = new CRM_Contact_DAO_GroupContact();
1171 $contactGroups->contact_id
= $this->_id
;
1172 $contactGroups->status
= 'Added';
1173 $contactGroups->find();
1174 $contactGroup = array();
1175 while ($contactGroups->fetch()) {
1176 $contactGroup[] = $contactGroups->group_id
;
1177 $groupSubscribed[$contactGroups->group_id
] = 1;
1180 foreach ($params['group'] as $key => $val) {
1182 unset($params['group'][$key]);
1185 $groupTypes = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group',
1186 $key, 'group_type', 'id'
1188 $groupType = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1189 substr($groupTypes, 1, -1)
1191 //filter group of mailing type and unset it from params
1192 if (in_array(2, $groupType)) {
1193 //if group is already subscribed , ignore it
1194 $groupExist = CRM_Utils_Array
::key($key, $contactGroup);
1195 if (!isset($groupExist)) {
1196 $mailingType[] = $key;
1197 unset($params['group'][$key]);
1204 $addToGroupId = CRM_Utils_Array
::value('add_to_group_id', $this->_ufGroup
);
1205 if (!empty($addToGroupId)) {
1206 //run same check whether group is a mailing list
1207 $groupTypes = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group',
1208 $addToGroupId, 'group_type', 'id'
1210 $groupType = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1211 substr($groupTypes, 1, -1)
1213 //filter group of mailing type and unset it from params
1214 if (in_array(2, $groupType) && !empty($result['email']) &&
1215 CRM_Core_BAO_UFGroup
::isProfileAddToGroupDoubleOptin()
1217 if (!count($contactGroup)) {
1218 //array of group id, subscribed by contact
1219 $contactGroup = array();
1221 $contactGroups = new CRM_Contact_DAO_GroupContact();
1222 $contactGroups->contact_id
= $this->_id
;
1223 $contactGroups->status
= 'Added';
1224 $contactGroups->find();
1225 $contactGroup = array();
1226 while ($contactGroups->fetch()) {
1227 $contactGroup[] = $contactGroups->group_id
;
1228 $groupSubscribed[$contactGroups->group_id
] = 1;
1232 //if group is already subscribed , ignore it
1233 $groupExist = CRM_Utils_Array
::key($addToGroupId, $contactGroup);
1234 if (!isset($groupExist)) {
1235 $mailingType[] = $addToGroupId;
1236 $addToGroupId = NULL;
1240 // since we are directly adding contact to group lets unset it from mailing
1241 if ($key = array_search($addToGroupId, $mailingType)) {
1242 unset($mailingType[$key]);
1248 $params['group'] = $groupSubscribed;
1251 // commenting below code, since we potentially
1252 // triggered maximum name field formatting cases during CRM-4430.
1254 // $params['preserveDBName'] = true;
1256 $profileFields = $this->_fields
;
1257 if (($this->_mode
& self
::MODE_EDIT
) && $this->_activityId
&& $this->_isContactActivityProfile
) {
1258 $profileFields = $activityParams = array();
1259 foreach ($this->_fields
as $fieldName => $field) {
1260 if (CRM_Utils_Array
::value('field_type', $field) == 'Activity') {
1261 if (isset($params[$fieldName])) {
1262 $activityParams[$fieldName] = $params[$fieldName];
1264 if (isset($params['activity_date_time'])) {
1265 $activityParams['activity_date_time'] = CRM_Utils_Date
::processDate($params['activity_date_time'], $params['activity_date_time_time']);
1267 if (!empty($params[$fieldName]) && isset($params["{$fieldName}_id"])) {
1268 $activityParams[$fieldName] = $params["{$fieldName}_id"];
1272 $profileFields[$fieldName] = $field;
1276 if (!empty($activityParams)) {
1277 $activityParams['version'] = 3;
1278 $activityParams['id'] = $this->_activityId
;
1279 $activityParams['skipRecentView'] = TRUE;
1280 civicrm_api('Activity', 'create', $activityParams);
1284 if ($this->_multiRecord
&& $this->_recordId
&& $this->_multiRecordFields
&& $this->_recordExists
) {
1285 $params['customRecordValues'][$this->_recordId
] = array_keys($this->_multiRecordFields
);
1288 $this->_id
= CRM_Contact_BAO_Contact
::createProfileContact(
1298 //mailing type group
1299 if (!empty($mailingType)) {
1300 // we send in the contactID so we match the same groups and are exact, rather than relying on email
1302 CRM_Mailing_Event_BAO_Subscribe
::commonSubscribe($mailingType, $result, $this->_id
, 'profile');
1305 $ufGroups = array();
1307 $ufGroups[$this->_gid
] = 1;
1309 elseif ($this->_mode
== self
::MODE_REGISTER
) {
1310 $ufGroups = CRM_Core_BAO_UFGroup
::getModuleUFGroup('User Registration');
1313 foreach ($ufGroups as $gId => $val) {
1314 if ($notify = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $gId, 'notify')) {
1315 $values = CRM_Core_BAO_UFGroup
::checkFieldsEmptyValues($gId, $this->_id
, NULL);
1316 CRM_Core_BAO_UFGroup
::commonSendMail($this->_id
, $values);
1320 //create CMS user (if CMS user option is selected in profile)
1321 if (!empty($params['cms_create_account']) &&
1322 $this->_mode
== self
::MODE_CREATE
1324 $params['contactID'] = $this->_id
;
1325 if (!CRM_Core_BAO_CMSUser
::create($params, $this->_mail
)) {
1326 CRM_Core_Session
::setStatus(ts('Your profile is not saved and Account is not created.'), ts('Profile Error'), 'error');
1327 CRM_Core_Error
::debug_log_message("Rolling back transaction as CMSUser Create failed in Profile_Form for contact " . $params['contactID']);
1328 $transaction->rollback();
1329 return CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/profile/create',
1330 'reset=1&gid=' . $this->_gid
1335 $transaction->commit();
1339 * @param null $suffix
1341 * @return null|string
1343 public function checkTemplateFileExists($suffix = NULL) {
1345 $templateFile = "CRM/Profile/Form/{$this->_gid}/{$this->_name}.{$suffix}tpl";
1346 $template = CRM_Core_Form
::getTemplate();
1347 if ($template->template_exists($templateFile)) {
1348 return $templateFile;
1351 // lets see if we have customized by name
1352 $ufGroupName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $this->_gid
, 'name');
1354 $templateFile = "CRM/Profile/Form/{$ufGroupName}/{$this->_name}.{$suffix}tpl";
1355 if ($template->template_exists($templateFile)) {
1356 return $templateFile;
1364 * Use the form name to create the tpl file name.
1371 public function getTemplateFileName() {
1372 $fileName = $this->checkTemplateFileExists();
1373 return $fileName ?
$fileName : parent
::getTemplateFileName();
1377 * Default extra tpl file basically just replaces .tpl with .extra.tpl
1378 * i.e. we dont override
1385 public function overrideExtraTemplateFileName() {
1386 $fileName = $this->checkTemplateFileExists('extra.');
1387 return $fileName ?
$fileName : parent
::overrideExtraTemplateFileName();