3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2013
39 class CRM_Core_BAO_UFGroup
extends CRM_Core_DAO_UFGroup
{
40 CONST PUBLIC_VISIBILITY
= 1,
42 LISTINGS_VISIBILITY
= 4;
45 * cache the match clause used in this transaction
49 static $_matchFields = NULL;
52 * Takes a bunch of params that are needed to match certain criteria and
53 * retrieves the relevant objects. Typically the valid params are only
54 * contact_id. We'll tweak this function to be more full featured over a period
55 * of time. This is the inverse function of create. It also stores all the retrieved
56 * values in the default array
58 * @param array $params (reference) an assoc array of name/value pairs
59 * @param array $defaults (reference) an assoc array to hold the flattened values
61 * @return object CRM_Core_DAO_UFGroup object
65 static function retrieve(&$params, &$defaults) {
66 return CRM_Core_DAO
::commonRetrieve('CRM_Core_DAO_UFGroup', $params, $defaults);
70 * Retrieve the first non-generic contact type
72 * @param int $id id of uf_group
74 * @return string contact type
76 static function getContactType($id) {
78 $validTypes = array_filter(array_keys(CRM_Core_SelectValues
::contactType()));
79 $validSubTypes = CRM_Contact_BAO_ContactType
::subTypeInfo();
81 $typesParts = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $id, 'group_type'));
82 $types = explode(',', $typesParts[0]);
85 foreach ($types as $type) {
86 if (in_array($type, $validTypes)) {
89 elseif (array_key_exists($type, $validSubTypes)) {
90 $cType = CRM_Utils_Array
::value('parent', $validSubTypes[$type]);
100 * Get the form title.
102 * @param int $id id of uf_form
104 * @return string title
110 public static function getTitle($id) {
111 return CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $id, 'title');
115 * update the is_active flag in the db
117 * @param int $id id of the database record
118 * @param boolean $is_active value we want to set the is_active field
120 * @return Object CRM_Core_DAO_UFGroup object on success, null otherwise
124 static function setIsActive($id, $is_active) {
125 return CRM_Core_DAO
::setFieldValue('CRM_Core_DAO_UFGroup', $id, 'is_active', $is_active);
129 * get all the registration fields
131 * @param int $action what action are we doing
132 * @param int $mode mode
134 * @return array the fields that are needed for registration
138 static function getRegistrationFields($action, $mode, $ctype = NULL) {
139 if ($mode & CRM_Profile_Form
::MODE_REGISTER
) {
140 $ufGroups = CRM_Core_BAO_UFGroup
::getModuleUFGroup('User Registration');
143 $ufGroups = CRM_Core_BAO_UFGroup
::getModuleUFGroup('Profile');
146 if (!is_array($ufGroups)) {
152 foreach ($ufGroups as $id => $title) {
154 $fieldType = CRM_Core_BAO_UFField
::getProfileType($id);
155 if (($fieldType != 'Contact') &&
156 ($fieldType != $ctype) &&
157 !CRM_Contact_BAO_ContactType
::isExtendsContactType($fieldType, $ctype)
161 if (CRM_Contact_BAO_ContactType
::isaSubType($fieldType)) {
162 $profileSubType = $fieldType;
166 $subset = self
::getFields($id, TRUE, $action,
167 NULL, NULL, FALSE, NULL, TRUE, $ctype
170 // we do not allow duplicates. the first field is the winner
171 foreach ($subset as $name => $field) {
172 if (!CRM_Utils_Array
::value($name, $fields)) {
173 $fields[$name] = $field;
182 * get all the listing fields
184 * @param int $action what action are we doing
185 * @param int $visibility visibility of fields we are interested in
186 * @param bool $considerSelector whether to consider the in_selector parameter
187 * @param array $ufGroupIds
188 * @param boolean $searchable
190 * @return array the fields that are listings related
194 static function getListingFields(
197 $considerSelector = FALSE,
201 $skipPermission = FALSE,
202 $permissionType = CRM_Core_Permission
::SEARCH
205 $subset = self
::getFields($ufGroupIds, FALSE, $action,
206 $visibility, $searchable,
212 if ($considerSelector) {
213 // drop the fields not meant for the selector
214 foreach ($subset as $name => $field) {
215 if (!$field['in_selector']) {
216 unset($subset[$name]);
223 $ufGroups = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_UFField', 'uf_group_id');
226 foreach ($ufGroups as $id => $title) {
227 $subset = self
::getFields($id, FALSE, $action,
228 $visibility, $searchable,
234 if ($considerSelector) {
235 // drop the fields not meant for the selector
236 foreach ($subset as $name => $field) {
237 if (!$field['in_selector'])unset($subset[$name]);
240 $fields = array_merge($fields, $subset);
247 * Get all the fields that belong to the group with the name title,
248 * and format for use with buildProfile. This is the SQL analog of
251 * @param mix $id the id of the UF group or ids of ufgroup
252 * @param int $register are we interested in registration fields
253 * @param int $action what action are we doing
254 * @param int $visibility visibility of fields we are interested in
256 * @param boolean $showall
257 * @param string $restrict should we restrict based on a specified profile type
259 * @return array the fields that belong to this ufgroup(s)
263 static function getFields(
271 $skipPermission = FALSE,
273 $permissionType = CRM_Core_Permission
::CREATE
,
274 $orderBy = 'field_name',
275 $orderProfiles = NULL
277 if (!is_array($id)) {
278 $id = CRM_Utils_Type
::escape($id, 'Positive');
279 $profileIds = array($id);
285 $gids = implode(',', $profileIds);
288 $query = "SELECT g.* from civicrm_uf_group g, civicrm_uf_join j
289 WHERE g.id IN ( {$gids} )
290 AND j.uf_group_id IN ( {$gids} )
293 $params = array(1 => array($restrict, 'String'));
296 $query = "SELECT g.* from civicrm_uf_group g WHERE g.id IN ( {$gids} ) ";
300 $query .= " AND g.is_active = 1";
303 // add permissioning for profiles only if not registration
304 if (!$skipPermission) {
305 $permissionClause = CRM_Core_Permission
::ufGroupClause($permissionType, 'g.');
306 $query .= " AND $permissionClause ";
309 if ($orderProfiles AND count($profileIds) > 1) {
310 $query .= " ORDER BY FIELD( g.id, {$gids} )";
312 $group = CRM_Core_DAO
::executeQuery($query, $params);
316 while ($group->fetch()) {
318 $query = self
::createUFFieldQuery($group->id
, $searchable, $showAll, $visibility, $orderBy);
319 $field = CRM_Core_DAO
::executeQuery($query);
321 $profileType = CRM_Core_BAO_UFField
::getProfileType($group->id
);
322 $contactActivityProfile = CRM_Core_BAO_UFField
::checkContactActivityProfileType($group->id
);
323 $importableFields = self
::getImportableFields($showAll, $profileType, $contactActivityProfile);
324 list($customFields, $addressCustomFields) = self
::getCustomFields($ctype);
326 while ($field->fetch()) {
327 list($name, $formattedField) = self
::formatUFField($group, $field, $customFields, $addressCustomFields, $importableFields, $permissionType);
328 if ($formattedField !== NULL) {
329 $fields[$name] = $formattedField;
335 if (empty($fields) && !$validGroup) {
336 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.',
337 array(1 => implode(',', $profileIds))
341 self
::reformatProfileFields($fields);
348 * Format a list of UFFields for use with buildProfile. This is the in-memory analog
351 * @param array $groupArr (mimic CRM_UF_DAO_UFGroup)
352 * @param array $fieldArrs list of fields (each mimics CRM_UF_DAO_UFField)
353 * @param bool $visibility visibility of fields we are interested in
354 * @param bool $searchable
355 * @param bool $showall
359 public static function formatUFFields(
366 $permissionType = CRM_Core_Permission
::CREATE
368 // $group = new CRM_Core_DAO_UFGroup();
369 // $group->copyValues($groupArr); // no... converts string('') to string('null')
370 $group = (object) $groupArr;
372 // Refactoring note: The $fieldArrs here may be slightly different than the $ufFields
373 // used by calculateGroupType, but I don't think the missing fields matter, and -- if
374 // they did -- the obvious fix would produce mutual recursion.
375 $ufGroupType = self
::_calculateGroupType($fieldArrs);
376 $profileType = CRM_Core_BAO_UFField
::calculateProfileType(implode(',',$ufGroupType));
377 $contactActivityProfile = CRM_Core_BAO_UFField
::checkContactActivityProfileTypeByGroupType(implode(',',$ufGroupType));
378 $importableFields = self
::getImportableFields($showAll, $profileType, $contactActivityProfile);
379 list($customFields, $addressCustomFields) = self
::getCustomFields($ctype);
381 $formattedFields = array();
382 foreach ($fieldArrs as $fieldArr) {
383 $field = (object) $fieldArr;
384 if (!self
::filterUFField($field, $searchable, $showAll, $visibility)) {
388 list($name, $formattedField) = self
::formatUFField($group, $field, $customFields, $addressCustomFields, $importableFields, $permissionType);
389 if ($formattedField !== NULL) {
390 $formattedFields[$name] = $formattedField;
393 return $formattedFields;
397 * Prepare a field for rendering with CRM_Core_BAO_UFGroup::buildProfile.
399 * @param CRM_Core_DAO_UFGroup|CRM_Core_DAO $group
400 * @param CRM_Core_DAO_UFField|CRM_Core_DAO $field
401 * @param array $addressCustomFields
402 * @param array $importableFields
403 * @param array $customFields
404 * @param int $permissionType eg CRM_Core_Permission::CREATE
407 protected static function formatUFField(
411 $addressCustomFields,
413 $permissionType = CRM_Core_Permission
::CREATE
415 $name = $field->field_name
;
416 $title = $field->label
;
418 $addressCustom = FALSE;
419 if (in_array($permissionType, array(
420 CRM_Core_Permission
::CREATE
,
421 CRM_Core_Permission
::EDIT
,
423 in_array($field->field_name
, array_keys($addressCustomFields))
425 $addressCustom = TRUE;
426 $name = "address_{$name}";
429 if (!empty($field->location_type_id
)) {
430 $name .= "-{$field->location_type_id}";
433 $locationFields = self
::getLocationFields();
434 if (in_array($field->field_name
, $locationFields) ||
$addressCustom) {
439 if (isset($field->phone_type_id
)) {
440 $name .= "-{$field->phone_type_id}";
443 // No lie: this is bizarre; why do we need to mix so many UFGroup properties into UFFields?
444 // I guess to make field self sufficient with all the required data and avoid additional calls
445 $formattedField = array(
447 'groupTitle' => $group->title
,
448 'groupName' => $group->name
,
449 'groupHelpPre' => empty($group->help_pre
) ?
'' : $group->help_pre
,
450 'groupHelpPost' => empty($group->help_post
) ?
'' : $group->help_post
,
452 'where' => CRM_Utils_Array
::value('where', CRM_Utils_Array
::value($field->field_name
, $importableFields)),
453 'attributes' => CRM_Core_DAO
::makeAttribute(CRM_Utils_Array
::value($field->field_name
, $importableFields)),
454 'is_required' => $field->is_required
,
455 'is_view' => $field->is_view
,
456 'help_pre' => $field->help_pre
,
457 'help_post' => $field->help_post
,
458 'visibility' => $field->visibility
,
459 'in_selector' => $field->in_selector
,
460 'rule' => CRM_Utils_Array
::value('rule', CRM_Utils_Array
::value($field->field_name
, $importableFields)),
461 'location_type_id' => isset($field->location_type_id
) ?
$field->location_type_id
: NULL,
462 'phone_type_id' => isset($field->phone_type_id
) ?
$field->phone_type_id
: NULL,
463 'group_id' => $group->id
,
464 'add_to_group_id' => isset($group->add_to_group_id
) ?
$group->add_to_group_id
: NULL,
465 'add_captcha' => isset($group->add_captcha
) ?
$group->add_captcha
: NULL,
466 'field_type' => $field->field_type
,
467 'field_id' => $field->id
,
468 'pseudoconstant' => CRM_Utils_Array
::value(
470 CRM_Utils_Array
::value($field->field_name
, $importableFields)
472 // obsolete this when we remove the name / dbName discrepancy with gender/suffix/prefix
473 'dbName' => CRM_Utils_Array
::value(
475 CRM_Utils_Array
::value($field->field_name
, $importableFields)
480 //adding custom field property
481 if (substr($field->field_name
, 0, 6) == 'custom' ||
482 substr($field->field_name
, 0, 14) === 'address_custom'
484 // if field is not present in customFields, that means the user
485 // DOES NOT HAVE permission to access that field
486 if (array_key_exists($field->field_name
, $customFields)) {
487 $formattedField['is_search_range'] = $customFields[$field->field_name
]['is_search_range'];
489 $formattedField['options_per_line'] = $customFields[$field->field_name
]['options_per_line'];
490 $formattedField['data_type'] = $customFields[$field->field_name
]['data_type'];
491 $formattedField['html_type'] = $customFields[$field->field_name
]['html_type'];
493 if (CRM_Utils_Array
::value('html_type', $formattedField) == 'Select Date') {
494 $formattedField['date_format'] = $customFields[$field->field_name
]['date_format'];
495 $formattedField['time_format'] = $customFields[$field->field_name
]['time_format'];
498 $formattedField['is_multi_summary'] = $field->is_multi_summary
;
499 return array($name, $formattedField);
502 $formattedField = NULL;
503 return array($name, $formattedField);
506 return array($name, $formattedField);
510 * Create a query to find all visible UFFields in a UFGroup
512 * This is the SQL-variant of checkUFFieldDisplayable().
514 * @param int $groupId
515 * @param bool $searchable
516 * @param bool $showAll
517 * @param int $visibility
518 * @param string $orderBy comma-delimited list of SQL columns
521 protected static function createUFFieldQuery($groupId, $searchable, $showAll, $visibility, $orderBy) {
522 $where = " WHERE uf_group_id = {$groupId}";
525 $where .= " AND is_searchable = 1";
529 $where .= " AND is_active = 1";
534 if ($visibility & self
::PUBLIC_VISIBILITY
) {
535 $clause[] = 'visibility = "Public Pages"';
537 if ($visibility & self
::ADMIN_VISIBILITY
) {
538 $clause[] = 'visibility = "User and User Admin Only"';
540 if ($visibility & self
::LISTINGS_VISIBILITY
) {
541 $clause[] = 'visibility = "Public Pages and Listings"';
543 if (!empty($clause)) {
544 $where .= ' AND ( ' . implode(' OR ', $clause) . ' ) ';
548 $query = "SELECT * FROM civicrm_uf_field $where ORDER BY weight";
550 $query .= ", " . $orderBy;
557 * Create a query to find all visible UFFields in a UFGroup
559 * This is the PHP in-memory variant of createUFFieldQuery().
561 * @param CRM_Core_DAO_UFField|CRM_Core_DAO $field
562 * @param bool $searchable
563 * @param bool $showAll
564 * @param int $visibility
565 * @return bool TRUE if field is displayable
567 protected static function filterUFField($field, $searchable, $showAll, $visibility) {
568 if ($searchable && $field->is_searchable
!= 1) {
572 if (!$showAll && $field->is_active
!= 1) {
577 $allowedVisibilities = array();
578 if ($visibility & self
::PUBLIC_VISIBILITY
) {
579 $allowedVisibilities[] = 'Public Pages';
581 if ($visibility & self
::ADMIN_VISIBILITY
) {
582 $allowedVisibilities[] = 'User and User Admin Only';
584 if ($visibility & self
::LISTINGS_VISIBILITY
) {
585 $allowedVisibilities[] = 'Public Pages and Listings';
587 // !empty($allowedVisibilities) seems silly to me, but it is equivalent to the pre-existing SQL
588 if (!empty($allowedVisibilities) && !in_array($field->visibility
, $allowedVisibilities)) {
596 protected static function getImportableFields($showAll, $profileType, $contactActivityProfile) {
598 $importableFields = CRM_Contact_BAO_Contact
::importableFields('All', FALSE, FALSE, FALSE, TRUE, TRUE);
601 $importableFields = CRM_Contact_BAO_Contact
::importableFields('All', FALSE, TRUE, FALSE, TRUE, TRUE);
604 if ($profileType == 'Activity' ||
$contactActivityProfile) {
605 $componentFields = CRM_Activity_BAO_Activity
::getProfileFields();
608 $componentFields = CRM_Core_Component
::getQueryFields();
611 $importableFields = array_merge($importableFields, $componentFields);
613 $importableFields['group']['title'] = ts('Group(s)');
614 $importableFields['group']['where'] = NULL;
615 $importableFields['tag']['title'] = ts('Tag(s)');
616 $importableFields['tag']['where'] = NULL;
617 return $importableFields;
620 public static function getLocationFields() {
621 static $locationFields = array(
623 'supplemental_address_1',
624 'supplemental_address_2',
627 'postal_code_suffix',
640 return $locationFields;
643 protected static function getCustomFields($ctype) {
644 static $customFieldCache = array();
645 if (!isset($customFieldCache[$ctype])) {
646 $customFields = CRM_Core_BAO_CustomField
::getFieldsForImport($ctype, FALSE, FALSE, FALSE, TRUE, TRUE);
648 // hack to add custom data for components
649 $components = array('Contribution', 'Participant', 'Membership', 'Activity');
650 foreach ($components as $value) {
651 $customFields = array_merge($customFields, CRM_Core_BAO_CustomField
::getFieldsForImport($value));
653 $addressCustomFields = CRM_Core_BAO_CustomField
::getFieldsForImport('Address');
654 $customFields = array_merge($customFields, $addressCustomFields);
655 $customFieldCache[$ctype] = array($customFields, $addressCustomFields);
657 return $customFieldCache[$ctype];
661 * check the data validity
663 * @param int $userID the user id that we are actually editing
664 * @param string $title the title of the group we are interested in
665 * @pram boolean $register is this the registrtion form
666 * @param int $action the action of the form
668 * @return boolean true if form is valid
672 static function isValid($userID, $title, $register = FALSE, $action = NULL) {
674 $controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Dynamic',
675 ts('Dynamic Form Creator'),
678 $controller->set('id', $userID);
679 $controller->set('register', 1);
680 $controller->process();
681 return $controller->validate();
684 // make sure we have a valid group
685 $group = new CRM_Core_DAO_UFGroup();
687 $group->title
= $title;
689 if ($group->find(TRUE) && $userID) {
690 $controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Dynamic', ts('Dynamic Form Creator'), $action);
691 $controller->set('gid', $group->id
);
692 $controller->set('id', $userID);
693 $controller->set('register', 0);
694 $controller->process();
695 return $controller->validate();
702 * get the html for the form that represents this particular group
704 * @param int $userID the user id that we are actually editing
705 * @param string $title the title of the group we are interested in
706 * @param int $action the action of the form
707 * @param boolean $register is this the registration form
708 * @param boolean $reset should we reset the form?
709 * @param int $profileID do we have the profile ID?
711 * @return string the html for the form on success, otherwise empty string
715 static function getEditHTML($userID,
721 $doNotProcess = FALSE,
726 $controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Dynamic',
727 ts('Dynamic Form Creator'),
730 if ($reset ||
$doNotProcess) {
731 // hack to make sure we do not process this form
732 $oldQFDefault = CRM_Utils_Array
::value('_qf_default',
735 unset($_POST['_qf_default']);
736 unset($_REQUEST['_qf_default']);
738 $controller->reset();
742 $controller->set('id', $userID);
743 $controller->set('register', 1);
744 $controller->set('skipPermission', 1);
745 $controller->set('ctype', $ctype);
746 $controller->process();
747 if ($doNotProcess ||
!empty($_POST)) {
748 $controller->validate();
750 $controller->setEmbedded(TRUE);
752 //CRM-5839 - though we want to process form, get the control back.
753 $controller->setSkipRedirection(($doNotProcess) ?
FALSE : TRUE);
757 // we are done processing so restore the POST/REQUEST vars
758 if (($reset ||
$doNotProcess) && $oldQFDefault) {
759 $_POST['_qf_default'] = $_REQUEST['_qf_default'] = $oldQFDefault;
762 $template = CRM_Core_Smarty
::singleton();
764 // Hide CRM error messages if they are displayed using drupal form_set_error.
765 if (!empty($_POST)) {
766 $template->assign('suppressForm', TRUE);
769 return trim($template->fetch('CRM/Profile/Form/Dynamic.tpl'));
773 // make sure we have a valid group
774 $group = new CRM_Core_DAO_UFGroup();
776 $group->title
= $title;
778 if ($group->find(TRUE)) {
779 $profileID = $group->id
;
784 // make sure profileID and ctype match if ctype exists
786 $profileType = CRM_Core_BAO_UFField
::getProfileType($profileID);
787 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
788 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
791 if (($profileType != 'Contact') && ($profileType != $ctype)) {
796 $controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Dynamic',
797 ts('Dynamic Form Creator'),
801 $controller->reset();
803 $controller->set('gid', $profileID);
804 $controller->set('id', $userID);
805 $controller->set('register', 0);
806 $controller->set('skipPermission', 1);
808 $controller->set('ctype', $ctype);
810 $controller->process();
811 $controller->setEmbedded(TRUE);
813 //CRM-5846 - give the control back to drupal.
814 $controller->setSkipRedirection(($doNotProcess) ?
FALSE : TRUE);
817 $template = CRM_Core_Smarty
::singleton();
819 // Hide CRM error messages if they are displayed using drupal form_set_error.
820 if (!empty($_POST) && CRM_Core_Config
::singleton()->userFramework
== 'Drupal') {
821 if (arg(0) == 'user' ||
(arg(0) == 'admin' && arg(1) == 'people')) {
822 $template->assign('suppressForm', TRUE);
826 $templateFile = "CRM/Profile/Form/{$profileID}/Dynamic.tpl";
827 if (!$template->template_exists($templateFile)) {
828 $templateFile = 'CRM/Profile/Form/Dynamic.tpl';
830 return trim($template->fetch($templateFile));
833 $userEmail = CRM_Contact_BAO_Contact_Location
::getEmailDetails($userID);
835 // if post not empty then only proceed
836 if (!empty($_POST)) {
838 $config = CRM_Core_Config
::singleton();
839 $email = CRM_Utils_Array
::value('mail', $_POST);
841 if (CRM_Utils_Rule
::email($email) && ($email != $userEmail[1])) {
842 CRM_Core_BAO_UFMatch
::updateContactEmail($userID, $email);
851 * searches for a contact in the db with similar attributes
853 * @param array $params the list of values to be used in the where clause
854 * @param int $id the current contact id (hence excluded from matching)
855 * @param boolean $flatten should we flatten the input params
857 * @return contact_id if found, null otherwise
861 public static function findContact(&$params, $id = NULL, $contactType = 'Individual') {
862 $dedupeParams = CRM_Dedupe_Finder
::formatParams($params, $contactType);
863 $dedupeParams['check_permission'] = CRM_Utils_Array
::value('check_permission', $params, TRUE);
864 $ids = CRM_Dedupe_Finder
::dupesByParams($dedupeParams, $contactType, 'Supervised', array($id));
866 return implode(',', $ids);
874 * Given a contact id and a field set, return the values from the db
877 * @param int $id the contact id
878 * @param array $fields the profile fields of interest
879 * @param array $values the values for the above fields
880 * @param boolean $searchable searchable or not
881 * @param array $componentWhere component condition
882 * @param boolean $absolute return urls in absolute form (useful when sending an email)
888 public static function getValues($cid, &$fields, &$values,
889 $searchable = TRUE, $componentWhere = NULL,
890 $absolute = FALSE, $additionalWhereClause = NULL
892 if (empty($cid) && empty($componentWhere)) {
896 // get the contact details (hier)
897 $returnProperties = CRM_Contact_BAO_Contact
::makeHierReturnProperties($fields);
898 $params = $cid ?
array(array('contact_id', '=', $cid, 0, 0)) : array();
900 // add conditions specified by components. eg partcipant_id etc
901 if (!empty($componentWhere)) {
902 $params = array_merge($params, $componentWhere);
905 $query = new CRM_Contact_BAO_Query($params, $returnProperties, $fields);
906 $options = &$query->_options
;
908 $details = $query->searchQuery( 0, 0, NULL, FALSE, FALSE,
909 FALSE, FALSE, FALSE, $additionalWhereClause);
910 if (!$details->fetch()) {
913 $query->convertToPseudoNames($details);
914 $config = CRM_Core_Config
::singleton();
916 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
917 $imProviders = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id');
918 $websiteTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Website', 'website_type_id');
920 $multipleFields = array('url');
921 $nullIndex = $nullValueIndex = ' ';
923 //start of code to set the default values
924 foreach ($fields as $name => $field) {
927 $name = 'contact_id';
930 // skip fields that should not be displayed separately
931 if (CRM_Utils_Array
::value('skipDisplay', $field)) {
935 $index = $field['title'];
936 //handle for the label not set for the field
937 if (empty($field['title'])) {
939 $nullIndex .= $nullIndex;
942 //handle the case to avoid re-write where the profile field labels are the same
943 if (CRM_Utils_Array
::value($index, $values)) {
944 $index .= $nullValueIndex;
945 $nullValueIndex .= $nullValueIndex;
947 $params[$index] = $values[$index] = '';
948 $customFieldName = NULL;
950 if (isset($details->$name) ||
$name == 'group' ||
$name == 'tag') {
951 // to handle gender / suffix / prefix
952 if (in_array(substr($name, -6), array('gender', 'prefix', 'suffix'))) {
953 $values[$index] = $details->$name;
954 $idColumn = "{$name}_id";
955 $params[$index] = $details->$idColumn;
957 elseif (in_array($name, CRM_Contact_BAO_Contact
::$_greetingTypes)) {
958 $dname = $name . '_display';
959 $values[$index] = $details->$dname;
960 $name = $name . '_id';
961 $params[$index] = $details->$name;
963 elseif (in_array($name, array(
964 'state_province', 'country', 'county'))) {
965 $values[$index] = $details->$name;
966 $idx = $name . '_id';
967 $params[$index] = $details->$idx;
969 elseif ($name === 'preferred_communication_method') {
970 $communicationFields = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'preferred_communication_method');
972 $pref = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $details->$name);
974 foreach ($pref as $k) {
976 $compref[] = $communicationFields[$k];
979 $params[$index] = $details->$name;
980 $values[$index] = implode(',', $compref);
982 elseif ($name === 'preferred_language') {
983 $params[$index] = $details->$name;
984 $values[$index] = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_DAO_Contact', 'preferred_language', $details->$name);
986 elseif ($name == 'group') {
987 $groups = CRM_Contact_BAO_GroupContact
::getContactGroup($cid, 'Added', NULL, FALSE, TRUE);
988 $title = $ids = array();
990 foreach ($groups as $g) {
991 // CRM-8362: User and User Admin visibility groups should be included in display if user has
992 // VIEW permission on that group
993 $groupPerm = CRM_Contact_BAO_Group
::checkPermission($g['group_id'], $g['title']);
995 if ($g['visibility'] != 'User and User Admin Only' ||
996 CRM_Utils_Array
::key(CRM_Core_Permission
::VIEW
, $groupPerm)
998 $title[] = $g['title'];
999 if ($g['visibility'] == 'Public Pages') {
1000 $ids[] = $g['group_id'];
1004 $values[$index] = implode(', ', $title);
1005 $params[$index] = implode(',', $ids);
1007 elseif ($name == 'tag') {
1008 $entityTags = CRM_Core_BAO_EntityTag
::getTag($cid);
1009 $allTags = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_EntityTag', 'tag_id', array('onlyActive' => FALSE));
1011 foreach ($entityTags as $tagId) {
1012 $title[] = $allTags[$tagId];
1014 $values[$index] = implode(', ', $title);
1015 $params[$index] = implode(',', $entityTags);
1017 elseif ($name == 'activity_status_id') {
1018 $activityStatus = CRM_Core_PseudoConstant
::activityStatus();
1019 $values[$index] = $activityStatus[$details->$name];
1020 $params[$index] = $details->$name;
1022 elseif ($name == 'activity_date_time') {
1023 $values[$index] = CRM_Utils_Date
::customFormat($details->$name);
1024 $params[$index] = $details->$name;
1026 elseif ($name == 'contact_sub_type') {
1027 $contactSubTypeNames = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $details->$name);
1028 if (!empty($contactSubTypeNames)) {
1029 $contactSubTypeLabels = array();
1030 // get all contact subtypes
1031 $allContactSubTypes = CRM_Contact_BAO_ContactType
::subTypeInfo();
1032 // build contact subtype labels array
1033 foreach( $contactSubTypeNames as $cstName ) {
1035 $contactSubTypeLabels[] = $allContactSubTypes[$cstName]['label'];
1038 $values[$index] = implode(',', $contactSubTypeLabels);
1041 $params[$index] = $details->$name;
1044 if (substr($name, 0, 7) === 'do_not_' ||
substr($name, 0, 3) === 'is_') {
1045 if ($details->$name) {
1046 $values[$index] = '[ x ]';
1050 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($name)) {
1051 $htmlType = $field['html_type'];
1053 // field_type is only set when we are retrieving profile values
1054 // when sending email, we call the same function to get custom field
1055 // values etc, i.e. emulating a profile
1056 $fieldType = CRM_Utils_Array
::value('field_type', $field);
1058 if ($htmlType == 'File') {
1061 $fieldType == 'Activity' &&
1062 CRM_Utils_Array
::value(2, $componentWhere[0])
1064 $entityId = $componentWhere[0][2];
1067 $fileURL = CRM_Core_BAO_CustomField
::getFileURL($entityId,
1072 $params[$index] = $values[$index] = $fileURL['file_url'];
1076 if (isset($dao) && property_exists($dao, 'data_type') &&
1077 ($dao->data_type
== 'Int' ||
1078 $dao->data_type
== 'Boolean'
1081 $customVal = (int )($details->{$name});
1083 elseif (isset($dao) && property_exists($dao, 'data_type')
1084 && $dao->data_type
== 'Float'
1086 $customVal = (float )($details->{$name});
1088 elseif (!CRM_Utils_System
::isNull(explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1091 $customVal = $details->{$name};
1095 if (CRM_Utils_System
::isNull($customVal)) {
1099 $params[$index] = $customVal;
1100 $values[$index] = CRM_Core_BAO_CustomField
::getDisplayValue($customVal,
1104 if ($htmlType == 'Autocomplete-Select') {
1105 $params[$index] = $values[$index];
1107 if (CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
1108 $cfID, 'is_search_range'
1110 $customFieldName = "{$name}_from";
1114 elseif ($name == 'image_URL') {
1115 list($width, $height) = getimagesize($details->$name);
1116 list($thumbWidth, $thumbHeight) = CRM_Contact_BAO_Contact
::getThumbSize($width, $height);
1118 $image_URL = '<img src="' . $details->$name . '" height= ' . $thumbHeight . ' width= ' . $thumbWidth . ' />';
1119 $values[$index] = "<a href='#' onclick='contactImagePopUp(\"{$details->$name}\", {$width}, {$height});'>{$image_URL}</a>";
1121 elseif (in_array($name, array(
1122 'birth_date', 'deceased_date', 'membership_start_date', 'membership_end_date', 'join_date'))) {
1123 $values[$index] = CRM_Utils_Date
::customFormat($details->$name);
1124 $params[$index] = CRM_Utils_Date
::isoToMysql($details->$name);
1128 if ($index == 'Campaign') {
1129 $dao = 'CRM_Campaign_DAO_Campaign';
1131 elseif ($index == 'Contribution Page') {
1132 $dao = 'CRM_Contribute_DAO_ContributionPage';
1135 $value = CRM_Core_DAO
::getFieldValue($dao, $details->$name, 'title');
1138 $value = $details->$name;
1140 $values[$index] = $value;
1145 elseif (strpos($name, '-') !== FALSE) {
1146 list($fieldName, $id, $type) = CRM_Utils_System
::explode('-', $name, 3);
1148 if (!in_array($fieldName, $multipleFields)) {
1149 if ($id == 'Primary') {
1151 // not sure why we'd every use Primary location type id
1152 // we need to fix the source if we are using it
1153 // $locationTypeName = CRM_Contact_BAO_Contact::getPrimaryLocationType( $cid );
1154 $locationTypeName = 1;
1157 $locationTypeName = CRM_Utils_Array
::value($id, $locationTypes);
1160 if (!$locationTypeName) {
1164 $detailName = "{$locationTypeName}-{$fieldName}";
1165 $detailName = str_replace(' ', '_', $detailName);
1167 if (in_array($fieldName, array(
1168 'phone', 'im', 'email', 'openid'))) {
1170 $detailName .= "-{$type}";
1174 if (in_array($fieldName, array(
1175 'state_province', 'country', 'county'))) {
1176 $values[$index] = $details->$detailName;
1177 $idx = $detailName . '_id';
1178 $params[$index] = $details->$idx;
1180 elseif ($fieldName == 'im') {
1181 $providerId = $detailName . '-provider_id';
1182 $providerName = $imProviders[$details->$providerId];
1183 if ($providerName) {
1184 $values[$index] = $details->$detailName . " (" . $providerName . ")";
1187 $values[$index] = $details->$detailName;
1189 $params[$index] = $details->$detailName;
1191 elseif ($fieldName == 'phone') {
1192 $phoneExtField = str_replace('phone', 'phone_ext', $detailName);
1193 if (isset($details->$phoneExtField)) {
1194 $values[$index] = $details->$detailName . " (" . $details->$phoneExtField . ")";
1197 $values[$index] = $details->$detailName;
1199 $params[$index] = $details->$detailName;
1202 $values[$index] = $params[$index] = $details->$detailName;
1206 $detailName = "website-{$id}-{$fieldName}";
1207 $url = CRM_Utils_System
::fixURL($details->$detailName);
1208 if ($details->$detailName) {
1209 $websiteTypeId = "website-{$id}-website_type_id";
1210 $websiteType = $websiteTypes[$details->$websiteTypeId];
1211 $values[$index] = "<a href=\"$url\">{$details->$detailName} ( {$websiteType} )</a>";
1214 $values[$index] = '';
1219 if ((CRM_Utils_Array
::value('visibility', $field) == 'Public Pages and Listings') &&
1220 CRM_Core_Permission
::check('profile listings and forms')
1223 if (CRM_Utils_System
::isNull($params[$index])) {
1224 $params[$index] = $values[$index];
1226 if (!isset($params[$index])) {
1229 if (!$customFieldName) {
1230 $fieldName = $field['name'];
1233 $fieldName = $customFieldName;
1237 if (CRM_Core_BAO_CustomField
::getKeyID($field['name'])) {
1238 $htmlType = $field['html_type'];
1239 if ($htmlType == 'Link') {
1240 $url = $params[$index];
1242 elseif (in_array($htmlType, array(
1243 'CheckBox', 'Multi-Select', 'AdvMulti-Select',
1244 'Multi-Select State/Province', 'Multi-Select Country',
1246 $valSeperator = CRM_Core_DAO
::VALUE_SEPARATOR
;
1247 $selectedOptions = explode($valSeperator, $params[$index]);
1249 foreach ($selectedOptions as $key => $multiOption) {
1251 $url[] = CRM_Utils_System
::url('civicrm/profile',
1252 'reset=1&force=1&gid=' . $field['group_id'] . '&' .
1253 urlencode($fieldName) .
1255 urlencode($multiOption)
1261 $url = CRM_Utils_System
::url('civicrm/profile',
1262 'reset=1&force=1&gid=' . $field['group_id'] . '&' .
1263 urlencode($fieldName) .
1265 urlencode($params[$index])
1270 $url = CRM_Utils_System
::url('civicrm/profile',
1271 'reset=1&force=1&gid=' . $field['group_id'] . '&' .
1272 urlencode($fieldName) .
1274 urlencode($params[$index])
1279 !empty($values[$index]) &&
1283 if (is_array($url) && !empty($url)) {
1285 $eachMultiValue = explode(', ', $values[$index]);
1286 foreach ($eachMultiValue as $key => $valueLabel) {
1287 $links[] = '<a href="' . $url[$key] . '">' . $valueLabel . '</a>';
1289 $values[$index] = implode(', ', $links);
1292 $values[$index] = '<a href="' . $url . '">' . $values[$index] . '</a>';
1300 * Check if profile Group used by any module.
1302 * @param int $id profile Id
1310 public static function usedByModule($id) {
1311 //check whether this group is used by any module(check uf join records)
1313 FROM civicrm_uf_join
1314 WHERE civicrm_uf_join.uf_group_id=$id";
1316 $dao = new CRM_Core_DAO();
1318 if ($dao->fetch()) {
1327 * Delete the profile Group.
1329 * @param int $id profile Id
1337 public static function del($id) {
1338 //check whether this group contains any profile fields
1339 $profileField = new CRM_Core_DAO_UFField();
1340 $profileField->uf_group_id
= $id;
1341 $profileField->find();
1342 while ($profileField->fetch()) {
1343 CRM_Core_BAO_UFField
::del($profileField->id
);
1346 //delete records from uf join table
1347 $ufJoin = new CRM_Core_DAO_UFJoin();
1348 $ufJoin->uf_group_id
= $id;
1351 //delete profile group
1352 $group = new CRM_Core_DAO_UFGroup();
1359 * function to add the UF Group
1361 * @param array $params reference array contains the values submitted by the form
1362 * @param array $ids reference array contains the id
1369 static function add(&$params, $ids = array()) {
1370 $fields = array('is_active', 'add_captcha', 'is_map', 'is_update_dupe', 'is_edit_link', 'is_uf_link', 'is_cms_user');
1371 foreach ($fields as $field) {
1372 $params[$field] = CRM_Utils_Array
::value($field, $params, FALSE);
1375 $params['limit_listings_group_id'] = CRM_Utils_Array
::value('group', $params);
1376 $params['add_to_group_id'] = CRM_Utils_Array
::value('add_contact_to_group', $params);
1378 $ufGroup = new CRM_Core_DAO_UFGroup();
1379 $ufGroup->copyValues($params);
1381 $ufGroupID = CRM_Utils_Array
::value('ufgroup', $ids, CRM_Utils_Array
::value('id', $params));
1383 $ufGroup->name
= CRM_Utils_String
::munge($ufGroup->title
, '_', 56);
1385 $ufGroup->id
= $ufGroupID;
1390 $ufGroup->name
= $ufGroup->name
. "_{$ufGroup->id}";
1398 * Function to make uf join entries for an uf group
1400 * @param array $params (reference) an assoc array of name/value pairs
1401 * @param int $ufGroupId ufgroup id
1407 static function createUFJoin(&$params, $ufGroupId) {
1408 $groupTypes = CRM_Utils_Array
::value('uf_group_type', $params);
1410 // get ufjoin records for uf group
1411 $ufGroupRecord = CRM_Core_BAO_UFGroup
::getUFJoinRecord($ufGroupId);
1413 // get the list of all ufgroup types
1414 $allUFGroupType = CRM_Core_SelectValues
::ufGroupTypes();
1416 // this fix is done to prevent warning generated by array_key_exits incase of empty array is given as input
1417 if (!is_array($groupTypes)) {
1418 $groupTypes = array();
1421 // this fix is done to prevent warning generated by array_key_exits incase of empty array is given as input
1422 if (!is_array($ufGroupRecord)) {
1423 $ufGroupRecord = array();
1426 // check which values has to be inserted/deleted for contact
1427 $menuRebuild = FALSE;
1428 foreach ($allUFGroupType as $key => $value) {
1429 $joinParams = array();
1430 $joinParams['uf_group_id'] = $ufGroupId;
1431 $joinParams['module'] = $key;
1432 if ($key == 'User Account') {
1433 $menuRebuild = TRUE;
1435 if (array_key_exists($key, $groupTypes) && !in_array($key, $ufGroupRecord)) {
1436 // insert a new record
1437 CRM_Core_BAO_UFGroup
::addUFJoin($joinParams);
1439 elseif (!array_key_exists($key, $groupTypes) && in_array($key, $ufGroupRecord)) {
1440 // delete a record for existing ufgroup
1441 CRM_Core_BAO_UFGroup
::delUFJoin($joinParams);
1447 UPDATE civicrm_uf_join
1449 WHERE uf_group_id = %2
1450 AND ( entity_id IS NULL OR entity_id <= 0 )
1452 $p = array(1 => array($params['weight'], 'Integer'),
1453 2 => array($ufGroupId, 'Integer'),
1455 CRM_Core_DAO
::executeQuery($query, $p);
1457 // do a menu rebuild if we are on drupal, so it gets all the new menu entries
1459 $config = CRM_Core_Config
::singleton();
1461 $config->userSystem
->is_drupal
1468 * Function to get the UF Join records for an ufgroup id
1470 * @params int $ufGroupId uf group id
1471 * @params int $displayName if set return display name in array
1472 * @params int $status if set return module other than default modules (User Account/User registration/Profile)
1474 * @return array $ufGroupJoinRecords
1479 public static function getUFJoinRecord($ufGroupId = NULL, $displayName = NULL, $status = NULL) {
1481 $UFGroupType = array();
1482 $UFGroupType = CRM_Core_SelectValues
::ufGroupTypes();
1486 $dao = new CRM_Core_DAO_UFJoin();
1489 $dao->uf_group_id
= $ufGroupId;
1495 while ($dao->fetch()) {
1496 if (!$displayName) {
1497 $ufJoin[$dao->id
] = $dao->module
;
1500 if (isset($UFGroupType[$dao->module
])) {
1501 // skip the default modules
1503 $ufJoin[$dao->id
] = $UFGroupType[$dao->module
];
1505 // added for CRM-1475
1507 elseif (!CRM_Utils_Array
::key($dao->module
, $ufJoin)) {
1508 $ufJoin[$dao->id
] = $dao->module
;
1516 * Function takes an associative array and creates a ufjoin record for ufgroup
1518 * @param array $params (reference) an assoc array of name/value pairs
1520 * @return object CRM_Core_BAO_UFJoin object
1524 static function addUFJoin(&$params) {
1525 $ufJoin = new CRM_Core_DAO_UFJoin();
1526 $ufJoin->copyValues($params);
1532 * Function to delete the uf join record for an uf group
1534 * @param array $params (reference) an assoc array of name/value pairs
1540 static function delUFJoin(&$params) {
1541 $ufJoin = new CRM_Core_DAO_UFJoin();
1542 $ufJoin->copyValues($params);
1547 * Function to get the weight for ufjoin record
1549 * @param int $ufGroupId if $ufGroupId get update weight or add weight
1551 * @return int weight of the UFGroup
1555 static function getWeight($ufGroupId = NULL) {
1556 //calculate the weight
1559 $queryString = "SELECT ( MAX(civicrm_uf_join.weight)+1) as new_weight
1560 FROM civicrm_uf_join
1561 WHERE module = 'User Registration' OR module = 'User Account' OR module = 'Profile'";
1564 $queryString = "SELECT MAX(civicrm_uf_join.weight) as new_weight
1565 FROM civicrm_uf_join
1566 WHERE civicrm_uf_join.uf_group_id = %1
1567 AND ( entity_id IS NULL OR entity_id <= 0 )";
1568 $p[1] = array($ufGroupId, 'Integer');
1571 $dao = CRM_Core_DAO
::executeQuery($queryString, $p);
1573 return ($dao->new_weight
) ?
$dao->new_weight
: 1;
1577 * Function to get the uf group for a module
1579 * @param string $moduleName module name
1580 * @param int $count no to increment the weight
1581 * @param bool $skipPermision - whether to add permission clause
1582 * @param int $op - which operation (view, edit, create, etc) to check permission for
1583 * @param array|NULL $returnFields list of UFGroup fields to return; NULL for default
1585 * @return array $ufGroups array of ufgroups for a module
1589 public static function getModuleUFGroup($moduleName = NULL, $count = 0, $skipPermission = TRUE, $op = CRM_Core_Permission
::VIEW
, $returnFields = NULL) {
1590 if ($returnFields === NULL) {
1591 $returnFields = array('id', 'title', 'created_id', 'description', 'is_active', 'is_reserved', 'group_type');
1593 $queryString = 'SELECT civicrm_uf_group.' . implode(', civicrm_uf_group.', $returnFields) . '
1594 FROM civicrm_uf_group
1595 LEFT JOIN civicrm_uf_join ON (civicrm_uf_group.id = uf_group_id)';
1598 $queryString .= ' AND civicrm_uf_group.is_active = 1
1599 WHERE civicrm_uf_join.module = %2';
1600 $p[2] = array($moduleName, 'String');
1604 // add permissioning for profiles only if not registration
1605 if (!$skipPermission) {
1606 $permissionClause = CRM_Core_Permission
::ufGroupClause($op, 'civicrm_uf_group.');
1607 if (strpos($queryString, 'WHERE') !== FALSE) {
1608 $queryString .= " AND $permissionClause ";
1611 $queryString .= " $permissionClause ";
1615 $queryString .= ' ORDER BY civicrm_uf_join.weight, civicrm_uf_group.title';
1616 $dao = CRM_Core_DAO
::executeQuery($queryString, $p);
1618 $ufGroups = array();
1619 while ($dao->fetch()) {
1620 //skip mix profiles in user Registration / User Account
1621 if (($moduleName == 'User Registration' ||
$moduleName == 'User Account') &&
1622 CRM_Core_BAO_UFField
::checkProfileType($dao->id
)
1626 $ufGroups[$dao->id
]['name'] = $dao->title
;
1627 $ufGroups[$dao->id
]['title'] = $dao->title
;
1628 $ufGroups[$dao->id
]['created_id'] = $dao->created_id
;
1629 $ufGroups[$dao->id
]['description'] = $dao->description
;
1630 $ufGroups[$dao->id
]['is_active'] = $dao->is_active
;
1631 $ufGroups[$dao->id
]['group_type'] = $dao->group_type
;
1632 $ufGroups[$dao->id
]['is_reserved'] = $dao->is_reserved
;
1635 // Allow other modules to alter/override the UFGroups.
1636 CRM_Utils_Hook
::buildUFGroupsForModule($moduleName, $ufGroups);
1642 * Function to filter ufgroups based on logged in user contact type
1644 * @params int $ufGroupId uf group id (profile id)
1646 * @return boolean true or false
1650 static function filterUFGroups($ufGroupId, $contactID = NULL) {
1652 $session = CRM_Core_Session
::singleton();
1653 $contactID = $session->get('userID');
1657 //get the contact type
1658 $contactType = CRM_Contact_BAO_Contact
::getContactType($contactID);
1660 //match if exixting contact type is same as profile contact type
1661 $profileType = CRM_Core_BAO_UFField
::getProfileType($ufGroupId);
1663 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
1664 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
1667 //allow special mix profiles for Contribution and Participant
1668 $specialProfiles = array('Contribution', 'Participant', 'Membership');
1670 if (in_array($profileType, $specialProfiles)) {
1674 if (($contactType == $profileType) ||
$profileType == 'Contact') {
1683 * Function to build profile form
1685 * @params object $form form object
1686 * @params array $field array field properties
1687 * @params int $mode profile mode
1688 * @params int $contactID contact id
1694 static function buildProfile(
1704 $defaultValues = array();
1705 $fieldName = $field['name'];
1706 $title = $field['title'];
1707 $attributes = $field['attributes'];
1708 $rule = $field['rule'];
1709 $view = $field['is_view'];
1710 $required = ($mode == CRM_Profile_Form
::MODE_SEARCH
) ?
FALSE : $field['is_required'];
1711 $search = ($mode == CRM_Profile_Form
::MODE_SEARCH
) ?
TRUE : FALSE;
1712 $isShared = CRM_Utils_Array
::value('is_shared', $field, 0);
1714 // do not display view fields in drupal registration form
1716 if ($view && $mode == CRM_Profile_Form
::MODE_REGISTER
) {
1721 $name = "onbehalf[$fieldName]";
1723 elseif ($contactId && !$online) {
1724 $name = "field[$contactId][$fieldName]";
1726 elseif ($rowNumber) {
1727 $name = "field[$rowNumber][$fieldName]";
1729 elseif (!empty($prefix)) {
1730 $name = $prefix ."[$fieldName]";
1736 if ($fieldName == 'image_URL' && $mode == CRM_Profile_Form
::MODE_EDIT
) {
1737 $deleteExtra = ts('Are you sure you want to delete contact image.');
1739 CRM_Core_Action
::DELETE
=>
1741 'name' => ts('Delete Contact Image'),
1742 'url' => 'civicrm/contact/image',
1743 'qs' => 'reset=1&id=%%id%%&gid=%%gid%%&action=delete',
1745 'onclick = "if (confirm( \'' . $deleteExtra . '\' ) ) this.href+=\'&confirmed=1\'; else return false;"',
1748 $deleteURL = CRM_Core_Action
::formLink($deleteURL,
1749 CRM_Core_Action
::DELETE
,
1750 array('id' => $form->get('id'),
1751 'gid' => $form->get('gid'),
1754 $form->assign('deleteURL', $deleteURL);
1756 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
1757 'address_options', TRUE, NULL, TRUE
1760 if (substr($fieldName, 0, 14) === 'state_province') {
1761 $form->add('select', $name, $title,
1763 '' => ts('- select -')) + CRM_Core_PseudoConstant
::stateProvince(), $required
1765 $config = CRM_Core_Config
::singleton();
1766 if (!in_array($mode, array(
1767 CRM_Profile_Form
::MODE_EDIT
, CRM_Profile_Form
::MODE_SEARCH
)) &&
1768 $config->defaultContactStateProvince
1770 $defaultValues[$name] = $config->defaultContactStateProvince
;
1771 $form->setDefaults($defaultValues);
1774 elseif (substr($fieldName, 0, 7) === 'country') {
1775 $form->add('select', $name, $title,
1777 '' => ts('- select -')) + CRM_Core_PseudoConstant
::country(), $required
1779 $config = CRM_Core_Config
::singleton();
1780 if (!in_array($mode, array(
1781 CRM_Profile_Form
::MODE_EDIT
, CRM_Profile_Form
::MODE_SEARCH
)) &&
1782 $config->defaultContactCountry
1784 $defaultValues[$name] = $config->defaultContactCountry
;
1785 $form->setDefaults($defaultValues);
1788 elseif (substr($fieldName, 0, 6) === 'county') {
1789 if ($addressOptions['county']) {
1790 $form->add('select', $name, $title,
1792 '' => ts('- select state -')), $required
1796 elseif (substr($fieldName, 0, 9) === 'image_URL') {
1797 $form->add('file', $name, $title, $attributes, $required);
1798 $form->addUploadElement($name);
1800 elseif (substr($fieldName, 0, 2) === 'im') {
1801 $form->add('text', $name, $title, $attributes, $required);
1804 if (substr($name, -1) == ']') {
1805 $providerName = substr($name, 0, -1) . '-provider_id]';
1807 $form->add('select', $providerName, NULL,
1809 '' => ts('- select -')) + CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id'), $required
1813 $form->add('select', $name . '-provider_id', $title,
1815 '' => ts('- select -')) + CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id'), $required
1819 if ($view && $mode != CRM_Profile_Form
::MODE_SEARCH
) {
1820 $form->freeze($name . '-provider_id');
1824 elseif (($fieldName === 'birth_date') ||
($fieldName === 'deceased_date')) {
1825 $form->addDate($name, $title, $required, array('formatType' => 'birth'));
1827 elseif (in_array($fieldName, array(
1828 'membership_start_date', 'membership_end_date', 'join_date'))) {
1829 $form->addDate($name, $title, $required, array('formatType' => 'custom'));
1831 elseif (CRM_Utils_Array
::value('name',$field) == 'membership_type') {
1832 list($orgInfo, $types) = CRM_Member_BAO_MembershipType
::getMembershipTypeInfo();
1833 $sel = &$form->addElement('hierselect', $name, $title);
1834 $select = array('' => ts('- select -') );
1835 if(count($orgInfo) == 1 && $field['is_required']) {
1836 // we only have one org - so we should default to it. Not sure about defaulting to first type
1837 // as it could be missed - so adding a select
1838 // however, possibly that is more similar to the membership form
1839 if(count($types[1]) > 1) {
1840 $types[1] = $select +
$types[1];
1844 $orgInfo = $select +
$orgInfo;
1846 $sel->setOptions(array($orgInfo, $types));
1848 elseif (CRM_Utils_Array
::value('name',$field) == 'membership_status') {
1849 $form->add('select', $name, $title,
1851 '' => ts('- select -')) + CRM_Member_PseudoConstant
::membershipStatus(NULL, NULL, 'label'), $required
1854 elseif ($fieldName === 'gender') {
1855 $genderOptions = array();
1856 $gender = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'gender_id');
1857 foreach ($gender as $key => $var) {
1858 $genderOptions[$key] = $form->createElement('radio', NULL, ts('Gender'), $var, $key);
1860 $form->addGroup($genderOptions, $name, $title);
1862 $form->addRule($name, ts('%1 is a required field.', array(1 => $title)), 'required');
1865 elseif ($fieldName === 'individual_prefix') {
1866 $form->add('select', $name, $title,
1868 '' => ts('- select -')) + CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'prefix_id'), $required
1871 elseif ($fieldName === 'individual_suffix') {
1872 $form->add('select', $name, $title,
1874 '' => ts('- select -')) + CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'suffix_id'), $required
1877 elseif ($fieldName === 'contact_sub_type') {
1878 $gId = $form->get('gid') ?
$form->get('gid') : CRM_Utils_Array
::value('group_id', $field);
1880 $profileType = 'Organization';
1883 $profileType = $gId ? CRM_Core_BAO_UFField
::getProfileType($gId) : NULL;
1884 if ($profileType == 'Contact') {
1885 $profileType = 'Individual';
1889 $setSubtype = FALSE;
1890 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
1891 $setSubtype = $profileType;
1892 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
1895 $subtypes = $profileType ? CRM_Contact_BAO_ContactType
::subTypePairs($profileType) : array();
1898 $subtypeList = array();
1899 $subtypeList[$setSubtype] = $subtypes[$setSubtype];
1902 $subtypeList = $subtypes;
1905 $sel = $form->add('select', $name, $title, $subtypeList, $required);
1906 $sel->setMultiple(TRUE);
1908 elseif (in_array($fieldName, CRM_Contact_BAO_Contact
::$_greetingTypes)) {
1909 //add email greeting, postal greeting, addressee, CRM-4575
1910 $gId = $form->get('gid') ?
$form->get('gid') : CRM_Utils_Array
::value('group_id', $field);
1911 $profileType = CRM_Core_BAO_UFField
::getProfileType($gId, TRUE, FALSE, TRUE);
1913 if (empty($profileType) ||
in_array($profileType, array(
1914 'Contact', 'Contribution', 'Participant', 'Membership'))) {
1915 $profileType = 'Individual';
1917 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
1918 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
1921 'contact_type' => $profileType,
1922 'greeting_type' => $fieldName,
1924 $form->add('select', $name, $title,
1926 '' => ts('- select -')) + CRM_Core_PseudoConstant
::greeting($greeting), $required
1928 // add custom greeting element
1929 $form->add('text', $fieldName . '_custom', ts('Custom %1', array(1 => ucwords(str_replace('_', ' ', $fieldName)))),
1933 elseif ($fieldName === 'preferred_communication_method') {
1934 $communicationFields = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'preferred_communication_method');
1935 foreach ($communicationFields as $key => $var) {
1939 $communicationOptions[] = $form->createElement('checkbox', $key, NULL, $var);
1941 $form->addGroup($communicationOptions, $name, $title, '<br/>');
1943 elseif ($fieldName === 'preferred_mail_format') {
1944 $form->add('select', $name, $title, CRM_Core_SelectValues
::pmf());
1946 elseif ($fieldName === 'preferred_language') {
1947 $form->add('select', $name, $title, array('' => ts('- select -')) + CRM_Contact_BAO_Contact
::buildOptions('preferred_language'));
1949 elseif ($fieldName == 'external_identifier') {
1950 $form->add('text', $name, $title, $attributes, $required);
1951 $contID = $contactId;
1953 $contID = $form->get('id');
1955 $form->addRule($name,
1956 ts('External ID already exists in Database.'),
1958 array('CRM_Contact_DAO_Contact', $contID, 'external_identifier')
1961 elseif ($fieldName === 'group') {
1962 CRM_Contact_Form_Edit_TagsAndGroups
::buildQuickForm($form, $contactId,
1963 CRM_Contact_Form_Edit_TagsAndGroups
::GROUP
,
1968 elseif ($fieldName === 'tag') {
1969 CRM_Contact_Form_Edit_TagsAndGroups
::buildQuickForm($form, $contactId,
1970 CRM_Contact_Form_Edit_TagsAndGroups
::TAG
,
1975 elseif (substr($fieldName, 0, 4) === 'url-') {
1976 $form->add('text', $name, $title,
1977 array_merge(CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Website', 'url'),
1979 'onfocus' => "if (!this.value) { this.value='http://';} else return false",
1980 'onblur' => "if ( this.value == 'http://') { this.value='';} else return false",
1985 $form->addRule($name, ts('Enter a valid Website.'), 'url');
1987 //Website type select
1989 if (substr($name, -1) == ']') {
1990 $websiteTypeName = substr($name, 0, -1) . '-website_type_id]';
1992 $form->addElement('select', $websiteTypeName, NULL, CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Website', 'website_type_id'));
1995 $form->addElement('select', $name . '-website_type_id', NULL, CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Website', 'website_type_id'));
1998 // Note should be rendered as textarea
1999 elseif (substr($fieldName, -4) == 'note') {
2000 $form->add('textarea', $name, $title, $attributes, $required);
2002 elseif (substr($fieldName, 0, 6) === 'custom') {
2003 $customFieldID = CRM_Core_BAO_CustomField
::getKeyID($fieldName);
2004 if ($customFieldID) {
2005 CRM_Core_BAO_CustomField
::addQuickFormElement($form, $name, $customFieldID, FALSE, $required, $search, $title);
2008 elseif (substr($fieldName, 0, 14) === 'address_custom') {
2009 list($fName, $locTypeId) = CRM_Utils_System
::explode('-', $fieldName, 2);
2010 $customFieldID = CRM_Core_BAO_CustomField
::getKeyID(substr($fName, 8));
2011 if ($customFieldID) {
2012 CRM_Core_BAO_CustomField
::addQuickFormElement($form, $name, $customFieldID, FALSE, $required, $search, $title);
2015 elseif (in_array($fieldName, array(
2016 'receive_date', 'receipt_date', 'thankyou_date', 'cancel_date'))) {
2017 $form->addDateTime($name, $title, $required, array('formatType' => 'activityDateTime'));
2019 elseif ($fieldName == 'send_receipt') {
2020 $form->addElement('checkbox', $name, $title);
2022 elseif ($fieldName == 'soft_credit') {
2023 CRM_Contact_Form_NewContact
::buildQuickForm($form, $rowNumber, NULL, FALSE, 'soft_credit_');
2024 $form->addMoney("soft_credit_amount[{$rowNumber}]", ts('Amount'), FALSE, NULL, FALSE);
2026 elseif ($fieldName == 'product_name') {
2027 list($products, $options) = CRM_Contribute_BAO_Premium
::getPremiumProductInfo();
2028 $sel = &$form->addElement('hierselect', $name, $title);
2030 '0' => ts('- select -')) +
$products;
2031 $sel->setOptions(array($products, $options));
2033 elseif ($fieldName == 'payment_instrument') {
2034 $form->add('select', $name, $title,
2035 array(''=>ts( '- select -' )) + CRM_Contribute_PseudoConstant
::paymentInstrument( ), $required );
2037 else if ($fieldName == 'financial_type' ) {
2038 $form->add('select', $name, $title,
2040 '' => ts('- select -')) + CRM_Contribute_PseudoConstant
::financialType(), $required
2043 elseif ($fieldName == 'contribution_status_id') {
2044 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus();
2045 $statusName = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
2051 unset($contributionStatuses[CRM_Utils_Array
::key($suppress, $statusName)]);
2054 $form->add('select', $name, $title,
2056 '' => ts('- select -')) +
$contributionStatuses, $required
2059 elseif ($fieldName == 'currency') {
2060 $form->addCurrency($name, $title, $required);
2062 elseif ($fieldName == 'contribution_page_id') {
2063 $form->add('select', $name, $title,
2065 '' => ts('- select -')) + CRM_Contribute_PseudoConstant
::contributionPage(), $required, 'class="big"'
2068 elseif ($fieldName == 'participant_register_date') {
2069 $form->addDateTime($name, $title, $required, array('formatType' => 'activityDateTime'));
2071 elseif ($fieldName == 'activity_status_id') {
2072 $form->add('select', $name, $title,
2074 '' => ts('- select -')) + CRM_Core_PseudoConstant
::activityStatus(), $required
2077 elseif ($fieldName == 'activity_engagement_level') {
2078 $form->add('select', $name, $title,
2080 '' => ts('- select -')) + CRM_Campaign_PseudoConstant
::engagementLevel(), $required
2083 elseif ($fieldName == 'activity_date_time') {
2084 $form->addDateTime($name, $title, $required, array('formatType' => 'activityDateTime'));
2086 elseif ($fieldName == 'participant_status') {
2088 if ($online == TRUE) {
2089 $cond = 'visibility_id = 1';
2091 $form->add('select', $name, $title,
2093 '' => ts('- select -')) + CRM_Event_PseudoConstant
::participantStatus(NULL, $cond, 'label'), $required
2096 elseif ($fieldName == 'participant_role') {
2097 if (CRM_Utils_Array
::value('is_multiple', $field)) {
2098 $form->addCheckBox($name, $title, CRM_Event_PseudoConstant
::participantRole(), NULL, NULL, NULL, NULL, ' ', TRUE);
2101 $form->add('select', $name, $title,
2103 '' => ts('- select -')) + CRM_Event_PseudoConstant
::participantRole(), $required
2107 elseif ($fieldName == 'world_region') {
2108 $form->add('select', $name, $title,
2110 '' => ts('- select -')) + CRM_Core_PseudoConstant
::worldRegion(), $required
2113 elseif ($fieldName == 'signature_html') {
2114 $form->addWysiwyg($name, $title, CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Email', $fieldName));
2116 elseif ($fieldName == 'signature_text') {
2117 $form->add('textarea', $name, $title, CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Email', $fieldName));
2119 elseif (substr($fieldName, -11) == 'campaign_id') {
2120 if (CRM_Campaign_BAO_Campaign
::isCampaignEnable()) {
2121 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(CRM_Utils_Array
::value($contactId,
2122 $form->_componentCampaigns
2124 $form->add('select', $name, $title,
2126 '' => ts('- select -')) +
$campaigns, $required, 'class="big"'
2130 elseif ($fieldName == 'activity_details') {
2131 $form->addWysiwyg($fieldName, $title, array('rows' => 4, 'cols' => 60), $required);
2133 elseif ($fieldName == 'activity_duration') {
2134 $form->add('text', $name, $title, $attributes, $required);
2135 $form->addRule($name, ts('Please enter the duration as number of minutes (integers only).'), 'positiveInteger');
2138 if (substr($fieldName, 0, 3) === 'is_' or substr($fieldName, 0, 7) === 'do_not_') {
2139 $form->add('advcheckbox', $name, $title, $attributes, $required);
2142 $form->add('text', $name, $title, $attributes, $required);
2146 static $hiddenSubtype = FALSE;
2147 if (!$hiddenSubtype && CRM_Contact_BAO_ContactType
::isaSubType($field['field_type'])) {
2148 // In registration mode params are submitted via POST and we don't have any clue
2149 // about profile-id or the profile-type (which could be a subtype)
2150 // To generalize the behavior and simplify the process,
2151 // lets always add the hidden
2152 //subtype value if there is any, and we won't have to
2153 // compute it while processing.
2155 $form->addElement('hidden', 'onbehalf[contact_sub_type]', $field['field_type']);
2158 $form->addElement('hidden', 'contact_sub_type_hidden', $field['field_type']);
2160 $hiddenSubtype = TRUE;
2163 if (($view && $mode != CRM_Profile_Form
::MODE_SEARCH
) ||
$isShared) {
2164 $form->freeze($name);
2168 if (in_array($fieldName, array(
2169 'non_deductible_amount', 'total_amount', 'fee_amount', 'net_amount'))) {
2170 $form->addRule($name, ts('Please enter a valid amount.'), 'money');
2174 if (!($rule == 'email' && $mode == CRM_Profile_Form
::MODE_SEARCH
)) {
2175 $form->addRule($name, ts('Please enter a valid %1', array(1 => $title)), $rule);
2181 * Function to set profile defaults
2183 * @params int $contactId contact id
2184 * @params array $fields associative array of fields
2185 * @params array $defaults defaults array
2186 * @params boolean $singleProfile true for single profile else false(batch update)
2187 * @params int $componentId id for specific components like contribute, event etc
2193 static function setProfileDefaults($contactId, &$fields, &$defaults,
2194 $singleProfile = TRUE, $componentId = NULL, $component = NULL
2196 if (!$componentId) {
2197 //get the contact details
2198 list($contactDetails, $options) = CRM_Contact_BAO_Contact
::getHierContactDetails($contactId, $fields);
2199 $details = CRM_Utils_Array
::value($contactId, $contactDetails);
2200 $multipleFields = array('website' => 'url');
2202 //start of code to set the default values
2203 foreach ($fields as $name => $field) {
2204 // skip pseudo fields
2205 if (substr($name, 0, 9) == 'phone_ext') {
2209 //set the field name depending upon the profile mode(single/batch)
2210 if ($singleProfile) {
2214 $fldName = "field[$contactId][$name]";
2217 if ($name == 'group') {
2218 CRM_Contact_Form_Edit_TagsAndGroups
::setDefaults($contactId, $defaults, CRM_Contact_Form_Edit_TagsAndGroups
::GROUP
, $fldName);
2220 if ($name == 'tag') {
2221 CRM_Contact_Form_Edit_TagsAndGroups
::setDefaults($contactId, $defaults, CRM_Contact_Form_Edit_TagsAndGroups
::TAG
, $fldName);
2224 if (CRM_Utils_Array
::value($name, $details) ||
isset($details[$name])) {
2225 //to handle custom data (checkbox) to be written
2226 // to handle birth/deceased date, greeting_type and few other fields
2227 if (($name == 'birth_date') ||
($name == 'deceased_date')) {
2228 list($defaults[$fldName]) = CRM_Utils_Date
::setDateDefaults($details[$name], 'birth');
2230 elseif (in_array($name, CRM_Contact_BAO_Contact
::$_greetingTypes)) {
2231 $defaults[$fldName] = $details[$name . '_id'];
2232 $defaults[$name . '_custom'] = $details[$name . '_custom'];
2234 elseif ($name == 'preferred_communication_method') {
2235 $v = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $details[$name]);
2236 foreach ($v as $item) {
2238 $defaults[$fldName . "[$item]"] = 1;
2242 elseif ($name == 'world_region') {
2243 $defaults[$fldName] = $details['worldregion_id'];
2245 elseif ($customFieldId = CRM_Core_BAO_CustomField
::getKeyID($name)) {
2246 //fix for custom fields
2247 $customFields = CRM_Core_BAO_CustomField
::getFields(CRM_Utils_Array
::value('contact_type', $details));
2249 // hack to add custom data for components
2250 $components = array('Contribution', 'Participant', 'Membership', 'Activity');
2251 foreach ($components as $value) {
2252 $customFields = CRM_Utils_Array
::crmArrayMerge($customFields,
2253 CRM_Core_BAO_CustomField
::getFieldsForImport($value)
2257 switch ($customFields[$customFieldId]['html_type']) {
2258 case 'Multi-Select State/Province':
2259 case 'Multi-Select Country':
2260 case 'AdvMulti-Select':
2261 case 'Multi-Select':
2262 $v = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $details[$name]);
2263 foreach ($v as $item) {
2265 $defaults[$fldName][$item] = $item;
2271 $v = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $details[$name]);
2272 foreach ($v as $item) {
2274 $defaults[$fldName][$item] = 1;
2275 // seems like we need this for QF style checkboxes in profile where its multiindexed
2277 $defaults["{$fldName}[{$item}]"] = 1;
2282 case 'Autocomplete-Select':
2283 if ($customFields[$customFieldId]['data_type'] == 'ContactReference') {
2284 if (is_numeric($details[$name])) {
2285 $defaults[$fldName . '_id'] = $details[$name];
2286 $defaults[$fldName] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $details[$name], 'sort_name');
2290 $label = CRM_Core_BAO_CustomOption
::getOptionLabel($customFieldId, $details[$name]);
2291 $defaults[$fldName . '_id'] = $details[$name];
2292 $defaults[$fldName] = $label;
2297 // CRM-6681, set defult values according to date and time format (if any).
2299 if (CRM_Utils_Array
::value('date_format', $customFields[$customFieldId])) {
2300 $dateFormat = $customFields[$customFieldId]['date_format'];
2303 if (!CRM_Utils_Array
::value('time_format', $customFields[$customFieldId])) {
2304 list($defaults[$fldName]) = CRM_Utils_Date
::setDateDefaults($details[$name], NULL,
2309 $timeElement = $fldName . '_time';
2310 if (substr($fldName, -1) == ']') {
2311 $timeElement = substr($fldName, 0, -1) . '_time]';
2313 list($defaults[$fldName], $defaults[$timeElement]) = CRM_Utils_Date
::setDateDefaults($details[$name],
2314 NULL, $dateFormat, $customFields[$customFieldId]['time_format']);
2319 $defaults[$fldName] = $details[$name];
2324 $defaults[$fldName] = $details[$name];
2328 $blocks = array('email', 'phone', 'im', 'openid');
2329 list($fieldName, $locTypeId, $phoneTypeId) = CRM_Utils_System
::explode('-', $name, 3);
2330 if (!in_array($fieldName, $multipleFields)) {
2331 if (is_array($details)) {
2332 foreach ($details as $key => $value) {
2333 // when we fixed CRM-5319 - get primary loc
2334 // type as per loc field and removed below code.
2335 $primaryLocationType = FALSE;
2336 if ($locTypeId == 'Primary') {
2337 if (is_array($value) && array_key_exists($fieldName, $value)){
2338 $primaryLocationType = TRUE;
2339 if (in_array($fieldName, $blocks)){
2340 $locTypeId = CRM_Contact_BAO_Contact
::getPrimaryLocationType($contactId, FALSE, $fieldName);
2343 $locTypeId = CRM_Contact_BAO_Contact
::getPrimaryLocationType($contactId, FALSE, 'address');
2348 // fixed for CRM-665
2349 if (is_numeric($locTypeId)) {
2350 if ($primaryLocationType ||
$locTypeId == CRM_Utils_Array
::value('location_type_id', $value)) {
2351 if (CRM_Utils_Array
::value($fieldName, $value)) {
2352 //to handle stateprovince and country
2353 if ($fieldName == 'state_province') {
2354 $defaults[$fldName] = $value['state_province_id'];
2356 elseif ($fieldName == 'county') {
2357 $defaults[$fldName] = $value['county_id'];
2359 elseif ($fieldName == 'country') {
2360 $defaults[$fldName] = $value['country_id'];
2361 if (!isset($value['country_id']) ||
!$value['country_id']) {
2362 $config = CRM_Core_Config
::singleton();
2363 if ($config->defaultContactCountry
) {
2364 $defaults[$fldName] = $config->defaultContactCountry
;
2368 elseif ($fieldName == 'phone') {
2370 if (isset($value['phone'][$phoneTypeId])) {
2371 $defaults[$fldName] = $value['phone'][$phoneTypeId];
2373 if (isset($value['phone_ext'][$phoneTypeId])) {
2374 $defaults[str_replace('phone', 'phone_ext', $fldName)] = $value['phone_ext'][$phoneTypeId];
2378 $phoneDefault = CRM_Utils_Array
::value('phone', $value);
2380 if (!is_array($phoneDefault)) {
2381 $defaults[$fldName] = $phoneDefault;
2385 elseif ($fieldName == 'email') {
2386 //adding the first email (currently we don't support multiple emails of same location type)
2387 $defaults[$fldName] = $value['email'];
2389 elseif ($fieldName == 'im') {
2390 //adding the first im (currently we don't support multiple ims of same location type)
2391 $defaults[$fldName] = $value['im'];
2392 $defaults[$fldName . '-provider_id'] = $value['im_provider_id'];
2395 $defaults[$fldName] = $value[$fieldName];
2398 elseif (substr($fieldName, 0, 14) === 'address_custom' &&
2399 CRM_Utils_Array
::value(substr($fieldName, 8), $value)
2401 $defaults[$fldName] = $value[substr($fieldName, 8)];
2409 if (is_array($details)) {
2410 if ($fieldName === 'url') {
2411 if (!empty($details['website'])) {
2412 foreach ($details['website'] as $val) {
2413 $defaults[$fldName] = CRM_Utils_Array
::value('url', $val);
2414 $defaults[$fldName . '-website_type_id'] = $val['website_type_id'];
2424 //Handling Contribution Part of the batch profile
2425 if (CRM_Core_Permission
::access('CiviContribute') && $component == 'Contribute') {
2426 self
::setComponentDefaults($fields, $componentId, $component, $defaults);
2429 //Handling Event Participation Part of the batch profile
2430 if (CRM_Core_Permission
::access('CiviEvent') && $component == 'Event') {
2431 self
::setComponentDefaults($fields, $componentId, $component, $defaults);
2434 //Handling membership Part of the batch profile
2435 if (CRM_Core_Permission
::access('CiviMember') && $component == 'Membership') {
2436 self
::setComponentDefaults($fields, $componentId, $component, $defaults);
2439 //Handling Activity Part of the batch profile
2440 if ($component == 'Activity') {
2441 self
::setComponentDefaults($fields, $componentId, $component, $defaults);
2446 * Function to get profiles by type eg: pure Individual etc
2448 * @param array $types associative array of types eg: types('Individual')
2449 * @param boolean $onlyPure true if only pure profiles are required
2451 * @return array $profiles associative array of profiles
2455 static function getProfiles($types, $onlyPure = FALSE) {
2456 $profiles = array();
2457 $ufGroups = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_UFField', 'uf_group_id');
2459 CRM_Utils_Hook
::aclGroup(CRM_Core_Permission
::ADMIN
, NULL, 'civicrm_uf_group', $ufGroups, $ufGroups);
2461 // Exclude Batch Data Entry profiles - CRM-10901
2462 $batchProfiles = CRM_Core_BAO_UFGroup
::getBatchProfiles();
2464 foreach ($ufGroups as $id => $title) {
2465 $ptype = CRM_Core_BAO_UFField
::getProfileType($id, FALSE, $onlyPure);
2466 if (in_array($ptype, $types) && !array_key_exists($id, $batchProfiles)) {
2467 $profiles[$id] = $title;
2474 * Function to check whether a profile is valid combination of
2475 * required and/or optional profile types
2477 * @param array $required array of types those are required
2478 * @param array $optional array of types those are optional
2480 * @return array $profiles associative array of profiles
2484 static function getValidProfiles($required, $optional = NULL) {
2485 if (!is_array($required) ||
empty($required)) {
2489 $profiles = array();
2490 $ufGroups = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_UFField', 'uf_group_id');
2492 CRM_Utils_Hook
::aclGroup(CRM_Core_Permission
::ADMIN
, NULL, 'civicrm_uf_group', $ufGroups, $ufGroups);
2494 foreach ($ufGroups as $id => $title) {
2495 $type = CRM_Core_BAO_UFField
::checkValidProfileType($id, $required, $optional);
2497 $profiles[$id] = $title;
2505 * Function to check whether a profile is valid combination of
2506 * required profile fields
2508 * @param array $ufId integer id of the profile
2509 * @param array $required array of fields those are required in the profile
2511 * @return array $profiles associative array of profiles
2515 static function checkValidProfile($ufId, $required = NULL) {
2516 $validProfile = FALSE;
2518 return $validProfile;
2521 if (!CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $ufId, 'is_active')) {
2522 return $validProfile;
2525 $profileFields = self
::getFields($ufId, FALSE, CRM_Core_Action
::VIEW
, NULL,
2526 NULL, FALSE, NULL, FALSE, NULL,
2527 CRM_Core_Permission
::CREATE
, NULL
2530 $validProfile = array();
2531 if (!empty($profileFields)) {
2532 $fields = array_keys($profileFields);
2533 foreach ($fields as $val) {
2534 foreach ($required as $key => $field) {
2535 if (strpos($val, $field) === 0) {
2536 unset($required[$key]);
2541 $validProfile = (empty($required)) ?
TRUE : FALSE;
2544 return $validProfile;
2548 * Function to get default value for Register.
2554 static function setRegisterDefaults(&$fields, &$defaults) {
2555 $config = CRM_Core_Config
::singleton();
2556 foreach ($fields as $name => $field) {
2557 if (substr($name, 0, 8) == 'country-') {
2558 if (!empty($config->defaultContactCountry
)) {
2559 $defaults[$name] = $config->defaultContactCountry
;
2562 elseif (substr($name, 0, 15) == 'state_province-') {
2563 if (!empty($config->defaultContactStateProvince
)) {
2564 $defaults[$name] = $config->defaultContactStateProvince
;
2572 * This function is to make a copy of a profile, including
2573 * all the fields in the profile
2575 * @param int $id the profile id to copy
2580 static function copy($id) {
2581 $fieldsFix = array('prefix' => array('title' => ts('Copy of ')));
2582 $copy = &CRM_Core_DAO
::copyGeneric('CRM_Core_DAO_UFGroup',
2588 if ($pos = strrpos($copy->name
, "_{$id}")) {
2589 $copy->name
= substr_replace($copy->name
, '', $pos);
2591 $copy->name
= CRM_Utils_String
::munge($copy->name
, '_', 56) . "_{$copy->id}";
2594 $copyUFJoin = &CRM_Core_DAO
::copyGeneric('CRM_Core_DAO_UFJoin',
2595 array('uf_group_id' => $id),
2596 array('uf_group_id' => $copy->id
),
2601 $copyUFField = &CRM_Core_DAO
::copyGeneric('CRM_Core_BAO_UFField',
2602 array('uf_group_id' => $id),
2603 array('uf_group_id' => $copy->id
)
2606 $maxWeight = CRM_Utils_Weight
::getMax('CRM_Core_DAO_UFJoin', NULL, 'weight');
2610 UPDATE civicrm_uf_join
2612 WHERE uf_group_id = %2
2613 AND ( entity_id IS NULL OR entity_id <= 0 )
2615 $p = array(1 => array($maxWeight +
1, 'Integer'),
2616 2 => array($copy->id
, 'Integer'),
2618 CRM_Core_DAO
::executeQuery($query, $p);
2619 if ($copy->is_reserved
) {
2620 $query = "UPDATE civicrm_uf_group SET is_reserved = 0 WHERE id = %1";
2621 $params = array(1 => array($copy->id
, 'Integer'));
2622 CRM_Core_DAO
::executeQuery($query, $params);
2624 CRM_Utils_Hook
::copy('UFGroup', $copy);
2630 * Process that send notification e-mails
2632 * @params int $contactId contact id
2633 * @params array $values associative array of name/value pair
2639 static function commonSendMail($contactID, &$values) {
2640 if (!$contactID ||
!$values) {
2644 $template = CRM_Core_Smarty
::singleton();
2646 $displayName = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
2651 self
::profileDisplay($values['id'], $values['values'], $template);
2652 $emailList = explode(',', $values['email']);
2654 $contactLink = CRM_Utils_System
::url('civicrm/contact/view',
2655 "reset=1&cid=$contactID",
2656 TRUE, NULL, FALSE, FALSE, TRUE
2659 //get the default domain email address.
2660 list($domainEmailName, $domainEmailAddress) = CRM_Core_BAO_Domain
::getNameAndEmail();
2662 if (!$domainEmailAddress ||
$domainEmailAddress == 'info@EXAMPLE.ORG') {
2663 $fixUrl = CRM_Utils_System
::url('civicrm/admin/domain', 'action=update&reset=1');
2664 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)));
2667 foreach ($emailList as $emailTo) {
2668 // FIXME: take the below out of the foreach loop
2669 CRM_Core_BAO_MessageTemplate
::sendTemplate(
2671 'groupName' => 'msg_tpl_workflow_uf',
2672 'valueName' => 'uf_notify',
2673 'contactId' => $contactID,
2674 'tplParams' => array(
2675 'displayName' => $displayName,
2676 'currentDate' => date('r'),
2677 'contactLink' => $contactLink,
2679 'from' => "$domainEmailName <$domainEmailAddress>",
2680 'toEmail' => $emailTo,
2687 * Given a contact id and a group id, returns the field values from the db
2688 * for this group and notify email only if group's notify field is
2689 * set and field values are not empty
2691 * @params $gid group id
2692 * @params $cid contact id
2693 * @params $params associative array
2698 function checkFieldsEmptyValues($gid, $cid, $params, $skipCheck = FALSE) {
2700 if (CRM_Core_BAO_UFGroup
::filterUFGroups($gid, $cid) ||
$skipCheck) {
2702 $fields = CRM_Core_BAO_UFGroup
::getFields($gid, FALSE, CRM_Core_Action
::VIEW
);
2703 CRM_Core_BAO_UFGroup
::getValues($cid, $fields, $values, FALSE, $params, TRUE);
2705 $email = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $gid, 'notify');
2707 if (!empty($values) &&
2712 'values' => $values,
2723 * Function to assign uf fields to template
2725 * @params int $gid group id
2726 * @params array $values associative array of fields
2731 function profileDisplay($gid, $values, $template) {
2732 $groupTitle = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $gid, 'title');
2733 $template->assign('grouptitle', $groupTitle);
2734 if (count($values)) {
2735 $template->assign('values', $values);
2740 * Format fields for dupe Contact Matching
2742 * @param array $params associated array
2744 * @return array $data assoicated formatted array
2748 static function formatFields($params, $contactId = NULL) {
2750 // get the primary location type id and email
2751 list($name, $primaryEmail, $primaryLocationType) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contactId);
2754 $defaultLocationType = CRM_Core_BAO_LocationType
::getDefault();
2755 $primaryLocationType = $defaultLocationType->id
;
2759 $locationType = array();
2761 $primaryLocation = 0;
2762 foreach ($params as $key => $value) {
2763 list($fieldName, $locTypeId, $phoneTypeId) = explode('-', $key);
2765 if ($locTypeId == 'Primary') {
2766 $locTypeId = $primaryLocationType;
2769 if (is_numeric($locTypeId)) {
2770 if (!in_array($locTypeId, $locationType)) {
2771 $locationType[$count] = $locTypeId;
2774 $loc = CRM_Utils_Array
::key($locTypeId, $locationType);
2776 $data['location'][$loc]['location_type_id'] = $locTypeId;
2778 // if we are getting in a new primary email, dont overwrite the new one
2779 if ($locTypeId == $primaryLocationType) {
2780 if (CRM_Utils_Array
::value('email-' . $primaryLocationType, $params)) {
2781 $data['location'][$loc]['email'][$loc]['email'] = $fields['email-' . $primaryLocationType];
2783 elseif (isset($primaryEmail)) {
2784 $data['location'][$loc]['email'][$loc]['email'] = $primaryEmail;
2790 $data['location'][$loc]['is_primary'] = 1;
2792 if ($fieldName == 'phone') {
2794 $data['location'][$loc]['phone'][$loc]['phone_type_id'] = $phoneTypeId;
2797 $data['location'][$loc]['phone'][$loc]['phone_type_id'] = '';
2799 $data['location'][$loc]['phone'][$loc]['phone'] = $value;
2801 elseif ($fieldName == 'email') {
2802 $data['location'][$loc]['email'][$loc]['email'] = $value;
2804 elseif ($fieldName == 'im') {
2805 $data['location'][$loc]['im'][$loc]['name'] = $value;
2808 if ($fieldName === 'state_province') {
2809 $data['location'][$loc]['address']['state_province_id'] = $value;
2811 elseif ($fieldName === 'country') {
2812 $data['location'][$loc]['address']['country_id'] = $value;
2815 $data['location'][$loc]['address'][$fieldName] = $value;
2820 if ($key === 'individual_suffix') {
2821 $data['suffix_id'] = $value;
2823 elseif ($key === 'individual_prefix') {
2824 $data['prefix_id'] = $value;
2826 elseif ($key === 'gender') {
2827 $data['gender_id'] = $value;
2829 elseif (substr($key, 0, 6) === 'custom') {
2830 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
2832 if ($customFields[$customFieldID]['html_type'] == 'CheckBox') {
2833 $value = implode(CRM_Core_DAO
::VALUE_SEPARATOR
, array_keys($value));
2835 // fix the date field
2836 if ($customFields[$customFieldID]['data_type'] == 'Date') {
2837 $date = CRM_Utils_Date
::format($value);
2844 $data['custom'][$customFieldID] = array(
2847 'extends' => $customFields[$customFieldID]['extends'],
2848 'type' => $customFields[$customFieldID]['data_type'],
2849 'custom_field_id' => $customFieldID,
2853 elseif ($key == 'edit') {
2857 $data[$key] = $value;
2862 if (!$primaryLocation) {
2864 $data['location'][$loc]['email'][$loc]['email'] = $primaryEmail;
2872 * calculate the profile type 'group_type' as per profile fields.
2874 * @param int $gid profile id
2875 * @param int $ignoreFieldId ignore particular profile field
2877 * @return array list of calculated group type
2879 static function calculateGroupType($gId, $includeTypeValues = FALSE, $ignoreFieldId = NULL) {
2880 //get the profile fields.
2881 $ufFields = self
::getFields($gId, FALSE, NULL, NULL, NULL, TRUE, NULL, TRUE);
2882 return self
::_calculateGroupType($ufFields, $includeTypeValues, $ignoreFieldId);
2886 * calculate the profile type 'group_type' as per profile fields.
2888 * @param int $gid profile id
2889 * @param int $ignoreFieldId ignore perticular profile field
2891 * @return array list of calculated group type
2893 static function _calculateGroupType($ufFields, $includeTypeValues = FALSE, $ignoreFieldId = NULL) {
2894 $groupType = $groupTypeValues = $customFieldIds = array();
2895 if (!empty($ufFields)) {
2896 foreach ($ufFields as $fieldName => $fieldValue) {
2897 //ignore field from group type when provided.
2898 //in case of update profile field.
2899 if ($ignoreFieldId && ($ignoreFieldId == $fieldValue['field_id'])) {
2902 if (!in_array($fieldValue['field_type'], $groupType)) {
2903 $groupType[$fieldValue['field_type']] = $fieldValue['field_type'];
2906 if ($includeTypeValues && ($fldId = CRM_Core_BAO_CustomField
::getKeyID($fieldName))) {
2907 $customFieldIds[$fldId] = $fldId;
2912 if (!empty($customFieldIds)) {
2913 $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) . ')';
2915 $customGroups = CRM_Core_DAO
::executeQuery($query);
2916 while ($customGroups->fetch()) {
2917 if (!$customGroups->extends_entity_column_value
) {
2921 $groupTypeName = "{$customGroups->extends}Type";
2922 if ($customGroups->extends == 'Participant' && $customGroups->extends_entity_column_id
) {
2923 $groupTypeName = CRM_Core_OptionGroup
::getValue('custom_data_type', $customGroups->extends_entity_column_id
, 'value', 'String', 'name');
2926 foreach (explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $customGroups->extends_entity_column_value
) as $val) {
2928 $groupTypeValues[$groupTypeName][$val] = $val;
2933 if (!empty($groupTypeValues)) {
2934 $groupType = array_merge($groupType, $groupTypeValues);
2942 * Update the profile type 'group_type' as per profile fields including group types and group subtype values.
2943 * Build and store string like: group_type1,group_type2[VALUE_SEPERATOR]group_type1Type:1:2:3,group_type2Type:1:2
2946 * BirthDate + Email Individual,Contact
2947 * BirthDate + Subject Individual,Activity
2948 * BirthDate + Subject + SurveyOnlyField Individual,Activity\0ActivityType:28
2949 * BirthDate + Subject + SurveyOnlyField + PhoneOnlyField (Not allowed)
2950 * BirthDate + SurveyOnlyField Individual,Activity\0ActivityType:28
2951 * BirthDate + Subject + SurveyOrPhoneField Individual,Activity\0ActivityType:2:28
2952 * BirthDate + SurveyOrPhoneField Individual,Activity\0ActivityType:2:28
2953 * BirthDate + SurveyOrPhoneField + SurveyOnlyField Individual,Activity\0ActivityType:2:28
2954 * BirthDate + StudentField + Subject + SurveyOnlyField Individual,Activity,Student\0ActivityType:28
2956 * @param Integer $gid profile id
2957 * @param Array $groupTypes With key having group type names
2961 static function updateGroupTypes($gId, $groupTypes = array(
2963 if (!is_array($groupTypes) ||
!$gId) {
2967 // If empty group types set group_type as 'null'
2968 if (empty($groupTypes)) {
2969 return CRM_Core_DAO
::setFieldValue('CRM_Core_DAO_UFGroup', $gId, 'group_type', 'null');
2972 $componentGroupTypes = array('Contribution', 'Participant', 'Membership', 'Activity');
2973 $validGroupTypes = array_merge(array('Contact', 'Individual', 'Organization', 'Household'), $componentGroupTypes, CRM_Contact_BAO_ContactType
::subTypes());
2975 $gTypes = $gTypeValues = array();
2977 $participantExtends = array('ParticipantRole', 'ParticipantEventName', 'ParticipantEventType');
2978 // Get valid group type and group subtypes
2979 foreach ($groupTypes as $groupType => $value) {
2980 if (in_array($groupType, $validGroupTypes) && !in_array($groupType, $gTypes)) {
2981 $gTypes[] = $groupType;
2986 if (in_array($groupType, $participantExtends)) {
2987 $subTypesOf = $groupType;
2989 elseif (strpos($groupType, 'Type') > 0) {
2990 $subTypesOf = substr($groupType, 0, strpos($groupType, 'Type'));
2996 if (!empty($value) &&
2997 (in_array($subTypesOf, $componentGroupTypes) ||
2998 in_array($subTypesOf, $participantExtends)
3001 $gTypeValues[$subTypesOf] = $groupType . ":" . implode(':', $value);
3005 if (empty($gTypes)) {
3009 // Build String to store group types and group subtypes
3010 $groupTypeString = implode(',', $gTypes);
3011 if (!empty($gTypeValues)) {
3012 $groupTypeString .= CRM_Core_DAO
::VALUE_SEPARATOR
. implode(',', $gTypeValues);
3015 return CRM_Core_DAO
::setFieldValue('CRM_Core_DAO_UFGroup', $gId, 'group_type', $groupTypeString);
3019 * Create a "group_type" string
3021 * @param array $coreTypes e.g. array('Individual','Contact','Student')
3022 * @param array $subTypes e.g. array('ActivityType' => array(7, 11))
3023 * @param string $delim
3024 * @throws CRM_Core_Exception
3026 static function encodeGroupType($coreTypes, $subTypes, $delim = CRM_Core_DAO
::VALUE_SEPARATOR
) {
3027 $groupTypeExpr = '';
3029 $groupTypeExpr .= implode(',', $coreTypes);
3032 if (count($subTypes) > 1) {
3033 throw new CRM_Core_Exception("Multiple subtype filtering is not currently supported by widget.");
3035 foreach ($subTypes as $subType => $subTypeIds) {
3036 $groupTypeExpr .= $delim . $subType . ':' . implode(':', $subTypeIds);
3039 return $groupTypeExpr;
3043 * This function is used to setDefault componet specific profile fields.
3045 * @param array $fields profile fields.
3046 * @param int $componentId componetID
3047 * @param string $component component name
3048 * @param array $defaults an array of default values.
3052 function setComponentDefaults(&$fields, $componentId, $component, &$defaults, $isStandalone = FALSE) {
3053 if (!$componentId ||
3054 !in_array($component, array('Contribute', 'Membership', 'Event', 'Activity'))
3059 $componentBAO = $componentSubType = NULL;
3060 switch ($component) {
3062 $componentBAO = 'CRM_Member_BAO_Membership';
3063 $componentBAOName = 'Membership';
3064 $componentSubType = array('membership_type_id');
3068 $componentBAO = 'CRM_Contribute_BAO_Contribution';
3069 $componentBAOName = 'Contribution';
3070 $componentSubType = array( 'financial_type_id' );
3074 $componentBAO = 'CRM_Event_BAO_Participant';
3075 $componentBAOName = 'Participant';
3076 $componentSubType = array('role_id', 'event_id');
3080 $componentBAO = 'CRM_Activity_BAO_Activity';
3081 $componentBAOName = 'Activity';
3082 $componentSubType = array('activity_type_id');
3087 $params = array('id' => $componentId);
3089 //get the component values.
3090 CRM_Core_DAO
::commonRetrieve($componentBAO, $params, $values);
3092 $formattedGroupTree = array();
3093 $dateTimeFields = array('participant_register_date', 'activity_date_time', 'receive_date', 'receipt_date', 'cancel_date', 'thankyou_date', 'membership_start_date', 'membership_end_date', 'join_date');
3094 foreach ($fields as $name => $field) {
3095 $fldName = $isStandalone ?
$name : "field[$componentId][$name]";
3096 if (in_array($name, $dateTimeFields)) {
3097 $timefldName = $isStandalone ?
"{$name}_time" : "field[$componentId][{$name}_time]";
3098 if (CRM_Utils_Array
::value($name, $values)) {
3099 list($defaults[$fldName], $defaults[$timefldName]) = CRM_Utils_Date
::setDateDefaults($values[$name]);
3102 elseif (array_key_exists($name, $values)) {
3103 $defaults[$fldName] = $values[$name];
3105 elseif ($name == 'participant_note') {
3106 $noteDetails = CRM_Core_BAO_Note
::getNote($componentId, 'civicrm_participant');
3107 $defaults[$fldName] = array_pop($noteDetails);
3109 elseif (in_array($name, array(
3110 'financial_type', 'payment_instrument', 'participant_status', 'participant_role'))) {
3111 $defaults[$fldName] = $values["{$name}_id"];
3113 elseif ($name == 'membership_type') {
3114 // since membership_type field is a hierselect -
3115 $defaults[$fldName][0] =
3116 CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',$values['membership_type_id'],'member_of_contact_id','id');
3117 $defaults[$fldName][1] = $values['membership_type_id'];
3119 elseif ($name == 'membership_status') {
3120 $defaults[$fldName] = $values['status_id'];
3122 elseif ($customFieldInfo = CRM_Core_BAO_CustomField
::getKeyID($name, TRUE)) {
3123 if (empty($formattedGroupTree)) {
3124 //get the groupTree as per subTypes.
3125 $groupTree = array();
3126 foreach ($componentSubType as $subType) {
3127 $subTree = CRM_Core_BAO_CustomGroup
::getTree($componentBAOName, CRM_Core_DAO
::$_nullObject,
3128 $componentId, 0, $values[$subType]
3130 $groupTree = CRM_Utils_Array
::crmArrayMerge($groupTree, $subTree);
3132 $formattedGroupTree = CRM_Core_BAO_CustomGroup
::formatGroupTree($groupTree, 1, CRM_Core_DAO
::$_nullObject);
3133 CRM_Core_BAO_CustomGroup
::setDefaults($formattedGroupTree, $defaults);
3136 //FIX ME: We need to loop defaults, but once we move to custom_1_x convention this code can be simplified.
3137 foreach ($defaults as $customKey => $customValue) {
3138 if ($customFieldDetails = CRM_Core_BAO_CustomField
::getKeyID($customKey, TRUE)) {
3139 if ($name == 'custom_' . $customFieldDetails[0]) {
3141 //hack to set default for checkbox
3142 //basically this is for weired field name like field[33][custom_19]
3143 //we are converting this field name to array structure and assign value.
3146 foreach ($formattedGroupTree as $tree) {
3147 if ('CheckBox' == CRM_Utils_Array
::value('html_type', $tree['fields'][$customFieldDetails[0]])) {
3149 $defaults['field'][$componentId][$name] = $customValue;
3152 elseif (CRM_Utils_Array
::value('data_type', $tree['fields'][$customFieldDetails[0]]) == 'Date') {
3155 // CRM-6681, $default contains formatted date, time values.
3156 $defaults[$fldName] = $customValue;
3157 if (CRM_Utils_Array
::value($customKey . '_time', $defaults)) {
3158 $defaults['field'][$componentId][$name . '_time'] = $defaults[$customKey . '_time'];
3163 if (!$skipValue ||
$isStandalone) {
3164 $defaults[$fldName] = $customValue;
3166 unset($defaults[$customKey]);
3176 * Function to retrieve reserved profiles
3178 * @param string $name name if the reserve profile
3179 * @param array $extraProfiles associated array of profile id's that needs to merge
3181 * @return array $reservedProfiles returns associated array
3184 static function getReservedProfiles($type = 'Contact', $extraProfiles = NULL) {
3185 $reservedProfiles = array();
3186 $profileNames = array();
3187 if ($type == 'Contact') {
3188 $whereClause = 'name IN ( "new_individual", "new_organization", "new_household" )';
3189 if (CRM_Contact_BAO_ContactType
::isActive('Individual')) {
3190 $profileNames[] = '"new_individual"';
3192 if (CRM_Contact_BAO_ContactType
::isActive('Household')) {
3193 $profileNames[] = '"new_household"';
3195 if (CRM_Contact_BAO_ContactType
::isActive('Organization')) {
3196 $profileNames[] = '"new_organization"';
3199 if (!empty($profileNames)) {
3200 $whereClause = 'name IN ( ' . implode(',', $profileNames) . ' ) AND is_reserved = 1';
3203 $whereClause = 'is_reserved = 1';
3206 $query = "SELECT id, title FROM civicrm_uf_group WHERE {$whereClause}";
3208 $dao = CRM_Core_DAO
::executeQuery($query);
3209 while ($dao->fetch()) {
3211 if ($extraProfiles) {
3212 $key .= ',' . implode(',', $extraProfiles);
3214 $reservedProfiles[$key] = $dao->title
;
3216 return $reservedProfiles;
3220 * Function to retrieve groups of profiles
3222 * @param integer $profileID id of the profile
3224 * @return array returns array
3227 static function profileGroups($profileID) {
3228 $groupTypes = array();
3229 $profileTypes = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $profileID, 'group_type');
3230 if ($profileTypes) {
3231 $groupTypeParts = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $profileTypes);
3232 $groupTypes = explode(',', $groupTypeParts[0]);
3238 * Function to alter contact params by filtering existing subscribed groups and returns
3239 * unsubscribed groups array for subscription.
3241 * @param array $params contact params
3242 * @param int $contactId user contact id
3244 * @return array $subscribeGroupIds This contains array of groups for subscription
3246 static function getDoubleOptInGroupIds(&$params, $contactId = NULL) {
3247 $config = CRM_Core_Config
::singleton();
3248 $subscribeGroupIds = array();
3250 // process further only if profileDoubleOptIn enabled and if groups exist
3251 if (!array_key_exists('group', $params) ||
3252 !self
::isProfileDoubleOptin() ||
3253 CRM_Utils_System
::isNull($params['group'])
3255 return $subscribeGroupIds;
3258 //check if contact email exist.
3260 foreach ($params as $name => $value) {
3261 if (strpos($name, 'email-') !== FALSE) {
3267 //Proceed furthur only if email present
3269 return $subscribeGroupIds;
3272 //do check for already subscriptions.
3273 $contactGroups = array();
3277 FROM civicrm_group_contact
3278 WHERE status = 'Added'
3279 AND contact_id = %1";
3281 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array($contactId, 'Integer')));
3282 while ($dao->fetch()) {
3283 $contactGroups[$dao->group_id
] = $dao->group_id
;
3287 //since we don't have names, compare w/ label.
3288 $mailingListGroupType = array_search('Mailing List', CRM_Core_OptionGroup
::values('group_type'));
3290 //actual processing start.
3291 foreach ($params['group'] as $groupId => $isSelected) {
3292 //unset group those are not selected.
3294 unset($params['group'][$groupId]);
3298 $groupTypes = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
3299 CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group', $groupId, 'group_type', 'id')
3301 //get only mailing type group and unset it from params
3302 if (in_array($mailingListGroupType, $groupTypes) && !in_array($groupId, $contactGroups)) {
3303 $subscribeGroupIds[$groupId] = $groupId;
3304 unset($params['group'][$groupId]);
3308 return $subscribeGroupIds;
3312 * Function to check if we are rendering mixed profiles
3314 * @param array $profileIds associated array of profile ids
3316 * @return boolean $mixProfile true if profile is mixed
3320 static function checkForMixProfiles($profileIds) {
3321 $mixProfile = FALSE;
3323 $contactTypes = array('Individual', 'Household', 'Organization');
3324 $subTypes = CRM_Contact_BAO_ContactType
::subTypes();
3326 $components = array('Contribution', 'Participant', 'Membership', 'Activity');
3328 $typeCount = array('ctype' => array(), 'subtype' => array());
3329 foreach ($profileIds as $gid) {
3330 $profileType = CRM_Core_BAO_UFField
::getProfileType($gid);
3331 // ignore profile of type Contact
3332 if ($profileType == 'Contact') {
3335 if (in_array($profileType, $contactTypes)) {
3336 if (!isset($typeCount['ctype'][$profileType])) {
3337 $typeCount['ctype'][$profileType] = 1;
3340 // check if we are rendering profile of different contact types
3341 if (count($typeCount['ctype']) == 2) {
3346 elseif (in_array($profileType, $components)) {
3351 if (!isset($typeCount['subtype'][$profileType])) {
3352 $typeCount['subtype'][$profileType] = 1;
3354 // check if we are rendering profile of different contact sub types
3355 if (count($typeCount['subtype']) == 2) {
3365 * Funtion to determine of we show overlay profile or not
3367 * @return boolean true if profile should be shown else false
3371 static function showOverlayProfile() {
3372 $showOverlay = TRUE;
3374 // get the id of overlay profile
3375 $overlayProfileId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', 'summary_overlay', 'id', 'name');
3376 $query = "SELECT count(id) FROM civicrm_uf_field WHERE uf_group_id = {$overlayProfileId} AND visibility IN ('Public Pages', 'Public Pages and Listings') ";
3378 $count = CRM_Core_DAO
::singleValueQuery($query);
3380 //check if there are no public fields and use is anonymous
3381 $session = CRM_Core_Session
::singleton();
3382 if (!$count && !$session->get('userID')) {
3383 $showOverlay = FALSE;
3386 return $showOverlay;
3390 * function to get group type values of the profile
3392 * @params Integer $profileId Profile Id
3393 * @params String $groupType Group Type
3395 * @return Array group type values
3399 static function groupTypeValues($profileId, $groupType = NULL) {
3400 $groupTypeValue = array();
3401 $groupTypes = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $profileId, 'group_type');
3403 $groupTypeParts = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $groupTypes);
3404 if (!CRM_Utils_Array
::value(1, $groupTypeParts)) {
3405 return $groupTypeValue;
3407 $participantExtends = array('ParticipantRole', 'ParticipantEventName', 'ParticipantEventType');
3409 foreach (explode(',', $groupTypeParts[1]) as $groupTypeValues) {
3411 $valueParts = explode(':', $groupTypeValues);
3413 ($valueParts[0] != "{$groupType}Type" ||
3414 ($groupType == 'Participant' &&
3415 !in_array($valueParts[0], $participantExtends)
3421 foreach ($valueParts as $val) {
3422 if (CRM_Utils_Rule
::integer($val)) {
3423 $values[$val] = $val;
3426 if (!empty($values)) {
3427 $typeName = substr($valueParts[0], 0, -4);
3428 if (in_array($valueParts[0], $participantExtends)) {
3429 $typeName = $valueParts[0];
3431 $groupTypeValue[$typeName] = $values;
3435 return $groupTypeValue;
3438 static function isProfileDoubleOptin() {
3439 // check for double optin
3440 $config = CRM_Core_Config
::singleton();
3441 if (in_array('CiviMail', $config->enableComponents
)) {
3442 return CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
3443 'profile_double_optin', NULL, FALSE
3449 static function isProfileAddToGroupDoubleOptin() {
3450 // check for add to group double optin
3451 $config = CRM_Core_Config
::singleton();
3452 if (in_array('CiviMail', $config->enableComponents
)) {
3453 return CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
3454 'profile_add_to_group_double_optin', NULL, FALSE
3461 * get profiles used for batch entry
3463 * @return array profileIds profile ids
3466 static function getBatchProfiles() {
3468 FROM civicrm_uf_group
3469 WHERE name IN ('contribution_batch_entry', 'membership_batch_entry')";
3470 $dao = CRM_Core_DAO
::executeQuery( $query );
3471 $profileIds = array();
3472 while( $dao->fetch() ) {
3473 $profileIds[$dao->id
] = $dao->id
;
3478 static function shiftMultiRecordFields(&$source, &$destination, $returnMultiSummaryFields = FALSE) {
3479 $multiSummaryFields = $returnMultiSummaryFields ?
array( ) : NULL;
3480 foreach ($source as $field => $properties) {
3481 if (!CRM_Core_BAO_CustomField
::getKeyID($field)) {
3484 if (CRM_Core_BAO_CustomField
::isMultiRecordField($field)) {
3485 $destination[$field] = $properties;
3486 if ($returnMultiSummaryFields) {
3487 if ($properties['is_multi_summary']) {
3488 $multiSummaryFields[$field] = $properties;
3491 unset($source[$field]);
3494 return $multiSummaryFields;
3498 * This is function is used to format pseudo fields
3500 * @param array $fields associated array of profile fields
3504 static function reformatProfileFields(&$fields) {
3505 //reformat fields array
3506 foreach ($fields as $name => $field) {
3507 //reformat phone and extension field
3508 if ( substr($field['name'], 0, 13) == 'phone_and_ext') {
3509 $fieldSuffix = str_replace('phone_and_ext-', '', $field['name']);
3511 // retain existing element properties and just update and replace key
3512 CRM_Utils_Array
::crmReplaceKey($fields, $name, "phone-{$fieldSuffix}");
3513 $fields["phone-{$fieldSuffix}"]['name'] = "phone-{$fieldSuffix}";
3514 $fields["phone-{$fieldSuffix}"]['where'] = 'civicrm_phone.phone';
3516 // add additional phone extension field
3517 $fields["phone_ext-{$fieldSuffix}"] = $field;
3518 $fields["phone_ext-{$fieldSuffix}"]['title'] = $field['title'] .' - '.ts('Ext.');
3519 $fields["phone_ext-{$fieldSuffix}"]['name'] = "phone_ext-{$fieldSuffix}";
3520 $fields["phone_ext-{$fieldSuffix}"]['where'] = 'civicrm_phone.phone_ext';
3521 $fields["phone_ext-{$fieldSuffix}"]['skipDisplay'] = 1;
3522 //ignore required for extension field
3523 $fields["phone_ext-{$fieldSuffix}"]['is_required'] = 0;