3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
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;
183 public $_stateCountryMap = array();
185 * pre processing work done here.
187 * gets session variables for table name, id of entity in table, type of entity and stores them.
195 function preProcess() {
196 $this->_id
= $this->get('id');
197 $this->_gid
= $this->get('gid');
198 $this->_profileIds
= $this->get('profileIds');
199 $this->_grid
= CRM_Utils_Request
::retrieve('grid', 'Integer', $this);
200 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this);
202 //unset from session when $_GET doesn't have it
203 //except when the form is submitted
205 if (!array_key_exists('multiRecord', $_GET)) {
206 $this->set('multiRecord', NULL);
208 if (!array_key_exists('recordId', $_GET)) {
209 $this->set('recordId', NULL);
213 $this->_session
= CRM_Core_Session
::singleton();
214 $this->_currentUserID
= $this->_session
->get('userID');
216 if ($this->_mode
== self
::MODE_EDIT
) {
217 //specifies the action being done on a multi record field
218 $multiRecordAction = CRM_Utils_Request
::retrieve('multiRecord', 'String', $this);
219 $this->_multiRecord
= (!is_numeric($multiRecordAction)) ?
220 CRM_Core_Action
::resolve($multiRecordAction) : $multiRecordAction;
221 if ($this->_multiRecord
) {
222 $this->set('multiRecord', $this->_multiRecord
);
225 if ($this->_multiRecord
&&
226 !in_array($this->_multiRecord
, array(CRM_Core_Action
::UPDATE
, CRM_Core_Action
::ADD
, CRM_Core_Action
::DELETE
))) {
227 CRM_Core_Error
::fatal(ts('Proper action not specified for this custom value record profile'));
230 $this->_duplicateButtonName
= $this->getButtonName('upload', 'duplicate');
232 $gids = explode(',', CRM_Utils_Request
::retrieve('gid', 'String', CRM_Core_DAO
::$_nullObject, FALSE, 0, 'GET'));
234 if ((count($gids) > 1) && !$this->_profileIds
&& empty($this->_profileIds
)) {
236 foreach ($gids as $pfId) {
237 $this->_profileIds
[] = CRM_Utils_Type
::escape($pfId, 'Positive');
241 // check if we are rendering mixed profiles
242 if (CRM_Core_BAO_UFGroup
::checkForMixProfiles($this->_profileIds
)) {
243 CRM_Core_Error
::fatal(ts('You cannot combine profiles of multiple types.'));
246 // for now consider 1'st profile as primary profile and validate it
247 // i.e check for profile type etc.
248 // FIX ME: validations for other than primary
249 $this->_gid
= $this->_profileIds
[0];
250 $this->set('gid', $this->_gid
);
251 $this->set('profileIds', $this->_profileIds
);
255 $this->_gid
= CRM_Utils_Request
::retrieve('gid', 'Positive', $this, FALSE, 0, 'GET');
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 if (!empty($dao->name
)) {
275 $this->_ufGroupName
= $dao->name
;
280 $this->assign('ufGroupName', $this->_ufGroupName
);
282 $gids = empty($this->_profileIds
) ?
$this->_gid
: $this->_profileIds
;
284 // if we dont have a gid use the default, else just use that specific gid
285 if (($this->_mode
== self
::MODE_REGISTER ||
$this->_mode
== self
::MODE_CREATE
) && !$this->_gid
) {
286 $this->_ctype
= CRM_Utils_Request
::retrieve('ctype', 'String', $this, FALSE, 'Individual', 'REQUEST');
287 $this->_fields
= CRM_Core_BAO_UFGroup
::getRegistrationFields($this->_action
, $this->_mode
, $this->_ctype
);
289 elseif ($this->_mode
== self
::MODE_SEARCH
) {
290 $this->_fields
= CRM_Core_BAO_UFGroup
::getListingFields($this->_action
,
291 CRM_Core_BAO_UFGroup
::PUBLIC_VISIBILITY | CRM_Core_BAO_UFGroup
::LISTINGS_VISIBILITY
,
295 $this->_skipPermission
,
296 CRM_Core_Permission
::SEARCH
300 $this->_fields
= CRM_Core_BAO_UFGroup
::getFields($gids, FALSE, NULL,
303 $this->_skipPermission
,
305 ($this->_action
== CRM_Core_Action
::ADD
) ? CRM_Core_Permission
::CREATE
: CRM_Core_Permission
::EDIT
307 $multiRecordFieldListing = FALSE;
308 //using selector for listing of multirecord fields
309 if ($this->_mode
== self
::MODE_EDIT
&& $this->_gid
) {
310 CRM_Core_BAO_UFGroup
::shiftMultiRecordFields($this->_fields
, $this->_multiRecordFields
);
312 if ($this->_multiRecord
) {
313 if ($this->_multiRecord
!= CRM_Core_Action
::ADD
) {
314 $this->_recordId
= CRM_Utils_Request
::retrieve('recordId', 'Positive', $this);
316 $this->_recordId
= NULL;
317 $this->set('recordId', NULL);
319 //record id is neccessary for _multiRecord view and update/edit action
320 if (!$this->_recordId
321 && ($this->_multiRecord
== CRM_Core_Action
::UPDATE ||
$this->_multiRecord
== CRM_Core_Action
::DELETE
)) {
322 CRM_Core_Error
::fatal(ts('The requested Profile (gid=%1) requires record id while performing this action',
323 array(1 => $this->_gid
)
325 } elseif (empty($this->_multiRecordFields
)) {
326 CRM_Core_Error
::fatal(ts('No Multi-Record Fields configured for this profile (gid=%1)',
327 array(1 => $this->_gid
)
331 $fieldId = CRM_Core_BAO_CustomField
::getKeyID(key($this->_multiRecordFields
));
332 $customGroupDetails = CRM_Core_BAO_CustomGroup
::getGroupTitles(array($fieldId));
333 $this->_customGroupTitle
= $customGroupDetails[$fieldId]['groupTitle'];
334 $this->_customGroupId
= $customGroupDetails[$fieldId]['groupID'];
336 if ($this->_multiRecord
== CRM_Core_Action
::UPDATE ||
$this->_multiRecord
== CRM_Core_Action
::DELETE
) {
337 //record exists check
338 foreach ($this->_multiRecordFields
as $key => $field) {
339 $fieldIds[] = CRM_Core_BAO_CustomField
::getKeyID($key);
341 $getValues = CRM_Core_BAO_CustomValueTable
::getEntityValues($this->_id
, NULL, $fieldIds, TRUE);
343 if (array_key_exists($this->_recordId
, $getValues)) {
344 $this->_recordExists
= TRUE;
346 $this->_recordExists
= FALSE;
347 if ($this->_multiRecord
& CRM_Core_Action
::UPDATE
) {
348 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');
352 if ($this->_multiRecord
& CRM_Core_Action
::ADD
) {
353 $this->_maxRecordLimit
= CRM_Core_BAO_CustomGroup
::hasReachedMaxLimit($customGroupDetails[$fieldId]['groupID'], $this->_id
);
354 if ($this->_maxRecordLimit
) {
355 CRM_Core_Session
::setStatus(ts('You cannot add a new record as maximum allowed limit is reached'), ts('Sorry'), 'error');
359 } elseif (!empty($this->_multiRecordFields
)
360 && (!$this->_multiRecord ||
!in_array($this->_multiRecord
, array(CRM_Core_Action
::DELETE
, CRM_Core_Action
::UPDATE
)) )) {
361 //multirecord listing page
362 $multiRecordFieldListing = TRUE;
363 $page = new CRM_Profile_Page_MultipleRecordFieldsListing();
364 $cs = $this->get('cs');
365 $page->set('pageCheckSum', $cs);
366 $page->set('contactId', $this->_id
);
367 $page->set('profileId', $this->_gid
);
368 $page->set('action', CRM_Core_Action
::BROWSE
);
369 $page->set('multiRecordFieldListing', $multiRecordFieldListing);
373 $this->assign('multiRecordFieldListing', $multiRecordFieldListing);
375 // is profile double-opt in?
376 if (!empty($this->_fields
['group']) &&
377 CRM_Core_BAO_UFGroup
::isProfileDoubleOptin()
380 foreach ($this->_fields
as $name => $values) {
381 if (substr($name, 0, 6) == 'email-') {
387 $status = ts("Email field should be included in profile if you want to use Group(s) when Profile double-opt in process is enabled.");
388 $this->_session
->setStatus($status);
392 //transfering all the multirecord custom fields in _fields
393 if ($this->_multiRecord
&& !empty($this->_multiRecordFields
)) {
394 $this->_fields
= $this->_multiRecordFields
;
395 $this->_multiRecordProfile
= TRUE;
396 } elseif ($this->_multiRecord
&& empty($this->_multiRecordFields
)) {
397 CRM_Core_Session
::setStatus(ts('This feature is not currently available.'), ts('Sorry'), 'error');
398 return CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm', 'reset=1'));
402 if (!is_array($this->_fields
)) {
403 CRM_Core_Session
::setStatus(ts('This feature is not currently available.'), ts('Sorry'), 'error');
404 return CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm', 'reset=1'));
409 * This function sets the default values for the form. Note that in edit/view mode
410 * the default values are retrieved from the database
416 function setDefaultsValues() {
417 $this->_defaults
= array();
418 if ($this->_multiRecordProfile
&& ($this->_multiRecord
== CRM_Core_Action
::DELETE
)) {
422 if ($this->_mode
!= self
::MODE_SEARCH
) {
423 // set default values for country / state to start with
424 CRM_Core_BAO_UFGroup
::setRegisterDefaults($this->_fields
, $this->_defaults
);
427 if ($this->_id
&& !$this->_multiRecordProfile
) {
428 if ($this->_isContactActivityProfile
) {
429 $contactFields = $activityFields = array();
430 foreach ($this->_fields
as $fieldName => $field) {
431 if (CRM_Utils_Array
::value('field_type', $field) == 'Activity') {
432 $activityFields[$fieldName] = $field;
435 $contactFields[$fieldName] = $field;
439 CRM_Core_BAO_UFGroup
::setProfileDefaults($this->_id
, $contactFields, $this->_defaults
, TRUE);
440 if ($this->_activityId
) {
441 CRM_Core_BAO_UFGroup
::setComponentDefaults($activityFields, $this->_activityId
, 'Activity', $this->_defaults
, TRUE);
445 CRM_Core_BAO_UFGroup
::setProfileDefaults($this->_id
, $this->_fields
, $this->_defaults
, TRUE);
449 //set custom field defaults
450 if ($this->_multiRecordProfile
) {
451 foreach ($this->_multiRecordFields
as $key => $field) {
452 $fieldIds[] = CRM_Core_BAO_CustomField
::getKeyID($key);
455 $defaultValues = array( );
456 if ($this->_multiRecord
&& $this->_multiRecord
== CRM_Core_Action
::UPDATE
) {
457 $defaultValues = CRM_Core_BAO_CustomValueTable
::getEntityValues($this->_id
, NULL, $fieldIds, TRUE);
458 if ($this->_recordExists
== TRUE) {
459 $defaultValues = $defaultValues[$this->_recordId
];
461 $defaultValues = NULL;
465 if (!empty($defaultValues)) {
466 foreach ($defaultValues as $key => $value) {
467 $name = "custom_{$key}";
468 $htmlType = $this->_multiRecordFields
[$name]['html_type'];
469 if ($htmlType != 'File') {
471 CRM_Core_BAO_CustomField
::setProfileDefaults($key,
479 $this->_defaults
[$name] = "";
483 if ($htmlType == 'File') {
484 $entityId = $this->_id
;
485 if (CRM_Utils_Array
::value('field_type', $field) == 'Activity' &&
488 $entityId = $this->_activityId
;
490 $url = CRM_Core_BAO_CustomField
::getFileURL($entityId, $key);
493 $customFiles[$name]['displayURL'] = ts("Attached File") . ": {$url['file_url']}";
495 $deleteExtra = ts("Are you sure you want to delete attached file?");
496 $fileId = $url['file_id'];
497 $deleteURL = CRM_Utils_System
::url('civicrm/file',
498 "reset=1&id={$fileId}&eid=$entityId&fid={$key}&action=delete"
500 $text = ts("Delete Attached File");
501 $customFiles[$field['name']]['deleteURL'] = "<a href=\"{$deleteURL}\" onclick = \"if (confirm( ' $deleteExtra ' )) this.href+='&confirmed=1'; else return false;\">$text</a>";
503 // also delete the required rule that we've set on the form element
504 $this->removeFileRequiredRules($name);
511 foreach ($this->_fields
as $name => $field) {
512 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($name)) {
513 $htmlType = $field['html_type'];
514 if ((!isset($this->_defaults
[$name]) ||
$htmlType == 'File') &&
515 (CRM_Utils_Array
::value('field_type', $field) != 'Activity')
517 CRM_Core_BAO_CustomField
::setProfileDefaults($customFieldID,
525 if ($htmlType == 'File') {
526 $entityId = $this->_id
;
527 if (CRM_Utils_Array
::value('field_type', $field) == 'Activity' && $this->_activityId
) {
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 (!empty($this->_defaults
['image_URL'])) {
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']);
567 $this->removeFileRequiredRules('image_URL');
570 if (array_key_exists('contact_sub_type', $this->_defaults
) &&
571 !empty($this->_defaults
['contact_sub_type'])
573 $this->_defaults
['contact_sub_type'] = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
574 trim($this->_defaults
['contact_sub_type'], CRM_Core_DAO
::VALUE_SEPARATOR
)
578 $this->setDefaults($this->_defaults
);
582 * Function to actually build the form
587 public function buildQuickForm() {
588 switch ($this->_mode
) {
589 case self
::MODE_CREATE
:
590 case self
::MODE_EDIT
:
591 case self
::MODE_REGISTER
:
592 CRM_Utils_Hook
::buildProfile($this->_ufGroupName
);
594 case self
::MODE_SEARCH
:
595 CRM_Utils_Hook
::searchProfile($this->_ufGroupName
);
600 //lets have single status message, CRM-4363
602 $statusMessage = NULL;
603 if (($this->_multiRecord
& CRM_Core_Action
::ADD
) && $this->_maxRecordLimit
) {
607 if (($this->_multiRecord
& CRM_Core_Action
::DELETE
)) {
608 if (!$this->_recordExists
) {
609 CRM_Core_Session
::setStatus(ts('The record %1 doesnot exists', array(1 => $this->_recordId
)), ts('Record doesnot exists'), 'alert');
612 $this->assign('deleteRecord', TRUE);
617 CRM_Core_BAO_Address
::checkContactSharedAddressFields($this->_fields
, $this->_id
);
619 // we should not allow component and mix profiles in search mode
620 if ($this->_mode
!= self
::MODE_REGISTER
) {
621 //check for mix profile fields (eg: individual + other contact type)
622 if (CRM_Core_BAO_UFField
::checkProfileType($this->_gid
)) {
623 if (($this->_mode
& self
::MODE_EDIT
) && $this->_isContactActivityProfile
) {
624 $errors = self
::validateContactActivityProfile($this->_activityId
, $this->_id
, $this->_gid
);
625 if (!empty($errors)) {
626 $statusMessage = array_pop($errors);
631 $statusMessage = ts('Profile search, view and edit are not supported for Profiles which include fields for more than one record type.');
636 $profileType = CRM_Core_BAO_UFField
::getProfileType($this->_gid
);
639 $contactTypes = CRM_Contact_BAO_Contact
::getContactTypes($this->_id
);
640 $contactType = $contactTypes[0];
642 array_shift($contactTypes);
643 $contactSubtypes = $contactTypes;
645 $profileSubType = FALSE;
646 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
647 $profileSubType = $profileType;
648 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
652 ($profileType != 'Contact' && !$this->_isContactActivityProfile
) &&
653 (($profileSubType && !empty($contactSubtypes) && (!in_array($profileSubType,$contactSubtypes))) ||
654 ($profileType != $contactType))
657 if (!$statusMessage) {
659 ts("This profile is configured for contact type '%1'. It cannot be used to edit contacts of other types.",
660 array(1 => $profileSubType ?
$profileSubType : $profileType));
668 array("Membership", "Participant", "Contribution")
672 if (!$statusMessage) {
673 $statusMessage = ts('Profile is not configured for the selected action.');
678 //lets have sigle status message,
679 $this->assign('statusMessage', $statusMessage);
684 if (count($this->_submitValues
)) {
685 $locationTypeId = null;
686 foreach ($this->_fields
as $field) {
687 if (!empty($field['location_type_id'])) {
688 $locationTypeId = $field['location_type_id'];
690 if (array_key_exists("country-{$locationTypeId}", $this->_fields
) &&
691 array_key_exists("state_province-{$locationTypeId}", $this->_fields
) &&
692 !empty($this->_submitValues
["country-{$locationTypeId}"])) {
693 $this->_fields
["state_province-{$locationTypeId}"]['is_required'] =
694 CRM_Core_Payment_Form
::checkRequiredStateProvince($this, "country-{$locationTypeId}");
699 $this->assign('id', $this->_id
);
700 $this->assign('mode', $this->_mode
);
701 $this->assign('action', $this->_action
);
702 $this->assign('fields', $this->_fields
);
703 $this->assign('fieldset', (isset($this->_fieldset
)) ?
$this->_fieldset
: "");
705 // should we restrict what we display
707 if ($this->_mode
== self
::MODE_EDIT
) {
709 // show all fields that are visibile:
710 // if we are a admin OR the same user OR acl-user with access to the profile
711 // or we have checksum access to this contact (i.e. the user without a login) - CRM-5909
713 CRM_Core_Permission
::check('administer users') ||
714 $this->_id
== $this->_currentUserID ||
715 $this->_isPermissionedChecksum ||
719 CRM_Core_Permission
::EDIT
,
722 CRM_Core_PseudoConstant
::get('CRM_Core_DAO_UFField', 'uf_group_id')
730 // if false, user is not logged-in.
732 if (!$this->_currentUserID
) {
733 $defaultLocationType = CRM_Core_BAO_LocationType
::getDefault();
734 $primaryLocationType = $defaultLocationType->id
;
737 $this->assign('anonUser', $anonUser);
739 $addCaptcha = array();
740 $emailPresent = FALSE;
742 // cache the state country fields. based on the results, we could use our javascript solution
743 // in create or register mode
744 $stateCountryMap = array();
746 // add the form elements
747 foreach ($this->_fields
as $name => $field) {
748 // make sure that there is enough permission to expose this field
749 if (!$admin && $field['visibility'] == 'User and User Admin Only') {
750 unset($this->_fields
[$name]);
754 // since the CMS manages the email field, suppress the email display if in
755 // register mode which occur within the CMS form
756 if ($this->_mode
== self
::MODE_REGISTER
&& substr($name, 0, 5) == 'email') {
757 unset($this->_fields
[$name]);
761 list($prefixName, $index) = CRM_Utils_System
::explode('-', $name, 2);
762 if ($prefixName == 'state_province' ||
$prefixName == 'country' ||
$prefixName == 'county') {
763 if (!array_key_exists($index, $stateCountryMap)) {
764 $stateCountryMap[$index] = array();
766 $stateCountryMap[$index][$prefixName] = $name;
769 CRM_Core_BAO_UFGroup
::buildProfile($this, $field, $this->_mode
);
771 if ($field['add_to_group_id']) {
772 $addToGroupId = $field['add_to_group_id'];
775 //build array for captcha
776 if ($field['add_captcha']) {
777 $addCaptcha[$field['group_id']] = $field['add_captcha'];
780 if (($name == 'email-Primary') ||
($name == 'email-' . isset($primaryLocationType) ?
$primaryLocationType : "")) {
781 $emailPresent = TRUE;
782 $this->_mail
= $name;
786 // add captcha only for create mode.
787 if ($this->_mode
== self
::MODE_CREATE
) {
788 // suppress captcha for logged in users only
789 if ($this->_currentUserID
) {
790 $this->_isAddCaptcha
= FALSE;
792 else if (!$this->_isAddCaptcha
&& !empty($addCaptcha)) {
793 $this->_isAddCaptcha
= TRUE;
797 $dao = new CRM_Core_DAO_UFGroup();
798 $dao->id
= $this->_gid
;
800 $dao->addSelect('is_update_dupe');
801 if ($dao->find(TRUE)) {
802 if ($dao->is_update_dupe
) {
803 $this->_isUpdateDupe
= $dao->is_update_dupe
;
809 $this->_isAddCaptcha
= FALSE;
812 //finally add captcha to form.
813 if ($this->_isAddCaptcha
) {
814 $captcha = CRM_Utils_ReCAPTCHA
::singleton();
815 $captcha->add($this);
817 $this->assign("isCaptcha", $this->_isAddCaptcha
);
819 if ($this->_mode
!= self
::MODE_SEARCH
) {
820 if (isset($addToGroupId)) {
821 $this->add('hidden', "add_to_group", $addToGroupId);
822 $this->_addToGroupID
= $addToGroupId;
826 // lets do the defaults, so we can use it for the below state country routines
827 $this->setDefaultsValues();
829 // also do state country js
830 CRM_Core_BAO_Address
::addStateCountryMap($stateCountryMap, $this->_defaults
);
832 $action = CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, NULL);
833 if ($this->_mode
== self
::MODE_CREATE
) {
834 CRM_Core_BAO_CMSUser
::buildForm($this, $this->_gid
, $emailPresent, $action);
837 $this->assign('showCMS', FALSE);
840 $this->assign('groupId', $this->_gid
);
842 // now fix all state country selectors
843 CRM_Core_BAO_Address
::fixAllStateSelects($this, $this->_defaults
);
845 // if view mode pls freeze it with the done button.
846 if ($this->_action
& CRM_Core_Action
::VIEW
) {
850 if ($this->_context
== 'dialog') {
853 $this->_duplicateButtonName
,
854 ts('Save Matching Contact')
860 * Function to validate profile and provided activity Id
862 * @params Integer $activityId Activity Id
863 * @params Integer $gid Profile Id
865 * @return Array $errors Errors ( if any ).
867 static function validateContactActivityProfile($activityId, $contactId, $gid) {
870 $errors[] = 'Profile is using one or more activity fields, and is missing the activity Id (aid) in the URL.';
874 $activityDetails = array();
875 $activityParams = array('id' => $activityId);
876 CRM_Activity_BAO_Activity
::retrieve($activityParams, $activityDetails);
878 if (empty($activityDetails)) {
879 $errors[] = 'Invalid Activity Id (aid).';
883 $profileActivityTypes = CRM_Core_BAO_UFGroup
::groupTypeValues($gid, 'Activity');
885 if ((!empty($profileActivityTypes['Activity']) &&
886 !in_array($activityDetails['activity_type_id'], $profileActivityTypes['Activity'])
888 (!in_array($contactId, $activityDetails['assignee_contact']) &&
889 !in_array($contactId, $activityDetails['target_contact'])
892 $errors[] = 'This activity cannot be edited or viewed via this profile.';
901 * @param array $fields the input form values
902 * @param array $files the uploaded files if any
903 * @param object $form the form object
905 * @return true if no errors, else array of errors
909 static function formRule($fields, $files, $form) {
910 CRM_Utils_Hook
::validateProfile($form->_ufGroupName
);
913 // if no values, return
914 if (empty($fields)) {
920 // hack we use a -1 in options to indicate that its registration
922 $form->_isUpdateDupe
= 1;
925 if ($form->_mode
== CRM_Profile_Form
::MODE_REGISTER
) {
929 // dont check for duplicates during registration validation: CRM-375
930 if (!$register && empty($fields['_qf_Edit_upload_duplicate'])) {
932 if (!empty($fields['email-Primary'])) {
933 $fields['email'] = CRM_Utils_Array
::value('email-Primary', $fields);
937 if (!empty($fields['phone-Primary-1']) && empty($fields['phone-Primary'])) {
938 $fields['phone-Primary'] = $fields['phone-Primary-1'];
941 $ctype = CRM_Core_BAO_UFGroup
::getContactType($form->_gid
);
942 // If all profile fields is of Contact Type then consider
943 // profile is of Individual type(default).
945 $ctype = 'Individual';
947 $dedupeParams = CRM_Dedupe_Finder
::formatParams($fields, $ctype);
948 if ($form->_mode
== CRM_Profile_Form
::MODE_CREATE
) {
950 $exceptions = array();
953 // for edit mode we need to allow our own record to be a dupe match!
954 $exceptions = array($form->_session
->get('userID'));
957 // for dialog mode we should always use fuzzy rule.
958 $ruleType = 'Unsupervised';
959 if ($form->_context
== 'dialog') {
960 $ruleType = 'Supervised';
963 $dedupeParams['check_permission'] = FALSE;
964 $ids = CRM_Dedupe_Finder
::dupesByParams($dedupeParams,
970 if ($form->_isUpdateDupe
== 2) {
971 CRM_Core_Session
::setStatus(ts('Note: this contact may be a duplicate of an existing record.'), ts('Possible Duplicate Detected'), 'alert');
973 elseif ($form->_isUpdateDupe
== 1) {
975 $form->_id
= $ids[0];
979 if ($form->_context
== 'dialog') {
980 $contactLinks = CRM_Contact_BAO_Contact_Utils
::formatContactIDSToLinks($ids, TRUE, TRUE);
982 $duplicateContactsLinks = '<div class="matching-contacts-found">';
983 $duplicateContactsLinks .= ts('One matching contact was found. ', array('count' => count($contactLinks['rows']), 'plural' => '%count matching contacts were found.<br />'));
984 if ($contactLinks['msg'] == 'view') {
985 $duplicateContactsLinks .= ts('You can View the existing contact.', array('count' => count($contactLinks['rows']), 'plural' => 'You can View the existing contacts.'));
988 $duplicateContactsLinks .= ts('You can View or Edit the existing contact.', array('count' => count($contactLinks['rows']), 'plural' => 'You can View or Edit the existing contacts.'));
990 $duplicateContactsLinks .= '</div>';
991 $duplicateContactsLinks .= '<table class="matching-contacts-actions">';
993 for ($i = 0; $i < sizeof($contactLinks['rows']); $i++
) {
995 $row .= ' <td class="matching-contacts-name"> ';
996 $row .= $contactLinks['rows'][$i]['display_name'];
998 $row .= ' <td class="matching-contacts-email"> ';
999 $row .= $contactLinks['rows'][$i]['primary_email'];
1001 $row .= ' <td class="action-items"> ';
1002 $row .= $contactLinks['rows'][$i]['view'] . ' ';
1003 $row .= $contactLinks['rows'][$i]['edit'];
1008 $duplicateContactsLinks .= $row . '</table>';
1009 $duplicateContactsLinks .= "If you're sure this record is not a duplicate, click the 'Save Matching Contact' button below.";
1011 $errors['_qf_default'] = $duplicateContactsLinks;
1013 // let smarty know that there are duplicates
1014 $template = CRM_Core_Smarty
::singleton();
1015 $template->assign('isDuplicate', 1);
1018 $errors['_qf_default'] = ts('A record already exists with the same information.');
1024 foreach ($fields as $key => $value) {
1025 list($fieldName, $locTypeId, $phoneTypeId) = CRM_Utils_System
::explode('-', $key, 3);
1026 if ($fieldName == 'state_province' && !empty($fields["country-{$locTypeId}"])) {
1027 // Validate Country - State list
1028 $countryId = $fields["country-{$locTypeId}"];
1029 $stateProvinceId = $value;
1031 if ($stateProvinceId && $countryId) {
1032 $stateProvinceDAO = new CRM_Core_DAO_StateProvince();
1033 $stateProvinceDAO->id
= $stateProvinceId;
1034 $stateProvinceDAO->find(TRUE);
1036 if ($stateProvinceDAO->country_id
!= $countryId) {
1037 // country mismatch hence display error
1038 $stateProvinces = CRM_Core_PseudoConstant
::stateProvince();
1039 $countries = CRM_Core_PseudoConstant
::country();
1040 $errors[$key] = "State/Province " . $stateProvinces[$stateProvinceId] . " is not part of " . $countries[$countryId] . ". It belongs to " . $countries[$stateProvinceDAO->country_id
] . ".";
1045 if ($fieldName == 'county' && $fields["state_province-{$locTypeId}"]) {
1046 // Validate County - State list
1047 $stateProvinceId = $fields["state_province-{$locTypeId}"];
1050 if ($countyId && $stateProvinceId) {
1051 $countyDAO = new CRM_Core_DAO_County();
1052 $countyDAO->id
= $countyId;
1053 $countyDAO->find(TRUE);
1055 if ($countyDAO->state_province_id
!= $stateProvinceId) {
1056 // state province mismatch hence display error
1057 $stateProvinces = CRM_Core_PseudoConstant
::stateProvince();
1058 $counties = CRM_Core_PseudoConstant
::county();
1059 $errors[$key] = "County " . $counties[$countyId] . " is not part of " . $stateProvinces[$stateProvinceId] . ". It belongs to " . $stateProvinces[$countyDAO->state_province_id
] . ".";
1064 foreach (CRM_Contact_BAO_Contact
::$_greetingTypes as $greeting) {
1065 if ($greetingType = CRM_Utils_Array
::value($greeting, $fields)) {
1066 $customizedValue = CRM_Core_OptionGroup
::getValue($greeting, 'Customized', 'name');
1067 if ($customizedValue == $greetingType && empty($fields[$greeting . '_custom'])) {
1068 $errors[$greeting . '_custom'] = ts('Custom %1 is a required field if %1 is of type Customized.',
1069 array(1 => ucwords(str_replace('_', ' ', $greeting)))
1075 return empty($errors) ?
TRUE : $errors;
1079 * Process the user submitted custom data values.
1085 public function postProcess() {
1086 $params = $this->controller
->exportValues($this->_name
);
1088 //if the delete record button is clicked
1089 if ($this->_deleteButtonName
) {
1090 if (!empty($_POST[$this->_deleteButtonName
]) && $this->_recordId
) {
1091 $filterParams['id'] = $this->_customGroupId
;
1092 $returnProperities = array('is_multiple', 'table_name');
1093 CRM_Core_DAO
::commonRetrieve("CRM_Core_DAO_CustomGroup", $filterParams, $returnValues, $returnProperities);
1094 if (!empty($returnValues['is_multiple'])) {
1095 if ($tableName = CRM_Utils_Array
::value('table_name', $returnValues)) {
1096 $sql = "DELETE FROM {$tableName} WHERE id = %1 AND entity_id = %2";
1098 1 => array($this->_recordId
, 'Integer'),
1099 2 => array($this->_id
, 'Integer')
1101 CRM_Core_DAO
::executeQuery($sql, $sqlParams);
1102 CRM_Core_Session
::setStatus(ts('Your record has been deleted.'), ts('Deleted'), 'success');
1108 CRM_Utils_Hook
::processProfile($this->_ufGroupName
);
1109 if (!empty($params['image_URL'])) {
1110 CRM_Contact_BAO_Contact
::processImageParams($params);
1113 $greetingTypes = array(
1114 'addressee' => 'addressee_id',
1115 'email_greeting' => 'email_greeting_id',
1116 'postal_greeting' => 'postal_greeting_id',
1121 $contactDetails = CRM_Contact_BAO_Contact
::getHierContactDetails($this->_id
,
1124 $details = $contactDetails[0][$this->_id
];
1126 if (!(!empty($details['addressee_id']) ||
!empty($details['email_greeting_id']) ||
1127 CRM_Utils_Array
::value('postal_greeting_id', $details)
1130 $profileType = CRM_Core_BAO_UFField
::getProfileType($this->_gid
);
1131 //Though Profile type is contact we need
1132 //Individual/Household/Organization for setting Greetings.
1133 if ($profileType == 'Contact') {
1134 $profileType = 'Individual';
1135 //if we editing Household/Organization.
1137 $profileType = CRM_Contact_BAO_Contact
::getContactType($this->_id
);
1140 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
1141 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
1144 foreach ($greetingTypes as $key => $value) {
1145 if (!array_key_exists($key, $params)) {
1146 $params[$key] = CRM_Contact_BAO_Contact_Utils
::defaultGreeting($profileType, $key);
1151 $transaction = new CRM_Core_Transaction();
1153 //used to send subcribe mail to the group which user want.
1154 //if the profile double option in is enabled
1155 $mailingType = array();
1156 $config = CRM_Core_Config
::singleton();
1159 foreach ($params as $name => $values) {
1160 if (substr($name, 0, 6) == 'email-') {
1161 $result['email'] = $values;
1165 //array of group id, subscribed by contact
1166 $contactGroup = array();
1167 if (!empty($params['group']) &&
1168 CRM_Core_BAO_UFGroup
::isProfileDoubleOptin()
1170 $groupSubscribed = array();
1171 if (!empty($result['email'])) {
1173 $contactGroups = new CRM_Contact_DAO_GroupContact();
1174 $contactGroups->contact_id
= $this->_id
;
1175 $contactGroups->status
= 'Added';
1176 $contactGroups->find();
1177 $contactGroup = array();
1178 while ($contactGroups->fetch()) {
1179 $contactGroup[] = $contactGroups->group_id
;
1180 $groupSubscribed[$contactGroups->group_id
] = 1;
1183 foreach ($params['group'] as $key => $val) {
1185 unset($params['group'][$key]);
1188 $groupTypes = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group',
1189 $key, 'group_type', 'id'
1191 $groupType = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1192 substr($groupTypes, 1, -1)
1194 //filter group of mailing type and unset it from params
1195 if (in_array(2, $groupType)) {
1196 //if group is already subscribed , ignore it
1197 $groupExist = CRM_Utils_Array
::key($key, $contactGroup);
1198 if (!isset($groupExist)) {
1199 $mailingType[] = $key;
1200 unset($params['group'][$key]);
1207 $addToGroupId = NULL;
1208 if (!empty($params['add_to_group'])) {
1209 $addToGroupId = $params['add_to_group'];
1211 //run same check whether group is a mailing list
1212 $groupTypes = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group',
1213 $addToGroupId, 'group_type', 'id'
1215 $groupType = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1216 substr($groupTypes, 1, -1)
1218 //filter group of mailing type and unset it from params
1219 if (in_array(2, $groupType) && !empty($result['email']) &&
1220 CRM_Core_BAO_UFGroup
::isProfileAddToGroupDoubleOptin()
1222 if (!count($contactGroup)) {
1223 //array of group id, subscribed by contact
1224 $contactGroup = array();
1226 $contactGroups = new CRM_Contact_DAO_GroupContact();
1227 $contactGroups->contact_id
= $this->_id
;
1228 $contactGroups->status
= 'Added';
1229 $contactGroups->find();
1230 $contactGroup = array();
1231 while ($contactGroups->fetch()) {
1232 $contactGroup[] = $contactGroups->group_id
;
1233 $groupSubscribed[$contactGroups->group_id
] = 1;
1237 //if group is already subscribed , ignore it
1238 $groupExist = CRM_Utils_Array
::key($addToGroupId, $contactGroup);
1239 if (!isset($groupExist)) {
1240 $mailingType[] = $addToGroupId;
1241 $addToGroupId = NULL;
1245 // since we are directly adding contact to group lets unset it from mailing
1246 if ($key = array_search($addToGroupId, $mailingType)) {
1247 unset($mailingType[$key]);
1253 $params['group'] = $groupSubscribed;
1256 // commenting below code, since we potentially
1257 // triggered maximum name field formatting cases during CRM-4430.
1259 // $params['preserveDBName'] = true;
1261 $profileFields = $this->_fields
;
1262 if (($this->_mode
& self
::MODE_EDIT
) && $this->_activityId
&& $this->_isContactActivityProfile
) {
1263 $profileFields = $activityParams = array();
1264 foreach ($this->_fields
as $fieldName => $field) {
1265 if (CRM_Utils_Array
::value('field_type', $field) == 'Activity') {
1266 if (isset($params[$fieldName])) {
1267 $activityParams[$fieldName] = $params[$fieldName];
1269 if (isset($params['activity_date_time'])) {
1270 $activityParams['activity_date_time'] = CRM_Utils_Date
::processDate($params['activity_date_time'], $params['activity_date_time_time']);
1272 if (!empty($params[$fieldName]) && isset($params["{$fieldName}_id"])) {
1273 $activityParams[$fieldName] = $params["{$fieldName}_id"];
1277 $profileFields[$fieldName] = $field;
1281 if (!empty($activityParams)) {
1282 $activityParams['version'] = 3;
1283 $activityParams['id'] = $this->_activityId
;
1284 $activityParams['skipRecentView'] = TRUE;
1285 civicrm_api('Activity', 'create', $activityParams);
1289 if ($this->_multiRecord
&& $this->_recordId
&& $this->_multiRecordFields
&& $this->_recordExists
) {
1290 $params['customRecordValues'][$this->_recordId
] = array_keys($this->_multiRecordFields
);
1293 $this->_id
= CRM_Contact_BAO_Contact
::createProfileContact(
1303 //mailing type group
1304 if (!empty($mailingType)) {
1305 // we send in the contactID so we match the same groups and are exact, rather than relying on email
1307 CRM_Mailing_Event_BAO_Subscribe
::commonSubscribe($mailingType, $result, $this->_id
, 'profile');
1310 $ufGroups = array();
1312 $ufGroups[$this->_gid
] = 1;
1314 elseif ($this->_mode
== self
::MODE_REGISTER
) {
1315 $ufGroups = CRM_Core_BAO_UFGroup
::getModuleUFGroup('User Registration');
1318 foreach ($ufGroups as $gId => $val) {
1319 if ($notify = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $gId, 'notify')) {
1320 $values = CRM_Core_BAO_UFGroup
::checkFieldsEmptyValues($gId, $this->_id
, NULL);
1321 CRM_Core_BAO_UFGroup
::commonSendMail($this->_id
, $values);
1325 //create CMS user (if CMS user option is selected in profile)
1326 if (!empty($params['cms_create_account']) &&
1327 $this->_mode
== self
::MODE_CREATE
1329 $params['contactID'] = $this->_id
;
1330 if (!CRM_Core_BAO_CMSUser
::create($params, $this->_mail
)) {
1331 CRM_Core_Session
::setStatus(ts('Your profile is not saved and Account is not created.'), ts('Profile Error'), 'error');
1332 CRM_Core_Error
::debug_log_message("Rolling back transaction as CMSUser Create failed in Profile_Form for contact " . $params['contactID']);
1333 $transaction->rollback();
1334 return CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/profile/create',
1335 'reset=1&gid=' . $this->_gid
1340 $transaction->commit();
1343 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;
1363 function getTemplateFileName() {
1364 $fileName = $this->checkTemplateFileExists();
1365 return $fileName ?
$fileName : parent
::getTemplateFileName();
1368 function overrideExtraTemplateFileName() {
1369 $fileName = $this->checkTemplateFileExists('extra.');
1370 return $fileName ?
$fileName : parent
::overrideExtraTemplateFileName();