3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
37 class CRM_Core_BAO_UFGroup
extends CRM_Core_DAO_UFGroup
{
38 const PUBLIC_VISIBILITY
= 1,
40 LISTINGS_VISIBILITY
= 4;
43 * Cache the match clause used in this transaction.
47 public static $_matchFields = NULL;
50 * Fetch object based on array of properties.
52 * @param array $params
53 * (reference) an assoc array of name/value pairs.
54 * @param array $defaults
55 * (reference) an assoc array to hold the flattened values.
58 * CRM_Core_DAO_UFGroup object
60 public static function retrieve(&$params, &$defaults) {
61 return CRM_Core_DAO
::commonRetrieve('CRM_Core_DAO_UFGroup', $params, $defaults);
65 * Retrieve the first non-generic contact type
73 public static function getContactType($id) {
75 $validTypes = array_filter(array_keys(CRM_Core_SelectValues
::contactType()));
76 $validSubTypes = CRM_Contact_BAO_ContactType
::subTypeInfo();
78 $typesParts = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $id, 'group_type'));
79 $types = explode(',', $typesParts[0]);
82 foreach ($types as $type) {
83 if (in_array($type, $validTypes)) {
86 elseif (array_key_exists($type, $validSubTypes)) {
87 $cType = CRM_Utils_Array
::value('parent', $validSubTypes[$type]);
107 public static function getTitle($id) {
108 return CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $id, 'title');
112 * Update the is_active flag in the db.
115 * Id of the database record.
116 * @param bool $is_active
117 * Value we want to set the is_active field.
120 * true if we found and updated the object, else false
122 public static function setIsActive($id, $is_active) {
123 return CRM_Core_DAO
::setFieldValue('CRM_Core_DAO_UFGroup', $id, 'is_active', $is_active);
127 * Get all the registration fields.
130 * What action are we doing.
137 * the fields that are needed for registration
139 public static function getRegistrationFields($action, $mode, $ctype = NULL) {
140 if ($mode & CRM_Profile_Form
::MODE_REGISTER
) {
141 $ufGroups = CRM_Core_BAO_UFGroup
::getModuleUFGroup('User Registration');
144 $ufGroups = CRM_Core_BAO_UFGroup
::getModuleUFGroup('Profile');
147 if (!is_array($ufGroups)) {
153 foreach ($ufGroups as $id => $title) {
155 $fieldType = CRM_Core_BAO_UFField
::getProfileType($id);
156 if (($fieldType != 'Contact') &&
157 ($fieldType != $ctype) &&
158 !CRM_Contact_BAO_ContactType
::isExtendsContactType($fieldType, $ctype)
162 if (CRM_Contact_BAO_ContactType
::isaSubType($fieldType)) {
163 $profileSubType = $fieldType;
167 $subset = self
::getFields($id, TRUE, $action,
168 NULL, NULL, FALSE, NULL, TRUE, $ctype
171 // we do not allow duplicates. the first field is the winner
172 foreach ($subset as $name => $field) {
173 if (empty($fields[$name])) {
174 $fields[$name] = $field;
183 * Get all the listing fields.
186 * What action are we doing.
187 * @param int $visibility
188 * Visibility of fields we are interested in.
189 * @param bool $considerSelector
190 * Whether to consider the in_selector parameter.
191 * @param array $ufGroupIds
192 * @param bool $searchable
194 * @param null $restrict
195 * @param bool $skipPermission
196 * @param int $permissionType
198 * the fields that are listings related
200 public static function getListingFields(
203 $considerSelector = FALSE,
207 $skipPermission = FALSE,
208 $permissionType = CRM_Core_Permission
::SEARCH
211 $subset = self
::getFields($ufGroupIds, FALSE, $action,
212 $visibility, $searchable,
218 if ($considerSelector) {
219 // drop the fields not meant for the selector
220 foreach ($subset as $name => $field) {
221 if (!$field['in_selector']) {
222 unset($subset[$name]);
229 $ufGroups = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_UFField', 'uf_group_id');
232 foreach ($ufGroups as $id => $title) {
233 $subset = self
::getFields($id, FALSE, $action,
234 $visibility, $searchable,
240 if ($considerSelector) {
241 // drop the fields not meant for the selector
242 foreach ($subset as $name => $field) {
243 if (!$field['in_selector']) {
244 unset($subset[$name]);
248 $fields = array_merge($fields, $subset);
255 * Get all the fields that belong to the group with the name title,
256 * and format for use with buildProfile. This is the SQL analog of
260 * The id of the UF group or ids of ufgroup.
261 * @param bool|int $register are we interested in registration fields
263 * What action are we doing.
264 * @param int $visibility
265 * Visibility of fields we are interested in.
267 * @param bool $showAll
268 * @param string $restrict
269 * Should we restrict based on a specified profile type.
270 * @param bool $skipPermission
272 * @param int $permissionType
273 * @param string $orderBy
274 * @param null $orderProfiles
276 * @param bool $eventProfile
279 * The fields that belong to this ufgroup(s)
282 public static function getFields(
290 $skipPermission = FALSE,
292 $permissionType = CRM_Core_Permission
::CREATE
,
293 $orderBy = 'field_name',
294 $orderProfiles = NULL,
295 $eventProfile = FALSE
297 if (!is_array($id)) {
298 $id = CRM_Utils_Type
::escape($id, 'Positive');
299 $profileIds = array($id);
305 $gids = implode(',', $profileIds);
308 $query = "SELECT g.* from civicrm_uf_group g
309 LEFT JOIN civicrm_uf_join j ON (j.uf_group_id = g.id)
310 WHERE g.id IN ( {$gids} )
311 AND ((j.uf_group_id IN ( {$gids} ) AND j.module = %1) OR g.is_reserved = 1 )
313 $params = array(1 => array($restrict, 'String'));
316 $query = "SELECT g.* from civicrm_uf_group g WHERE g.id IN ( {$gids} ) ";
320 $query .= " AND g.is_active = 1";
323 $checkPermission = array(
325 'administer CiviCRM',
326 'manage event profiles',
329 if ($eventProfile && CRM_Core_Permission
::check($checkPermission)) {
330 $skipPermission = TRUE;
333 // add permissioning for profiles only if not registration
334 if (!$skipPermission) {
335 $permissionClause = CRM_Core_Permission
::ufGroupClause($permissionType, 'g.');
336 $query .= " AND $permissionClause ";
339 if ($orderProfiles and count($profileIds) > 1) {
340 $query .= " ORDER BY FIELD( g.id, {$gids} )";
342 $group = CRM_Core_DAO
::executeQuery($query, $params);
346 while ($group->fetch()) {
348 $query = self
::createUFFieldQuery($group->id
, $searchable, $showAll, $visibility, $orderBy);
349 $field = CRM_Core_DAO
::executeQuery($query);
351 $importableFields = self
::getProfileFieldMetadata($showAll);
352 list($customFields, $addressCustomFields) = self
::getCustomFields($ctype);
354 while ($field->fetch()) {
355 list($name, $formattedField) = self
::formatUFField($group, $field, $customFields, $addressCustomFields, $importableFields, $permissionType);
356 if ($formattedField !== NULL) {
357 $fields[$name] = $formattedField;
362 if (empty($fields) && !$validGroup) {
363 CRM_Core_Error
::fatal(ts('The requested Profile (gid=%1) is disabled OR it is not configured to be used for \'Profile\' listings in its Settings OR there is no Profile with that ID OR you do not have permission to access this profile. Please contact the site administrator if you need assistance.',
364 array(1 => implode(',', $profileIds))
368 self
::reformatProfileFields($fields);
375 * Format a list of UFFields for use with buildProfile. This is the in-memory analog
378 * @param array $groupArr
379 * (mimic CRM_UF_DAO_UFGroup).
380 * @param array $fieldArrs
381 * List of fields (each mimics CRM_UF_DAO_UFField).
382 * @param bool $visibility
383 * Visibility of fields we are interested in.
384 * @param bool $searchable
385 * @param bool $showAll
387 * @param int $permissionType
390 * @see self::getFields
392 public static function formatUFFields(
399 $permissionType = CRM_Core_Permission
::CREATE
401 // $group = new CRM_Core_DAO_UFGroup();
402 // $group->copyValues($groupArr); // no... converts string('') to string('null')
403 $group = (object) $groupArr;
405 // Refactoring note: The $fieldArrs here may be slightly different than the $ufFields
406 // used by calculateGroupType, but I don't think the missing fields matter, and -- if
407 // they did -- the obvious fix would produce mutual recursion.
408 $ufGroupType = self
::_calculateGroupType($fieldArrs);
409 $profileType = CRM_Core_BAO_UFField
::calculateProfileType(implode(',', $ufGroupType));
410 $contactActivityProfile = CRM_Core_BAO_UFField
::checkContactActivityProfileTypeByGroupType(implode(',', $ufGroupType));
411 $importableFields = self
::getImportableFields($showAll, $profileType, $contactActivityProfile);
412 list($customFields, $addressCustomFields) = self
::getCustomFields($ctype);
414 $formattedFields = array();
415 foreach ($fieldArrs as $fieldArr) {
416 $field = (object) $fieldArr;
417 if (!self
::filterUFField($field, $searchable, $showAll, $visibility)) {
421 list($name, $formattedField) = self
::formatUFField($group, $field, $customFields, $addressCustomFields, $importableFields, $permissionType);
422 if ($formattedField !== NULL) {
423 $formattedFields[$name] = $formattedField;
426 return $formattedFields;
430 * Prepare a field for rendering with CRM_Core_BAO_UFGroup::buildProfile.
432 * @param CRM_Core_DAO_UFGroup|CRM_Core_DAO $group
433 * @param CRM_Core_DAO_UFField|CRM_Core_DAO $field
434 * @param array $customFields
435 * @param array $addressCustomFields
436 * @param array $importableFields
437 * @param int $permissionType
438 * Eg CRM_Core_Permission::CREATE.
441 protected static function formatUFField(
445 $addressCustomFields,
447 $permissionType = CRM_Core_Permission
::CREATE
449 $name = $field->field_name
;
450 $title = $field->label
;
452 $addressCustom = FALSE;
453 if (in_array($permissionType, array(
454 CRM_Core_Permission
::CREATE
,
455 CRM_Core_Permission
::EDIT
,
457 in_array($field->field_name
, array_keys($addressCustomFields))
459 $addressCustom = TRUE;
460 $name = "address_{$name}";
462 if ($field->field_name
== 'url') {
463 $name .= "-{$field->website_type_id}";
465 elseif (!empty($field->location_type_id
)) {
466 $name .= "-{$field->location_type_id}";
469 $locationFields = self
::getLocationFields();
470 if (in_array($field->field_name
, $locationFields) ||
$addressCustom) {
475 if (isset($field->phone_type_id
)) {
476 $name .= "-{$field->phone_type_id}";
478 $fieldMetaData = CRM_Utils_Array
::value($name, $importableFields, (isset($importableFields[$field->field_name
]) ?
$importableFields[$field->field_name
] : array()));
480 // No lie: this is bizarre; why do we need to mix so many UFGroup properties into UFFields?
481 // I guess to make field self sufficient with all the required data and avoid additional calls
482 $formattedField = array(
484 'groupTitle' => $group->title
,
485 'groupName' => $group->name
,
486 'groupDisplayTitle' => (!empty($group->frontend_title
)) ?
$group->frontend_title
: $group->title
,
487 'groupHelpPre' => empty($group->help_pre
) ?
'' : $group->help_pre
,
488 'groupHelpPost' => empty($group->help_post
) ?
'' : $group->help_post
,
490 'where' => CRM_Utils_Array
::value('where', CRM_Utils_Array
::value($field->field_name
, $importableFields)),
491 'attributes' => CRM_Core_DAO
::makeAttribute(CRM_Utils_Array
::value($field->field_name
, $importableFields)),
492 'is_required' => $field->is_required
,
493 'is_view' => $field->is_view
,
494 'help_pre' => $field->help_pre
,
495 'help_post' => $field->help_post
,
496 'visibility' => $field->visibility
,
497 'in_selector' => $field->in_selector
,
498 'rule' => CRM_Utils_Array
::value('rule', CRM_Utils_Array
::value($field->field_name
, $importableFields)),
499 'location_type_id' => isset($field->location_type_id
) ?
$field->location_type_id
: NULL,
500 'website_type_id' => isset($field->website_type_id
) ?
$field->website_type_id
: NULL,
501 'phone_type_id' => isset($field->phone_type_id
) ?
$field->phone_type_id
: NULL,
502 'group_id' => $group->id
,
503 'add_to_group_id' => isset($group->add_to_group_id
) ?
$group->add_to_group_id
: NULL,
504 'add_captcha' => isset($group->add_captcha
) ?
$group->add_captcha
: NULL,
505 'field_type' => $field->field_type
,
506 'field_id' => $field->id
,
507 'pseudoconstant' => CRM_Utils_Array
::value(
509 CRM_Utils_Array
::value($field->field_name
, $importableFields)
511 // obsolete this when we remove the name / dbName discrepancy with gender/suffix/prefix
512 'dbName' => CRM_Utils_Array
::value(
514 CRM_Utils_Array
::value($field->field_name
, $importableFields)
517 'data_type' => CRM_Utils_Type
::getDataTypeFromFieldMetadata($fieldMetaData),
518 'bao' => CRM_Utils_Array
::value('bao', $fieldMetaData),
521 $formattedField = CRM_Utils_Date
::addDateMetadataToField($fieldMetaData, $formattedField);
523 //adding custom field property
524 if (substr($field->field_name
, 0, 6) == 'custom' ||
525 substr($field->field_name
, 0, 14) === 'address_custom'
527 // if field is not present in customFields, that means the user
528 // DOES NOT HAVE permission to access that field
529 if (array_key_exists($field->field_name
, $customFields)) {
530 $formattedField['is_search_range'] = $customFields[$field->field_name
]['is_search_range'];
532 $formattedField['options_per_line'] = $customFields[$field->field_name
]['options_per_line'];
533 $formattedField['html_type'] = $customFields[$field->field_name
]['html_type'];
535 if (CRM_Utils_Array
::value('html_type', $formattedField) == 'Select Date') {
536 $formattedField['date_format'] = $customFields[$field->field_name
]['date_format'];
537 $formattedField['time_format'] = $customFields[$field->field_name
]['time_format'];
538 $formattedField['is_datetime_field'] = TRUE;
539 $formattedField['smarty_view_format'] = CRM_Utils_Date
::getDateFieldViewFormat($formattedField['date_format']);
542 $formattedField['is_multi_summary'] = $field->is_multi_summary
;
543 return array($name, $formattedField);
546 $formattedField = NULL;
547 return array($name, $formattedField);
550 return array($name, $formattedField);
554 * Create a query to find all visible UFFields in a UFGroup.
556 * This is the SQL-variant of checkUFFieldDisplayable().
558 * @param int $groupId
559 * @param bool $searchable
560 * @param bool $showAll
561 * @param int $visibility
562 * @param string $orderBy
563 * Comma-delimited list of SQL columns.
566 protected static function createUFFieldQuery($groupId, $searchable, $showAll, $visibility, $orderBy) {
567 $where = " WHERE uf_group_id = {$groupId}";
570 $where .= " AND is_searchable = 1";
574 $where .= " AND is_active = 1";
579 if ($visibility & self
::PUBLIC_VISIBILITY
) {
580 $clause[] = 'visibility = "Public Pages"';
582 if ($visibility & self
::ADMIN_VISIBILITY
) {
583 $clause[] = 'visibility = "User and User Admin Only"';
585 if ($visibility & self
::LISTINGS_VISIBILITY
) {
586 $clause[] = 'visibility = "Public Pages and Listings"';
588 if (!empty($clause)) {
589 $where .= ' AND ( ' . implode(' OR ', $clause) . ' ) ';
593 $query = "SELECT * FROM civicrm_uf_field $where ORDER BY weight";
595 $query .= ", " . $orderBy;
602 * Create a query to find all visible UFFields in a UFGroup.
604 * This is the PHP in-memory variant of createUFFieldQuery().
606 * @param CRM_Core_DAO_UFField|CRM_Core_DAO $field
607 * @param bool $searchable
608 * @param bool $showAll
609 * @param int $visibility
611 * TRUE if field is displayable
613 protected static function filterUFField($field, $searchable, $showAll, $visibility) {
614 if ($searchable && $field->is_searchable
!= 1) {
618 if (!$showAll && $field->is_active
!= 1) {
623 $allowedVisibilities = array();
624 if ($visibility & self
::PUBLIC_VISIBILITY
) {
625 $allowedVisibilities[] = 'Public Pages';
627 if ($visibility & self
::ADMIN_VISIBILITY
) {
628 $allowedVisibilities[] = 'User and User Admin Only';
630 if ($visibility & self
::LISTINGS_VISIBILITY
) {
631 $allowedVisibilities[] = 'Public Pages and Listings';
633 // !empty($allowedVisibilities) seems silly to me, but it is equivalent to the pre-existing SQL
634 if (!empty($allowedVisibilities) && !in_array($field->visibility
, $allowedVisibilities)) {
643 * Get a list of filtered field metadata.
645 * @deprecated use getProfileFieldMetadata
648 * @param $profileType
649 * @param $contactActivityProfile
650 * @param bool $filterMode
651 * Filter mode means you are using importable fields for filtering rather than just getting metadata.
652 * With filter mode = FALSE BOTH activity fields and component fields are returned.
653 * I can't see why you would ever want to use this function in filter mode as the component fields are
654 * still unfiltered. However, I feel scared enough to leave it as it is. I have marked this function as
655 * deprecated and am recommending the wrapper 'getProfileFieldMetadata' in order to try to
656 * send this confusion to history.
660 protected static function getImportableFields($showAll, $profileType, $contactActivityProfile, $filterMode = TRUE) {
662 $importableFields = CRM_Contact_BAO_Contact
::importableFields('All', FALSE, FALSE, FALSE, TRUE, TRUE);
665 $importableFields = CRM_Contact_BAO_Contact
::importableFields('All', FALSE, TRUE, FALSE, TRUE, TRUE);
668 $activityFields = CRM_Activity_BAO_Activity
::getProfileFields();
669 $componentFields = CRM_Core_Component
::getQueryFields();
670 if ($filterMode == TRUE) {
671 if ($profileType == 'Activity' ||
$contactActivityProfile) {
672 $importableFields = array_merge($importableFields, $activityFields);
675 $importableFields = array_merge($importableFields, $componentFields);
679 $importableFields = array_merge($importableFields, $activityFields, $componentFields);
682 $importableFields['group']['title'] = ts('Group(s)');
683 $importableFields['group']['where'] = NULL;
684 $importableFields['tag']['title'] = ts('Tag(s)');
685 $importableFields['tag']['where'] = NULL;
686 return $importableFields;
690 * Get the metadata for all potential profile fields.
692 * @param bool $isIncludeInactive
693 * Should disabled fields be included.
696 * Field metadata for all fields that might potentially be in a profile.
698 protected static function getProfileFieldMetadata($isIncludeInactive) {
699 return self
::getImportableFields($isIncludeInactive, NULL, NULL, NULL, TRUE);
703 * Get the fields relating to locations.
707 public static function getLocationFields() {
708 static $locationFields = array(
710 'supplemental_address_1',
711 'supplemental_address_2',
712 'supplemental_address_3',
715 'postal_code_suffix',
728 return $locationFields;
736 protected static function getCustomFields($ctype) {
737 static $customFieldCache = array();
738 if (!isset($customFieldCache[$ctype])) {
739 $customFields = CRM_Core_BAO_CustomField
::getFieldsForImport($ctype, FALSE, FALSE, FALSE, TRUE, TRUE);
741 // hack to add custom data for components
742 $components = array('Contribution', 'Participant', 'Membership', 'Activity', 'Case');
743 foreach ($components as $value) {
744 $customFields = array_merge($customFields, CRM_Core_BAO_CustomField
::getFieldsForImport($value));
746 $addressCustomFields = CRM_Core_BAO_CustomField
::getFieldsForImport('Address');
747 $customFields = array_merge($customFields, $addressCustomFields);
748 $customFieldCache[$ctype] = array($customFields, $addressCustomFields);
750 return $customFieldCache[$ctype];
754 * Check the data validity.
757 * The user id that we are actually editing.
758 * @param string $name
759 * The machine-name of the group we are interested in.
760 * @param bool $register
762 * The action of the form.
764 * @pram boolean $register is this the registrtion form
766 * true if form is valid
768 public static function isValid($userID, $name, $register = FALSE, $action = NULL) {
770 $controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Dynamic',
771 ts('Dynamic Form Creator'),
774 $controller->set('id', $userID);
775 $controller->set('register', 1);
776 $controller->process();
777 return $controller->validate();
780 // make sure we have a valid group
781 $group = new CRM_Core_DAO_UFGroup();
783 $group->name
= $name;
785 if ($group->find(TRUE) && $userID) {
786 $controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Dynamic', ts('Dynamic Form Creator'), $action);
787 $controller->set('gid', $group->id
);
788 $controller->set('id', $userID);
789 $controller->set('register', 0);
790 $controller->process();
791 return $controller->validate();
798 * Get the html for the form that represents this particular group.
801 * The user id that we are actually editing.
802 * @param string $title
803 * The title of the group we are interested in.
805 * The action of the form.
806 * @param bool $register
807 * Is this the registration form.
809 * Should we reset the form?.
810 * @param int $profileID
811 * Do we have the profile ID?.
813 * @param bool $doNotProcess
817 * the html for the form on success, otherwise empty string
819 public static function getEditHTML(
826 $doNotProcess = FALSE,
831 $controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Dynamic',
832 ts('Dynamic Form Creator'),
835 if ($reset ||
$doNotProcess) {
836 // hack to make sure we do not process this form
837 $oldQFDefault = CRM_Utils_Array
::value('_qf_default',
840 unset($_POST['_qf_default']);
841 unset($_REQUEST['_qf_default']);
843 $controller->reset();
847 $controller->set('id', $userID);
848 $controller->set('register', 1);
849 $controller->set('skipPermission', 1);
850 $controller->set('ctype', $ctype);
851 $controller->process();
852 if ($doNotProcess ||
!empty($_POST)) {
853 $controller->validate();
855 $controller->setEmbedded(TRUE);
857 //CRM-5839 - though we want to process form, get the control back.
858 $controller->setSkipRedirection(($doNotProcess) ?
FALSE : TRUE);
862 // we are done processing so restore the POST/REQUEST vars
863 if (($reset ||
$doNotProcess) && $oldQFDefault) {
864 $_POST['_qf_default'] = $_REQUEST['_qf_default'] = $oldQFDefault;
867 $template = CRM_Core_Smarty
::singleton();
869 // Hide CRM error messages if they are displayed using drupal form_set_error.
870 if (!empty($_POST)) {
871 $template->assign('suppressForm', TRUE);
874 return trim($template->fetch('CRM/Profile/Form/Dynamic.tpl'));
878 // make sure we have a valid group
879 $group = new CRM_Core_DAO_UFGroup();
881 $group->title
= $title;
883 if ($group->find(TRUE)) {
884 $profileID = $group->id
;
889 // make sure profileID and ctype match if ctype exists
891 $profileType = CRM_Core_BAO_UFField
::getProfileType($profileID);
892 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
893 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
896 if (($profileType != 'Contact') && ($profileType != $ctype)) {
901 $controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Dynamic',
902 ts('Dynamic Form Creator'),
906 $controller->reset();
908 $controller->set('gid', $profileID);
909 $controller->set('id', $userID);
910 $controller->set('register', 0);
911 $controller->set('skipPermission', 1);
913 $controller->set('ctype', $ctype);
915 $controller->process();
916 $controller->setEmbedded(TRUE);
918 //CRM-5846 - give the control back to drupal.
919 $controller->setSkipRedirection(($doNotProcess) ?
FALSE : TRUE);
922 $template = CRM_Core_Smarty
::singleton();
924 // Hide CRM error messages if they are displayed using drupal form_set_error.
925 if (!empty($_POST) && CRM_Core_Config
::singleton()->userFramework
== 'Drupal') {
926 if (arg(0) == 'user' ||
(arg(0) == 'admin' && arg(1) == 'people')) {
927 $template->assign('suppressForm', TRUE);
931 $templateFile = "CRM/Profile/Form/{$profileID}/Dynamic.tpl";
932 if (!$template->template_exists($templateFile)) {
933 $templateFile = 'CRM/Profile/Form/Dynamic.tpl';
935 return trim($template->fetch($templateFile));
938 $userEmail = CRM_Contact_BAO_Contact_Location
::getEmailDetails($userID);
940 // if post not empty then only proceed
941 if (!empty($_POST)) {
943 $config = CRM_Core_Config
::singleton();
944 $email = CRM_Utils_Array
::value('mail', $_POST);
946 if (CRM_Utils_Rule
::email($email) && ($email != $userEmail[1])) {
947 CRM_Core_BAO_UFMatch
::updateContactEmail($userID, $email);
956 * Given a contact id and a field set, return the values from the db.
959 * @param array $fields
960 * The profile fields of interest.
961 * @param array $values
962 * The values for the above fields.
963 * @param bool $searchable
965 * @param array $componentWhere
966 * Component condition.
967 * @param bool $absolute
968 * Return urls in absolute form (useful when sending an email).
969 * @param null $additionalWhereClause
973 public static function getValues(
974 $cid, &$fields, &$values,
975 $searchable = TRUE, $componentWhere = NULL,
976 $absolute = FALSE, $additionalWhereClause = NULL
978 if (empty($cid) && empty($componentWhere)) {
982 // get the contact details (hier)
983 $returnProperties = CRM_Contact_BAO_Contact
::makeHierReturnProperties($fields);
984 $params = $cid ?
array(array('contact_id', '=', $cid, 0, 0)) : array();
986 // add conditions specified by components. eg partcipant_id etc
987 if (!empty($componentWhere)) {
988 $params = array_merge($params, $componentWhere);
991 $query = new CRM_Contact_BAO_Query($params, $returnProperties, $fields);
993 $details = $query->searchQuery(0, 0, NULL, FALSE, FALSE,
994 FALSE, FALSE, FALSE, $additionalWhereClause);
995 while ($details->fetch()) {
1000 $query->convertToPseudoNames($details);
1001 $config = CRM_Core_Config
::singleton();
1003 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
1004 $imProviders = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id');
1005 $websiteTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Website', 'website_type_id');
1007 $multipleFields = array('url');
1009 //start of code to set the default values
1010 foreach ($fields as $name => $field) {
1012 if ($name == 'id') {
1013 $name = 'contact_id';
1016 // skip fields that should not be displayed separately
1017 if (!empty($field['skipDisplay'])) {
1021 // Create a unique, non-empty index for each field.
1022 $index = $field['title'];
1023 if ($index === '') {
1026 while (array_key_exists($index, $values)) {
1030 $params[$index] = $values[$index] = '';
1031 $customFieldName = NULL;
1033 if (isset($details->$name) ||
$name == 'group' ||
$name == 'tag') {
1034 // to handle gender / suffix / prefix
1035 if (in_array(substr($name, 0, -3), array('gender', 'prefix', 'suffix'))) {
1036 $params[$index] = $details->$name;
1037 $values[$index] = $details->$name;
1039 elseif (in_array($name, CRM_Contact_BAO_Contact
::$_greetingTypes)) {
1040 $dname = $name . '_display';
1041 $values[$index] = $details->$dname;
1042 $name = $name . '_id';
1043 $params[$index] = $details->$name;
1045 elseif (in_array($name, array(
1050 $values[$index] = $details->$name;
1051 $idx = $name . '_id';
1052 $params[$index] = $details->$idx;
1054 elseif ($name === 'preferred_language') {
1055 $params[$index] = $details->$name;
1056 $values[$index] = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_DAO_Contact', 'preferred_language', $details->$name);
1058 elseif ($name == 'group') {
1059 $groups = CRM_Contact_BAO_GroupContact
::getContactGroup($cid, 'Added', NULL, FALSE, TRUE);
1060 $title = $ids = array();
1062 foreach ($groups as $g) {
1063 // CRM-8362: User and User Admin visibility groups should be included in display if user has
1064 // VIEW permission on that group
1065 $groupPerm = CRM_Contact_BAO_Group
::checkPermission($g['group_id'], TRUE);
1067 if ($g['visibility'] != 'User and User Admin Only' ||
1068 CRM_Utils_Array
::key(CRM_Core_Permission
::VIEW
, $groupPerm)
1070 $title[] = $g['title'];
1071 if ($g['visibility'] == 'Public Pages') {
1072 $ids[] = $g['group_id'];
1076 $values[$index] = implode(', ', $title);
1077 $params[$index] = implode(',', $ids);
1079 elseif ($name == 'tag') {
1080 $entityTags = CRM_Core_BAO_EntityTag
::getTag($cid);
1081 $allTags = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_EntityTag', 'tag_id', array('onlyActive' => FALSE));
1083 foreach ($entityTags as $tagId) {
1084 $title[] = $allTags[$tagId];
1086 $values[$index] = implode(', ', $title);
1087 $params[$index] = implode(',', $entityTags);
1089 elseif ($name == 'activity_status_id') {
1090 $activityStatus = CRM_Core_PseudoConstant
::activityStatus();
1091 $values[$index] = $activityStatus[$details->$name];
1092 $params[$index] = $details->$name;
1094 elseif ($name == 'activity_date_time') {
1095 $values[$index] = CRM_Utils_Date
::customFormat($details->$name);
1096 $params[$index] = $details->$name;
1098 elseif ($name == 'contact_sub_type') {
1099 $contactSubTypeNames = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $details->$name);
1100 if (!empty($contactSubTypeNames)) {
1101 $contactSubTypeLabels = array();
1102 // get all contact subtypes
1103 $allContactSubTypes = CRM_Contact_BAO_ContactType
::subTypeInfo();
1104 // build contact subtype labels array
1105 foreach ($contactSubTypeNames as $cstName) {
1107 $contactSubTypeLabels[] = $allContactSubTypes[$cstName]['label'];
1110 $values[$index] = implode(',', $contactSubTypeLabels);
1113 $params[$index] = $details->$name;
1116 if (substr($name, 0, 7) === 'do_not_' ||
substr($name, 0, 3) === 'is_') {
1117 if ($details->$name) {
1118 $values[$index] = '[ x ]';
1122 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($name)) {
1123 $htmlType = $field['html_type'];
1125 // field_type is only set when we are retrieving profile values
1126 // when sending email, we call the same function to get custom field
1127 // values etc, i.e. emulating a profile
1128 $fieldType = CRM_Utils_Array
::value('field_type', $field);
1130 if ($htmlType == 'File') {
1133 $fieldType == 'Activity' && !empty($componentWhere[0][2])
1135 $entityId = $componentWhere[0][2];
1138 $fileURL = CRM_Core_BAO_CustomField
::getFileURL($entityId,
1142 $additionalWhereClause
1144 $params[$index] = $values[$index] = $fileURL['file_url'];
1148 if (isset($dao) && property_exists($dao, 'data_type') &&
1149 ($dao->data_type
== 'Int' ||
1150 $dao->data_type
== 'Boolean'
1153 $customVal = (int ) ($details->{$name});
1155 elseif (isset($dao) && property_exists($dao, 'data_type')
1156 && $dao->data_type
== 'Float'
1158 $customVal = (float ) ($details->{$name});
1160 elseif (!CRM_Utils_System
::isNull(explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1164 $customVal = $details->{$name};
1168 if (CRM_Utils_System
::isNull($customVal)) {
1172 $params[$index] = $customVal;
1173 $values[$index] = CRM_Core_BAO_CustomField
::displayValue($customVal, $cfID);
1174 if ($field['data_type'] == 'ContactReference') {
1175 $params[$index] = $values[$index];
1177 if (CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
1178 $cfID, 'is_search_range'
1181 $customFieldName = "{$name}_from";
1185 elseif ($name == 'image_URL') {
1186 list($width, $height) = getimagesize(CRM_Utils_String
::unstupifyUrl($details->$name));
1187 list($thumbWidth, $thumbHeight) = CRM_Contact_BAO_Contact
::getThumbSize($width, $height);
1189 $image_URL = '<img src="' . $details->$name . '" height= ' . $thumbHeight . ' width= ' . $thumbWidth . ' />';
1190 $values[$index] = "<a href='#' onclick='contactImagePopUp(\"{$details->$name}\", {$width}, {$height});'>{$image_URL}</a>";
1192 elseif (in_array($name, array(
1196 // @todo this set should be determined from metadata, not hard-coded.
1197 $values[$index] = CRM_Utils_Date
::customFormat($details->$name);
1198 $params[$index] = CRM_Utils_Date
::isoToMysql($details->$name);
1202 if ($index == 'Campaign') {
1203 $dao = 'CRM_Campaign_DAO_Campaign';
1205 elseif ($index == 'Contribution Page') {
1206 $dao = 'CRM_Contribute_DAO_ContributionPage';
1209 $value = CRM_Core_DAO
::getFieldValue($dao, $details->$name, 'title');
1212 $value = $details->$name;
1214 $values[$index] = $value;
1219 elseif (strpos($name, '-') !== FALSE) {
1220 list($fieldName, $id, $type) = CRM_Utils_System
::explode('-', $name, 3);
1222 if (!in_array($fieldName, $multipleFields)) {
1223 if ($id == 'Primary') {
1225 // not sure why we'd every use Primary location type id
1226 // we need to fix the source if we are using it
1227 // $locationTypeName = CRM_Contact_BAO_Contact::getPrimaryLocationType( $cid );
1228 $locationTypeName = 1;
1231 $locationTypeName = CRM_Utils_Array
::value($id, $locationTypes);
1234 if (!$locationTypeName) {
1238 $detailName = "{$locationTypeName}-{$fieldName}";
1239 $detailName = str_replace(' ', '_', $detailName);
1241 if (in_array($fieldName, array(
1248 $detailName .= "-{$type}";
1252 if (in_array($fieldName, array(
1257 $values[$index] = $details->$detailName;
1258 $idx = $detailName . '_id';
1259 $params[$index] = $details->$idx;
1261 elseif ($fieldName == 'im') {
1262 $providerId = $detailName . '-provider_id';
1263 if (isset($imProviders[$details->$providerId])) {
1264 $values[$index] = $details->$detailName . " (" . $imProviders[$details->$providerId] . ")";
1267 $values[$index] = $details->$detailName;
1269 $params[$index] = $details->$detailName;
1271 elseif ($fieldName == 'phone') {
1272 $phoneExtField = str_replace('phone', 'phone_ext', $detailName);
1273 if (isset($details->$phoneExtField)) {
1274 $values[$index] = $details->$detailName . " (" . $details->$phoneExtField . ")";
1277 $values[$index] = $details->$detailName;
1279 $params[$index] = $details->$detailName;
1282 $values[$index] = $params[$index] = $details->$detailName;
1286 $detailName = "website-{$id}-{$fieldName}";
1287 $url = CRM_Utils_System
::fixURL($details->$detailName);
1288 if ($details->$detailName) {
1289 $websiteTypeId = "website-{$id}-website_type_id";
1290 $websiteType = $websiteTypes[$details->$websiteTypeId];
1291 $values[$index] = "<a href=\"$url\">{$details->$detailName} ( {$websiteType} )</a>";
1294 $values[$index] = '';
1299 if ((CRM_Utils_Array
::value('visibility', $field) == 'Public Pages and Listings') &&
1300 CRM_Core_Permission
::check('profile listings and forms')
1303 if (CRM_Utils_System
::isNull($params[$index])) {
1304 $params[$index] = $values[$index];
1306 if (!isset($params[$index])) {
1309 if (!$customFieldName) {
1310 $fieldName = $field['name'];
1313 $fieldName = $customFieldName;
1317 if (CRM_Core_BAO_CustomField
::getKeyID($field['name'])) {
1318 $htmlType = $field['html_type'];
1319 if ($htmlType == 'Link') {
1320 $url = $params[$index];
1322 elseif (in_array($htmlType, array(
1325 'Multi-Select State/Province',
1326 'Multi-Select Country',
1328 $valSeperator = CRM_Core_DAO
::VALUE_SEPARATOR
;
1329 $selectedOptions = explode($valSeperator, $params[$index]);
1331 foreach ($selectedOptions as $key => $multiOption) {
1333 $url[] = CRM_Utils_System
::url('civicrm/profile',
1334 'reset=1&force=1&gid=' . $field['group_id'] . '&' .
1335 urlencode($fieldName) .
1337 urlencode($multiOption)
1343 $url = CRM_Utils_System
::url('civicrm/profile',
1344 'reset=1&force=1&gid=' . $field['group_id'] . '&' .
1345 urlencode($fieldName) .
1347 urlencode($params[$index])
1352 $url = CRM_Utils_System
::url('civicrm/profile',
1353 'reset=1&force=1&gid=' . $field['group_id'] . '&' .
1354 urlencode($fieldName) .
1356 urlencode($params[$index])
1361 !empty($values[$index]) &&
1365 if (is_array($url) && !empty($url)) {
1367 $eachMultiValue = explode(', ', $values[$index]);
1368 foreach ($eachMultiValue as $key => $valueLabel) {
1369 $links[] = '<a href="' . $url[$key] . '">' . $valueLabel . '</a>';
1371 $values[$index] = implode(', ', $links);
1374 $values[$index] = '<a href="' . $url . '">' . $values[$index] . '</a>';
1382 * Check if profile Group used by any module.
1390 public static function usedByModule($id) {
1391 //check whether this group is used by any module(check uf join records)
1393 FROM civicrm_uf_join
1394 WHERE civicrm_uf_join.uf_group_id=$id";
1396 $dao = new CRM_Core_DAO();
1398 if ($dao->fetch()) {
1407 * Delete the profile Group.
1415 public static function del($id) {
1416 //check whether this group contains any profile fields
1417 $profileField = new CRM_Core_DAO_UFField();
1418 $profileField->uf_group_id
= $id;
1419 $profileField->find();
1420 while ($profileField->fetch()) {
1421 CRM_Core_BAO_UFField
::del($profileField->id
);
1424 //delete records from uf join table
1425 $ufJoin = new CRM_Core_DAO_UFJoin();
1426 $ufJoin->uf_group_id
= $id;
1429 //delete profile group
1430 $group = new CRM_Core_DAO_UFGroup();
1439 * @param array $params
1440 * Reference array contains the values submitted by the form.
1442 * Reference array contains the id.
1447 public static function add(&$params, $ids = array()) {
1457 foreach ($fields as $field) {
1458 $params[$field] = CRM_Utils_Array
::value($field, $params, FALSE);
1461 $params['limit_listings_group_id'] = CRM_Utils_Array
::value('group', $params);
1462 $params['add_to_group_id'] = CRM_Utils_Array
::value('add_contact_to_group', $params);
1465 if (!empty($params['group_type']) && is_array($params['group_type'])) {
1466 $params['group_type'] = implode(',', $params['group_type']);
1468 $ufGroup = new CRM_Core_DAO_UFGroup();
1469 $ufGroup->copyValues($params);
1471 $ufGroupID = CRM_Utils_Array
::value('ufgroup', $ids, CRM_Utils_Array
::value('id', $params));
1472 if (!$ufGroupID && empty($params['name'])) {
1473 $ufGroup->name
= CRM_Utils_String
::munge($ufGroup->title
, '_', 56);
1475 $ufGroup->id
= $ufGroupID;
1479 if (!$ufGroupID && empty($params['name'])) {
1480 $ufGroup->name
= $ufGroup->name
. "_{$ufGroup->id}";
1488 * Make uf join entries for an uf group.
1490 * @param array $params
1491 * (reference) an assoc array of name/value pairs.
1492 * @param int $ufGroupId
1495 public static function createUFJoin(&$params, $ufGroupId) {
1496 $groupTypes = CRM_Utils_Array
::value('uf_group_type', $params);
1498 // get ufjoin records for uf group
1499 $ufGroupRecord = CRM_Core_BAO_UFGroup
::getUFJoinRecord($ufGroupId);
1501 // get the list of all ufgroup types
1502 $allUFGroupType = CRM_Core_SelectValues
::ufGroupTypes();
1504 // this fix is done to prevent warning generated by array_key_exits incase of empty array is given as input
1505 if (!is_array($groupTypes)) {
1506 $groupTypes = array();
1509 // this fix is done to prevent warning generated by array_key_exits incase of empty array is given as input
1510 if (!is_array($ufGroupRecord)) {
1511 $ufGroupRecord = array();
1514 // check which values has to be inserted/deleted for contact
1515 $menuRebuild = FALSE;
1516 foreach ($allUFGroupType as $key => $value) {
1517 $joinParams = array();
1518 $joinParams['uf_group_id'] = $ufGroupId;
1519 $joinParams['module'] = $key;
1520 if ($key == 'User Account') {
1521 $menuRebuild = TRUE;
1523 if (array_key_exists($key, $groupTypes) && !in_array($key, $ufGroupRecord)) {
1524 // insert a new record
1525 CRM_Core_BAO_UFGroup
::addUFJoin($joinParams);
1527 elseif (!array_key_exists($key, $groupTypes) && in_array($key, $ufGroupRecord)) {
1528 // delete a record for existing ufgroup
1529 CRM_Core_BAO_UFGroup
::delUFJoin($joinParams);
1535 UPDATE civicrm_uf_join
1537 WHERE uf_group_id = %2
1538 AND ( entity_id IS NULL OR entity_id <= 0 )
1541 1 => array($params['weight'], 'Integer'),
1542 2 => array($ufGroupId, 'Integer'),
1544 CRM_Core_DAO
::executeQuery($query, $p);
1546 // Do a menu rebuild, so it gets all the new menu entries for user account
1548 $config = CRM_Core_Config
::singleton();
1549 $config->userSystem
->updateCategories();
1554 * Get the UF Join records for an ufgroup id.
1556 * @param int $ufGroupId
1558 * @param int $displayName
1559 * If set return display name in array.
1560 * @param int $status
1561 * If set return module other than default modules (User Account/User registration/Profile).
1566 public static function getUFJoinRecord($ufGroupId = NULL, $displayName = NULL, $status = NULL) {
1568 $UFGroupType = array();
1569 $UFGroupType = CRM_Core_SelectValues
::ufGroupTypes();
1573 $dao = new CRM_Core_DAO_UFJoin();
1576 $dao->uf_group_id
= $ufGroupId;
1582 while ($dao->fetch()) {
1583 if (!$displayName) {
1584 $ufJoin[$dao->id
] = $dao->module
;
1587 if (isset($UFGroupType[$dao->module
])) {
1588 // skip the default modules
1590 $ufJoin[$dao->id
] = $UFGroupType[$dao->module
];
1592 // added for CRM-1475
1594 elseif (!CRM_Utils_Array
::key($dao->module
, $ufJoin)) {
1595 $ufJoin[$dao->id
] = $dao->module
;
1603 * Function takes an associative array and creates a ufjoin record for ufgroup.
1605 * @param array $params
1606 * (reference) an assoc array of name/value pairs.
1608 * @return CRM_Core_BAO_UFJoin
1610 public static function addUFJoin(&$params) {
1611 $ufJoin = new CRM_Core_DAO_UFJoin();
1612 $ufJoin->copyValues($params);
1618 * Delete the uf join record for an uf group.
1620 * @param array $params
1621 * (reference) an assoc array of name/value pairs.
1623 public static function delUFJoin(&$params) {
1624 $ufJoin = new CRM_Core_DAO_UFJoin();
1625 $ufJoin->copyValues($params);
1630 * Get the weight for ufjoin record.
1632 * @param int $ufGroupId
1633 * If $ufGroupId get update weight or add weight.
1636 * weight of the UFGroup
1638 public static function getWeight($ufGroupId = NULL) {
1639 //calculate the weight
1642 $queryString = "SELECT ( MAX(civicrm_uf_join.weight)+1) as new_weight
1643 FROM civicrm_uf_join
1644 WHERE module = 'User Registration' OR module = 'User Account' OR module = 'Profile'";
1647 $queryString = "SELECT MAX(civicrm_uf_join.weight) as new_weight
1648 FROM civicrm_uf_join
1649 WHERE civicrm_uf_join.uf_group_id = %1
1650 AND ( entity_id IS NULL OR entity_id <= 0 )";
1651 $p[1] = array($ufGroupId, 'Integer');
1654 $dao = CRM_Core_DAO
::executeQuery($queryString, $p);
1656 return ($dao->new_weight
) ?
$dao->new_weight
: 1;
1660 * Get the uf group for a module.
1662 * @param string $moduleName
1665 * No to increment the weight.
1666 * @param bool $skipPermission
1668 * Which operation (view, edit, create, etc) to check permission for.
1669 * @param array|NULL $returnFields list of UFGroup fields to return; NULL for default
1672 * array of ufgroups for a module
1674 public static function getModuleUFGroup($moduleName = NULL, $count = 0, $skipPermission = TRUE, $op = CRM_Core_Permission
::VIEW
, $returnFields = NULL) {
1675 $selectFields = array('id', 'title', 'created_id', 'is_active', 'is_reserved', 'group_type');
1677 if (CRM_Core_BAO_SchemaHandler
::checkIfFieldExists('civicrm_uf_group', 'description')) {
1678 // CRM-13555, since description field was added later (4.4), and to avoid any problems with upgrade
1679 $selectFields[] = 'description';
1682 if (CRM_Core_BAO_SchemaHandler
::checkIfFieldExists('civicrm_uf_group', 'frontend_title')) {
1683 $selectFields[] = 'frontend_title';
1686 if (!empty($returnFields)) {
1687 $selectFields = array_merge($returnFields, array_diff($selectFields, $returnFields));
1690 $queryString = 'SELECT civicrm_uf_group.' . implode(', civicrm_uf_group.', $selectFields) . '
1691 FROM civicrm_uf_group
1692 LEFT JOIN civicrm_uf_join ON (civicrm_uf_group.id = uf_group_id)';
1695 $queryString .= ' AND civicrm_uf_group.is_active = 1
1696 WHERE civicrm_uf_join.module = %2';
1697 $p[2] = array($moduleName, 'String');
1700 // add permissioning for profiles only if not registration
1701 if (!$skipPermission) {
1702 $permissionClause = CRM_Core_Permission
::ufGroupClause($op, 'civicrm_uf_group.');
1703 if (strpos($queryString, 'WHERE') !== FALSE) {
1704 $queryString .= " AND $permissionClause ";
1707 $queryString .= " $permissionClause ";
1711 $queryString .= ' ORDER BY civicrm_uf_join.weight, civicrm_uf_group.title';
1712 $dao = CRM_Core_DAO
::executeQuery($queryString, $p);
1714 $ufGroups = array();
1715 while ($dao->fetch()) {
1716 //skip mix profiles in user Registration / User Account
1717 if (($moduleName == 'User Registration' ||
$moduleName == 'User Account') &&
1718 CRM_Core_BAO_UFField
::checkProfileType($dao->id
)
1722 foreach ($selectFields as $key => $field) {
1723 if ($field == 'id') {
1726 $ufGroups[$dao->id
][$field] = $dao->$field;
1730 // Allow other modules to alter/override the UFGroups.
1731 CRM_Utils_Hook
::buildUFGroupsForModule($moduleName, $ufGroups);
1737 * Filter ufgroups based on logged in user contact type.
1739 * @param int $ufGroupId
1740 * Uf group id (profile id).
1741 * @param int $contactID
1746 public static function filterUFGroups($ufGroupId, $contactID = NULL) {
1748 $session = CRM_Core_Session
::singleton();
1749 $contactID = $session->get('userID');
1753 //get the contact type
1754 $contactType = CRM_Contact_BAO_Contact
::getContactType($contactID);
1756 //match if exixting contact type is same as profile contact type
1757 $profileType = CRM_Core_BAO_UFField
::getProfileType($ufGroupId);
1759 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
1760 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
1762 //in some cases getBasicType() returns a cached array instead of string. Example: array ('sponsor' => 'organization')
1763 if (is_array($profileType)) {
1764 $profileType = array_shift($profileType);
1768 //allow special mix profiles for Contribution and Participant
1769 $specialProfiles = array('Contribution', 'Participant', 'Membership');
1771 if (in_array($profileType, $specialProfiles)) {
1775 if (($contactType == $profileType) ||
$profileType == 'Contact') {
1784 * Add profile field to a form.
1786 * @param CRM_Core_Form $form
1787 * @param array $field
1791 * @param int $contactId
1792 * @param bool $online
1793 * @param string $usedFor
1794 * For building up prefixed fieldname for special cases (e.g. onBehalf, Honor).
1795 * @param int $rowNumber
1796 * @param string $prefix
1800 public static function buildProfile(
1810 $defaultValues = array();
1811 $fieldName = $field['name'];
1812 $title = $field['title'];
1813 $attributes = $field['attributes'];
1814 $rule = $field['rule'];
1815 $view = $field['is_view'];
1816 $required = ($mode == CRM_Profile_Form
::MODE_SEARCH
) ?
FALSE : $field['is_required'];
1817 $search = ($mode == CRM_Profile_Form
::MODE_SEARCH
) ?
TRUE : FALSE;
1818 $isShared = CRM_Utils_Array
::value('is_shared', $field, 0);
1820 // do not display view fields in drupal registration form
1822 if ($view && $mode == CRM_Profile_Form
::MODE_REGISTER
) {
1826 if ($usedFor == 'onbehalf') {
1827 $name = "onbehalf[$fieldName]";
1829 elseif ($usedFor == 'honor') {
1830 $name = "honor[$fieldName]";
1832 elseif ($contactId && !$online) {
1833 $name = "field[$contactId][$fieldName]";
1835 elseif ($rowNumber) {
1836 $name = "field[$rowNumber][$fieldName]";
1838 elseif (!empty($prefix)) {
1839 $name = $prefix . "[$fieldName]";
1845 $selectAttributes = array('class' => 'crm-select2', 'placeholder' => TRUE);
1847 if ($fieldName == 'image_URL' && $mode == CRM_Profile_Form
::MODE_EDIT
) {
1848 $deleteExtra = json_encode(ts('Are you sure you want to delete contact image.'));
1850 CRM_Core_Action
::DELETE
=> array(
1851 'name' => ts('Delete Contact Image'),
1852 'url' => 'civicrm/contact/image',
1853 'qs' => 'reset=1&id=%%id%%&gid=%%gid%%&action=delete',
1854 'extra' => 'onclick = "' . htmlspecialchars("if (confirm($deleteExtra)) this.href+='&confirmed=1'; else return false;") . '"',
1857 $deleteURL = CRM_Core_Action
::formLink($deleteURL,
1858 CRM_Core_Action
::DELETE
,
1860 'id' => $form->get('id'),
1861 'gid' => $form->get('gid'),
1865 'contact.profileimage.delete',
1869 $form->assign('deleteURL', $deleteURL);
1871 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
1872 'address_options', TRUE, NULL, TRUE
1875 if (substr($fieldName, 0, 14) === 'state_province') {
1876 $form->addChainSelect($name, array('label' => $title, 'required' => $required));
1877 $config = CRM_Core_Config
::singleton();
1878 if (!in_array($mode, array(
1879 CRM_Profile_Form
::MODE_EDIT
,
1880 CRM_Profile_Form
::MODE_SEARCH
,
1882 $config->defaultContactStateProvince
1884 $defaultValues[$name] = $config->defaultContactStateProvince
;
1885 $form->setDefaults($defaultValues);
1888 elseif (substr($fieldName, 0, 7) === 'country') {
1889 $form->add('select', $name, $title, array('' => ts('- select -')) + CRM_Core_PseudoConstant
::country(), $required, $selectAttributes);
1890 $config = CRM_Core_Config
::singleton();
1891 if (!in_array($mode, array(
1892 CRM_Profile_Form
::MODE_EDIT
,
1893 CRM_Profile_Form
::MODE_SEARCH
,
1895 $config->defaultContactCountry
1897 $defaultValues[$name] = $config->defaultContactCountry
;
1898 $form->setDefaults($defaultValues);
1901 elseif (substr($fieldName, 0, 6) === 'county') {
1902 if ($addressOptions['county']) {
1903 $form->addChainSelect($name, array('label' => $title, 'required' => $required));
1906 elseif (substr($fieldName, 0, 9) === 'image_URL') {
1907 $form->add('file', $name, $title, $attributes, $required);
1908 $form->addUploadElement($name);
1910 elseif (substr($fieldName, 0, 2) === 'im') {
1911 $form->add('text', $name, $title, $attributes, $required);
1914 if (substr($name, -1) == ']') {
1915 $providerName = substr($name, 0, -1) . '-provider_id]';
1917 $form->add('select', $providerName, NULL,
1919 '' => ts('- select -'),
1920 ) + CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id'), $required
1924 $form->add('select', $name . '-provider_id', $title,
1926 '' => ts('- select -'),
1927 ) + CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id'), $required
1931 if ($view && $mode != CRM_Profile_Form
::MODE_SEARCH
) {
1932 $form->freeze($name . '-provider_id');
1936 elseif (CRM_Utils_Array
::value('name', $field) == 'membership_type') {
1937 list($orgInfo, $types) = CRM_Member_BAO_MembershipType
::getMembershipTypeInfo();
1938 $sel = &$form->addElement('hierselect', $name, $title);
1939 $select = array('' => ts('- select -'));
1940 if (count($orgInfo) == 1 && $field['is_required']) {
1941 // we only have one org - so we should default to it. Not sure about defaulting to first type
1942 // as it could be missed - so adding a select
1943 // however, possibly that is more similar to the membership form
1944 if (count($types[1]) > 1) {
1945 $types[1] = $select +
$types[1];
1949 $orgInfo = $select +
$orgInfo;
1951 $sel->setOptions(array($orgInfo, $types));
1953 elseif (CRM_Utils_Array
::value('name', $field) == 'membership_status') {
1954 $form->add('select', $name, $title,
1956 '' => ts('- select -'),
1957 ) + CRM_Member_PseudoConstant
::membershipStatus(NULL, NULL, 'label'), $required
1960 elseif (in_array($fieldName, array('gender_id', 'communication_style_id'))) {
1962 $pseudoValues = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', $fieldName);
1963 foreach ($pseudoValues as $key => $var) {
1964 $options[$key] = $form->createElement('radio', NULL, ts($title), $var, $key);
1966 $group = $form->addGroup($options, $name, $title);
1968 $form->addRule($name, ts('%1 is a required field.', array(1 => $title)), 'required');
1971 $group->setAttribute('allowClear', TRUE);
1974 elseif ($fieldName === 'prefix_id' ||
$fieldName === 'suffix_id') {
1975 $form->addSelect($name, array(
1977 'entity' => 'contact',
1978 'field' => $fieldName,
1980 'placeholder' => '',
1983 elseif ($fieldName === 'contact_sub_type') {
1984 $gId = $form->get('gid') ?
$form->get('gid') : CRM_Utils_Array
::value('group_id', $field);
1985 if ($usedFor == 'onbehalf') {
1986 $profileType = 'Organization';
1988 elseif ($usedFor == 'honor') {
1989 $profileType = CRM_Core_BAO_UFField
::getProfileType($form->_params
['honoree_profile_id']);
1992 $profileType = $gId ? CRM_Core_BAO_UFField
::getProfileType($gId) : NULL;
1993 if ($profileType == 'Contact') {
1994 $profileType = 'Individual';
1998 $setSubtype = FALSE;
1999 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
2000 $setSubtype = $profileType;
2001 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
2004 $subtypes = $profileType ? CRM_Contact_BAO_ContactType
::subTypePairs($profileType) : array();
2007 $subtypeList = array();
2008 $subtypeList[$setSubtype] = $subtypes[$setSubtype];
2011 $subtypeList = $subtypes;
2014 $form->add('select', $name, $title, $subtypeList, $required, array('class' => 'crm-select2', 'multiple' => TRUE));
2016 elseif (in_array($fieldName, CRM_Contact_BAO_Contact
::$_greetingTypes)) {
2017 //add email greeting, postal greeting, addressee, CRM-4575
2018 $gId = $form->get('gid') ?
$form->get('gid') : CRM_Utils_Array
::value('group_id', $field);
2019 $profileType = CRM_Core_BAO_UFField
::getProfileType($gId, TRUE, FALSE, TRUE);
2021 if (empty($profileType) ||
in_array($profileType, array(
2028 $profileType = 'Individual';
2030 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
2031 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
2034 'contact_type' => $profileType,
2035 'greeting_type' => $fieldName,
2037 $form->add('select', $name, $title,
2039 '' => ts('- select -'),
2040 ) + CRM_Core_PseudoConstant
::greeting($greeting), $required
2042 // add custom greeting element
2043 $form->add('text', $fieldName . '_custom', ts('Custom %1', array(1 => ucwords(str_replace('_', ' ', $fieldName)))),
2047 elseif ($fieldName === 'preferred_communication_method') {
2048 $communicationFields = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'preferred_communication_method');
2049 foreach ($communicationFields as $key => $var) {
2053 $communicationOptions[] = $form->createElement('checkbox', $key, NULL, $var);
2055 $form->addGroup($communicationOptions, $name, $title, '<br/>');
2057 elseif ($fieldName === 'preferred_mail_format') {
2058 $form->add('select', $name, $title, CRM_Core_SelectValues
::pmf());
2060 elseif ($fieldName === 'preferred_language') {
2061 $form->add('select', $name, $title, array('' => ts('- select -')) + CRM_Contact_BAO_Contact
::buildOptions('preferred_language'));
2063 elseif ($fieldName == 'external_identifier') {
2064 $form->add('text', $name, $title, $attributes, $required);
2065 $contID = $contactId;
2067 $contID = $form->get('id');
2069 $form->addRule($name,
2070 ts('External ID already exists in Database.'),
2072 array('CRM_Contact_DAO_Contact', $contID, 'external_identifier')
2075 elseif ($fieldName === 'group') {
2076 CRM_Contact_Form_Edit_TagsAndGroups
::buildQuickForm($form, $contactId,
2077 CRM_Contact_Form_Edit_TagsAndGroups
::GROUP
,
2082 elseif ($fieldName === 'tag') {
2083 CRM_Contact_Form_Edit_TagsAndGroups
::buildQuickForm($form, $contactId,
2084 CRM_Contact_Form_Edit_TagsAndGroups
::TAG
,
2089 elseif (substr($fieldName, 0, 4) === 'url-') {
2090 $form->add('text', $name, $title, CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Website', 'url'), $required);
2091 $form->addRule($name, ts('Enter a valid web address beginning with \'http://\' or \'https://\'.'), 'url');
2093 // Note should be rendered as textarea
2094 elseif (substr($fieldName, -4) == 'note') {
2095 $form->add('textarea', $name, $title, $attributes, $required);
2097 elseif (substr($fieldName, 0, 6) === 'custom') {
2098 $customFieldID = CRM_Core_BAO_CustomField
::getKeyID($fieldName);
2099 if ($customFieldID) {
2100 CRM_Core_BAO_CustomField
::addQuickFormElement($form, $name, $customFieldID, $required, $search, $title);
2103 elseif (substr($fieldName, 0, 14) === 'address_custom') {
2104 list($fName, $locTypeId) = CRM_Utils_System
::explode('-', $fieldName, 2);
2105 $customFieldID = CRM_Core_BAO_CustomField
::getKeyID(substr($fName, 8));
2106 if ($customFieldID) {
2107 CRM_Core_BAO_CustomField
::addQuickFormElement($form, $name, $customFieldID, $required, $search, $title);
2110 elseif ($fieldName == 'send_receipt') {
2111 $form->addElement('checkbox', $name, $title);
2113 elseif ($fieldName == 'soft_credit') {
2114 $form->addEntityRef("soft_credit_contact_id[$rowNumber]", ts('Soft Credit To'), array('create' => TRUE));
2115 $form->addMoney("soft_credit_amount[{$rowNumber}]", ts('Amount'), FALSE, NULL, FALSE);
2117 elseif ($fieldName == 'product_name') {
2118 list($products, $options) = CRM_Contribute_BAO_Premium
::getPremiumProductInfo();
2119 $sel = &$form->addElement('hierselect', $name, $title);
2121 '0' => ts('- select -'),
2123 $sel->setOptions(array($products, $options));
2125 elseif ($fieldName == 'payment_instrument') {
2126 $form->add('select', $name, $title,
2127 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::paymentInstrument(), $required);
2129 elseif ($fieldName == 'financial_type') {
2130 $form->add('select', $name, $title,
2132 '' => ts('- select -'),
2133 ) + CRM_Contribute_PseudoConstant
::financialType(), $required
2136 elseif ($fieldName == 'contribution_status_id') {
2137 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus();
2138 $statusName = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
2144 unset($contributionStatuses[CRM_Utils_Array
::key($suppress, $statusName)]);
2147 $form->add('select', $name, $title,
2149 '' => ts('- select -'),
2150 ) +
$contributionStatuses, $required
2153 elseif ($fieldName == 'soft_credit_type') {
2154 $name = "soft_credit_type[$rowNumber]";
2155 $form->add('select', $name, $title,
2157 '' => ts('- select -'),
2158 ) + CRM_Core_OptionGroup
::values("soft_credit_type")
2160 //CRM-15350: choose SCT field default value as 'Gift' for membership use
2161 //else (for contribution), use configured SCT default value
2162 $SCTDefaultValue = CRM_Core_OptionGroup
::getDefaultValue("soft_credit_type");
2163 if ($field['field_type'] == 'Membership') {
2164 $SCTDefaultValue = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_ContributionSoft', 'soft_credit_type_id', 'gift');
2166 $form->addElement('hidden', 'sct_default_id', $SCTDefaultValue, array('id' => 'sct_default_id'));
2168 elseif ($fieldName == 'contribution_soft_credit_pcp_id') {
2169 CRM_Contribute_Form_SoftCredit
::addPCPFields($form, "[$rowNumber]");
2171 elseif ($fieldName == 'currency') {
2172 $form->addCurrency($name, $title, $required, NULL, FALSE, FALSE);
2174 elseif ($fieldName == 'contribution_page_id') {
2175 $form->add('select', $name, $title,
2177 '' => ts('- select -'),
2178 ) + CRM_Contribute_PseudoConstant
::contributionPage(), $required, 'class="big"'
2181 elseif ($fieldName == 'activity_status_id') {
2182 $form->add('select', $name, $title,
2184 '' => ts('- select -'),
2185 ) + CRM_Core_PseudoConstant
::activityStatus(), $required
2188 elseif ($fieldName == 'activity_engagement_level') {
2189 $form->add('select', $name, $title,
2191 '' => ts('- select -'),
2192 ) + CRM_Campaign_PseudoConstant
::engagementLevel(), $required
2195 elseif ($fieldName == 'participant_status') {
2197 if ($online == TRUE) {
2198 $cond = 'visibility_id = 1';
2200 $form->add('select', $name, $title,
2202 '' => ts('- select -'),
2203 ) + CRM_Event_PseudoConstant
::participantStatus(NULL, $cond, 'label'), $required
2206 elseif ($fieldName == 'participant_role') {
2207 if (!empty($field['is_multiple'])) {
2208 $form->addCheckBox($name, $title, CRM_Event_PseudoConstant
::participantRole(), NULL, NULL, NULL, NULL, ' ', TRUE);
2211 $form->add('select', $name, $title,
2213 '' => ts('- select -'),
2214 ) + CRM_Event_PseudoConstant
::participantRole(), $required
2218 elseif ($fieldName == 'world_region') {
2219 $form->add('select', $name, $title, CRM_Core_PseudoConstant
::worldRegion(), $required, $selectAttributes);
2221 elseif ($fieldName == 'signature_html') {
2222 $form->add('wysiwyg', $name, $title, CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Email', $fieldName));
2224 elseif ($fieldName == 'signature_text') {
2225 $form->add('textarea', $name, $title, CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Email', $fieldName));
2227 elseif (substr($fieldName, -11) == 'campaign_id') {
2228 if (CRM_Campaign_BAO_Campaign
::isCampaignEnable()) {
2229 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(CRM_Utils_Array
::value($contactId,
2230 $form->_componentCampaigns
2232 $form->add('select', $name, $title,
2234 '' => ts('- select -'),
2235 ) +
$campaigns, $required, 'class="crm-select2 big"'
2239 elseif ($fieldName == 'activity_details') {
2240 $form->add('wysiwyg', $fieldName, $title, array('rows' => 4, 'cols' => 60), $required);
2242 elseif ($fieldName == 'activity_duration') {
2243 $form->add('text', $name, $title, $attributes, $required);
2244 $form->addRule($name, ts('Please enter the duration as number of minutes (integers only).'), 'positiveInteger');
2246 elseif ($fieldName == 'case_status') {
2247 $form->add('select', $name, $title,
2249 '' => ts('- select -'),
2250 ) + CRM_Case_BAO_Case
::buildOptions('case_status_id', 'create'),
2255 if (substr($fieldName, 0, 3) === 'is_' or substr($fieldName, 0, 7) === 'do_not_') {
2256 $form->add('advcheckbox', $name, $title, $attributes, $required);
2258 elseif (CRM_Utils_Array
::value('html_type', $field) === 'Select Date') {
2259 $extra = isset($field['datepicker']) ?
$field['datepicker']['extra'] : CRM_Utils_Date
::getDatePickerExtra($field);
2260 $attributes = isset($field['datepicker']) ?
$field['datepicker']['attributes'] : CRM_Utils_Date
::getDatePickerAttributes($field);
2261 $form->add('datepicker', $name, $title, $attributes, $required, $extra);
2264 $form->add('text', $name, $title, $attributes, $required);
2268 static $hiddenSubtype = FALSE;
2269 if (!$hiddenSubtype && CRM_Contact_BAO_ContactType
::isaSubType($field['field_type'])) {
2270 // In registration mode params are submitted via POST and we don't have any clue
2271 // about profile-id or the profile-type (which could be a subtype)
2272 // To generalize the behavior and simplify the process,
2273 // lets always add the hidden
2274 //subtype value if there is any, and we won't have to
2275 // compute it while processing.
2277 $form->addElement('hidden', $usedFor . '[contact_sub_type]', $field['field_type']);
2280 $form->addElement('hidden', 'contact_sub_type_hidden', $field['field_type']);
2282 $hiddenSubtype = TRUE;
2285 if (($view && $mode != CRM_Profile_Form
::MODE_SEARCH
) ||
$isShared) {
2286 $form->freeze($name);
2290 if (in_array($fieldName, array(
2291 'non_deductible_amount',
2296 $form->addRule($name, ts('Please enter a valid amount.'), 'money');
2299 if (!($rule == 'email' && $mode == CRM_Profile_Form
::MODE_SEARCH
)) {
2300 $form->addRule($name, ts('Please enter a valid %1', array(1 => $title)), $rule);
2306 * Set profile defaults.
2308 * @param int $contactId
2310 * @param array $fields
2311 * Associative array of fields.
2312 * @param array $defaults
2314 * @param bool $singleProfile
2315 * True for single profile else false(Update multiple items).
2316 * @param int $componentId
2317 * Id for specific components like contribute, event etc.
2318 * @param null $component
2320 public static function setProfileDefaults(
2321 $contactId, &$fields, &$defaults,
2322 $singleProfile = TRUE, $componentId = NULL, $component = NULL
2324 if (!$componentId) {
2325 //get the contact details
2326 list($contactDetails, $options) = CRM_Contact_BAO_Contact
::getHierContactDetails($contactId, $fields);
2327 $details = CRM_Utils_Array
::value($contactId, $contactDetails);
2328 $multipleFields = array('website' => 'url');
2330 //start of code to set the default values
2331 foreach ($fields as $name => $field) {
2332 // skip pseudo fields
2333 if (substr($name, 0, 9) == 'phone_ext') {
2337 //set the field name depending upon the profile mode(single/multiple)
2338 if ($singleProfile) {
2342 $fldName = "field[$contactId][$name]";
2345 if ($name == 'group') {
2346 CRM_Contact_Form_Edit_TagsAndGroups
::setDefaults($contactId, $defaults, CRM_Contact_Form_Edit_TagsAndGroups
::GROUP
, $fldName);
2348 if ($name == 'tag') {
2349 CRM_Contact_Form_Edit_TagsAndGroups
::setDefaults($contactId, $defaults, CRM_Contact_Form_Edit_TagsAndGroups
::TAG
, $fldName);
2352 if (!empty($details[$name]) ||
isset($details[$name])) {
2353 //to handle custom data (checkbox) to be written
2354 // to handle birth/deceased date, greeting_type and few other fields
2355 if (in_array($name, CRM_Contact_BAO_Contact
::$_greetingTypes)) {
2356 $defaults[$fldName] = $details[$name . '_id'];
2357 $defaults[$name . '_custom'] = $details[$name . '_custom'];
2359 elseif ($name == 'preferred_communication_method') {
2360 $v = $details[$name];
2361 if (!is_array($details[$name])) {
2362 $v = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $v);
2364 foreach ($v as $item) {
2366 $defaults[$fldName . "[$item]"] = 1;
2370 elseif ($name == 'contact_sub_type') {
2371 $defaults[$fldName] = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, trim($details[$name], CRM_Core_DAO
::VALUE_SEPARATOR
));
2373 elseif ($name == 'world_region') {
2374 $defaults[$fldName] = $details['worldregion_id'];
2376 elseif ($customFieldId = CRM_Core_BAO_CustomField
::getKeyID($name)) {
2377 // @todo retrieving the custom fields here seems obsolete - $field holds more data for the fields.
2378 $customFields = CRM_Core_BAO_CustomField
::getFields(CRM_Utils_Array
::value('contact_type', $details));
2380 // hack to add custom data for components
2381 $components = array('Contribution', 'Participant', 'Membership', 'Activity');
2382 foreach ($components as $value) {
2383 $customFields = CRM_Utils_Array
::crmArrayMerge($customFields,
2384 CRM_Core_BAO_CustomField
::getFieldsForImport($value)
2388 switch ($customFields[$customFieldId]['html_type']) {
2389 case 'Multi-Select State/Province':
2390 case 'Multi-Select Country':
2391 case 'Multi-Select':
2392 $v = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $details[$name]);
2393 foreach ($v as $item) {
2395 $defaults[$fldName][$item] = $item;
2401 $v = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $details[$name]);
2402 foreach ($v as $item) {
2404 $defaults[$fldName][$item] = 1;
2405 // seems like we need this for QF style checkboxes in profile where its multiindexed
2407 $defaults["{$fldName}[{$item}]"] = 1;
2413 $defaults[$fldName] = $details[$name];
2418 $defaults[$fldName] = $details[$name];
2422 $blocks = array('email', 'phone', 'im', 'openid');
2423 list($fieldName, $locTypeId, $phoneTypeId) = CRM_Utils_System
::explode('-', $name, 3);
2424 if (!in_array($fieldName, $multipleFields)) {
2425 if (is_array($details)) {
2426 foreach ($details as $key => $value) {
2427 // when we fixed CRM-5319 - get primary loc
2428 // type as per loc field and removed below code.
2429 $primaryLocationType = FALSE;
2430 if ($locTypeId == 'Primary') {
2431 if (is_array($value) && array_key_exists($fieldName, $value)) {
2432 $primaryLocationType = TRUE;
2433 if (in_array($fieldName, $blocks)) {
2434 $locTypeId = CRM_Contact_BAO_Contact
::getPrimaryLocationType($contactId, FALSE, $fieldName);
2437 $locTypeId = CRM_Contact_BAO_Contact
::getPrimaryLocationType($contactId, FALSE, 'address');
2442 // fixed for CRM-665
2443 if (is_numeric($locTypeId)) {
2444 if ($primaryLocationType ||
$locTypeId == CRM_Utils_Array
::value('location_type_id', $value)) {
2445 if (!empty($value[$fieldName])) {
2446 //to handle stateprovince and country
2447 if ($fieldName == 'state_province') {
2448 $defaults[$fldName] = $value['state_province_id'];
2450 elseif ($fieldName == 'county') {
2451 $defaults[$fldName] = $value['county_id'];
2453 elseif ($fieldName == 'country') {
2454 if (!isset($value['country_id']) ||
!$value['country_id']) {
2455 $config = CRM_Core_Config
::singleton();
2456 if ($config->defaultContactCountry
) {
2457 $defaults[$fldName] = $config->defaultContactCountry
;
2461 $defaults[$fldName] = $value['country_id'];
2464 elseif ($fieldName == 'phone') {
2466 if (isset($value['phone'][$phoneTypeId])) {
2467 $defaults[$fldName] = $value['phone'][$phoneTypeId];
2469 if (isset($value['phone_ext'][$phoneTypeId])) {
2470 $defaults[str_replace('phone', 'phone_ext', $fldName)] = $value['phone_ext'][$phoneTypeId];
2474 $phoneDefault = CRM_Utils_Array
::value('phone', $value);
2476 if (!is_array($phoneDefault)) {
2477 $defaults[$fldName] = $phoneDefault;
2481 elseif ($fieldName == 'email') {
2482 //adding the first email (currently we don't support multiple emails of same location type)
2483 $defaults[$fldName] = $value['email'];
2485 elseif ($fieldName == 'im') {
2486 //adding the first im (currently we don't support multiple ims of same location type)
2487 $defaults[$fldName] = $value['im'];
2488 $defaults[$fldName . '-provider_id'] = $value['im_provider_id'];
2491 $defaults[$fldName] = $value[$fieldName];
2494 elseif (substr($fieldName, 0, 14) === 'address_custom' &&
2495 CRM_Utils_Array
::value(substr($fieldName, 8), $value)
2497 $defaults[$fldName] = $value[substr($fieldName, 8)];
2505 if (is_array($details)) {
2506 if ($fieldName === 'url'
2507 && !empty($details['website'])
2508 && !empty($details['website'][$locTypeId])
2510 $defaults[$fldName] = CRM_Utils_Array
::value('url', $details['website'][$locTypeId]);
2518 // Handling Contribution Part of the batch profile
2519 if (CRM_Core_Permission
::access('CiviContribute') && $component == 'Contribute') {
2520 self
::setComponentDefaults($fields, $componentId, $component, $defaults);
2523 // Handling Event Participation Part of the batch profile
2524 if (CRM_Core_Permission
::access('CiviEvent') && $component == 'Event') {
2525 self
::setComponentDefaults($fields, $componentId, $component, $defaults);
2528 // Handling membership Part of the batch profile
2529 if (CRM_Core_Permission
::access('CiviMember') && $component == 'Membership') {
2530 self
::setComponentDefaults($fields, $componentId, $component, $defaults);
2533 // Handling Activity Part of the batch profile
2534 if ($component == 'Activity') {
2535 self
::setComponentDefaults($fields, $componentId, $component, $defaults);
2538 // Handling Case Part of the batch profile
2539 if (CRM_Core_Permission
::access('CiviCase') && $component == 'Case') {
2540 self
::setComponentDefaults($fields, $componentId, $component, $defaults);
2545 * Get profiles by type eg: pure Individual etc
2547 * @param array $types
2548 * Associative array of types eg: types('Individual').
2549 * @param bool $onlyPure
2550 * True if only pure profiles are required.
2553 * associative array of profiles
2555 public static function getProfiles($types, $onlyPure = FALSE) {
2556 $profiles = array();
2557 $ufGroups = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_UFField', 'uf_group_id');
2559 CRM_Utils_Hook
::aclGroup(CRM_Core_Permission
::ADMIN
, NULL, 'civicrm_uf_group', $ufGroups, $ufGroups);
2561 // Exclude Batch Data Entry profiles - CRM-10901
2562 $batchProfiles = CRM_Core_BAO_UFGroup
::getBatchProfiles();
2564 foreach ($ufGroups as $id => $title) {
2565 $ptype = CRM_Core_BAO_UFField
::getProfileType($id, FALSE, $onlyPure);
2566 if (in_array($ptype, $types) && !array_key_exists($id, $batchProfiles)) {
2567 $profiles[$id] = $title;
2574 * Check whether a profile is valid combination of
2575 * required and/or optional profile types
2577 * @param array $required
2578 * Array of types those are required.
2579 * @param array $optional
2580 * Array of types those are optional.
2583 * associative array of profiles
2585 public static function getValidProfiles($required, $optional = NULL) {
2586 if (!is_array($required) ||
empty($required)) {
2590 $profiles = array();
2591 $ufGroups = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_UFField', 'uf_group_id');
2593 CRM_Utils_Hook
::aclGroup(CRM_Core_Permission
::ADMIN
, NULL, 'civicrm_uf_group', $ufGroups, $ufGroups);
2595 foreach ($ufGroups as $id => $title) {
2596 $type = CRM_Core_BAO_UFField
::checkValidProfileType($id, $required, $optional);
2598 $profiles[$id] = $title;
2606 * Check whether a profile is valid combination of
2607 * required profile fields
2609 * @param array $ufId
2610 * Integer id of the profile.
2611 * @param array $required
2612 * Array of fields those are required in the profile.
2615 * associative array of profiles
2617 public static function checkValidProfile($ufId, $required = NULL) {
2618 $validProfile = FALSE;
2620 return $validProfile;
2623 if (!CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $ufId, 'is_active')) {
2624 return $validProfile;
2627 $profileFields = self
::getFields($ufId, FALSE, CRM_Core_Action
::VIEW
, NULL,
2628 NULL, FALSE, NULL, FALSE, NULL,
2629 CRM_Core_Permission
::CREATE
, NULL
2632 $validProfile = array();
2633 if (!empty($profileFields)) {
2634 $fields = array_keys($profileFields);
2635 foreach ($fields as $val) {
2636 foreach ($required as $key => $field) {
2637 if (strpos($val, $field) === 0) {
2638 unset($required[$key]);
2643 $validProfile = (empty($required)) ?
TRUE : FALSE;
2646 return $validProfile;
2650 * Get default value for Register.
2652 * @param array $fields
2653 * @param array $defaults
2657 public static function setRegisterDefaults(&$fields, &$defaults) {
2658 $config = CRM_Core_Config
::singleton();
2659 foreach ($fields as $name => $field) {
2660 if (substr($name, 0, 8) == 'country-') {
2661 if (!empty($config->defaultContactCountry
)) {
2662 $defaults[$name] = $config->defaultContactCountry
;
2665 elseif (substr($name, 0, 15) == 'state_province-') {
2666 if (!empty($config->defaultContactStateProvince
)) {
2667 $defaults[$name] = $config->defaultContactStateProvince
;
2675 * make a copy of a profile, including
2676 * all the fields in the profile
2679 * The profile id to copy.
2681 * @return \CRM_Core_DAO
2683 public static function copy($id) {
2684 $maxId = CRM_Core_DAO
::singleValueQuery("SELECT max(id) FROM civicrm_uf_group");
2686 $title = ts('[Copy id %1]', array(1 => $maxId +
1));
2689 'title' => ' ' . $title,
2690 'name' => '__Copy_id_' . ($maxId +
1) . '_',
2694 $copy = CRM_Core_DAO
::copyGeneric('CRM_Core_DAO_UFGroup',
2700 if ($pos = strrpos($copy->name
, "_{$id}")) {
2701 $copy->name
= substr_replace($copy->name
, '', $pos);
2703 $copy->name
= CRM_Utils_String
::munge($copy->name
, '_', 56) . "_{$copy->id}";
2706 $copyUFJoin = CRM_Core_DAO
::copyGeneric('CRM_Core_DAO_UFJoin',
2707 array('uf_group_id' => $id),
2708 array('uf_group_id' => $copy->id
),
2713 $copyUFField = CRM_Core_DAO
::copyGeneric('CRM_Core_BAO_UFField',
2714 array('uf_group_id' => $id),
2715 array('uf_group_id' => $copy->id
)
2718 $maxWeight = CRM_Utils_Weight
::getMax('CRM_Core_DAO_UFJoin', NULL, 'weight');
2722 UPDATE civicrm_uf_join
2724 WHERE uf_group_id = %2
2725 AND ( entity_id IS NULL OR entity_id <= 0 )
2728 1 => array($maxWeight +
1, 'Integer'),
2729 2 => array($copy->id
, 'Integer'),
2731 CRM_Core_DAO
::executeQuery($query, $p);
2732 if ($copy->is_reserved
) {
2733 $query = "UPDATE civicrm_uf_group SET is_reserved = 0 WHERE id = %1";
2734 $params = array(1 => array($copy->id
, 'Integer'));
2735 CRM_Core_DAO
::executeQuery($query, $params);
2737 CRM_Utils_Hook
::copy('UFGroup', $copy);
2743 * Process that send notification e-mails
2745 * @param int $contactID
2747 * @param array $values
2748 * Associative array of name/value pair.
2750 public static function commonSendMail($contactID, &$values) {
2751 if (!$contactID ||
!$values) {
2755 $template = CRM_Core_Smarty
::singleton();
2757 $displayName = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
2762 self
::profileDisplay($values['id'], $values['values'], $template);
2763 $emailList = explode(',', $values['email']);
2765 $contactLink = CRM_Utils_System
::url('civicrm/contact/view',
2766 "reset=1&cid=$contactID",
2767 TRUE, NULL, FALSE, FALSE, TRUE
2770 //get the default domain email address.
2771 list($domainEmailName, $domainEmailAddress) = CRM_Core_BAO_Domain
::getNameAndEmail();
2773 if (!$domainEmailAddress ||
$domainEmailAddress == 'info@EXAMPLE.ORG') {
2774 $fixUrl = CRM_Utils_System
::url('civicrm/admin/domain', 'action=update&reset=1');
2775 CRM_Core_Error
::fatal(ts('The site administrator needs to enter a valid \'FROM Email Address\' in <a href="%1">Administer CiviCRM » Communications » FROM Email Addresses</a>. The email address used may need to be a valid mail account with your email service provider.', array(1 => $fixUrl)));
2778 foreach ($emailList as $emailTo) {
2779 // FIXME: take the below out of the foreach loop
2780 CRM_Core_BAO_MessageTemplate
::sendTemplate(
2782 'groupName' => 'msg_tpl_workflow_uf',
2783 'valueName' => 'uf_notify',
2784 'contactId' => $contactID,
2785 'tplParams' => array(
2786 'displayName' => $displayName,
2787 'currentDate' => date('r'),
2788 'contactLink' => $contactLink,
2790 'from' => "$domainEmailName <$domainEmailAddress>",
2791 'toEmail' => $emailTo,
2798 * Given a contact id and a group id, returns the field values from the db
2799 * for this group and notify email only if group's notify field is
2800 * set and field values are not empty
2806 * @param array $params
2807 * @param bool $skipCheck
2811 public function checkFieldsEmptyValues($gid, $cid, $params, $skipCheck = FALSE) {
2813 if (CRM_Core_BAO_UFGroup
::filterUFGroups($gid, $cid) ||
$skipCheck) {
2815 $fields = CRM_Core_BAO_UFGroup
::getFields($gid, FALSE, CRM_Core_Action
::VIEW
);
2816 CRM_Core_BAO_UFGroup
::getValues($cid, $fields, $values, FALSE, $params, TRUE);
2818 $email = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $gid, 'notify');
2820 if (!empty($values) &&
2825 'values' => $values,
2836 * Assign uf fields to template.
2840 * @param array $values
2841 * @param CRM_Core_Smarty $template
2843 public static function profileDisplay($gid, $values, $template) {
2844 $groupTitle = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $gid, 'title');
2845 $template->assign('grouptitle', $groupTitle);
2846 if (count($values)) {
2847 $template->assign('values', $values);
2852 * Format fields for dupe Contact Matching.
2854 * @param array $params
2856 * @param int $contactId
2859 * associated formatted array
2861 public static function formatFields($params, $contactId = NULL) {
2863 // get the primary location type id and email
2864 list($name, $primaryEmail, $primaryLocationType) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contactId);
2867 $defaultLocationType = CRM_Core_BAO_LocationType
::getDefault();
2868 $primaryLocationType = $defaultLocationType->id
;
2872 $locationType = array();
2874 $primaryLocation = 0;
2875 foreach ($params as $key => $value) {
2876 list($fieldName, $locTypeId, $phoneTypeId) = explode('-', $key);
2878 if ($locTypeId == 'Primary') {
2879 $locTypeId = $primaryLocationType;
2882 if (is_numeric($locTypeId)) {
2883 if (!in_array($locTypeId, $locationType)) {
2884 $locationType[$count] = $locTypeId;
2887 $loc = CRM_Utils_Array
::key($locTypeId, $locationType);
2889 $data['location'][$loc]['location_type_id'] = $locTypeId;
2891 // if we are getting in a new primary email, dont overwrite the new one
2892 if ($locTypeId == $primaryLocationType) {
2893 if (!empty($params['email-' . $primaryLocationType])) {
2894 $data['location'][$loc]['email'][$loc]['email'] = $fields['email-' . $primaryLocationType];
2896 elseif (isset($primaryEmail)) {
2897 $data['location'][$loc]['email'][$loc]['email'] = $primaryEmail;
2903 $data['location'][$loc]['is_primary'] = 1;
2905 if ($fieldName == 'phone') {
2907 $data['location'][$loc]['phone'][$loc]['phone_type_id'] = $phoneTypeId;
2910 $data['location'][$loc]['phone'][$loc]['phone_type_id'] = '';
2912 $data['location'][$loc]['phone'][$loc]['phone'] = $value;
2914 elseif ($fieldName == 'email') {
2915 $data['location'][$loc]['email'][$loc]['email'] = $value;
2917 elseif ($fieldName == 'im') {
2918 $data['location'][$loc]['im'][$loc]['name'] = $value;
2921 if ($fieldName === 'state_province') {
2922 $data['location'][$loc]['address']['state_province_id'] = $value;
2924 elseif ($fieldName === 'country') {
2925 $data['location'][$loc]['address']['country_id'] = $value;
2928 $data['location'][$loc]['address'][$fieldName] = $value;
2933 // TODO: prefix, suffix and gender translation may no longer be necessary - check inputs
2934 if ($key === 'individual_suffix') {
2935 $data['suffix_id'] = $value;
2937 elseif ($key === 'individual_prefix') {
2938 $data['prefix_id'] = $value;
2940 elseif ($key === 'gender') {
2941 $data['gender_id'] = $value;
2943 elseif (substr($key, 0, 6) === 'custom') {
2944 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
2946 if ($customFields[$customFieldID]['html_type'] == 'CheckBox') {
2947 $value = implode(CRM_Core_DAO
::VALUE_SEPARATOR
, array_keys($value));
2949 // fix the date field
2950 if ($customFields[$customFieldID]['data_type'] == 'Date') {
2951 $date = CRM_Utils_Date
::format($value);
2958 $data['custom'][$customFieldID] = array(
2961 'extends' => $customFields[$customFieldID]['extends'],
2962 'type' => $customFields[$customFieldID]['data_type'],
2963 'custom_field_id' => $customFieldID,
2967 elseif ($key == 'edit') {
2971 $data[$key] = $value;
2976 if (!$primaryLocation) {
2978 $data['location'][$loc]['email'][$loc]['email'] = $primaryEmail;
2985 * Calculate the profile type 'group_type' as per profile fields.
2989 * @param bool $includeTypeValues
2990 * @param int $ignoreFieldId
2991 * Ignore particular profile field.
2994 * list of calculated group type
2996 public static function calculateGroupType($gId, $includeTypeValues = FALSE, $ignoreFieldId = NULL) {
2997 //get the profile fields.
2998 $ufFields = self
::getFields($gId, FALSE, NULL, NULL, NULL, TRUE, NULL, TRUE);
2999 return self
::_calculateGroupType($ufFields, $includeTypeValues, $ignoreFieldId);
3003 * Calculate the profile type 'group_type' as per profile fields.
3006 * @param bool $includeTypeValues
3007 * @param int $ignoreFieldId
3008 * Ignore perticular profile field.
3011 * list of calculated group type
3013 public static function _calculateGroupType($ufFields, $includeTypeValues = FALSE, $ignoreFieldId = NULL) {
3014 $groupType = $groupTypeValues = $customFieldIds = array();
3015 if (!empty($ufFields)) {
3016 foreach ($ufFields as $fieldName => $fieldValue) {
3017 //ignore field from group type when provided.
3018 //in case of update profile field.
3019 if ($ignoreFieldId && ($ignoreFieldId == $fieldValue['field_id'])) {
3022 if (!in_array($fieldValue['field_type'], $groupType)) {
3023 $groupType[$fieldValue['field_type']] = $fieldValue['field_type'];
3026 if ($includeTypeValues && ($fldId = CRM_Core_BAO_CustomField
::getKeyID($fieldName))) {
3027 $customFieldIds[$fldId] = $fldId;
3032 if (!empty($customFieldIds)) {
3033 $query = 'SELECT DISTINCT(cg.id), cg.extends, cg.extends_entity_column_id, cg.extends_entity_column_value FROM civicrm_custom_group cg LEFT JOIN civicrm_custom_field cf ON cf.custom_group_id = cg.id WHERE cg.extends_entity_column_value IS NOT NULL AND cf.id IN (' . implode(',', $customFieldIds) . ')';
3035 $customGroups = CRM_Core_DAO
::executeQuery($query);
3036 while ($customGroups->fetch()) {
3037 if (!$customGroups->extends_entity_column_value
) {
3041 $groupTypeName = "{$customGroups->extends}Type";
3042 if ($customGroups->extends == 'Participant' && $customGroups->extends_entity_column_id
) {
3043 $groupTypeName = CRM_Core_PseudoConstant
::getName('CRM_Core_DAO_CustomGroup', 'extends_entity_column_id', $customGroups->extends_entity_column_id
);
3046 foreach (explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $customGroups->extends_entity_column_value
) as $val) {
3048 $groupTypeValues[$groupTypeName][$val] = $val;
3053 if (!empty($groupTypeValues)) {
3054 $groupType = array_merge($groupType, $groupTypeValues);
3062 * Update the profile type 'group_type' as per profile fields including group types and group subtype values.
3063 * Build and store string like: group_type1,group_type2[VALUE_SEPERATOR]group_type1Type:1:2:3,group_type2Type:1:2
3066 * BirthDate + Email Individual,Contact
3067 * BirthDate + Subject Individual,Activity
3068 * BirthDate + Subject + SurveyOnlyField Individual,Activity\0ActivityType:28
3069 * BirthDate + Subject + SurveyOnlyField + PhoneOnlyField (Not allowed)
3070 * BirthDate + SurveyOnlyField Individual,Activity\0ActivityType:28
3071 * BirthDate + Subject + SurveyOrPhoneField Individual,Activity\0ActivityType:2:28
3072 * BirthDate + SurveyOrPhoneField Individual,Activity\0ActivityType:2:28
3073 * BirthDate + SurveyOrPhoneField + SurveyOnlyField Individual,Activity\0ActivityType:2:28
3074 * BirthDate + StudentField + Subject + SurveyOnlyField Individual,Activity,Student\0ActivityType:28
3077 * @param array $groupTypes
3078 * With key having group type names.
3082 public static function updateGroupTypes($gId, $groupTypes = array()) {
3083 if (!is_array($groupTypes) ||
!$gId) {
3087 // If empty group types set group_type as 'null'
3088 if (empty($groupTypes)) {
3089 return CRM_Core_DAO
::setFieldValue('CRM_Core_DAO_UFGroup', $gId, 'group_type', 'null');
3092 $componentGroupTypes = array('Contribution', 'Participant', 'Membership', 'Activity', 'Case');
3093 $validGroupTypes = array_merge(array(
3098 ), $componentGroupTypes, CRM_Contact_BAO_ContactType
::subTypes());
3100 $gTypes = $gTypeValues = array();
3102 $participantExtends = array('ParticipantRole', 'ParticipantEventName', 'ParticipantEventType');
3103 // Get valid group type and group subtypes
3104 foreach ($groupTypes as $groupType => $value) {
3105 if (in_array($groupType, $validGroupTypes) && !in_array($groupType, $gTypes)) {
3106 $gTypes[] = $groupType;
3111 if (in_array($groupType, $participantExtends)) {
3112 $subTypesOf = $groupType;
3114 elseif (strpos($groupType, 'Type') > 0) {
3115 $subTypesOf = substr($groupType, 0, strpos($groupType, 'Type'));
3121 if (!empty($value) &&
3122 (in_array($subTypesOf, $componentGroupTypes) ||
3123 in_array($subTypesOf, $participantExtends)
3126 $gTypeValues[$subTypesOf] = $groupType . ":" . implode(':', $value);
3130 if (empty($gTypes)) {
3134 // Build String to store group types and group subtypes
3135 $groupTypeString = implode(',', $gTypes);
3136 if (!empty($gTypeValues)) {
3137 $groupTypeString .= CRM_Core_DAO
::VALUE_SEPARATOR
. implode(',', $gTypeValues);
3140 return CRM_Core_DAO
::setFieldValue('CRM_Core_DAO_UFGroup', $gId, 'group_type', $groupTypeString);
3144 * Create a "group_type" string.
3146 * @param array $coreTypes
3147 * E.g. array('Individual','Contact','Student').
3148 * @param array $subTypes
3149 * E.g. array('ActivityType' => array(7, 11)).
3150 * @param string $delim
3153 * @throws CRM_Core_Exception
3155 public static function encodeGroupType($coreTypes, $subTypes, $delim = CRM_Core_DAO
::VALUE_SEPARATOR
) {
3156 $groupTypeExpr = '';
3158 $groupTypeExpr .= implode(',', $coreTypes);
3161 //CRM-15427 Allow Multiple subtype filtering
3162 //if (count($subTypes) > 1) {
3163 //throw new CRM_Core_Exception("Multiple subtype filtering is not currently supported by widget.");
3165 foreach ($subTypes as $subType => $subTypeIds) {
3166 $groupTypeExpr .= $delim . $subType . ':' . implode(':', $subTypeIds);
3169 return $groupTypeExpr;
3173 * setDefault componet specific profile fields.
3175 * @param array $fields
3177 * @param int $componentId
3179 * @param string $component
3181 * @param array $defaults
3182 * An array of default values.
3184 * @param bool $isStandalone
3186 public static function setComponentDefaults(&$fields, $componentId, $component, &$defaults, $isStandalone = FALSE) {
3187 if (!$componentId ||
3188 !in_array($component, array('Contribute', 'Membership', 'Event', 'Activity', 'Case'))
3193 $componentBAO = $componentSubType = NULL;
3194 switch ($component) {
3196 $componentBAO = 'CRM_Member_BAO_Membership';
3197 $componentBAOName = 'Membership';
3198 $componentSubType = array('membership_type_id');
3202 $componentBAO = 'CRM_Contribute_BAO_Contribution';
3203 $componentBAOName = 'Contribution';
3204 $componentSubType = array('financial_type_id');
3208 $componentBAO = 'CRM_Event_BAO_Participant';
3209 $componentBAOName = 'Participant';
3210 $componentSubType = array('role_id', 'event_id', 'event_type_id');
3214 $componentBAO = 'CRM_Activity_BAO_Activity';
3215 $componentBAOName = 'Activity';
3216 $componentSubType = array('activity_type_id');
3220 $componentBAO = 'CRM_Case_BAO_Case';
3221 $componentBAOName = 'Case';
3222 $componentSubType = array('case_type_id');
3227 $params = array('id' => $componentId);
3229 //get the component values.
3230 CRM_Core_DAO
::commonRetrieve($componentBAO, $params, $values);
3231 if ($componentBAOName == 'Participant') {
3232 $values +
= array('event_type_id' => CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $values['event_id'], 'event_type_id'));
3235 $formattedGroupTree = array();
3237 foreach ($fields as $name => $field) {
3238 $fldName = $isStandalone ?
$name : "field[$componentId][$name]";
3239 if (array_key_exists($name, $values)) {
3240 $defaults[$fldName] = $values[$name];
3242 elseif ($name == 'participant_note') {
3243 $noteDetails = CRM_Core_BAO_Note
::getNote($componentId, 'civicrm_participant');
3244 $defaults[$fldName] = array_pop($noteDetails);
3246 elseif (in_array($name, array(
3248 'payment_instrument',
3249 'participant_status',
3252 $defaults[$fldName] = $values["{$name}_id"];
3254 elseif ($name == 'membership_type') {
3255 // since membership_type field is a hierselect -
3256 $defaults[$fldName][0]
3257 = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $values['membership_type_id'], 'member_of_contact_id', 'id');
3258 $defaults[$fldName][1] = $values['membership_type_id'];
3260 elseif ($name == 'membership_status') {
3261 $defaults[$fldName] = $values['status_id'];
3263 elseif ($name == 'case_status') {
3264 $defaults[$fldName] = $values['case_status_id'];
3266 elseif (CRM_Core_BAO_CustomField
::getKeyID($name, TRUE) !== array(NULL, NULL)) {
3267 if (empty($formattedGroupTree)) {
3268 //get the groupTree as per subTypes.
3269 $groupTree = array();
3270 foreach ($componentSubType as $subType) {
3271 $subTree = CRM_Core_BAO_CustomGroup
::getTree($componentBAOName, NULL,
3272 $componentId, 0, $values[$subType]
3274 $groupTree = CRM_Utils_Array
::crmArrayMerge($groupTree, $subTree);
3276 $formattedGroupTree = CRM_Core_BAO_CustomGroup
::formatGroupTree($groupTree, 1);
3277 CRM_Core_BAO_CustomGroup
::setDefaults($formattedGroupTree, $defaults);
3280 //FIX ME: We need to loop defaults, but once we move to custom_1_x convention this code can be simplified.
3281 foreach ($defaults as $customKey => $customValue) {
3282 if ($customFieldDetails = CRM_Core_BAO_CustomField
::getKeyID($customKey, TRUE)) {
3283 if ($name == 'custom_' . $customFieldDetails[0]) {
3285 //hack to set default for checkbox
3286 //basically this is for weired field name like field[33][custom_19]
3287 //we are converting this field name to array structure and assign value.
3290 foreach ($formattedGroupTree as $tree) {
3291 if (!empty($tree['fields'][$customFieldDetails[0]])) {
3292 if ('CheckBox' == CRM_Utils_Array
::value('html_type', $tree['fields'][$customFieldDetails[0]])) {
3294 $defaults['field'][$componentId][$name] = $customValue;
3297 elseif (CRM_Utils_Array
::value('data_type', $tree['fields'][$customFieldDetails[0]]) == 'Date') {
3300 // CRM-6681, $default contains formatted date, time values.
3301 $defaults[$fldName] = $customValue;
3302 if (!empty($defaults[$customKey . '_time'])) {
3303 $defaults['field'][$componentId][$name . '_time'] = $defaults[$customKey . '_time'];
3309 if (!$skipValue ||
$isStandalone) {
3310 $defaults[$fldName] = $customValue;
3312 unset($defaults[$customKey]);
3318 elseif (isset($values[$fldName])) {
3319 $defaults[$fldName] = $values[$fldName];
3325 * Retrieve groups of profiles.
3327 * @param int $profileID
3328 * Id of the profile.
3333 public static function profileGroups($profileID) {
3334 $groupTypes = array();
3335 $profileTypes = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $profileID, 'group_type');
3336 if ($profileTypes) {
3337 $groupTypeParts = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $profileTypes);
3338 $groupTypes = explode(',', $groupTypeParts[0]);
3344 * Alter contact params by filtering existing subscribed groups and returns
3345 * unsubscribed groups array for subscription.
3347 * @param array $params
3349 * @param int $contactId
3353 * This contains array of groups for subscription
3355 public static function getDoubleOptInGroupIds(&$params, $contactId = NULL) {
3356 $config = CRM_Core_Config
::singleton();
3357 $subscribeGroupIds = array();
3359 // process further only if profileDoubleOptIn enabled and if groups exist
3360 if (!array_key_exists('group', $params) ||
3361 !self
::isProfileDoubleOptin() ||
3362 CRM_Utils_System
::isNull($params['group'])
3364 return $subscribeGroupIds;
3367 //check if contact email exist.
3369 foreach ($params as $name => $value) {
3370 if (strpos($name, 'email-') !== FALSE) {
3376 //Proceed furthur only if email present
3378 return $subscribeGroupIds;
3381 //do check for already subscriptions.
3382 $contactGroups = array();
3386 FROM civicrm_group_contact
3387 WHERE status = 'Added'
3388 AND contact_id = %1";
3390 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array($contactId, 'Integer')));
3391 while ($dao->fetch()) {
3392 $contactGroups[$dao->group_id
] = $dao->group_id
;
3396 //since we don't have names, compare w/ label.
3397 $mailingListGroupType = array_search('Mailing List', CRM_Core_OptionGroup
::values('group_type'));
3399 //actual processing start.
3400 foreach ($params['group'] as $groupId => $isSelected) {
3401 //unset group those are not selected.
3403 unset($params['group'][$groupId]);
3407 $groupTypes = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
3408 CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group', $groupId, 'group_type', 'id')
3410 //get only mailing type group and unset it from params
3411 if (in_array($mailingListGroupType, $groupTypes) && !in_array($groupId, $contactGroups)) {
3412 $subscribeGroupIds[$groupId] = $groupId;
3413 unset($params['group'][$groupId]);
3417 return $subscribeGroupIds;
3421 * Check if we are rendering mixed profiles.
3423 * @param array $profileIds
3424 * Associated array of profile ids.
3427 * true if profile is mixed
3429 public static function checkForMixProfiles($profileIds) {
3430 $mixProfile = FALSE;
3432 $contactTypes = array('Individual', 'Household', 'Organization');
3433 $subTypes = CRM_Contact_BAO_ContactType
::subTypes();
3435 $components = array('Contribution', 'Participant', 'Membership', 'Activity');
3437 $typeCount = array('ctype' => array(), 'subtype' => array());
3438 foreach ($profileIds as $gid) {
3439 $profileType = CRM_Core_BAO_UFField
::getProfileType($gid);
3440 // ignore profile of type Contact
3441 if ($profileType == 'Contact') {
3444 if (in_array($profileType, $contactTypes)) {
3445 if (!isset($typeCount['ctype'][$profileType])) {
3446 $typeCount['ctype'][$profileType] = 1;
3449 // check if we are rendering profile of different contact types
3450 if (count($typeCount['ctype']) == 2) {
3455 elseif (in_array($profileType, $components)) {
3460 if (!isset($typeCount['subtype'][$profileType])) {
3461 $typeCount['subtype'][$profileType] = 1;
3463 // check if we are rendering profile of different contact sub types
3464 if (count($typeCount['subtype']) == 2) {
3474 * Determine of we show overlay profile or not.
3477 * true if profile should be shown else false
3479 public static function showOverlayProfile() {
3480 $showOverlay = TRUE;
3482 // get the id of overlay profile
3483 $overlayProfileId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', 'summary_overlay', 'id', 'name');
3484 $query = "SELECT count(id) FROM civicrm_uf_field WHERE uf_group_id = {$overlayProfileId} AND visibility IN ('Public Pages', 'Public Pages and Listings') ";
3486 $count = CRM_Core_DAO
::singleValueQuery($query);
3488 //check if there are no public fields and use is anonymous
3489 $session = CRM_Core_Session
::singleton();
3490 if (!$count && !$session->get('userID')) {
3491 $showOverlay = FALSE;
3494 return $showOverlay;
3498 * Get group type values of the profile.
3500 * @param int $profileId
3501 * @param string $groupType
3506 public static function groupTypeValues($profileId, $groupType = NULL) {
3507 $groupTypeValue = array();
3508 $groupTypes = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $profileId, 'group_type');
3510 $groupTypeParts = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $groupTypes);
3511 if (empty($groupTypeParts[1])) {
3512 return $groupTypeValue;
3514 $participantExtends = array('ParticipantRole', 'ParticipantEventName', 'ParticipantEventType');
3516 foreach (explode(',', $groupTypeParts[1]) as $groupTypeValues) {
3518 $valueParts = explode(':', $groupTypeValues);
3520 ($valueParts[0] != "{$groupType}Type" ||
3521 ($groupType == 'Participant' &&
3522 !in_array($valueParts[0], $participantExtends)
3528 foreach ($valueParts as $val) {
3529 if (CRM_Utils_Rule
::integer($val)) {
3530 $values[$val] = $val;
3533 if (!empty($values)) {
3534 $typeName = substr($valueParts[0], 0, -4);
3535 if (in_array($valueParts[0], $participantExtends)) {
3536 $typeName = $valueParts[0];
3538 $groupTypeValue[$typeName] = $values;
3542 return $groupTypeValue;
3546 * @return bool|object
3548 public static function isProfileDoubleOptin() {
3549 // check for double optin
3550 $config = CRM_Core_Config
::singleton();
3551 if (in_array('CiviMail', $config->enableComponents
)) {
3552 return Civi
::settings()->get('profile_double_optin');
3558 * @return bool|object
3560 public static function isProfileAddToGroupDoubleOptin() {
3561 // check for add to group double optin
3562 $config = CRM_Core_Config
::singleton();
3563 if (in_array('CiviMail', $config->enableComponents
)) {
3564 return Civi
::settings()->get('profile_add_to_group_double_optin');
3570 * Get profiles used for batch entry.
3573 * profileIds profile ids
3575 public static function getBatchProfiles() {
3577 FROM civicrm_uf_group
3578 WHERE name IN ('contribution_batch_entry', 'membership_batch_entry')";
3579 $dao = CRM_Core_DAO
::executeQuery($query);
3580 $profileIds = array();
3581 while ($dao->fetch()) {
3582 $profileIds[$dao->id
] = $dao->id
;
3588 * @todo what do I do?
3590 * @param $destination
3591 * @param bool $returnMultiSummaryFields
3593 * @return array|null
3595 public static function shiftMultiRecordFields(&$source, &$destination, $returnMultiSummaryFields = FALSE) {
3596 $multiSummaryFields = $returnMultiSummaryFields ?
array() : NULL;
3597 foreach ($source as $field => $properties) {
3598 if (!CRM_Core_BAO_CustomField
::getKeyID($field)) {
3601 if (CRM_Core_BAO_CustomField
::isMultiRecordField($field)) {
3602 $destination[$field] = $properties;
3603 if ($returnMultiSummaryFields) {
3604 if ($properties['is_multi_summary']) {
3605 $multiSummaryFields[$field] = $properties;
3608 unset($source[$field]);
3611 return $multiSummaryFields;
3615 * This is function is used to format pseudo fields.
3617 * @param array $fields
3618 * Associated array of profile fields.
3621 public static function reformatProfileFields(&$fields) {
3622 //reformat fields array
3623 foreach ($fields as $name => $field) {
3624 //reformat phone and extension field
3625 if (substr($field['name'], 0, 13) == 'phone_and_ext') {
3626 $fieldSuffix = str_replace('phone_and_ext-', '', $field['name']);
3628 // retain existing element properties and just update and replace key
3629 CRM_Utils_Array
::crmReplaceKey($fields, $name, "phone-{$fieldSuffix}");
3630 $fields["phone-{$fieldSuffix}"]['name'] = "phone-{$fieldSuffix}";
3631 $fields["phone-{$fieldSuffix}"]['where'] = 'civicrm_phone.phone';
3633 // add additional phone extension field
3634 $fields["phone_ext-{$fieldSuffix}"] = $field;
3635 $fields["phone_ext-{$fieldSuffix}"]['title'] = $field['title'] . ' - ' . ts('Ext.');
3636 $fields["phone_ext-{$fieldSuffix}"]['name'] = "phone_ext-{$fieldSuffix}";
3637 $fields["phone_ext-{$fieldSuffix}"]['where'] = 'civicrm_phone.phone_ext';
3638 $fields["phone_ext-{$fieldSuffix}"]['skipDisplay'] = 1;
3639 //ignore required for extension field
3640 $fields["phone_ext-{$fieldSuffix}"]['is_required'] = 0;