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 (array_key_exists($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, 0, -3), array('gender', 'prefix', 'suffix'))) {
953 $params[$index] = $details->$name;
954 $values[$index] = $details->$name;
956 elseif (in_array($name, CRM_Contact_BAO_Contact
::$_greetingTypes)) {
957 $dname = $name . '_display';
958 $values[$index] = $details->$dname;
959 $name = $name . '_id';
960 $params[$index] = $details->$name;
962 elseif (in_array($name, array(
963 'state_province', 'country', 'county'))) {
964 $values[$index] = $details->$name;
965 $idx = $name . '_id';
966 $params[$index] = $details->$idx;
968 elseif ($name === 'preferred_communication_method') {
969 $communicationFields = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'preferred_communication_method');
971 $pref = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $details->$name);
973 foreach ($pref as $k) {
975 $compref[] = $communicationFields[$k];
978 $params[$index] = $details->$name;
979 $values[$index] = implode(',', $compref);
981 elseif ($name === 'preferred_language') {
982 $params[$index] = $details->$name;
983 $values[$index] = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_DAO_Contact', 'preferred_language', $details->$name);
985 elseif ($name == 'group') {
986 $groups = CRM_Contact_BAO_GroupContact
::getContactGroup($cid, 'Added', NULL, FALSE, TRUE);
987 $title = $ids = array();
989 foreach ($groups as $g) {
990 // CRM-8362: User and User Admin visibility groups should be included in display if user has
991 // VIEW permission on that group
992 $groupPerm = CRM_Contact_BAO_Group
::checkPermission($g['group_id'], $g['title']);
994 if ($g['visibility'] != 'User and User Admin Only' ||
995 CRM_Utils_Array
::key(CRM_Core_Permission
::VIEW
, $groupPerm)
997 $title[] = $g['title'];
998 if ($g['visibility'] == 'Public Pages') {
999 $ids[] = $g['group_id'];
1003 $values[$index] = implode(', ', $title);
1004 $params[$index] = implode(',', $ids);
1006 elseif ($name == 'tag') {
1007 $entityTags = CRM_Core_BAO_EntityTag
::getTag($cid);
1008 $allTags = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_EntityTag', 'tag_id', array('onlyActive' => FALSE));
1010 foreach ($entityTags as $tagId) {
1011 $title[] = $allTags[$tagId];
1013 $values[$index] = implode(', ', $title);
1014 $params[$index] = implode(',', $entityTags);
1016 elseif ($name == 'activity_status_id') {
1017 $activityStatus = CRM_Core_PseudoConstant
::activityStatus();
1018 $values[$index] = $activityStatus[$details->$name];
1019 $params[$index] = $details->$name;
1021 elseif ($name == 'activity_date_time') {
1022 $values[$index] = CRM_Utils_Date
::customFormat($details->$name);
1023 $params[$index] = $details->$name;
1025 elseif ($name == 'contact_sub_type') {
1026 $contactSubTypeNames = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $details->$name);
1027 if (!empty($contactSubTypeNames)) {
1028 $contactSubTypeLabels = array();
1029 // get all contact subtypes
1030 $allContactSubTypes = CRM_Contact_BAO_ContactType
::subTypeInfo();
1031 // build contact subtype labels array
1032 foreach( $contactSubTypeNames as $cstName ) {
1034 $contactSubTypeLabels[] = $allContactSubTypes[$cstName]['label'];
1037 $values[$index] = implode(',', $contactSubTypeLabels);
1040 $params[$index] = $details->$name;
1043 if (substr($name, 0, 7) === 'do_not_' ||
substr($name, 0, 3) === 'is_') {
1044 if ($details->$name) {
1045 $values[$index] = '[ x ]';
1049 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($name)) {
1050 $htmlType = $field['html_type'];
1052 // field_type is only set when we are retrieving profile values
1053 // when sending email, we call the same function to get custom field
1054 // values etc, i.e. emulating a profile
1055 $fieldType = CRM_Utils_Array
::value('field_type', $field);
1057 if ($htmlType == 'File') {
1060 $fieldType == 'Activity' &&
1061 CRM_Utils_Array
::value(2, $componentWhere[0])
1063 $entityId = $componentWhere[0][2];
1066 $fileURL = CRM_Core_BAO_CustomField
::getFileURL($entityId,
1071 $params[$index] = $values[$index] = $fileURL['file_url'];
1075 if (isset($dao) && property_exists($dao, 'data_type') &&
1076 ($dao->data_type
== 'Int' ||
1077 $dao->data_type
== 'Boolean'
1080 $customVal = (int )($details->{$name});
1082 elseif (isset($dao) && property_exists($dao, 'data_type')
1083 && $dao->data_type
== 'Float'
1085 $customVal = (float )($details->{$name});
1087 elseif (!CRM_Utils_System
::isNull(explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1090 $customVal = $details->{$name};
1094 if (CRM_Utils_System
::isNull($customVal)) {
1098 $params[$index] = $customVal;
1099 $values[$index] = CRM_Core_BAO_CustomField
::getDisplayValue($customVal,
1103 if ($htmlType == 'Autocomplete-Select') {
1104 $params[$index] = $values[$index];
1106 if (CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
1107 $cfID, 'is_search_range'
1109 $customFieldName = "{$name}_from";
1113 elseif ($name == 'image_URL') {
1114 list($width, $height) = getimagesize($details->$name);
1115 list($thumbWidth, $thumbHeight) = CRM_Contact_BAO_Contact
::getThumbSize($width, $height);
1117 $image_URL = '<img src="' . $details->$name . '" height= ' . $thumbHeight . ' width= ' . $thumbWidth . ' />';
1118 $values[$index] = "<a href='#' onclick='contactImagePopUp(\"{$details->$name}\", {$width}, {$height});'>{$image_URL}</a>";
1120 elseif (in_array($name, array(
1121 'birth_date', 'deceased_date', 'membership_start_date', 'membership_end_date', 'join_date'))) {
1122 $values[$index] = CRM_Utils_Date
::customFormat($details->$name);
1123 $params[$index] = CRM_Utils_Date
::isoToMysql($details->$name);
1127 if ($index == 'Campaign') {
1128 $dao = 'CRM_Campaign_DAO_Campaign';
1130 elseif ($index == 'Contribution Page') {
1131 $dao = 'CRM_Contribute_DAO_ContributionPage';
1134 $value = CRM_Core_DAO
::getFieldValue($dao, $details->$name, 'title');
1137 $value = $details->$name;
1139 $values[$index] = $value;
1144 elseif (strpos($name, '-') !== FALSE) {
1145 list($fieldName, $id, $type) = CRM_Utils_System
::explode('-', $name, 3);
1147 if (!in_array($fieldName, $multipleFields)) {
1148 if ($id == 'Primary') {
1150 // not sure why we'd every use Primary location type id
1151 // we need to fix the source if we are using it
1152 // $locationTypeName = CRM_Contact_BAO_Contact::getPrimaryLocationType( $cid );
1153 $locationTypeName = 1;
1156 $locationTypeName = CRM_Utils_Array
::value($id, $locationTypes);
1159 if (!$locationTypeName) {
1163 $detailName = "{$locationTypeName}-{$fieldName}";
1164 $detailName = str_replace(' ', '_', $detailName);
1166 if (in_array($fieldName, array(
1167 'phone', 'im', 'email', 'openid'))) {
1169 $detailName .= "-{$type}";
1173 if (in_array($fieldName, array(
1174 'state_province', 'country', 'county'))) {
1175 $values[$index] = $details->$detailName;
1176 $idx = $detailName . '_id';
1177 $params[$index] = $details->$idx;
1179 elseif ($fieldName == 'im') {
1180 $providerId = $detailName . '-provider_id';
1181 if (isset($imProviders[$details->$providerId])) {
1182 $values[$index] = $details->$detailName . " (" . $imProviders[$details->$providerId] . ")";
1185 $values[$index] = $details->$detailName;
1187 $params[$index] = $details->$detailName;
1189 elseif ($fieldName == 'phone') {
1190 $phoneExtField = str_replace('phone', 'phone_ext', $detailName);
1191 if (isset($details->$phoneExtField)) {
1192 $values[$index] = $details->$detailName . " (" . $details->$phoneExtField . ")";
1195 $values[$index] = $details->$detailName;
1197 $params[$index] = $details->$detailName;
1200 $values[$index] = $params[$index] = $details->$detailName;
1204 $detailName = "website-{$id}-{$fieldName}";
1205 $url = CRM_Utils_System
::fixURL($details->$detailName);
1206 if ($details->$detailName) {
1207 $websiteTypeId = "website-{$id}-website_type_id";
1208 $websiteType = $websiteTypes[$details->$websiteTypeId];
1209 $values[$index] = "<a href=\"$url\">{$details->$detailName} ( {$websiteType} )</a>";
1212 $values[$index] = '';
1217 if ((CRM_Utils_Array
::value('visibility', $field) == 'Public Pages and Listings') &&
1218 CRM_Core_Permission
::check('profile listings and forms')
1221 if (CRM_Utils_System
::isNull($params[$index])) {
1222 $params[$index] = $values[$index];
1224 if (!isset($params[$index])) {
1227 if (!$customFieldName) {
1228 $fieldName = $field['name'];
1231 $fieldName = $customFieldName;
1235 if (CRM_Core_BAO_CustomField
::getKeyID($field['name'])) {
1236 $htmlType = $field['html_type'];
1237 if ($htmlType == 'Link') {
1238 $url = $params[$index];
1240 elseif (in_array($htmlType, array(
1241 'CheckBox', 'Multi-Select', 'AdvMulti-Select',
1242 'Multi-Select State/Province', 'Multi-Select Country',
1244 $valSeperator = CRM_Core_DAO
::VALUE_SEPARATOR
;
1245 $selectedOptions = explode($valSeperator, $params[$index]);
1247 foreach ($selectedOptions as $key => $multiOption) {
1249 $url[] = CRM_Utils_System
::url('civicrm/profile',
1250 'reset=1&force=1&gid=' . $field['group_id'] . '&' .
1251 urlencode($fieldName) .
1253 urlencode($multiOption)
1259 $url = CRM_Utils_System
::url('civicrm/profile',
1260 'reset=1&force=1&gid=' . $field['group_id'] . '&' .
1261 urlencode($fieldName) .
1263 urlencode($params[$index])
1268 $url = CRM_Utils_System
::url('civicrm/profile',
1269 'reset=1&force=1&gid=' . $field['group_id'] . '&' .
1270 urlencode($fieldName) .
1272 urlencode($params[$index])
1277 !empty($values[$index]) &&
1281 if (is_array($url) && !empty($url)) {
1283 $eachMultiValue = explode(', ', $values[$index]);
1284 foreach ($eachMultiValue as $key => $valueLabel) {
1285 $links[] = '<a href="' . $url[$key] . '">' . $valueLabel . '</a>';
1287 $values[$index] = implode(', ', $links);
1290 $values[$index] = '<a href="' . $url . '">' . $values[$index] . '</a>';
1298 * Check if profile Group used by any module.
1300 * @param int $id profile Id
1308 public static function usedByModule($id) {
1309 //check whether this group is used by any module(check uf join records)
1311 FROM civicrm_uf_join
1312 WHERE civicrm_uf_join.uf_group_id=$id";
1314 $dao = new CRM_Core_DAO();
1316 if ($dao->fetch()) {
1325 * Delete the profile Group.
1327 * @param int $id profile Id
1335 public static function del($id) {
1336 //check whether this group contains any profile fields
1337 $profileField = new CRM_Core_DAO_UFField();
1338 $profileField->uf_group_id
= $id;
1339 $profileField->find();
1340 while ($profileField->fetch()) {
1341 CRM_Core_BAO_UFField
::del($profileField->id
);
1344 //delete records from uf join table
1345 $ufJoin = new CRM_Core_DAO_UFJoin();
1346 $ufJoin->uf_group_id
= $id;
1349 //delete profile group
1350 $group = new CRM_Core_DAO_UFGroup();
1357 * function to add the UF Group
1359 * @param array $params reference array contains the values submitted by the form
1360 * @param array $ids reference array contains the id
1367 static function add(&$params, $ids = array()) {
1368 $fields = array('is_active', 'add_captcha', 'is_map', 'is_update_dupe', 'is_edit_link', 'is_uf_link', 'is_cms_user');
1369 foreach ($fields as $field) {
1370 $params[$field] = CRM_Utils_Array
::value($field, $params, FALSE);
1373 $params['limit_listings_group_id'] = CRM_Utils_Array
::value('group', $params);
1374 $params['add_to_group_id'] = CRM_Utils_Array
::value('add_contact_to_group', $params);
1376 $ufGroup = new CRM_Core_DAO_UFGroup();
1377 $ufGroup->copyValues($params);
1379 $ufGroupID = CRM_Utils_Array
::value('ufgroup', $ids, CRM_Utils_Array
::value('id', $params));
1381 $ufGroup->name
= CRM_Utils_String
::munge($ufGroup->title
, '_', 56);
1383 $ufGroup->id
= $ufGroupID;
1388 $ufGroup->name
= $ufGroup->name
. "_{$ufGroup->id}";
1396 * Function to make uf join entries for an uf group
1398 * @param array $params (reference) an assoc array of name/value pairs
1399 * @param int $ufGroupId ufgroup id
1405 static function createUFJoin(&$params, $ufGroupId) {
1406 $groupTypes = CRM_Utils_Array
::value('uf_group_type', $params);
1408 // get ufjoin records for uf group
1409 $ufGroupRecord = CRM_Core_BAO_UFGroup
::getUFJoinRecord($ufGroupId);
1411 // get the list of all ufgroup types
1412 $allUFGroupType = CRM_Core_SelectValues
::ufGroupTypes();
1414 // this fix is done to prevent warning generated by array_key_exits incase of empty array is given as input
1415 if (!is_array($groupTypes)) {
1416 $groupTypes = array();
1419 // this fix is done to prevent warning generated by array_key_exits incase of empty array is given as input
1420 if (!is_array($ufGroupRecord)) {
1421 $ufGroupRecord = array();
1424 // check which values has to be inserted/deleted for contact
1425 $menuRebuild = FALSE;
1426 foreach ($allUFGroupType as $key => $value) {
1427 $joinParams = array();
1428 $joinParams['uf_group_id'] = $ufGroupId;
1429 $joinParams['module'] = $key;
1430 if ($key == 'User Account') {
1431 $menuRebuild = TRUE;
1433 if (array_key_exists($key, $groupTypes) && !in_array($key, $ufGroupRecord)) {
1434 // insert a new record
1435 CRM_Core_BAO_UFGroup
::addUFJoin($joinParams);
1437 elseif (!array_key_exists($key, $groupTypes) && in_array($key, $ufGroupRecord)) {
1438 // delete a record for existing ufgroup
1439 CRM_Core_BAO_UFGroup
::delUFJoin($joinParams);
1445 UPDATE civicrm_uf_join
1447 WHERE uf_group_id = %2
1448 AND ( entity_id IS NULL OR entity_id <= 0 )
1450 $p = array(1 => array($params['weight'], 'Integer'),
1451 2 => array($ufGroupId, 'Integer'),
1453 CRM_Core_DAO
::executeQuery($query, $p);
1455 // do a menu rebuild if we are on drupal, so it gets all the new menu entries
1457 $config = CRM_Core_Config
::singleton();
1459 $config->userSystem
->is_drupal
1466 * Function to get the UF Join records for an ufgroup id
1468 * @params int $ufGroupId uf group id
1469 * @params int $displayName if set return display name in array
1470 * @params int $status if set return module other than default modules (User Account/User registration/Profile)
1472 * @return array $ufGroupJoinRecords
1477 public static function getUFJoinRecord($ufGroupId = NULL, $displayName = NULL, $status = NULL) {
1479 $UFGroupType = array();
1480 $UFGroupType = CRM_Core_SelectValues
::ufGroupTypes();
1484 $dao = new CRM_Core_DAO_UFJoin();
1487 $dao->uf_group_id
= $ufGroupId;
1493 while ($dao->fetch()) {
1494 if (!$displayName) {
1495 $ufJoin[$dao->id
] = $dao->module
;
1498 if (isset($UFGroupType[$dao->module
])) {
1499 // skip the default modules
1501 $ufJoin[$dao->id
] = $UFGroupType[$dao->module
];
1503 // added for CRM-1475
1505 elseif (!CRM_Utils_Array
::key($dao->module
, $ufJoin)) {
1506 $ufJoin[$dao->id
] = $dao->module
;
1514 * Function takes an associative array and creates a ufjoin record for ufgroup
1516 * @param array $params (reference) an assoc array of name/value pairs
1518 * @return object CRM_Core_BAO_UFJoin object
1522 static function addUFJoin(&$params) {
1523 $ufJoin = new CRM_Core_DAO_UFJoin();
1524 $ufJoin->copyValues($params);
1530 * Function to delete the uf join record for an uf group
1532 * @param array $params (reference) an assoc array of name/value pairs
1538 static function delUFJoin(&$params) {
1539 $ufJoin = new CRM_Core_DAO_UFJoin();
1540 $ufJoin->copyValues($params);
1545 * Function to get the weight for ufjoin record
1547 * @param int $ufGroupId if $ufGroupId get update weight or add weight
1549 * @return int weight of the UFGroup
1553 static function getWeight($ufGroupId = NULL) {
1554 //calculate the weight
1557 $queryString = "SELECT ( MAX(civicrm_uf_join.weight)+1) as new_weight
1558 FROM civicrm_uf_join
1559 WHERE module = 'User Registration' OR module = 'User Account' OR module = 'Profile'";
1562 $queryString = "SELECT MAX(civicrm_uf_join.weight) as new_weight
1563 FROM civicrm_uf_join
1564 WHERE civicrm_uf_join.uf_group_id = %1
1565 AND ( entity_id IS NULL OR entity_id <= 0 )";
1566 $p[1] = array($ufGroupId, 'Integer');
1569 $dao = CRM_Core_DAO
::executeQuery($queryString, $p);
1571 return ($dao->new_weight
) ?
$dao->new_weight
: 1;
1575 * Function to get the uf group for a module
1577 * @param string $moduleName module name
1578 * @param int $count no to increment the weight
1579 * @param bool $skipPermision - whether to add permission clause
1580 * @param int $op - which operation (view, edit, create, etc) to check permission for
1581 * @param array|NULL $returnFields list of UFGroup fields to return; NULL for default
1583 * @return array $ufGroups array of ufgroups for a module
1587 public static function getModuleUFGroup($moduleName = NULL, $count = 0, $skipPermission = TRUE, $op = CRM_Core_Permission
::VIEW
, $returnFields = NULL) {
1588 $selectFields = array('id', 'title', 'created_id', 'is_active', 'is_reserved', 'group_type');
1590 if (!CRM_Core_Config
::isUpgradeMode()) {
1591 // CRM-13555, since description field was added later (4.4), and to avoid any problems with upgrade
1592 $selectFields[] = 'description';
1595 if (!empty($returnFields)) {
1596 $selectFields = array_merge($returnFields, array_diff($selectFields, $returnFields));
1599 $queryString = 'SELECT civicrm_uf_group.' . implode(', civicrm_uf_group.', $selectFields) . '
1600 FROM civicrm_uf_group
1601 LEFT JOIN civicrm_uf_join ON (civicrm_uf_group.id = uf_group_id)';
1604 $queryString .= ' AND civicrm_uf_group.is_active = 1
1605 WHERE civicrm_uf_join.module = %2';
1606 $p[2] = array($moduleName, 'String');
1610 // add permissioning for profiles only if not registration
1611 if (!$skipPermission) {
1612 $permissionClause = CRM_Core_Permission
::ufGroupClause($op, 'civicrm_uf_group.');
1613 if (strpos($queryString, 'WHERE') !== FALSE) {
1614 $queryString .= " AND $permissionClause ";
1617 $queryString .= " $permissionClause ";
1621 $queryString .= ' ORDER BY civicrm_uf_join.weight, civicrm_uf_group.title';
1622 $dao = CRM_Core_DAO
::executeQuery($queryString, $p);
1624 $ufGroups = array();
1625 while ($dao->fetch()) {
1626 //skip mix profiles in user Registration / User Account
1627 if (($moduleName == 'User Registration' ||
$moduleName == 'User Account') &&
1628 CRM_Core_BAO_UFField
::checkProfileType($dao->id
)
1632 foreach ($selectFields as $key => $field) {
1633 if($field == 'id') {
1636 elseif ($field == 'name') {
1637 $ufGroups[$dao->id
][$field] = $dao->title
;
1640 $ufGroups[$dao->id
][$field] = $dao->$field;
1644 // Allow other modules to alter/override the UFGroups.
1645 CRM_Utils_Hook
::buildUFGroupsForModule($moduleName, $ufGroups);
1651 * Function to filter ufgroups based on logged in user contact type
1653 * @params int $ufGroupId uf group id (profile id)
1655 * @return boolean true or false
1659 static function filterUFGroups($ufGroupId, $contactID = NULL) {
1661 $session = CRM_Core_Session
::singleton();
1662 $contactID = $session->get('userID');
1666 //get the contact type
1667 $contactType = CRM_Contact_BAO_Contact
::getContactType($contactID);
1669 //match if exixting contact type is same as profile contact type
1670 $profileType = CRM_Core_BAO_UFField
::getProfileType($ufGroupId);
1672 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
1673 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
1676 //allow special mix profiles for Contribution and Participant
1677 $specialProfiles = array('Contribution', 'Participant', 'Membership');
1679 if (in_array($profileType, $specialProfiles)) {
1683 if (($contactType == $profileType) ||
$profileType == 'Contact') {
1692 * Function to build profile form
1694 * @params object $form form object
1695 * @params array $field array field properties
1696 * @params int $mode profile mode
1697 * @params int $contactID contact id
1703 static function buildProfile(
1713 $defaultValues = array();
1714 $fieldName = $field['name'];
1715 $title = $field['title'];
1716 $attributes = $field['attributes'];
1717 $rule = $field['rule'];
1718 $view = $field['is_view'];
1719 $required = ($mode == CRM_Profile_Form
::MODE_SEARCH
) ?
FALSE : $field['is_required'];
1720 $search = ($mode == CRM_Profile_Form
::MODE_SEARCH
) ?
TRUE : FALSE;
1721 $isShared = CRM_Utils_Array
::value('is_shared', $field, 0);
1723 // do not display view fields in drupal registration form
1725 if ($view && $mode == CRM_Profile_Form
::MODE_REGISTER
) {
1730 $name = "onbehalf[$fieldName]";
1732 elseif ($contactId && !$online) {
1733 $name = "field[$contactId][$fieldName]";
1735 elseif ($rowNumber) {
1736 $name = "field[$rowNumber][$fieldName]";
1738 elseif (!empty($prefix)) {
1739 $name = $prefix ."[$fieldName]";
1745 if ($fieldName == 'image_URL' && $mode == CRM_Profile_Form
::MODE_EDIT
) {
1746 $deleteExtra = ts('Are you sure you want to delete contact image.');
1748 CRM_Core_Action
::DELETE
=>
1750 'name' => ts('Delete Contact Image'),
1751 'url' => 'civicrm/contact/image',
1752 'qs' => 'reset=1&id=%%id%%&gid=%%gid%%&action=delete',
1754 'onclick = "if (confirm( \'' . $deleteExtra . '\' ) ) this.href+=\'&confirmed=1\'; else return false;"',
1757 $deleteURL = CRM_Core_Action
::formLink($deleteURL,
1758 CRM_Core_Action
::DELETE
,
1759 array('id' => $form->get('id'),
1760 'gid' => $form->get('gid'),
1763 $form->assign('deleteURL', $deleteURL);
1765 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
1766 'address_options', TRUE, NULL, TRUE
1769 if (substr($fieldName, 0, 14) === 'state_province') {
1770 $form->add('select', $name, $title,
1772 '' => ts('- select -')) + CRM_Core_PseudoConstant
::stateProvince(), $required
1774 $config = CRM_Core_Config
::singleton();
1775 if (!in_array($mode, array(
1776 CRM_Profile_Form
::MODE_EDIT
, CRM_Profile_Form
::MODE_SEARCH
)) &&
1777 $config->defaultContactStateProvince
1779 $defaultValues[$name] = $config->defaultContactStateProvince
;
1780 $form->setDefaults($defaultValues);
1783 elseif (substr($fieldName, 0, 7) === 'country') {
1784 $form->add('select', $name, $title,
1786 '' => ts('- select -')) + CRM_Core_PseudoConstant
::country(), $required
1788 $config = CRM_Core_Config
::singleton();
1789 if (!in_array($mode, array(
1790 CRM_Profile_Form
::MODE_EDIT
, CRM_Profile_Form
::MODE_SEARCH
)) &&
1791 $config->defaultContactCountry
1793 $defaultValues[$name] = $config->defaultContactCountry
;
1794 $form->setDefaults($defaultValues);
1797 elseif (substr($fieldName, 0, 6) === 'county') {
1798 if ($addressOptions['county']) {
1799 $form->add('select', $name, $title,
1801 '' => ts('- select state -')), $required
1805 elseif (substr($fieldName, 0, 9) === 'image_URL') {
1806 $form->add('file', $name, $title, $attributes, $required);
1807 $form->addUploadElement($name);
1809 elseif (substr($fieldName, 0, 2) === 'im') {
1810 $form->add('text', $name, $title, $attributes, $required);
1813 if (substr($name, -1) == ']') {
1814 $providerName = substr($name, 0, -1) . '-provider_id]';
1816 $form->add('select', $providerName, NULL,
1818 '' => ts('- select -')) + CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id'), $required
1822 $form->add('select', $name . '-provider_id', $title,
1824 '' => ts('- select -')) + CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id'), $required
1828 if ($view && $mode != CRM_Profile_Form
::MODE_SEARCH
) {
1829 $form->freeze($name . '-provider_id');
1833 elseif (($fieldName === 'birth_date') ||
($fieldName === 'deceased_date')) {
1834 $form->addDate($name, $title, $required, array('formatType' => 'birth'));
1836 elseif (in_array($fieldName, array(
1837 'membership_start_date', 'membership_end_date', 'join_date'))) {
1838 $form->addDate($name, $title, $required, array('formatType' => 'custom'));
1840 elseif (CRM_Utils_Array
::value('name',$field) == 'membership_type') {
1841 list($orgInfo, $types) = CRM_Member_BAO_MembershipType
::getMembershipTypeInfo();
1842 $sel = &$form->addElement('hierselect', $name, $title);
1843 $select = array('' => ts('- select -') );
1844 if(count($orgInfo) == 1 && $field['is_required']) {
1845 // we only have one org - so we should default to it. Not sure about defaulting to first type
1846 // as it could be missed - so adding a select
1847 // however, possibly that is more similar to the membership form
1848 if(count($types[1]) > 1) {
1849 $types[1] = $select +
$types[1];
1853 $orgInfo = $select +
$orgInfo;
1855 $sel->setOptions(array($orgInfo, $types));
1857 elseif (CRM_Utils_Array
::value('name',$field) == 'membership_status') {
1858 $form->add('select', $name, $title,
1860 '' => ts('- select -')) + CRM_Member_PseudoConstant
::membershipStatus(NULL, NULL, 'label'), $required
1863 elseif ($fieldName === 'gender_id') {
1864 $genderOptions = array();
1865 $gender = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'gender_id');
1866 foreach ($gender as $key => $var) {
1867 $genderOptions[$key] = $form->createElement('radio', NULL, ts('Gender'), $var, $key);
1869 $form->addGroup($genderOptions, $name, $title);
1871 $form->addRule($name, ts('%1 is a required field.', array(1 => $title)), 'required');
1874 elseif ($fieldName === 'prefix_id' ||
$fieldName === 'suffix_id') {
1875 $form->add('select', $name, $title,
1877 '' => ts('- select -')) + CRM_Core_PseudoConstant
::get('CRM_Contact_BAO_Contact', $fieldName), $required
1880 elseif ($fieldName === 'contact_sub_type') {
1881 $gId = $form->get('gid') ?
$form->get('gid') : CRM_Utils_Array
::value('group_id', $field);
1883 $profileType = 'Organization';
1886 $profileType = $gId ? CRM_Core_BAO_UFField
::getProfileType($gId) : NULL;
1887 if ($profileType == 'Contact') {
1888 $profileType = 'Individual';
1892 $setSubtype = FALSE;
1893 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
1894 $setSubtype = $profileType;
1895 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
1898 $subtypes = $profileType ? CRM_Contact_BAO_ContactType
::subTypePairs($profileType) : array();
1901 $subtypeList = array();
1902 $subtypeList[$setSubtype] = $subtypes[$setSubtype];
1905 $subtypeList = $subtypes;
1908 $sel = $form->add('select', $name, $title, $subtypeList, $required);
1909 $sel->setMultiple(TRUE);
1911 elseif (in_array($fieldName, CRM_Contact_BAO_Contact
::$_greetingTypes)) {
1912 //add email greeting, postal greeting, addressee, CRM-4575
1913 $gId = $form->get('gid') ?
$form->get('gid') : CRM_Utils_Array
::value('group_id', $field);
1914 $profileType = CRM_Core_BAO_UFField
::getProfileType($gId, TRUE, FALSE, TRUE);
1916 if (empty($profileType) ||
in_array($profileType, array(
1917 'Contact', 'Contribution', 'Participant', 'Membership'))) {
1918 $profileType = 'Individual';
1920 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
1921 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
1924 'contact_type' => $profileType,
1925 'greeting_type' => $fieldName,
1927 $form->add('select', $name, $title,
1929 '' => ts('- select -')) + CRM_Core_PseudoConstant
::greeting($greeting), $required
1931 // add custom greeting element
1932 $form->add('text', $fieldName . '_custom', ts('Custom %1', array(1 => ucwords(str_replace('_', ' ', $fieldName)))),
1936 elseif ($fieldName === 'preferred_communication_method') {
1937 $communicationFields = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'preferred_communication_method');
1938 foreach ($communicationFields as $key => $var) {
1942 $communicationOptions[] = $form->createElement('checkbox', $key, NULL, $var);
1944 $form->addGroup($communicationOptions, $name, $title, '<br/>');
1946 elseif ($fieldName === 'preferred_mail_format') {
1947 $form->add('select', $name, $title, CRM_Core_SelectValues
::pmf());
1949 elseif ($fieldName === 'preferred_language') {
1950 $form->add('select', $name, $title, array('' => ts('- select -')) + CRM_Contact_BAO_Contact
::buildOptions('preferred_language'));
1952 elseif ($fieldName == 'external_identifier') {
1953 $form->add('text', $name, $title, $attributes, $required);
1954 $contID = $contactId;
1956 $contID = $form->get('id');
1958 $form->addRule($name,
1959 ts('External ID already exists in Database.'),
1961 array('CRM_Contact_DAO_Contact', $contID, 'external_identifier')
1964 elseif ($fieldName === 'group') {
1965 CRM_Contact_Form_Edit_TagsAndGroups
::buildQuickForm($form, $contactId,
1966 CRM_Contact_Form_Edit_TagsAndGroups
::GROUP
,
1971 elseif ($fieldName === 'tag') {
1972 CRM_Contact_Form_Edit_TagsAndGroups
::buildQuickForm($form, $contactId,
1973 CRM_Contact_Form_Edit_TagsAndGroups
::TAG
,
1978 elseif (substr($fieldName, 0, 4) === 'url-') {
1979 $form->add('text', $name, $title,
1980 array_merge(CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Website', 'url'),
1982 'onfocus' => "if (!this.value) { this.value='http://';} else return false",
1983 'onblur' => "if ( this.value == 'http://') { this.value='';} else return false",
1988 $form->addRule($name, ts('Enter a valid Website.'), 'url');
1990 //Website type select
1992 if (substr($name, -1) == ']') {
1993 $websiteTypeName = substr($name, 0, -1) . '-website_type_id]';
1995 $form->addElement('select', $websiteTypeName, NULL, CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Website', 'website_type_id'));
1998 $form->addElement('select', $name . '-website_type_id', NULL, CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Website', 'website_type_id'));
2001 // Note should be rendered as textarea
2002 elseif (substr($fieldName, -4) == 'note') {
2003 $form->add('textarea', $name, $title, $attributes, $required);
2005 elseif (substr($fieldName, 0, 6) === 'custom') {
2006 $customFieldID = CRM_Core_BAO_CustomField
::getKeyID($fieldName);
2007 if ($customFieldID) {
2008 CRM_Core_BAO_CustomField
::addQuickFormElement($form, $name, $customFieldID, FALSE, $required, $search, $title);
2011 elseif (substr($fieldName, 0, 14) === 'address_custom') {
2012 list($fName, $locTypeId) = CRM_Utils_System
::explode('-', $fieldName, 2);
2013 $customFieldID = CRM_Core_BAO_CustomField
::getKeyID(substr($fName, 8));
2014 if ($customFieldID) {
2015 CRM_Core_BAO_CustomField
::addQuickFormElement($form, $name, $customFieldID, FALSE, $required, $search, $title);
2018 elseif (in_array($fieldName, array(
2019 'receive_date', 'receipt_date', 'thankyou_date', 'cancel_date'))) {
2020 $form->addDateTime($name, $title, $required, array('formatType' => 'activityDateTime'));
2022 elseif ($fieldName == 'send_receipt') {
2023 $form->addElement('checkbox', $name, $title);
2025 elseif ($fieldName == 'soft_credit') {
2026 CRM_Contact_Form_NewContact
::buildQuickForm($form, $rowNumber, NULL, FALSE, 'soft_credit_');
2027 $form->addMoney("soft_credit_amount[{$rowNumber}]", ts('Amount'), FALSE, NULL, FALSE);
2029 elseif ($fieldName == 'product_name') {
2030 list($products, $options) = CRM_Contribute_BAO_Premium
::getPremiumProductInfo();
2031 $sel = &$form->addElement('hierselect', $name, $title);
2033 '0' => ts('- select -')) +
$products;
2034 $sel->setOptions(array($products, $options));
2036 elseif ($fieldName == 'payment_instrument') {
2037 $form->add('select', $name, $title,
2038 array(''=>ts( '- select -' )) + CRM_Contribute_PseudoConstant
::paymentInstrument( ), $required );
2040 else if ($fieldName == 'financial_type' ) {
2041 $form->add('select', $name, $title,
2043 '' => ts('- select -')) + CRM_Contribute_PseudoConstant
::financialType(), $required
2046 elseif ($fieldName == 'contribution_status_id') {
2047 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus();
2048 $statusName = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
2054 unset($contributionStatuses[CRM_Utils_Array
::key($suppress, $statusName)]);
2057 $form->add('select', $name, $title,
2059 '' => ts('- select -')) +
$contributionStatuses, $required
2062 elseif ($fieldName == 'currency') {
2063 $form->addCurrency($name, $title, $required);
2065 elseif ($fieldName == 'contribution_page_id') {
2066 $form->add('select', $name, $title,
2068 '' => ts('- select -')) + CRM_Contribute_PseudoConstant
::contributionPage(), $required, 'class="big"'
2071 elseif ($fieldName == 'participant_register_date') {
2072 $form->addDateTime($name, $title, $required, array('formatType' => 'activityDateTime'));
2074 elseif ($fieldName == 'activity_status_id') {
2075 $form->add('select', $name, $title,
2077 '' => ts('- select -')) + CRM_Core_PseudoConstant
::activityStatus(), $required
2080 elseif ($fieldName == 'activity_engagement_level') {
2081 $form->add('select', $name, $title,
2083 '' => ts('- select -')) + CRM_Campaign_PseudoConstant
::engagementLevel(), $required
2086 elseif ($fieldName == 'activity_date_time') {
2087 $form->addDateTime($name, $title, $required, array('formatType' => 'activityDateTime'));
2089 elseif ($fieldName == 'participant_status') {
2091 if ($online == TRUE) {
2092 $cond = 'visibility_id = 1';
2094 $form->add('select', $name, $title,
2096 '' => ts('- select -')) + CRM_Event_PseudoConstant
::participantStatus(NULL, $cond, 'label'), $required
2099 elseif ($fieldName == 'participant_role') {
2100 if (CRM_Utils_Array
::value('is_multiple', $field)) {
2101 $form->addCheckBox($name, $title, CRM_Event_PseudoConstant
::participantRole(), NULL, NULL, NULL, NULL, ' ', TRUE);
2104 $form->add('select', $name, $title,
2106 '' => ts('- select -')) + CRM_Event_PseudoConstant
::participantRole(), $required
2110 elseif ($fieldName == 'world_region') {
2111 $form->add('select', $name, $title,
2113 '' => ts('- select -')) + CRM_Core_PseudoConstant
::worldRegion(), $required
2116 elseif ($fieldName == 'signature_html') {
2117 $form->addWysiwyg($name, $title, CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Email', $fieldName));
2119 elseif ($fieldName == 'signature_text') {
2120 $form->add('textarea', $name, $title, CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Email', $fieldName));
2122 elseif (substr($fieldName, -11) == 'campaign_id') {
2123 if (CRM_Campaign_BAO_Campaign
::isCampaignEnable()) {
2124 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(CRM_Utils_Array
::value($contactId,
2125 $form->_componentCampaigns
2127 $form->add('select', $name, $title,
2129 '' => ts('- select -')) +
$campaigns, $required, 'class="big"'
2133 elseif ($fieldName == 'activity_details') {
2134 $form->addWysiwyg($fieldName, $title, array('rows' => 4, 'cols' => 60), $required);
2136 elseif ($fieldName == 'activity_duration') {
2137 $form->add('text', $name, $title, $attributes, $required);
2138 $form->addRule($name, ts('Please enter the duration as number of minutes (integers only).'), 'positiveInteger');
2141 if (substr($fieldName, 0, 3) === 'is_' or substr($fieldName, 0, 7) === 'do_not_') {
2142 $form->add('advcheckbox', $name, $title, $attributes, $required);
2145 $form->add('text', $name, $title, $attributes, $required);
2149 static $hiddenSubtype = FALSE;
2150 if (!$hiddenSubtype && CRM_Contact_BAO_ContactType
::isaSubType($field['field_type'])) {
2151 // In registration mode params are submitted via POST and we don't have any clue
2152 // about profile-id or the profile-type (which could be a subtype)
2153 // To generalize the behavior and simplify the process,
2154 // lets always add the hidden
2155 //subtype value if there is any, and we won't have to
2156 // compute it while processing.
2158 $form->addElement('hidden', 'onbehalf[contact_sub_type]', $field['field_type']);
2161 $form->addElement('hidden', 'contact_sub_type_hidden', $field['field_type']);
2163 $hiddenSubtype = TRUE;
2166 if (($view && $mode != CRM_Profile_Form
::MODE_SEARCH
) ||
$isShared) {
2167 $form->freeze($name);
2171 if (in_array($fieldName, array(
2172 'non_deductible_amount', 'total_amount', 'fee_amount', 'net_amount'))) {
2173 $form->addRule($name, ts('Please enter a valid amount.'), 'money');
2177 if (!($rule == 'email' && $mode == CRM_Profile_Form
::MODE_SEARCH
)) {
2178 $form->addRule($name, ts('Please enter a valid %1', array(1 => $title)), $rule);
2184 * Function to set profile defaults
2186 * @params int $contactId contact id
2187 * @params array $fields associative array of fields
2188 * @params array $defaults defaults array
2189 * @params boolean $singleProfile true for single profile else false(batch update)
2190 * @params int $componentId id for specific components like contribute, event etc
2196 static function setProfileDefaults($contactId, &$fields, &$defaults,
2197 $singleProfile = TRUE, $componentId = NULL, $component = NULL
2199 if (!$componentId) {
2200 //get the contact details
2201 list($contactDetails, $options) = CRM_Contact_BAO_Contact
::getHierContactDetails($contactId, $fields);
2202 $details = CRM_Utils_Array
::value($contactId, $contactDetails);
2203 $multipleFields = array('website' => 'url');
2205 //start of code to set the default values
2206 foreach ($fields as $name => $field) {
2207 // skip pseudo fields
2208 if (substr($name, 0, 9) == 'phone_ext') {
2212 //set the field name depending upon the profile mode(single/batch)
2213 if ($singleProfile) {
2217 $fldName = "field[$contactId][$name]";
2220 if ($name == 'group') {
2221 CRM_Contact_Form_Edit_TagsAndGroups
::setDefaults($contactId, $defaults, CRM_Contact_Form_Edit_TagsAndGroups
::GROUP
, $fldName);
2223 if ($name == 'tag') {
2224 CRM_Contact_Form_Edit_TagsAndGroups
::setDefaults($contactId, $defaults, CRM_Contact_Form_Edit_TagsAndGroups
::TAG
, $fldName);
2227 if (CRM_Utils_Array
::value($name, $details) ||
isset($details[$name])) {
2228 //to handle custom data (checkbox) to be written
2229 // to handle birth/deceased date, greeting_type and few other fields
2230 if (($name == 'birth_date') ||
($name == 'deceased_date')) {
2231 list($defaults[$fldName]) = CRM_Utils_Date
::setDateDefaults($details[$name], 'birth');
2233 elseif (in_array($name, CRM_Contact_BAO_Contact
::$_greetingTypes)) {
2234 $defaults[$fldName] = $details[$name . '_id'];
2235 $defaults[$name . '_custom'] = $details[$name . '_custom'];
2237 elseif ($name == 'preferred_communication_method') {
2238 $v = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $details[$name]);
2239 foreach ($v as $item) {
2241 $defaults[$fldName . "[$item]"] = 1;
2245 elseif ($name == 'world_region') {
2246 $defaults[$fldName] = $details['worldregion_id'];
2248 elseif ($customFieldId = CRM_Core_BAO_CustomField
::getKeyID($name)) {
2249 //fix for custom fields
2250 $customFields = CRM_Core_BAO_CustomField
::getFields(CRM_Utils_Array
::value('contact_type', $details));
2252 // hack to add custom data for components
2253 $components = array('Contribution', 'Participant', 'Membership', 'Activity');
2254 foreach ($components as $value) {
2255 $customFields = CRM_Utils_Array
::crmArrayMerge($customFields,
2256 CRM_Core_BAO_CustomField
::getFieldsForImport($value)
2260 switch ($customFields[$customFieldId]['html_type']) {
2261 case 'Multi-Select State/Province':
2262 case 'Multi-Select Country':
2263 case 'AdvMulti-Select':
2264 case 'Multi-Select':
2265 $v = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $details[$name]);
2266 foreach ($v as $item) {
2268 $defaults[$fldName][$item] = $item;
2274 $v = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $details[$name]);
2275 foreach ($v as $item) {
2277 $defaults[$fldName][$item] = 1;
2278 // seems like we need this for QF style checkboxes in profile where its multiindexed
2280 $defaults["{$fldName}[{$item}]"] = 1;
2285 case 'Autocomplete-Select':
2286 if ($customFields[$customFieldId]['data_type'] == 'ContactReference') {
2287 if (is_numeric($details[$name])) {
2288 $defaults[$fldName . '_id'] = $details[$name];
2289 $defaults[$fldName] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $details[$name], 'sort_name');
2293 $label = CRM_Core_BAO_CustomOption
::getOptionLabel($customFieldId, $details[$name]);
2294 $defaults[$fldName . '_id'] = $details[$name];
2295 $defaults[$fldName] = $label;
2300 // CRM-6681, set defult values according to date and time format (if any).
2302 if (CRM_Utils_Array
::value('date_format', $customFields[$customFieldId])) {
2303 $dateFormat = $customFields[$customFieldId]['date_format'];
2306 if (!CRM_Utils_Array
::value('time_format', $customFields[$customFieldId])) {
2307 list($defaults[$fldName]) = CRM_Utils_Date
::setDateDefaults($details[$name], NULL,
2312 $timeElement = $fldName . '_time';
2313 if (substr($fldName, -1) == ']') {
2314 $timeElement = substr($fldName, 0, -1) . '_time]';
2316 list($defaults[$fldName], $defaults[$timeElement]) = CRM_Utils_Date
::setDateDefaults($details[$name],
2317 NULL, $dateFormat, $customFields[$customFieldId]['time_format']);
2322 $defaults[$fldName] = $details[$name];
2327 $defaults[$fldName] = $details[$name];
2331 $blocks = array('email', 'phone', 'im', 'openid');
2332 list($fieldName, $locTypeId, $phoneTypeId) = CRM_Utils_System
::explode('-', $name, 3);
2333 if (!in_array($fieldName, $multipleFields)) {
2334 if (is_array($details)) {
2335 foreach ($details as $key => $value) {
2336 // when we fixed CRM-5319 - get primary loc
2337 // type as per loc field and removed below code.
2338 $primaryLocationType = FALSE;
2339 if ($locTypeId == 'Primary') {
2340 if (is_array($value) && array_key_exists($fieldName, $value)){
2341 $primaryLocationType = TRUE;
2342 if (in_array($fieldName, $blocks)){
2343 $locTypeId = CRM_Contact_BAO_Contact
::getPrimaryLocationType($contactId, FALSE, $fieldName);
2346 $locTypeId = CRM_Contact_BAO_Contact
::getPrimaryLocationType($contactId, FALSE, 'address');
2351 // fixed for CRM-665
2352 if (is_numeric($locTypeId)) {
2353 if ($primaryLocationType ||
$locTypeId == CRM_Utils_Array
::value('location_type_id', $value)) {
2354 if (CRM_Utils_Array
::value($fieldName, $value)) {
2355 //to handle stateprovince and country
2356 if ($fieldName == 'state_province') {
2357 $defaults[$fldName] = $value['state_province_id'];
2359 elseif ($fieldName == 'county') {
2360 $defaults[$fldName] = $value['county_id'];
2362 elseif ($fieldName == 'country') {
2363 if (!isset($value['country_id']) ||
!$value['country_id']) {
2364 $config = CRM_Core_Config
::singleton();
2365 if ($config->defaultContactCountry
) {
2366 $defaults[$fldName] = $config->defaultContactCountry
;
2370 $defaults[$fldName] = $value['country_id'];
2373 elseif ($fieldName == 'phone') {
2375 if (isset($value['phone'][$phoneTypeId])) {
2376 $defaults[$fldName] = $value['phone'][$phoneTypeId];
2378 if (isset($value['phone_ext'][$phoneTypeId])) {
2379 $defaults[str_replace('phone', 'phone_ext', $fldName)] = $value['phone_ext'][$phoneTypeId];
2383 $phoneDefault = CRM_Utils_Array
::value('phone', $value);
2385 if (!is_array($phoneDefault)) {
2386 $defaults[$fldName] = $phoneDefault;
2390 elseif ($fieldName == 'email') {
2391 //adding the first email (currently we don't support multiple emails of same location type)
2392 $defaults[$fldName] = $value['email'];
2394 elseif ($fieldName == 'im') {
2395 //adding the first im (currently we don't support multiple ims of same location type)
2396 $defaults[$fldName] = $value['im'];
2397 $defaults[$fldName . '-provider_id'] = $value['im_provider_id'];
2400 $defaults[$fldName] = $value[$fieldName];
2403 elseif (substr($fieldName, 0, 14) === 'address_custom' &&
2404 CRM_Utils_Array
::value(substr($fieldName, 8), $value)
2406 $defaults[$fldName] = $value[substr($fieldName, 8)];
2414 if (is_array($details)) {
2415 if ($fieldName === 'url') {
2416 if (!empty($details['website'])) {
2417 foreach ($details['website'] as $val) {
2418 $defaults[$fldName] = CRM_Utils_Array
::value('url', $val);
2419 $defaults[$fldName . '-website_type_id'] = $val['website_type_id'];
2429 //Handling Contribution Part of the batch profile
2430 if (CRM_Core_Permission
::access('CiviContribute') && $component == 'Contribute') {
2431 self
::setComponentDefaults($fields, $componentId, $component, $defaults);
2434 //Handling Event Participation Part of the batch profile
2435 if (CRM_Core_Permission
::access('CiviEvent') && $component == 'Event') {
2436 self
::setComponentDefaults($fields, $componentId, $component, $defaults);
2439 //Handling membership Part of the batch profile
2440 if (CRM_Core_Permission
::access('CiviMember') && $component == 'Membership') {
2441 self
::setComponentDefaults($fields, $componentId, $component, $defaults);
2444 //Handling Activity Part of the batch profile
2445 if ($component == 'Activity') {
2446 self
::setComponentDefaults($fields, $componentId, $component, $defaults);
2451 * Function to get profiles by type eg: pure Individual etc
2453 * @param array $types associative array of types eg: types('Individual')
2454 * @param boolean $onlyPure true if only pure profiles are required
2456 * @return array $profiles associative array of profiles
2460 static function getProfiles($types, $onlyPure = FALSE) {
2461 $profiles = array();
2462 $ufGroups = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_UFField', 'uf_group_id');
2464 CRM_Utils_Hook
::aclGroup(CRM_Core_Permission
::ADMIN
, NULL, 'civicrm_uf_group', $ufGroups, $ufGroups);
2466 // Exclude Batch Data Entry profiles - CRM-10901
2467 $batchProfiles = CRM_Core_BAO_UFGroup
::getBatchProfiles();
2469 foreach ($ufGroups as $id => $title) {
2470 $ptype = CRM_Core_BAO_UFField
::getProfileType($id, FALSE, $onlyPure);
2471 if (in_array($ptype, $types) && !array_key_exists($id, $batchProfiles)) {
2472 $profiles[$id] = $title;
2479 * Function to check whether a profile is valid combination of
2480 * required and/or optional profile types
2482 * @param array $required array of types those are required
2483 * @param array $optional array of types those are optional
2485 * @return array $profiles associative array of profiles
2489 static function getValidProfiles($required, $optional = NULL) {
2490 if (!is_array($required) ||
empty($required)) {
2494 $profiles = array();
2495 $ufGroups = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_UFField', 'uf_group_id');
2497 CRM_Utils_Hook
::aclGroup(CRM_Core_Permission
::ADMIN
, NULL, 'civicrm_uf_group', $ufGroups, $ufGroups);
2499 foreach ($ufGroups as $id => $title) {
2500 $type = CRM_Core_BAO_UFField
::checkValidProfileType($id, $required, $optional);
2502 $profiles[$id] = $title;
2510 * Function to check whether a profile is valid combination of
2511 * required profile fields
2513 * @param array $ufId integer id of the profile
2514 * @param array $required array of fields those are required in the profile
2516 * @return array $profiles associative array of profiles
2520 static function checkValidProfile($ufId, $required = NULL) {
2521 $validProfile = FALSE;
2523 return $validProfile;
2526 if (!CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $ufId, 'is_active')) {
2527 return $validProfile;
2530 $profileFields = self
::getFields($ufId, FALSE, CRM_Core_Action
::VIEW
, NULL,
2531 NULL, FALSE, NULL, FALSE, NULL,
2532 CRM_Core_Permission
::CREATE
, NULL
2535 $validProfile = array();
2536 if (!empty($profileFields)) {
2537 $fields = array_keys($profileFields);
2538 foreach ($fields as $val) {
2539 foreach ($required as $key => $field) {
2540 if (strpos($val, $field) === 0) {
2541 unset($required[$key]);
2546 $validProfile = (empty($required)) ?
TRUE : FALSE;
2549 return $validProfile;
2553 * Function to get default value for Register.
2559 static function setRegisterDefaults(&$fields, &$defaults) {
2560 $config = CRM_Core_Config
::singleton();
2561 foreach ($fields as $name => $field) {
2562 if (substr($name, 0, 8) == 'country-') {
2563 if (!empty($config->defaultContactCountry
)) {
2564 $defaults[$name] = $config->defaultContactCountry
;
2567 elseif (substr($name, 0, 15) == 'state_province-') {
2568 if (!empty($config->defaultContactStateProvince
)) {
2569 $defaults[$name] = $config->defaultContactStateProvince
;
2577 * This function is to make a copy of a profile, including
2578 * all the fields in the profile
2580 * @param int $id the profile id to copy
2585 static function copy($id) {
2586 $fieldsFix = array('prefix' => array('title' => ts('Copy of ')));
2587 $copy = &CRM_Core_DAO
::copyGeneric('CRM_Core_DAO_UFGroup',
2593 if ($pos = strrpos($copy->name
, "_{$id}")) {
2594 $copy->name
= substr_replace($copy->name
, '', $pos);
2596 $copy->name
= CRM_Utils_String
::munge($copy->name
, '_', 56) . "_{$copy->id}";
2599 $copyUFJoin = &CRM_Core_DAO
::copyGeneric('CRM_Core_DAO_UFJoin',
2600 array('uf_group_id' => $id),
2601 array('uf_group_id' => $copy->id
),
2606 $copyUFField = &CRM_Core_DAO
::copyGeneric('CRM_Core_BAO_UFField',
2607 array('uf_group_id' => $id),
2608 array('uf_group_id' => $copy->id
)
2611 $maxWeight = CRM_Utils_Weight
::getMax('CRM_Core_DAO_UFJoin', NULL, 'weight');
2615 UPDATE civicrm_uf_join
2617 WHERE uf_group_id = %2
2618 AND ( entity_id IS NULL OR entity_id <= 0 )
2620 $p = array(1 => array($maxWeight +
1, 'Integer'),
2621 2 => array($copy->id
, 'Integer'),
2623 CRM_Core_DAO
::executeQuery($query, $p);
2624 if ($copy->is_reserved
) {
2625 $query = "UPDATE civicrm_uf_group SET is_reserved = 0 WHERE id = %1";
2626 $params = array(1 => array($copy->id
, 'Integer'));
2627 CRM_Core_DAO
::executeQuery($query, $params);
2629 CRM_Utils_Hook
::copy('UFGroup', $copy);
2635 * Process that send notification e-mails
2637 * @params int $contactId contact id
2638 * @params array $values associative array of name/value pair
2644 static function commonSendMail($contactID, &$values) {
2645 if (!$contactID ||
!$values) {
2649 $template = CRM_Core_Smarty
::singleton();
2651 $displayName = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
2656 self
::profileDisplay($values['id'], $values['values'], $template);
2657 $emailList = explode(',', $values['email']);
2659 $contactLink = CRM_Utils_System
::url('civicrm/contact/view',
2660 "reset=1&cid=$contactID",
2661 TRUE, NULL, FALSE, FALSE, TRUE
2664 //get the default domain email address.
2665 list($domainEmailName, $domainEmailAddress) = CRM_Core_BAO_Domain
::getNameAndEmail();
2667 if (!$domainEmailAddress ||
$domainEmailAddress == 'info@EXAMPLE.ORG') {
2668 $fixUrl = CRM_Utils_System
::url('civicrm/admin/domain', 'action=update&reset=1');
2669 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)));
2672 foreach ($emailList as $emailTo) {
2673 // FIXME: take the below out of the foreach loop
2674 CRM_Core_BAO_MessageTemplate
::sendTemplate(
2676 'groupName' => 'msg_tpl_workflow_uf',
2677 'valueName' => 'uf_notify',
2678 'contactId' => $contactID,
2679 'tplParams' => array(
2680 'displayName' => $displayName,
2681 'currentDate' => date('r'),
2682 'contactLink' => $contactLink,
2684 'from' => "$domainEmailName <$domainEmailAddress>",
2685 'toEmail' => $emailTo,
2692 * Given a contact id and a group id, returns the field values from the db
2693 * for this group and notify email only if group's notify field is
2694 * set and field values are not empty
2696 * @params $gid group id
2697 * @params $cid contact id
2698 * @params $params associative array
2703 function checkFieldsEmptyValues($gid, $cid, $params, $skipCheck = FALSE) {
2705 if (CRM_Core_BAO_UFGroup
::filterUFGroups($gid, $cid) ||
$skipCheck) {
2707 $fields = CRM_Core_BAO_UFGroup
::getFields($gid, FALSE, CRM_Core_Action
::VIEW
);
2708 CRM_Core_BAO_UFGroup
::getValues($cid, $fields, $values, FALSE, $params, TRUE);
2710 $email = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $gid, 'notify');
2712 if (!empty($values) &&
2717 'values' => $values,
2728 * Function to assign uf fields to template
2730 * @params int $gid group id
2731 * @params array $values associative array of fields
2736 function profileDisplay($gid, $values, $template) {
2737 $groupTitle = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $gid, 'title');
2738 $template->assign('grouptitle', $groupTitle);
2739 if (count($values)) {
2740 $template->assign('values', $values);
2745 * Format fields for dupe Contact Matching
2747 * @param array $params associated array
2749 * @return array $data assoicated formatted array
2753 static function formatFields($params, $contactId = NULL) {
2755 // get the primary location type id and email
2756 list($name, $primaryEmail, $primaryLocationType) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contactId);
2759 $defaultLocationType = CRM_Core_BAO_LocationType
::getDefault();
2760 $primaryLocationType = $defaultLocationType->id
;
2764 $locationType = array();
2766 $primaryLocation = 0;
2767 foreach ($params as $key => $value) {
2768 list($fieldName, $locTypeId, $phoneTypeId) = explode('-', $key);
2770 if ($locTypeId == 'Primary') {
2771 $locTypeId = $primaryLocationType;
2774 if (is_numeric($locTypeId)) {
2775 if (!in_array($locTypeId, $locationType)) {
2776 $locationType[$count] = $locTypeId;
2779 $loc = CRM_Utils_Array
::key($locTypeId, $locationType);
2781 $data['location'][$loc]['location_type_id'] = $locTypeId;
2783 // if we are getting in a new primary email, dont overwrite the new one
2784 if ($locTypeId == $primaryLocationType) {
2785 if (CRM_Utils_Array
::value('email-' . $primaryLocationType, $params)) {
2786 $data['location'][$loc]['email'][$loc]['email'] = $fields['email-' . $primaryLocationType];
2788 elseif (isset($primaryEmail)) {
2789 $data['location'][$loc]['email'][$loc]['email'] = $primaryEmail;
2795 $data['location'][$loc]['is_primary'] = 1;
2797 if ($fieldName == 'phone') {
2799 $data['location'][$loc]['phone'][$loc]['phone_type_id'] = $phoneTypeId;
2802 $data['location'][$loc]['phone'][$loc]['phone_type_id'] = '';
2804 $data['location'][$loc]['phone'][$loc]['phone'] = $value;
2806 elseif ($fieldName == 'email') {
2807 $data['location'][$loc]['email'][$loc]['email'] = $value;
2809 elseif ($fieldName == 'im') {
2810 $data['location'][$loc]['im'][$loc]['name'] = $value;
2813 if ($fieldName === 'state_province') {
2814 $data['location'][$loc]['address']['state_province_id'] = $value;
2816 elseif ($fieldName === 'country') {
2817 $data['location'][$loc]['address']['country_id'] = $value;
2820 $data['location'][$loc]['address'][$fieldName] = $value;
2825 // TODO: prefix, suffix and gender translation may no longer be necessary - check inputs
2826 if ($key === 'individual_suffix') {
2827 $data['suffix_id'] = $value;
2829 elseif ($key === 'individual_prefix') {
2830 $data['prefix_id'] = $value;
2832 elseif ($key === 'gender') {
2833 $data['gender_id'] = $value;
2835 elseif (substr($key, 0, 6) === 'custom') {
2836 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
2838 if ($customFields[$customFieldID]['html_type'] == 'CheckBox') {
2839 $value = implode(CRM_Core_DAO
::VALUE_SEPARATOR
, array_keys($value));
2841 // fix the date field
2842 if ($customFields[$customFieldID]['data_type'] == 'Date') {
2843 $date = CRM_Utils_Date
::format($value);
2850 $data['custom'][$customFieldID] = array(
2853 'extends' => $customFields[$customFieldID]['extends'],
2854 'type' => $customFields[$customFieldID]['data_type'],
2855 'custom_field_id' => $customFieldID,
2859 elseif ($key == 'edit') {
2863 $data[$key] = $value;
2868 if (!$primaryLocation) {
2870 $data['location'][$loc]['email'][$loc]['email'] = $primaryEmail;
2878 * calculate the profile type 'group_type' as per profile fields.
2880 * @param int $gid profile id
2881 * @param int $ignoreFieldId ignore particular profile field
2883 * @return array list of calculated group type
2885 static function calculateGroupType($gId, $includeTypeValues = FALSE, $ignoreFieldId = NULL) {
2886 //get the profile fields.
2887 $ufFields = self
::getFields($gId, FALSE, NULL, NULL, NULL, TRUE, NULL, TRUE);
2888 return self
::_calculateGroupType($ufFields, $includeTypeValues, $ignoreFieldId);
2892 * calculate the profile type 'group_type' as per profile fields.
2894 * @param int $gid profile id
2895 * @param int $ignoreFieldId ignore perticular profile field
2897 * @return array list of calculated group type
2899 static function _calculateGroupType($ufFields, $includeTypeValues = FALSE, $ignoreFieldId = NULL) {
2900 $groupType = $groupTypeValues = $customFieldIds = array();
2901 if (!empty($ufFields)) {
2902 foreach ($ufFields as $fieldName => $fieldValue) {
2903 //ignore field from group type when provided.
2904 //in case of update profile field.
2905 if ($ignoreFieldId && ($ignoreFieldId == $fieldValue['field_id'])) {
2908 if (!in_array($fieldValue['field_type'], $groupType)) {
2909 $groupType[$fieldValue['field_type']] = $fieldValue['field_type'];
2912 if ($includeTypeValues && ($fldId = CRM_Core_BAO_CustomField
::getKeyID($fieldName))) {
2913 $customFieldIds[$fldId] = $fldId;
2918 if (!empty($customFieldIds)) {
2919 $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) . ')';
2921 $customGroups = CRM_Core_DAO
::executeQuery($query);
2922 while ($customGroups->fetch()) {
2923 if (!$customGroups->extends_entity_column_value
) {
2927 $groupTypeName = "{$customGroups->extends}Type";
2928 if ($customGroups->extends == 'Participant' && $customGroups->extends_entity_column_id
) {
2929 $groupTypeName = CRM_Core_OptionGroup
::getValue('custom_data_type', $customGroups->extends_entity_column_id
, 'value', 'String', 'name');
2932 foreach (explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $customGroups->extends_entity_column_value
) as $val) {
2934 $groupTypeValues[$groupTypeName][$val] = $val;
2939 if (!empty($groupTypeValues)) {
2940 $groupType = array_merge($groupType, $groupTypeValues);
2948 * Update the profile type 'group_type' as per profile fields including group types and group subtype values.
2949 * Build and store string like: group_type1,group_type2[VALUE_SEPERATOR]group_type1Type:1:2:3,group_type2Type:1:2
2952 * BirthDate + Email Individual,Contact
2953 * BirthDate + Subject Individual,Activity
2954 * BirthDate + Subject + SurveyOnlyField Individual,Activity\0ActivityType:28
2955 * BirthDate + Subject + SurveyOnlyField + PhoneOnlyField (Not allowed)
2956 * BirthDate + SurveyOnlyField Individual,Activity\0ActivityType:28
2957 * BirthDate + Subject + SurveyOrPhoneField Individual,Activity\0ActivityType:2:28
2958 * BirthDate + SurveyOrPhoneField Individual,Activity\0ActivityType:2:28
2959 * BirthDate + SurveyOrPhoneField + SurveyOnlyField Individual,Activity\0ActivityType:2:28
2960 * BirthDate + StudentField + Subject + SurveyOnlyField Individual,Activity,Student\0ActivityType:28
2962 * @param Integer $gid profile id
2963 * @param Array $groupTypes With key having group type names
2967 static function updateGroupTypes($gId, $groupTypes = array(
2969 if (!is_array($groupTypes) ||
!$gId) {
2973 // If empty group types set group_type as 'null'
2974 if (empty($groupTypes)) {
2975 return CRM_Core_DAO
::setFieldValue('CRM_Core_DAO_UFGroup', $gId, 'group_type', 'null');
2978 $componentGroupTypes = array('Contribution', 'Participant', 'Membership', 'Activity');
2979 $validGroupTypes = array_merge(array('Contact', 'Individual', 'Organization', 'Household'), $componentGroupTypes, CRM_Contact_BAO_ContactType
::subTypes());
2981 $gTypes = $gTypeValues = array();
2983 $participantExtends = array('ParticipantRole', 'ParticipantEventName', 'ParticipantEventType');
2984 // Get valid group type and group subtypes
2985 foreach ($groupTypes as $groupType => $value) {
2986 if (in_array($groupType, $validGroupTypes) && !in_array($groupType, $gTypes)) {
2987 $gTypes[] = $groupType;
2992 if (in_array($groupType, $participantExtends)) {
2993 $subTypesOf = $groupType;
2995 elseif (strpos($groupType, 'Type') > 0) {
2996 $subTypesOf = substr($groupType, 0, strpos($groupType, 'Type'));
3002 if (!empty($value) &&
3003 (in_array($subTypesOf, $componentGroupTypes) ||
3004 in_array($subTypesOf, $participantExtends)
3007 $gTypeValues[$subTypesOf] = $groupType . ":" . implode(':', $value);
3011 if (empty($gTypes)) {
3015 // Build String to store group types and group subtypes
3016 $groupTypeString = implode(',', $gTypes);
3017 if (!empty($gTypeValues)) {
3018 $groupTypeString .= CRM_Core_DAO
::VALUE_SEPARATOR
. implode(',', $gTypeValues);
3021 return CRM_Core_DAO
::setFieldValue('CRM_Core_DAO_UFGroup', $gId, 'group_type', $groupTypeString);
3025 * Create a "group_type" string
3027 * @param array $coreTypes e.g. array('Individual','Contact','Student')
3028 * @param array $subTypes e.g. array('ActivityType' => array(7, 11))
3029 * @param string $delim
3030 * @throws CRM_Core_Exception
3032 static function encodeGroupType($coreTypes, $subTypes, $delim = CRM_Core_DAO
::VALUE_SEPARATOR
) {
3033 $groupTypeExpr = '';
3035 $groupTypeExpr .= implode(',', $coreTypes);
3038 if (count($subTypes) > 1) {
3039 throw new CRM_Core_Exception("Multiple subtype filtering is not currently supported by widget.");
3041 foreach ($subTypes as $subType => $subTypeIds) {
3042 $groupTypeExpr .= $delim . $subType . ':' . implode(':', $subTypeIds);
3045 return $groupTypeExpr;
3049 * This function is used to setDefault componet specific profile fields.
3051 * @param array $fields profile fields.
3052 * @param int $componentId componetID
3053 * @param string $component component name
3054 * @param array $defaults an array of default values.
3058 public static function setComponentDefaults(&$fields, $componentId, $component, &$defaults, $isStandalone = FALSE) {
3059 if (!$componentId ||
3060 !in_array($component, array('Contribute', 'Membership', 'Event', 'Activity'))
3065 $componentBAO = $componentSubType = NULL;
3066 switch ($component) {
3068 $componentBAO = 'CRM_Member_BAO_Membership';
3069 $componentBAOName = 'Membership';
3070 $componentSubType = array('membership_type_id');
3074 $componentBAO = 'CRM_Contribute_BAO_Contribution';
3075 $componentBAOName = 'Contribution';
3076 $componentSubType = array( 'financial_type_id' );
3080 $componentBAO = 'CRM_Event_BAO_Participant';
3081 $componentBAOName = 'Participant';
3082 $componentSubType = array('role_id', 'event_id');
3086 $componentBAO = 'CRM_Activity_BAO_Activity';
3087 $componentBAOName = 'Activity';
3088 $componentSubType = array('activity_type_id');
3093 $params = array('id' => $componentId);
3095 //get the component values.
3096 CRM_Core_DAO
::commonRetrieve($componentBAO, $params, $values);
3098 $formattedGroupTree = array();
3099 $dateTimeFields = array('participant_register_date', 'activity_date_time', 'receive_date', 'receipt_date', 'cancel_date', 'thankyou_date', 'membership_start_date', 'membership_end_date', 'join_date');
3100 foreach ($fields as $name => $field) {
3101 $fldName = $isStandalone ?
$name : "field[$componentId][$name]";
3102 if (in_array($name, $dateTimeFields)) {
3103 $timefldName = $isStandalone ?
"{$name}_time" : "field[$componentId][{$name}_time]";
3104 if (CRM_Utils_Array
::value($name, $values)) {
3105 list($defaults[$fldName], $defaults[$timefldName]) = CRM_Utils_Date
::setDateDefaults($values[$name]);
3108 elseif (array_key_exists($name, $values)) {
3109 $defaults[$fldName] = $values[$name];
3111 elseif ($name == 'participant_note') {
3112 $noteDetails = CRM_Core_BAO_Note
::getNote($componentId, 'civicrm_participant');
3113 $defaults[$fldName] = array_pop($noteDetails);
3115 elseif (in_array($name, array(
3116 'financial_type', 'payment_instrument', 'participant_status', 'participant_role'))) {
3117 $defaults[$fldName] = $values["{$name}_id"];
3119 elseif ($name == 'membership_type') {
3120 // since membership_type field is a hierselect -
3121 $defaults[$fldName][0] =
3122 CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',$values['membership_type_id'],'member_of_contact_id','id');
3123 $defaults[$fldName][1] = $values['membership_type_id'];
3125 elseif ($name == 'membership_status') {
3126 $defaults[$fldName] = $values['status_id'];
3128 elseif ($customFieldInfo = CRM_Core_BAO_CustomField
::getKeyID($name, TRUE)) {
3129 if (empty($formattedGroupTree)) {
3130 //get the groupTree as per subTypes.
3131 $groupTree = array();
3132 foreach ($componentSubType as $subType) {
3133 $subTree = CRM_Core_BAO_CustomGroup
::getTree($componentBAOName, CRM_Core_DAO
::$_nullObject,
3134 $componentId, 0, $values[$subType]
3136 $groupTree = CRM_Utils_Array
::crmArrayMerge($groupTree, $subTree);
3138 $formattedGroupTree = CRM_Core_BAO_CustomGroup
::formatGroupTree($groupTree, 1, CRM_Core_DAO
::$_nullObject);
3139 CRM_Core_BAO_CustomGroup
::setDefaults($formattedGroupTree, $defaults);
3142 //FIX ME: We need to loop defaults, but once we move to custom_1_x convention this code can be simplified.
3143 foreach ($defaults as $customKey => $customValue) {
3144 if ($customFieldDetails = CRM_Core_BAO_CustomField
::getKeyID($customKey, TRUE)) {
3145 if ($name == 'custom_' . $customFieldDetails[0]) {
3147 //hack to set default for checkbox
3148 //basically this is for weired field name like field[33][custom_19]
3149 //we are converting this field name to array structure and assign value.
3152 foreach ($formattedGroupTree as $tree) {
3153 if ('CheckBox' == CRM_Utils_Array
::value('html_type', $tree['fields'][$customFieldDetails[0]])) {
3155 $defaults['field'][$componentId][$name] = $customValue;
3158 elseif (CRM_Utils_Array
::value('data_type', $tree['fields'][$customFieldDetails[0]]) == 'Date') {
3161 // CRM-6681, $default contains formatted date, time values.
3162 $defaults[$fldName] = $customValue;
3163 if (CRM_Utils_Array
::value($customKey . '_time', $defaults)) {
3164 $defaults['field'][$componentId][$name . '_time'] = $defaults[$customKey . '_time'];
3169 if (!$skipValue ||
$isStandalone) {
3170 $defaults[$fldName] = $customValue;
3172 unset($defaults[$customKey]);
3182 * Function to retrieve reserved profiles
3184 * @param string $name name if the reserve profile
3185 * @param array $extraProfiles associated array of profile id's that needs to merge
3187 * @return array $reservedProfiles returns associated array
3190 static function getReservedProfiles($type = 'Contact', $extraProfiles = NULL) {
3191 $reservedProfiles = array();
3192 $profileNames = array();
3193 if ($type == 'Contact') {
3194 $whereClause = 'name IN ( "new_individual", "new_organization", "new_household" )';
3195 if (CRM_Contact_BAO_ContactType
::isActive('Individual')) {
3196 $profileNames[] = '"new_individual"';
3198 if (CRM_Contact_BAO_ContactType
::isActive('Household')) {
3199 $profileNames[] = '"new_household"';
3201 if (CRM_Contact_BAO_ContactType
::isActive('Organization')) {
3202 $profileNames[] = '"new_organization"';
3205 if (!empty($profileNames)) {
3206 $whereClause = 'name IN ( ' . implode(',', $profileNames) . ' ) AND is_reserved = 1';
3209 $whereClause = 'is_reserved = 1';
3212 $query = "SELECT id, title FROM civicrm_uf_group WHERE {$whereClause}";
3214 $dao = CRM_Core_DAO
::executeQuery($query);
3215 while ($dao->fetch()) {
3217 if ($extraProfiles) {
3218 $key .= ',' . implode(',', $extraProfiles);
3220 $reservedProfiles[$key] = $dao->title
;
3222 return $reservedProfiles;
3226 * Function to retrieve groups of profiles
3228 * @param integer $profileID id of the profile
3230 * @return array returns array
3233 static function profileGroups($profileID) {
3234 $groupTypes = array();
3235 $profileTypes = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $profileID, 'group_type');
3236 if ($profileTypes) {
3237 $groupTypeParts = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $profileTypes);
3238 $groupTypes = explode(',', $groupTypeParts[0]);
3244 * Function to alter contact params by filtering existing subscribed groups and returns
3245 * unsubscribed groups array for subscription.
3247 * @param array $params contact params
3248 * @param int $contactId user contact id
3250 * @return array $subscribeGroupIds This contains array of groups for subscription
3252 static function getDoubleOptInGroupIds(&$params, $contactId = NULL) {
3253 $config = CRM_Core_Config
::singleton();
3254 $subscribeGroupIds = array();
3256 // process further only if profileDoubleOptIn enabled and if groups exist
3257 if (!array_key_exists('group', $params) ||
3258 !self
::isProfileDoubleOptin() ||
3259 CRM_Utils_System
::isNull($params['group'])
3261 return $subscribeGroupIds;
3264 //check if contact email exist.
3266 foreach ($params as $name => $value) {
3267 if (strpos($name, 'email-') !== FALSE) {
3273 //Proceed furthur only if email present
3275 return $subscribeGroupIds;
3278 //do check for already subscriptions.
3279 $contactGroups = array();
3283 FROM civicrm_group_contact
3284 WHERE status = 'Added'
3285 AND contact_id = %1";
3287 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array($contactId, 'Integer')));
3288 while ($dao->fetch()) {
3289 $contactGroups[$dao->group_id
] = $dao->group_id
;
3293 //since we don't have names, compare w/ label.
3294 $mailingListGroupType = array_search('Mailing List', CRM_Core_OptionGroup
::values('group_type'));
3296 //actual processing start.
3297 foreach ($params['group'] as $groupId => $isSelected) {
3298 //unset group those are not selected.
3300 unset($params['group'][$groupId]);
3304 $groupTypes = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
3305 CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group', $groupId, 'group_type', 'id')
3307 //get only mailing type group and unset it from params
3308 if (in_array($mailingListGroupType, $groupTypes) && !in_array($groupId, $contactGroups)) {
3309 $subscribeGroupIds[$groupId] = $groupId;
3310 unset($params['group'][$groupId]);
3314 return $subscribeGroupIds;
3318 * Function to check if we are rendering mixed profiles
3320 * @param array $profileIds associated array of profile ids
3322 * @return boolean $mixProfile true if profile is mixed
3326 static function checkForMixProfiles($profileIds) {
3327 $mixProfile = FALSE;
3329 $contactTypes = array('Individual', 'Household', 'Organization');
3330 $subTypes = CRM_Contact_BAO_ContactType
::subTypes();
3332 $components = array('Contribution', 'Participant', 'Membership', 'Activity');
3334 $typeCount = array('ctype' => array(), 'subtype' => array());
3335 foreach ($profileIds as $gid) {
3336 $profileType = CRM_Core_BAO_UFField
::getProfileType($gid);
3337 // ignore profile of type Contact
3338 if ($profileType == 'Contact') {
3341 if (in_array($profileType, $contactTypes)) {
3342 if (!isset($typeCount['ctype'][$profileType])) {
3343 $typeCount['ctype'][$profileType] = 1;
3346 // check if we are rendering profile of different contact types
3347 if (count($typeCount['ctype']) == 2) {
3352 elseif (in_array($profileType, $components)) {
3357 if (!isset($typeCount['subtype'][$profileType])) {
3358 $typeCount['subtype'][$profileType] = 1;
3360 // check if we are rendering profile of different contact sub types
3361 if (count($typeCount['subtype']) == 2) {
3371 * Funtion to determine of we show overlay profile or not
3373 * @return boolean true if profile should be shown else false
3377 static function showOverlayProfile() {
3378 $showOverlay = TRUE;
3380 // get the id of overlay profile
3381 $overlayProfileId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', 'summary_overlay', 'id', 'name');
3382 $query = "SELECT count(id) FROM civicrm_uf_field WHERE uf_group_id = {$overlayProfileId} AND visibility IN ('Public Pages', 'Public Pages and Listings') ";
3384 $count = CRM_Core_DAO
::singleValueQuery($query);
3386 //check if there are no public fields and use is anonymous
3387 $session = CRM_Core_Session
::singleton();
3388 if (!$count && !$session->get('userID')) {
3389 $showOverlay = FALSE;
3392 return $showOverlay;
3396 * function to get group type values of the profile
3398 * @params Integer $profileId Profile Id
3399 * @params String $groupType Group Type
3401 * @return Array group type values
3405 static function groupTypeValues($profileId, $groupType = NULL) {
3406 $groupTypeValue = array();
3407 $groupTypes = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $profileId, 'group_type');
3409 $groupTypeParts = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $groupTypes);
3410 if (!CRM_Utils_Array
::value(1, $groupTypeParts)) {
3411 return $groupTypeValue;
3413 $participantExtends = array('ParticipantRole', 'ParticipantEventName', 'ParticipantEventType');
3415 foreach (explode(',', $groupTypeParts[1]) as $groupTypeValues) {
3417 $valueParts = explode(':', $groupTypeValues);
3419 ($valueParts[0] != "{$groupType}Type" ||
3420 ($groupType == 'Participant' &&
3421 !in_array($valueParts[0], $participantExtends)
3427 foreach ($valueParts as $val) {
3428 if (CRM_Utils_Rule
::integer($val)) {
3429 $values[$val] = $val;
3432 if (!empty($values)) {
3433 $typeName = substr($valueParts[0], 0, -4);
3434 if (in_array($valueParts[0], $participantExtends)) {
3435 $typeName = $valueParts[0];
3437 $groupTypeValue[$typeName] = $values;
3441 return $groupTypeValue;
3444 static function isProfileDoubleOptin() {
3445 // check for double optin
3446 $config = CRM_Core_Config
::singleton();
3447 if (in_array('CiviMail', $config->enableComponents
)) {
3448 return CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
3449 'profile_double_optin', NULL, FALSE
3455 static function isProfileAddToGroupDoubleOptin() {
3456 // check for add to group double optin
3457 $config = CRM_Core_Config
::singleton();
3458 if (in_array('CiviMail', $config->enableComponents
)) {
3459 return CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
3460 'profile_add_to_group_double_optin', NULL, FALSE
3467 * get profiles used for batch entry
3469 * @return array profileIds profile ids
3472 static function getBatchProfiles() {
3474 FROM civicrm_uf_group
3475 WHERE name IN ('contribution_batch_entry', 'membership_batch_entry')";
3476 $dao = CRM_Core_DAO
::executeQuery( $query );
3477 $profileIds = array();
3478 while( $dao->fetch() ) {
3479 $profileIds[$dao->id
] = $dao->id
;
3484 static function shiftMultiRecordFields(&$source, &$destination, $returnMultiSummaryFields = FALSE) {
3485 $multiSummaryFields = $returnMultiSummaryFields ?
array( ) : NULL;
3486 foreach ($source as $field => $properties) {
3487 if (!CRM_Core_BAO_CustomField
::getKeyID($field)) {
3490 if (CRM_Core_BAO_CustomField
::isMultiRecordField($field)) {
3491 $destination[$field] = $properties;
3492 if ($returnMultiSummaryFields) {
3493 if ($properties['is_multi_summary']) {
3494 $multiSummaryFields[$field] = $properties;
3497 unset($source[$field]);
3500 return $multiSummaryFields;
3504 * This is function is used to format pseudo fields
3506 * @param array $fields associated array of profile fields
3510 static function reformatProfileFields(&$fields) {
3511 //reformat fields array
3512 foreach ($fields as $name => $field) {
3513 //reformat phone and extension field
3514 if ( substr($field['name'], 0, 13) == 'phone_and_ext') {
3515 $fieldSuffix = str_replace('phone_and_ext-', '', $field['name']);
3517 // retain existing element properties and just update and replace key
3518 CRM_Utils_Array
::crmReplaceKey($fields, $name, "phone-{$fieldSuffix}");
3519 $fields["phone-{$fieldSuffix}"]['name'] = "phone-{$fieldSuffix}";
3520 $fields["phone-{$fieldSuffix}"]['where'] = 'civicrm_phone.phone';
3522 // add additional phone extension field
3523 $fields["phone_ext-{$fieldSuffix}"] = $field;
3524 $fields["phone_ext-{$fieldSuffix}"]['title'] = $field['title'] .' - '.ts('Ext.');
3525 $fields["phone_ext-{$fieldSuffix}"]['name'] = "phone_ext-{$fieldSuffix}";
3526 $fields["phone_ext-{$fieldSuffix}"]['where'] = 'civicrm_phone.phone_ext';
3527 $fields["phone_ext-{$fieldSuffix}"]['skipDisplay'] = 1;
3528 //ignore required for extension field
3529 $fields["phone_ext-{$fieldSuffix}"]['is_required'] = 0;