3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2015
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 * Fetch object based on array of properties.
54 * @param array $params
55 * (reference) an assoc array of name/value pairs.
56 * @param array $defaults
57 * (reference) an assoc array to hold the flattened values.
60 * CRM_Core_DAO_UFGroup object
62 public static function retrieve(&$params, &$defaults) {
63 return CRM_Core_DAO
::commonRetrieve('CRM_Core_DAO_UFGroup', $params, $defaults);
67 * Retrieve the first non-generic contact type
75 public static function getContactType($id) {
77 $validTypes = array_filter(array_keys(CRM_Core_SelectValues
::contactType()));
78 $validSubTypes = CRM_Contact_BAO_ContactType
::subTypeInfo();
80 $typesParts = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $id, 'group_type'));
81 $types = explode(',', $typesParts[0]);
84 foreach ($types as $type) {
85 if (in_array($type, $validTypes)) {
88 elseif (array_key_exists($type, $validSubTypes)) {
89 $cType = CRM_Utils_Array
::value('parent', $validSubTypes[$type]);
100 * Get the form title.
109 public static function getTitle($id) {
110 return CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $id, 'title');
114 * Update the is_active flag in the db.
117 * Id of the database record.
118 * @param bool $is_active
119 * Value we want to set the is_active field.
122 * CRM_Core_DAO_UFGroup object on success, null otherwise
124 public 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.
132 * What action are we doing.
139 * the fields that are needed for registration
141 public static function getRegistrationFields($action, $mode, $ctype = NULL) {
142 if ($mode & CRM_Profile_Form
::MODE_REGISTER
) {
143 $ufGroups = CRM_Core_BAO_UFGroup
::getModuleUFGroup('User Registration');
146 $ufGroups = CRM_Core_BAO_UFGroup
::getModuleUFGroup('Profile');
149 if (!is_array($ufGroups)) {
155 foreach ($ufGroups as $id => $title) {
157 $fieldType = CRM_Core_BAO_UFField
::getProfileType($id);
158 if (($fieldType != 'Contact') &&
159 ($fieldType != $ctype) &&
160 !CRM_Contact_BAO_ContactType
::isExtendsContactType($fieldType, $ctype)
164 if (CRM_Contact_BAO_ContactType
::isaSubType($fieldType)) {
165 $profileSubType = $fieldType;
169 $subset = self
::getFields($id, TRUE, $action,
170 NULL, NULL, FALSE, NULL, TRUE, $ctype
173 // we do not allow duplicates. the first field is the winner
174 foreach ($subset as $name => $field) {
175 if (empty($fields[$name])) {
176 $fields[$name] = $field;
185 * Get all the listing fields.
188 * What action are we doing.
189 * @param int $visibility
190 * Visibility of fields we are interested in.
191 * @param bool $considerSelector
192 * Whether to consider the in_selector parameter.
193 * @param array $ufGroupIds
194 * @param bool $searchable
196 * @param null $restrict
197 * @param bool $skipPermission
198 * @param int $permissionType
200 * the fields that are listings related
202 public static function getListingFields(
205 $considerSelector = FALSE,
209 $skipPermission = FALSE,
210 $permissionType = CRM_Core_Permission
::SEARCH
213 $subset = self
::getFields($ufGroupIds, FALSE, $action,
214 $visibility, $searchable,
220 if ($considerSelector) {
221 // drop the fields not meant for the selector
222 foreach ($subset as $name => $field) {
223 if (!$field['in_selector']) {
224 unset($subset[$name]);
231 $ufGroups = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_UFField', 'uf_group_id');
234 foreach ($ufGroups as $id => $title) {
235 $subset = self
::getFields($id, FALSE, $action,
236 $visibility, $searchable,
242 if ($considerSelector) {
243 // drop the fields not meant for the selector
244 foreach ($subset as $name => $field) {
245 if (!$field['in_selector']) {
246 unset($subset[$name]);
250 $fields = array_merge($fields, $subset);
257 * Get all the fields that belong to the group with the name title,
258 * and format for use with buildProfile. This is the SQL analog of
262 * The id of the UF group or ids of ufgroup.
263 * @param bool|int $register are we interested in registration fields
265 * What action are we doing.
266 * @param int $visibility
267 * Visibility of fields we are interested in.
269 * @param bool $showAll
270 * @param string $restrict
271 * Should we restrict based on a specified profile type.
272 * @param bool $skipPermission
274 * @param int $permissionType
275 * @param string $orderBy
276 * @param null $orderProfiles
279 * the fields that belong to this ufgroup(s)
281 public static function getFields(
289 $skipPermission = FALSE,
291 $permissionType = CRM_Core_Permission
::CREATE
,
292 $orderBy = 'field_name',
293 $orderProfiles = NULL
295 if (!is_array($id)) {
296 $id = CRM_Utils_Type
::escape($id, 'Positive');
297 $profileIds = array($id);
303 $gids = implode(',', $profileIds);
306 $query = "SELECT g.* from civicrm_uf_group g
307 LEFT JOIN civicrm_uf_join j ON (j.uf_group_id = g.id)
308 WHERE g.id IN ( {$gids} )
309 AND ((j.uf_group_id IN ( {$gids} ) AND j.module = %1) OR g.is_reserved = 1 )
311 $params = array(1 => array($restrict, 'String'));
314 $query = "SELECT g.* from civicrm_uf_group g WHERE g.id IN ( {$gids} ) ";
318 $query .= " AND g.is_active = 1";
321 // add permissioning for profiles only if not registration
322 if (!$skipPermission) {
323 $permissionClause = CRM_Core_Permission
::ufGroupClause($permissionType, 'g.');
324 $query .= " AND $permissionClause ";
327 if ($orderProfiles AND count($profileIds) > 1) {
328 $query .= " ORDER BY FIELD( g.id, {$gids} )";
330 $group = CRM_Core_DAO
::executeQuery($query, $params);
334 while ($group->fetch()) {
336 $query = self
::createUFFieldQuery($group->id
, $searchable, $showAll, $visibility, $orderBy);
337 $field = CRM_Core_DAO
::executeQuery($query);
339 $profileType = CRM_Core_BAO_UFField
::getProfileType($group->id
);
340 $contactActivityProfile = CRM_Core_BAO_UFField
::checkContactActivityProfileType($group->id
);
341 $importableFields = self
::getImportableFields($showAll, $profileType, $contactActivityProfile);
342 list($customFields, $addressCustomFields) = self
::getCustomFields($ctype);
344 while ($field->fetch()) {
345 list($name, $formattedField) = self
::formatUFField($group, $field, $customFields, $addressCustomFields, $importableFields, $permissionType);
346 if ($formattedField !== NULL) {
347 $fields[$name] = $formattedField;
353 if (empty($fields) && !$validGroup) {
354 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.',
355 array(1 => implode(',', $profileIds))
359 self
::reformatProfileFields($fields);
366 * Format a list of UFFields for use with buildProfile. This is the in-memory analog
369 * @param array $groupArr
370 * (mimic CRM_UF_DAO_UFGroup).
371 * @param array $fieldArrs
372 * List of fields (each mimics CRM_UF_DAO_UFField).
373 * @param bool $visibility
374 * Visibility of fields we are interested in.
375 * @param bool $searchable
376 * @param bool $showAll
378 * @param int $permissionType
381 * @see self::getFields
383 public static function formatUFFields(
390 $permissionType = CRM_Core_Permission
::CREATE
392 // $group = new CRM_Core_DAO_UFGroup();
393 // $group->copyValues($groupArr); // no... converts string('') to string('null')
394 $group = (object) $groupArr;
396 // Refactoring note: The $fieldArrs here may be slightly different than the $ufFields
397 // used by calculateGroupType, but I don't think the missing fields matter, and -- if
398 // they did -- the obvious fix would produce mutual recursion.
399 $ufGroupType = self
::_calculateGroupType($fieldArrs);
400 $profileType = CRM_Core_BAO_UFField
::calculateProfileType(implode(',', $ufGroupType));
401 $contactActivityProfile = CRM_Core_BAO_UFField
::checkContactActivityProfileTypeByGroupType(implode(',', $ufGroupType));
402 $importableFields = self
::getImportableFields($showAll, $profileType, $contactActivityProfile);
403 list($customFields, $addressCustomFields) = self
::getCustomFields($ctype);
405 $formattedFields = array();
406 foreach ($fieldArrs as $fieldArr) {
407 $field = (object) $fieldArr;
408 if (!self
::filterUFField($field, $searchable, $showAll, $visibility)) {
412 list($name, $formattedField) = self
::formatUFField($group, $field, $customFields, $addressCustomFields, $importableFields, $permissionType);
413 if ($formattedField !== NULL) {
414 $formattedFields[$name] = $formattedField;
417 return $formattedFields;
421 * Prepare a field for rendering with CRM_Core_BAO_UFGroup::buildProfile.
423 * @param CRM_Core_DAO_UFGroup|CRM_Core_DAO $group
424 * @param CRM_Core_DAO_UFField|CRM_Core_DAO $field
425 * @param array $customFields
426 * @param array $addressCustomFields
427 * @param array $importableFields
428 * @param int $permissionType
429 * Eg CRM_Core_Permission::CREATE.
432 protected static function formatUFField(
436 $addressCustomFields,
438 $permissionType = CRM_Core_Permission
::CREATE
440 $name = $field->field_name
;
441 $title = $field->label
;
443 $addressCustom = FALSE;
444 if (in_array($permissionType, array(
445 CRM_Core_Permission
::CREATE
,
446 CRM_Core_Permission
::EDIT
,
448 in_array($field->field_name
, array_keys($addressCustomFields))
450 $addressCustom = TRUE;
451 $name = "address_{$name}";
453 if ($field->field_name
== 'url') {
454 $name .= "-{$field->website_type_id}";
456 elseif (!empty($field->location_type_id
)) {
457 $name .= "-{$field->location_type_id}";
460 $locationFields = self
::getLocationFields();
461 if (in_array($field->field_name
, $locationFields) ||
$addressCustom) {
466 if (isset($field->phone_type_id
)) {
467 $name .= "-{$field->phone_type_id}";
470 // No lie: this is bizarre; why do we need to mix so many UFGroup properties into UFFields?
471 // I guess to make field self sufficient with all the required data and avoid additional calls
472 $formattedField = array(
474 'groupTitle' => $group->title
,
475 'groupName' => $group->name
,
476 'groupHelpPre' => empty($group->help_pre
) ?
'' : $group->help_pre
,
477 'groupHelpPost' => empty($group->help_post
) ?
'' : $group->help_post
,
479 'where' => CRM_Utils_Array
::value('where', CRM_Utils_Array
::value($field->field_name
, $importableFields)),
480 'attributes' => CRM_Core_DAO
::makeAttribute(CRM_Utils_Array
::value($field->field_name
, $importableFields)),
481 'is_required' => $field->is_required
,
482 'is_view' => $field->is_view
,
483 'help_pre' => $field->help_pre
,
484 'help_post' => $field->help_post
,
485 'visibility' => $field->visibility
,
486 'in_selector' => $field->in_selector
,
487 'rule' => CRM_Utils_Array
::value('rule', CRM_Utils_Array
::value($field->field_name
, $importableFields)),
488 'location_type_id' => isset($field->location_type_id
) ?
$field->location_type_id
: NULL,
489 'website_type_id' => isset($field->website_type_id
) ?
$field->website_type_id
: NULL,
490 'phone_type_id' => isset($field->phone_type_id
) ?
$field->phone_type_id
: NULL,
491 'group_id' => $group->id
,
492 'add_to_group_id' => isset($group->add_to_group_id
) ?
$group->add_to_group_id
: NULL,
493 'add_captcha' => isset($group->add_captcha
) ?
$group->add_captcha
: NULL,
494 'field_type' => $field->field_type
,
495 'field_id' => $field->id
,
496 'pseudoconstant' => CRM_Utils_Array
::value(
498 CRM_Utils_Array
::value($field->field_name
, $importableFields)
500 // obsolete this when we remove the name / dbName discrepancy with gender/suffix/prefix
501 'dbName' => CRM_Utils_Array
::value(
503 CRM_Utils_Array
::value($field->field_name
, $importableFields)
508 //adding custom field property
509 if (substr($field->field_name
, 0, 6) == 'custom' ||
510 substr($field->field_name
, 0, 14) === 'address_custom'
512 // if field is not present in customFields, that means the user
513 // DOES NOT HAVE permission to access that field
514 if (array_key_exists($field->field_name
, $customFields)) {
515 $formattedField['is_search_range'] = $customFields[$field->field_name
]['is_search_range'];
517 $formattedField['options_per_line'] = $customFields[$field->field_name
]['options_per_line'];
518 $formattedField['data_type'] = $customFields[$field->field_name
]['data_type'];
519 $formattedField['html_type'] = $customFields[$field->field_name
]['html_type'];
521 if (CRM_Utils_Array
::value('html_type', $formattedField) == 'Select Date') {
522 $formattedField['date_format'] = $customFields[$field->field_name
]['date_format'];
523 $formattedField['time_format'] = $customFields[$field->field_name
]['time_format'];
526 $formattedField['is_multi_summary'] = $field->is_multi_summary
;
527 return array($name, $formattedField);
530 $formattedField = NULL;
531 return array($name, $formattedField);
534 return array($name, $formattedField);
538 * Create a query to find all visible UFFields in a UFGroup.
540 * This is the SQL-variant of checkUFFieldDisplayable().
542 * @param int $groupId
543 * @param bool $searchable
544 * @param bool $showAll
545 * @param int $visibility
546 * @param string $orderBy
547 * Comma-delimited list of SQL columns.
550 protected static function createUFFieldQuery($groupId, $searchable, $showAll, $visibility, $orderBy) {
551 $where = " WHERE uf_group_id = {$groupId}";
554 $where .= " AND is_searchable = 1";
558 $where .= " AND is_active = 1";
563 if ($visibility & self
::PUBLIC_VISIBILITY
) {
564 $clause[] = 'visibility = "Public Pages"';
566 if ($visibility & self
::ADMIN_VISIBILITY
) {
567 $clause[] = 'visibility = "User and User Admin Only"';
569 if ($visibility & self
::LISTINGS_VISIBILITY
) {
570 $clause[] = 'visibility = "Public Pages and Listings"';
572 if (!empty($clause)) {
573 $where .= ' AND ( ' . implode(' OR ', $clause) . ' ) ';
577 $query = "SELECT * FROM civicrm_uf_field $where ORDER BY weight";
579 $query .= ", " . $orderBy;
586 * Create a query to find all visible UFFields in a UFGroup.
588 * This is the PHP in-memory variant of createUFFieldQuery().
590 * @param CRM_Core_DAO_UFField|CRM_Core_DAO $field
591 * @param bool $searchable
592 * @param bool $showAll
593 * @param int $visibility
595 * TRUE if field is displayable
597 protected static function filterUFField($field, $searchable, $showAll, $visibility) {
598 if ($searchable && $field->is_searchable
!= 1) {
602 if (!$showAll && $field->is_active
!= 1) {
607 $allowedVisibilities = array();
608 if ($visibility & self
::PUBLIC_VISIBILITY
) {
609 $allowedVisibilities[] = 'Public Pages';
611 if ($visibility & self
::ADMIN_VISIBILITY
) {
612 $allowedVisibilities[] = 'User and User Admin Only';
614 if ($visibility & self
::LISTINGS_VISIBILITY
) {
615 $allowedVisibilities[] = 'Public Pages and Listings';
617 // !empty($allowedVisibilities) seems silly to me, but it is equivalent to the pre-existing SQL
618 if (!empty($allowedVisibilities) && !in_array($field->visibility
, $allowedVisibilities)) {
628 * @param $profileType
629 * @param $contactActivityProfile
633 protected static function getImportableFields($showAll, $profileType, $contactActivityProfile) {
635 $importableFields = CRM_Contact_BAO_Contact
::importableFields('All', FALSE, FALSE, FALSE, TRUE, TRUE);
638 $importableFields = CRM_Contact_BAO_Contact
::importableFields('All', FALSE, TRUE, FALSE, TRUE, TRUE);
641 if ($profileType == 'Activity' ||
$contactActivityProfile) {
642 $componentFields = CRM_Activity_BAO_Activity
::getProfileFields();
645 $componentFields = CRM_Core_Component
::getQueryFields();
648 $importableFields = array_merge($importableFields, $componentFields);
650 $importableFields['group']['title'] = ts('Group(s)');
651 $importableFields['group']['where'] = NULL;
652 $importableFields['tag']['title'] = ts('Tag(s)');
653 $importableFields['tag']['where'] = NULL;
654 return $importableFields;
657 public static function getLocationFields() {
658 static $locationFields = array(
660 'supplemental_address_1',
661 'supplemental_address_2',
664 'postal_code_suffix',
677 return $locationFields;
685 protected static function getCustomFields($ctype) {
686 static $customFieldCache = array();
687 if (!isset($customFieldCache[$ctype])) {
688 $customFields = CRM_Core_BAO_CustomField
::getFieldsForImport($ctype, FALSE, FALSE, FALSE, TRUE, TRUE);
690 // hack to add custom data for components
691 $components = array('Contribution', 'Participant', 'Membership', 'Activity', 'Case');
692 foreach ($components as $value) {
693 $customFields = array_merge($customFields, CRM_Core_BAO_CustomField
::getFieldsForImport($value));
695 $addressCustomFields = CRM_Core_BAO_CustomField
::getFieldsForImport('Address');
696 $customFields = array_merge($customFields, $addressCustomFields);
697 $customFieldCache[$ctype] = array($customFields, $addressCustomFields);
699 return $customFieldCache[$ctype];
703 * Check the data validity.
706 * The user id that we are actually editing.
707 * @param string $title
708 * The title of the group we are interested in.
709 * @param bool $register
711 * The action of the form.
713 * @pram boolean $register is this the registrtion form
715 * true if form is valid
717 public static function isValid($userID, $title, $register = FALSE, $action = NULL) {
719 $controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Dynamic',
720 ts('Dynamic Form Creator'),
723 $controller->set('id', $userID);
724 $controller->set('register', 1);
725 $controller->process();
726 return $controller->validate();
729 // make sure we have a valid group
730 $group = new CRM_Core_DAO_UFGroup();
732 $group->title
= $title;
734 if ($group->find(TRUE) && $userID) {
735 $controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Dynamic', ts('Dynamic Form Creator'), $action);
736 $controller->set('gid', $group->id
);
737 $controller->set('id', $userID);
738 $controller->set('register', 0);
739 $controller->process();
740 return $controller->validate();
747 * Get the html for the form that represents this particular group.
750 * The user id that we are actually editing.
751 * @param string $title
752 * The title of the group we are interested in.
754 * The action of the form.
755 * @param bool $register
756 * Is this the registration form.
758 * Should we reset the form?.
759 * @param int $profileID
760 * Do we have the profile ID?.
762 * @param bool $doNotProcess
766 * the html for the form on success, otherwise empty string
768 public static function getEditHTML(
775 $doNotProcess = FALSE,
780 $controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Dynamic',
781 ts('Dynamic Form Creator'),
784 if ($reset ||
$doNotProcess) {
785 // hack to make sure we do not process this form
786 $oldQFDefault = CRM_Utils_Array
::value('_qf_default',
789 unset($_POST['_qf_default']);
790 unset($_REQUEST['_qf_default']);
792 $controller->reset();
796 $controller->set('id', $userID);
797 $controller->set('register', 1);
798 $controller->set('skipPermission', 1);
799 $controller->set('ctype', $ctype);
800 $controller->process();
801 if ($doNotProcess ||
!empty($_POST)) {
802 $controller->validate();
804 $controller->setEmbedded(TRUE);
806 //CRM-5839 - though we want to process form, get the control back.
807 $controller->setSkipRedirection(($doNotProcess) ?
FALSE : TRUE);
811 // we are done processing so restore the POST/REQUEST vars
812 if (($reset ||
$doNotProcess) && $oldQFDefault) {
813 $_POST['_qf_default'] = $_REQUEST['_qf_default'] = $oldQFDefault;
816 $template = CRM_Core_Smarty
::singleton();
818 // Hide CRM error messages if they are displayed using drupal form_set_error.
819 if (!empty($_POST)) {
820 $template->assign('suppressForm', TRUE);
823 return trim($template->fetch('CRM/Profile/Form/Dynamic.tpl'));
827 // make sure we have a valid group
828 $group = new CRM_Core_DAO_UFGroup();
830 $group->title
= $title;
832 if ($group->find(TRUE)) {
833 $profileID = $group->id
;
838 // make sure profileID and ctype match if ctype exists
840 $profileType = CRM_Core_BAO_UFField
::getProfileType($profileID);
841 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
842 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
845 if (($profileType != 'Contact') && ($profileType != $ctype)) {
850 $controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Dynamic',
851 ts('Dynamic Form Creator'),
855 $controller->reset();
857 $controller->set('gid', $profileID);
858 $controller->set('id', $userID);
859 $controller->set('register', 0);
860 $controller->set('skipPermission', 1);
862 $controller->set('ctype', $ctype);
864 $controller->process();
865 $controller->setEmbedded(TRUE);
867 //CRM-5846 - give the control back to drupal.
868 $controller->setSkipRedirection(($doNotProcess) ?
FALSE : TRUE);
871 $template = CRM_Core_Smarty
::singleton();
873 // Hide CRM error messages if they are displayed using drupal form_set_error.
874 if (!empty($_POST) && CRM_Core_Config
::singleton()->userFramework
== 'Drupal') {
875 if (arg(0) == 'user' ||
(arg(0) == 'admin' && arg(1) == 'people')) {
876 $template->assign('suppressForm', TRUE);
880 $templateFile = "CRM/Profile/Form/{$profileID}/Dynamic.tpl";
881 if (!$template->template_exists($templateFile)) {
882 $templateFile = 'CRM/Profile/Form/Dynamic.tpl';
884 return trim($template->fetch($templateFile));
887 $userEmail = CRM_Contact_BAO_Contact_Location
::getEmailDetails($userID);
889 // if post not empty then only proceed
890 if (!empty($_POST)) {
892 $config = CRM_Core_Config
::singleton();
893 $email = CRM_Utils_Array
::value('mail', $_POST);
895 if (CRM_Utils_Rule
::email($email) && ($email != $userEmail[1])) {
896 CRM_Core_BAO_UFMatch
::updateContactEmail($userID, $email);
905 * Searches for a contact in the db with similar attributes.
907 * @param array $params
908 * The list of values to be used in the where clause.
910 * The current contact id (hence excluded from matching).
911 * @param string $contactType
914 * contact_id if found, null otherwise
916 public static function findContact(&$params, $id = NULL, $contactType = 'Individual') {
917 $dedupeParams = CRM_Dedupe_Finder
::formatParams($params, $contactType);
918 $dedupeParams['check_permission'] = CRM_Utils_Array
::value('check_permission', $params, TRUE);
919 $ids = CRM_Dedupe_Finder
::dupesByParams($dedupeParams, $contactType, 'Supervised', array($id));
921 return implode(',', $ids);
929 * Given a contact id and a field set, return the values from the db
933 * @param array $fields
934 * The profile fields of interest.
935 * @param array $values
936 * The values for the above fields.
937 * @param bool $searchable
939 * @param array $componentWhere
940 * Component condition.
941 * @param bool $absolute
942 * Return urls in absolute form (useful when sending an email).
943 * @param null $additionalWhereClause
947 public static function getValues(
948 $cid, &$fields, &$values,
949 $searchable = TRUE, $componentWhere = NULL,
950 $absolute = FALSE, $additionalWhereClause = NULL
952 if (empty($cid) && empty($componentWhere)) {
956 // get the contact details (hier)
957 $returnProperties = CRM_Contact_BAO_Contact
::makeHierReturnProperties($fields);
958 $params = $cid ?
array(array('contact_id', '=', $cid, 0, 0)) : array();
960 // add conditions specified by components. eg partcipant_id etc
961 if (!empty($componentWhere)) {
962 $params = array_merge($params, $componentWhere);
965 $query = new CRM_Contact_BAO_Query($params, $returnProperties, $fields);
966 $options = &$query->_options
;
968 $details = $query->searchQuery(0, 0, NULL, FALSE, FALSE,
969 FALSE, FALSE, FALSE, $additionalWhereClause);
970 if (!$details->fetch()) {
973 $query->convertToPseudoNames($details);
974 $config = CRM_Core_Config
::singleton();
976 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
977 $imProviders = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id');
978 $websiteTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Website', 'website_type_id');
980 $multipleFields = array('url');
982 //start of code to set the default values
983 foreach ($fields as $name => $field) {
986 $name = 'contact_id';
989 // skip fields that should not be displayed separately
990 if (!empty($field['skipDisplay'])) {
994 // Create a unique, non-empty index for each field.
995 $index = $field['title'];
999 while (array_key_exists($index, $values)) {
1003 $params[$index] = $values[$index] = '';
1004 $customFieldName = NULL;
1006 if (isset($details->$name) ||
$name == 'group' ||
$name == 'tag') {
1007 // to handle gender / suffix / prefix
1008 if (in_array(substr($name, 0, -3), array('gender', 'prefix', 'suffix'))) {
1009 $params[$index] = $details->$name;
1010 $values[$index] = $details->$name;
1012 elseif (in_array($name, CRM_Contact_BAO_Contact
::$_greetingTypes)) {
1013 $dname = $name . '_display';
1014 $values[$index] = $details->$dname;
1015 $name = $name . '_id';
1016 $params[$index] = $details->$name;
1018 elseif (in_array($name, array(
1023 $values[$index] = $details->$name;
1024 $idx = $name . '_id';
1025 $params[$index] = $details->$idx;
1027 elseif ($name === 'preferred_communication_method') {
1028 $communicationFields = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'preferred_communication_method');
1030 $pref = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $details->$name);
1032 foreach ($pref as $k) {
1034 $compref[] = $communicationFields[$k];
1037 $params[$index] = $details->$name;
1038 $values[$index] = implode(',', $compref);
1040 elseif ($name === 'preferred_language') {
1041 $params[$index] = $details->$name;
1042 $values[$index] = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_DAO_Contact', 'preferred_language', $details->$name);
1044 elseif ($name == 'group') {
1045 $groups = CRM_Contact_BAO_GroupContact
::getContactGroup($cid, 'Added', NULL, FALSE, TRUE);
1046 $title = $ids = array();
1048 foreach ($groups as $g) {
1049 // CRM-8362: User and User Admin visibility groups should be included in display if user has
1050 // VIEW permission on that group
1051 $groupPerm = CRM_Contact_BAO_Group
::checkPermission($g['group_id'], $g['title']);
1053 if ($g['visibility'] != 'User and User Admin Only' ||
1054 CRM_Utils_Array
::key(CRM_Core_Permission
::VIEW
, $groupPerm)
1056 $title[] = $g['title'];
1057 if ($g['visibility'] == 'Public Pages') {
1058 $ids[] = $g['group_id'];
1062 $values[$index] = implode(', ', $title);
1063 $params[$index] = implode(',', $ids);
1065 elseif ($name == 'tag') {
1066 $entityTags = CRM_Core_BAO_EntityTag
::getTag($cid);
1067 $allTags = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_EntityTag', 'tag_id', array('onlyActive' => FALSE));
1069 foreach ($entityTags as $tagId) {
1070 $title[] = $allTags[$tagId];
1072 $values[$index] = implode(', ', $title);
1073 $params[$index] = implode(',', $entityTags);
1075 elseif ($name == 'activity_status_id') {
1076 $activityStatus = CRM_Core_PseudoConstant
::activityStatus();
1077 $values[$index] = $activityStatus[$details->$name];
1078 $params[$index] = $details->$name;
1080 elseif ($name == 'activity_date_time') {
1081 $values[$index] = CRM_Utils_Date
::customFormat($details->$name);
1082 $params[$index] = $details->$name;
1084 elseif ($name == 'contact_sub_type') {
1085 $contactSubTypeNames = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $details->$name);
1086 if (!empty($contactSubTypeNames)) {
1087 $contactSubTypeLabels = array();
1088 // get all contact subtypes
1089 $allContactSubTypes = CRM_Contact_BAO_ContactType
::subTypeInfo();
1090 // build contact subtype labels array
1091 foreach ($contactSubTypeNames as $cstName) {
1093 $contactSubTypeLabels[] = $allContactSubTypes[$cstName]['label'];
1096 $values[$index] = implode(',', $contactSubTypeLabels);
1099 $params[$index] = $details->$name;
1102 if (substr($name, 0, 7) === 'do_not_' ||
substr($name, 0, 3) === 'is_') {
1103 if ($details->$name) {
1104 $values[$index] = '[ x ]';
1108 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($name)) {
1109 $htmlType = $field['html_type'];
1111 // field_type is only set when we are retrieving profile values
1112 // when sending email, we call the same function to get custom field
1113 // values etc, i.e. emulating a profile
1114 $fieldType = CRM_Utils_Array
::value('field_type', $field);
1116 if ($htmlType == 'File') {
1119 $fieldType == 'Activity' && !empty($componentWhere[0][2])
1121 $entityId = $componentWhere[0][2];
1124 $fileURL = CRM_Core_BAO_CustomField
::getFileURL($entityId,
1128 $additionalWhereClause
1130 $params[$index] = $values[$index] = $fileURL['file_url'];
1134 if (isset($dao) && property_exists($dao, 'data_type') &&
1135 ($dao->data_type
== 'Int' ||
1136 $dao->data_type
== 'Boolean'
1139 $customVal = (int ) ($details->{$name});
1141 elseif (isset($dao) && property_exists($dao, 'data_type')
1142 && $dao->data_type
== 'Float'
1144 $customVal = (float ) ($details->{$name});
1146 elseif (!CRM_Utils_System
::isNull(explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1150 $customVal = $details->{$name};
1154 if (CRM_Utils_System
::isNull($customVal)) {
1158 $params[$index] = $customVal;
1159 $values[$index] = CRM_Core_BAO_CustomField
::getDisplayValue($customVal,
1163 if ($field['data_type'] == 'ContactReference') {
1164 $params[$index] = $values[$index];
1166 if (CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
1167 $cfID, 'is_search_range'
1170 $customFieldName = "{$name}_from";
1174 elseif ($name == 'image_URL') {
1175 list($width, $height) = getimagesize(CRM_Utils_String
::unstupifyUrl($details->$name));
1176 list($thumbWidth, $thumbHeight) = CRM_Contact_BAO_Contact
::getThumbSize($width, $height);
1178 $image_URL = '<img src="' . $details->$name . '" height= ' . $thumbHeight . ' width= ' . $thumbWidth . ' />';
1179 $values[$index] = "<a href='#' onclick='contactImagePopUp(\"{$details->$name}\", {$width}, {$height});'>{$image_URL}</a>";
1181 elseif (in_array($name, array(
1184 'membership_start_date',
1185 'membership_end_date',
1188 $values[$index] = CRM_Utils_Date
::customFormat($details->$name);
1189 $params[$index] = CRM_Utils_Date
::isoToMysql($details->$name);
1193 if ($index == 'Campaign') {
1194 $dao = 'CRM_Campaign_DAO_Campaign';
1196 elseif ($index == 'Contribution Page') {
1197 $dao = 'CRM_Contribute_DAO_ContributionPage';
1200 $value = CRM_Core_DAO
::getFieldValue($dao, $details->$name, 'title');
1203 $value = $details->$name;
1205 $values[$index] = $value;
1210 elseif (strpos($name, '-') !== FALSE) {
1211 list($fieldName, $id, $type) = CRM_Utils_System
::explode('-', $name, 3);
1213 if (!in_array($fieldName, $multipleFields)) {
1214 if ($id == 'Primary') {
1216 // not sure why we'd every use Primary location type id
1217 // we need to fix the source if we are using it
1218 // $locationTypeName = CRM_Contact_BAO_Contact::getPrimaryLocationType( $cid );
1219 $locationTypeName = 1;
1222 $locationTypeName = CRM_Utils_Array
::value($id, $locationTypes);
1225 if (!$locationTypeName) {
1229 $detailName = "{$locationTypeName}-{$fieldName}";
1230 $detailName = str_replace(' ', '_', $detailName);
1232 if (in_array($fieldName, array(
1239 $detailName .= "-{$type}";
1243 if (in_array($fieldName, array(
1248 $values[$index] = $details->$detailName;
1249 $idx = $detailName . '_id';
1250 $params[$index] = $details->$idx;
1252 elseif ($fieldName == 'im') {
1253 $providerId = $detailName . '-provider_id';
1254 if (isset($imProviders[$details->$providerId])) {
1255 $values[$index] = $details->$detailName . " (" . $imProviders[$details->$providerId] . ")";
1258 $values[$index] = $details->$detailName;
1260 $params[$index] = $details->$detailName;
1262 elseif ($fieldName == 'phone') {
1263 $phoneExtField = str_replace('phone', 'phone_ext', $detailName);
1264 if (isset($details->$phoneExtField)) {
1265 $values[$index] = $details->$detailName . " (" . $details->$phoneExtField . ")";
1268 $values[$index] = $details->$detailName;
1270 $params[$index] = $details->$detailName;
1273 $values[$index] = $params[$index] = $details->$detailName;
1277 $detailName = "website-{$id}-{$fieldName}";
1278 $url = CRM_Utils_System
::fixURL($details->$detailName);
1279 if ($details->$detailName) {
1280 $websiteTypeId = "website-{$id}-website_type_id";
1281 $websiteType = $websiteTypes[$details->$websiteTypeId];
1282 $values[$index] = "<a href=\"$url\">{$details->$detailName} ( {$websiteType} )</a>";
1285 $values[$index] = '';
1290 if ((CRM_Utils_Array
::value('visibility', $field) == 'Public Pages and Listings') &&
1291 CRM_Core_Permission
::check('profile listings and forms')
1294 if (CRM_Utils_System
::isNull($params[$index])) {
1295 $params[$index] = $values[$index];
1297 if (!isset($params[$index])) {
1300 if (!$customFieldName) {
1301 $fieldName = $field['name'];
1304 $fieldName = $customFieldName;
1308 if (CRM_Core_BAO_CustomField
::getKeyID($field['name'])) {
1309 $htmlType = $field['html_type'];
1310 if ($htmlType == 'Link') {
1311 $url = $params[$index];
1313 elseif (in_array($htmlType, array(
1317 'Multi-Select State/Province',
1318 'Multi-Select Country',
1320 $valSeperator = CRM_Core_DAO
::VALUE_SEPARATOR
;
1321 $selectedOptions = explode($valSeperator, $params[$index]);
1323 foreach ($selectedOptions as $key => $multiOption) {
1325 $url[] = CRM_Utils_System
::url('civicrm/profile',
1326 'reset=1&force=1&gid=' . $field['group_id'] . '&' .
1327 urlencode($fieldName) .
1329 urlencode($multiOption)
1335 $url = CRM_Utils_System
::url('civicrm/profile',
1336 'reset=1&force=1&gid=' . $field['group_id'] . '&' .
1337 urlencode($fieldName) .
1339 urlencode($params[$index])
1344 $url = CRM_Utils_System
::url('civicrm/profile',
1345 'reset=1&force=1&gid=' . $field['group_id'] . '&' .
1346 urlencode($fieldName) .
1348 urlencode($params[$index])
1353 !empty($values[$index]) &&
1357 if (is_array($url) && !empty($url)) {
1359 $eachMultiValue = explode(', ', $values[$index]);
1360 foreach ($eachMultiValue as $key => $valueLabel) {
1361 $links[] = '<a href="' . $url[$key] . '">' . $valueLabel . '</a>';
1363 $values[$index] = implode(', ', $links);
1366 $values[$index] = '<a href="' . $url . '">' . $values[$index] . '</a>';
1374 * Check if profile Group used by any module.
1382 public static function usedByModule($id) {
1383 //check whether this group is used by any module(check uf join records)
1385 FROM civicrm_uf_join
1386 WHERE civicrm_uf_join.uf_group_id=$id";
1388 $dao = new CRM_Core_DAO();
1390 if ($dao->fetch()) {
1399 * Delete the profile Group.
1407 public static function del($id) {
1408 //check whether this group contains any profile fields
1409 $profileField = new CRM_Core_DAO_UFField();
1410 $profileField->uf_group_id
= $id;
1411 $profileField->find();
1412 while ($profileField->fetch()) {
1413 CRM_Core_BAO_UFField
::del($profileField->id
);
1416 //delete records from uf join table
1417 $ufJoin = new CRM_Core_DAO_UFJoin();
1418 $ufJoin->uf_group_id
= $id;
1421 //delete profile group
1422 $group = new CRM_Core_DAO_UFGroup();
1431 * @param array $params
1432 * Reference array contains the values submitted by the form.
1434 * Reference array contains the id.
1439 public static function add(&$params, $ids = array()) {
1449 foreach ($fields as $field) {
1450 $params[$field] = CRM_Utils_Array
::value($field, $params, FALSE);
1453 $params['limit_listings_group_id'] = CRM_Utils_Array
::value('group', $params);
1454 $params['add_to_group_id'] = CRM_Utils_Array
::value('add_contact_to_group', $params);
1457 if (!empty($params['group_type']) && is_array($params['group_type'])) {
1458 $params['group_type'] = implode(',', $params['group_type']);
1460 $ufGroup = new CRM_Core_DAO_UFGroup();
1461 $ufGroup->copyValues($params);
1463 $ufGroupID = CRM_Utils_Array
::value('ufgroup', $ids, CRM_Utils_Array
::value('id', $params));
1465 $ufGroup->name
= CRM_Utils_String
::munge($ufGroup->title
, '_', 56);
1467 $ufGroup->id
= $ufGroupID;
1472 $ufGroup->name
= $ufGroup->name
. "_{$ufGroup->id}";
1480 * Make uf join entries for an uf group.
1482 * @param array $params
1483 * (reference) an assoc array of name/value pairs.
1484 * @param int $ufGroupId
1489 public static function createUFJoin(&$params, $ufGroupId) {
1490 $groupTypes = CRM_Utils_Array
::value('uf_group_type', $params);
1492 // get ufjoin records for uf group
1493 $ufGroupRecord = CRM_Core_BAO_UFGroup
::getUFJoinRecord($ufGroupId);
1495 // get the list of all ufgroup types
1496 $allUFGroupType = CRM_Core_SelectValues
::ufGroupTypes();
1498 // this fix is done to prevent warning generated by array_key_exits incase of empty array is given as input
1499 if (!is_array($groupTypes)) {
1500 $groupTypes = array();
1503 // this fix is done to prevent warning generated by array_key_exits incase of empty array is given as input
1504 if (!is_array($ufGroupRecord)) {
1505 $ufGroupRecord = array();
1508 // check which values has to be inserted/deleted for contact
1509 $menuRebuild = FALSE;
1510 foreach ($allUFGroupType as $key => $value) {
1511 $joinParams = array();
1512 $joinParams['uf_group_id'] = $ufGroupId;
1513 $joinParams['module'] = $key;
1514 if ($key == 'User Account') {
1515 $menuRebuild = TRUE;
1517 if (array_key_exists($key, $groupTypes) && !in_array($key, $ufGroupRecord)) {
1518 // insert a new record
1519 CRM_Core_BAO_UFGroup
::addUFJoin($joinParams);
1521 elseif (!array_key_exists($key, $groupTypes) && in_array($key, $ufGroupRecord)) {
1522 // delete a record for existing ufgroup
1523 CRM_Core_BAO_UFGroup
::delUFJoin($joinParams);
1529 UPDATE civicrm_uf_join
1531 WHERE uf_group_id = %2
1532 AND ( entity_id IS NULL OR entity_id <= 0 )
1535 1 => array($params['weight'], 'Integer'),
1536 2 => array($ufGroupId, 'Integer'),
1538 CRM_Core_DAO
::executeQuery($query, $p);
1540 // do a menu rebuild if we are on drupal, so it gets all the new menu entries
1542 $config = CRM_Core_Config
::singleton();
1544 $config->userSystem
->is_drupal
1551 * Get the UF Join records for an ufgroup id.
1553 * @param int $ufGroupId
1555 * @param int $displayName
1556 * If set return display name in array.
1557 * @param int $status
1558 * If set return module other than default modules (User Account/User registration/Profile).
1563 public static function getUFJoinRecord($ufGroupId = NULL, $displayName = NULL, $status = NULL) {
1565 $UFGroupType = array();
1566 $UFGroupType = CRM_Core_SelectValues
::ufGroupTypes();
1570 $dao = new CRM_Core_DAO_UFJoin();
1573 $dao->uf_group_id
= $ufGroupId;
1579 while ($dao->fetch()) {
1580 if (!$displayName) {
1581 $ufJoin[$dao->id
] = $dao->module
;
1584 if (isset($UFGroupType[$dao->module
])) {
1585 // skip the default modules
1587 $ufJoin[$dao->id
] = $UFGroupType[$dao->module
];
1589 // added for CRM-1475
1591 elseif (!CRM_Utils_Array
::key($dao->module
, $ufJoin)) {
1592 $ufJoin[$dao->id
] = $dao->module
;
1600 * Function takes an associative array and creates a ufjoin record for ufgroup.
1602 * @param array $params
1603 * (reference) an assoc array of name/value pairs.
1605 * @return CRM_Core_BAO_UFJoin
1607 public static function addUFJoin(&$params) {
1608 $ufJoin = new CRM_Core_DAO_UFJoin();
1609 $ufJoin->copyValues($params);
1615 * Delete the uf join record for an uf group.
1617 * @param array $params
1618 * (reference) an assoc array of name/value pairs.
1622 public static function delUFJoin(&$params) {
1623 $ufJoin = new CRM_Core_DAO_UFJoin();
1624 $ufJoin->copyValues($params);
1629 * Get the weight for ufjoin record.
1631 * @param int $ufGroupId
1632 * If $ufGroupId get update weight or add weight.
1635 * weight of the UFGroup
1637 public static function getWeight($ufGroupId = NULL) {
1638 //calculate the weight
1641 $queryString = "SELECT ( MAX(civicrm_uf_join.weight)+1) as new_weight
1642 FROM civicrm_uf_join
1643 WHERE module = 'User Registration' OR module = 'User Account' OR module = 'Profile'";
1646 $queryString = "SELECT MAX(civicrm_uf_join.weight) as new_weight
1647 FROM civicrm_uf_join
1648 WHERE civicrm_uf_join.uf_group_id = %1
1649 AND ( entity_id IS NULL OR entity_id <= 0 )";
1650 $p[1] = array($ufGroupId, 'Integer');
1653 $dao = CRM_Core_DAO
::executeQuery($queryString, $p);
1655 return ($dao->new_weight
) ?
$dao->new_weight
: 1;
1659 * Get the uf group for a module.
1661 * @param string $moduleName
1664 * No to increment the weight.
1665 * @param bool $skipPermission
1667 * Which operation (view, edit, create, etc) to check permission for.
1668 * @param array|NULL $returnFields list of UFGroup fields to return; NULL for default
1671 * array of ufgroups for a module
1673 public static function getModuleUFGroup($moduleName = NULL, $count = 0, $skipPermission = TRUE, $op = CRM_Core_Permission
::VIEW
, $returnFields = NULL) {
1674 $selectFields = array('id', 'title', 'created_id', 'is_active', 'is_reserved', 'group_type');
1676 if (!CRM_Core_Config
::isUpgradeMode()) {
1677 // CRM-13555, since description field was added later (4.4), and to avoid any problems with upgrade
1678 $selectFields[] = 'description';
1681 if (!empty($returnFields)) {
1682 $selectFields = array_merge($returnFields, array_diff($selectFields, $returnFields));
1685 $queryString = 'SELECT civicrm_uf_group.' . implode(', civicrm_uf_group.', $selectFields) . '
1686 FROM civicrm_uf_group
1687 LEFT JOIN civicrm_uf_join ON (civicrm_uf_group.id = uf_group_id)';
1690 $queryString .= ' AND civicrm_uf_group.is_active = 1
1691 WHERE civicrm_uf_join.module = %2';
1692 $p[2] = array($moduleName, 'String');
1695 // add permissioning for profiles only if not registration
1696 if (!$skipPermission) {
1697 $permissionClause = CRM_Core_Permission
::ufGroupClause($op, 'civicrm_uf_group.');
1698 if (strpos($queryString, 'WHERE') !== FALSE) {
1699 $queryString .= " AND $permissionClause ";
1702 $queryString .= " $permissionClause ";
1706 $queryString .= ' ORDER BY civicrm_uf_join.weight, civicrm_uf_group.title';
1707 $dao = CRM_Core_DAO
::executeQuery($queryString, $p);
1709 $ufGroups = array();
1710 while ($dao->fetch()) {
1711 //skip mix profiles in user Registration / User Account
1712 if (($moduleName == 'User Registration' ||
$moduleName == 'User Account') &&
1713 CRM_Core_BAO_UFField
::checkProfileType($dao->id
)
1717 foreach ($selectFields as $key => $field) {
1718 if ($field == 'id') {
1721 $ufGroups[$dao->id
][$field] = $dao->$field;
1725 // Allow other modules to alter/override the UFGroups.
1726 CRM_Utils_Hook
::buildUFGroupsForModule($moduleName, $ufGroups);
1732 * Filter ufgroups based on logged in user contact type.
1734 * @param int $ufGroupId
1735 * Uf group id (profile id).
1736 * @param int $contactID
1741 public static function filterUFGroups($ufGroupId, $contactID = NULL) {
1743 $session = CRM_Core_Session
::singleton();
1744 $contactID = $session->get('userID');
1748 //get the contact type
1749 $contactType = CRM_Contact_BAO_Contact
::getContactType($contactID);
1751 //match if exixting contact type is same as profile contact type
1752 $profileType = CRM_Core_BAO_UFField
::getProfileType($ufGroupId);
1754 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
1755 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
1758 //allow special mix profiles for Contribution and Participant
1759 $specialProfiles = array('Contribution', 'Participant', 'Membership');
1761 if (in_array($profileType, $specialProfiles)) {
1765 if (($contactType == $profileType) ||
$profileType == 'Contact') {
1774 * Add profile field to a form.
1776 * @param CRM_Core_Form $form
1777 * @param array $field
1781 * @param int $contactId
1782 * @param bool $online
1783 * @param string $usedFor
1784 * For building up prefixed fieldname for special cases (e.g. onBehalf, Honor).
1785 * @param int $rowNumber
1786 * @param string $prefix
1790 public static function buildProfile(
1800 $defaultValues = array();
1801 $fieldName = $field['name'];
1802 $title = $field['title'];
1803 $attributes = $field['attributes'];
1804 $rule = $field['rule'];
1805 $view = $field['is_view'];
1806 $required = ($mode == CRM_Profile_Form
::MODE_SEARCH
) ?
FALSE : $field['is_required'];
1807 $search = ($mode == CRM_Profile_Form
::MODE_SEARCH
) ?
TRUE : FALSE;
1808 $isShared = CRM_Utils_Array
::value('is_shared', $field, 0);
1810 // do not display view fields in drupal registration form
1812 if ($view && $mode == CRM_Profile_Form
::MODE_REGISTER
) {
1816 if ($usedFor == 'onbehalf') {
1817 $name = "onbehalf[$fieldName]";
1819 elseif ($usedFor == 'honor') {
1820 $name = "honor[$fieldName]";
1822 elseif ($contactId && !$online) {
1823 $name = "field[$contactId][$fieldName]";
1825 elseif ($rowNumber) {
1826 $name = "field[$rowNumber][$fieldName]";
1828 elseif (!empty($prefix)) {
1829 $name = $prefix . "[$fieldName]";
1835 $selectAttributes = array('class' => 'crm-select2', 'placeholder' => TRUE);
1837 if ($fieldName == 'image_URL' && $mode == CRM_Profile_Form
::MODE_EDIT
) {
1838 $deleteExtra = json_encode(ts('Are you sure you want to delete contact image.'));
1840 CRM_Core_Action
::DELETE
=> array(
1841 'name' => ts('Delete Contact Image'),
1842 'url' => 'civicrm/contact/image',
1843 'qs' => 'reset=1&id=%%id%%&gid=%%gid%%&action=delete',
1844 'extra' => 'onclick = "' . htmlspecialchars("if (confirm($deleteExtra)) this.href+='&confirmed=1'; else return false;") . '"',
1847 $deleteURL = CRM_Core_Action
::formLink($deleteURL,
1848 CRM_Core_Action
::DELETE
,
1850 'id' => $form->get('id'),
1851 'gid' => $form->get('gid'),
1855 'contact.profileimage.delete',
1859 $form->assign('deleteURL', $deleteURL);
1861 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
1862 'address_options', TRUE, NULL, TRUE
1865 if (substr($fieldName, 0, 14) === 'state_province') {
1866 $form->addChainSelect($name, array('label' => $title, 'required' => $required));
1867 $config = CRM_Core_Config
::singleton();
1868 if (!in_array($mode, array(
1869 CRM_Profile_Form
::MODE_EDIT
,
1870 CRM_Profile_Form
::MODE_SEARCH
,
1872 $config->defaultContactStateProvince
1874 $defaultValues[$name] = $config->defaultContactStateProvince
;
1875 $form->setDefaults($defaultValues);
1878 elseif (substr($fieldName, 0, 7) === 'country') {
1879 $form->add('select', $name, $title, array('' => ts('- select -')) + CRM_Core_PseudoConstant
::country(), $required, $selectAttributes);
1880 $config = CRM_Core_Config
::singleton();
1881 if (!in_array($mode, array(
1882 CRM_Profile_Form
::MODE_EDIT
,
1883 CRM_Profile_Form
::MODE_SEARCH
,
1885 $config->defaultContactCountry
1887 $defaultValues[$name] = $config->defaultContactCountry
;
1888 $form->setDefaults($defaultValues);
1891 elseif (substr($fieldName, 0, 6) === 'county') {
1892 if ($addressOptions['county']) {
1893 $form->addChainSelect($name, array('label' => $title, 'required' => $required));
1896 elseif (substr($fieldName, 0, 9) === 'image_URL') {
1897 $form->add('file', $name, $title, $attributes, $required);
1898 $form->addUploadElement($name);
1900 elseif (substr($fieldName, 0, 2) === 'im') {
1901 $form->add('text', $name, $title, $attributes, $required);
1904 if (substr($name, -1) == ']') {
1905 $providerName = substr($name, 0, -1) . '-provider_id]';
1907 $form->add('select', $providerName, NULL,
1909 '' => ts('- select -'),
1910 ) + CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id'), $required
1914 $form->add('select', $name . '-provider_id', $title,
1916 '' => ts('- select -'),
1917 ) + CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id'), $required
1921 if ($view && $mode != CRM_Profile_Form
::MODE_SEARCH
) {
1922 $form->freeze($name . '-provider_id');
1926 elseif (($fieldName === 'birth_date') ||
($fieldName === 'deceased_date')) {
1927 $form->addDate($name, $title, $required, array('formatType' => 'birth'));
1929 elseif (in_array($fieldName, array(
1930 'membership_start_date',
1931 'membership_end_date',
1934 $form->addDate($name, $title, $required, array('formatType' => 'activityDate'));
1936 elseif (CRM_Utils_Array
::value('name', $field) == 'membership_type') {
1937 list($orgInfo, $types) = CRM_Member_BAO_MembershipType
::getMembershipTypeInfo();
1938 $sel = &$form->addElement('hierselect', $name, $title);
1939 $select = array('' => ts('- select -'));
1940 if (count($orgInfo) == 1 && $field['is_required']) {
1941 // we only have one org - so we should default to it. Not sure about defaulting to first type
1942 // as it could be missed - so adding a select
1943 // however, possibly that is more similar to the membership form
1944 if (count($types[1]) > 1) {
1945 $types[1] = $select +
$types[1];
1949 $orgInfo = $select +
$orgInfo;
1951 $sel->setOptions(array($orgInfo, $types));
1953 elseif (CRM_Utils_Array
::value('name', $field) == 'membership_status') {
1954 $form->add('select', $name, $title,
1956 '' => ts('- select -'),
1957 ) + CRM_Member_PseudoConstant
::membershipStatus(NULL, NULL, 'label'), $required
1960 elseif (in_array($fieldName, array('gender_id', 'communication_style_id'))) {
1962 $pseudoValues = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', $fieldName);
1963 foreach ($pseudoValues as $key => $var) {
1964 $options[$key] = $form->createElement('radio', NULL, ts($title), $var, $key);
1966 $group = $form->addGroup($options, $name, $title);
1968 $form->addRule($name, ts('%1 is a required field.', array(1 => $title)), 'required');
1971 $group->setAttribute('allowClear', TRUE);
1974 elseif ($fieldName === 'prefix_id' ||
$fieldName === 'suffix_id') {
1975 $form->addSelect($name, array(
1977 'entity' => 'contact',
1978 'field' => $fieldName,
1980 'placeholder' => '',
1983 elseif ($fieldName === 'contact_sub_type') {
1984 $gId = $form->get('gid') ?
$form->get('gid') : CRM_Utils_Array
::value('group_id', $field);
1985 if ($usedFor == 'onbehalf') {
1986 $profileType = 'Organization';
1988 elseif ($usedFor == 'honor') {
1989 $profileType = CRM_Core_BAO_UFField
::getProfileType($form->_params
['honoree_profile_id']);
1992 $profileType = $gId ? CRM_Core_BAO_UFField
::getProfileType($gId) : NULL;
1993 if ($profileType == 'Contact') {
1994 $profileType = 'Individual';
1998 $setSubtype = FALSE;
1999 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
2000 $setSubtype = $profileType;
2001 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
2004 $subtypes = $profileType ? CRM_Contact_BAO_ContactType
::subTypePairs($profileType) : array();
2007 $subtypeList = array();
2008 $subtypeList[$setSubtype] = $subtypes[$setSubtype];
2011 $subtypeList = $subtypes;
2014 $sel = $form->add('select', $name, $title, $subtypeList, $required);
2015 $sel->setMultiple(TRUE);
2017 elseif (in_array($fieldName, CRM_Contact_BAO_Contact
::$_greetingTypes)) {
2018 //add email greeting, postal greeting, addressee, CRM-4575
2019 $gId = $form->get('gid') ?
$form->get('gid') : CRM_Utils_Array
::value('group_id', $field);
2020 $profileType = CRM_Core_BAO_UFField
::getProfileType($gId, TRUE, FALSE, TRUE);
2022 if (empty($profileType) ||
in_array($profileType, array(
2029 $profileType = 'Individual';
2031 if (CRM_Contact_BAO_ContactType
::isaSubType($profileType)) {
2032 $profileType = CRM_Contact_BAO_ContactType
::getBasicType($profileType);
2035 'contact_type' => $profileType,
2036 'greeting_type' => $fieldName,
2038 $form->add('select', $name, $title,
2040 '' => ts('- select -'),
2041 ) + CRM_Core_PseudoConstant
::greeting($greeting), $required
2043 // add custom greeting element
2044 $form->add('text', $fieldName . '_custom', ts('Custom %1', array(1 => ucwords(str_replace('_', ' ', $fieldName)))),
2048 elseif ($fieldName === 'preferred_communication_method') {
2049 $communicationFields = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'preferred_communication_method');
2050 foreach ($communicationFields as $key => $var) {
2054 $communicationOptions[] = $form->createElement('checkbox', $key, NULL, $var);
2056 $form->addGroup($communicationOptions, $name, $title, '<br/>');
2058 elseif ($fieldName === 'preferred_mail_format') {
2059 $form->add('select', $name, $title, CRM_Core_SelectValues
::pmf());
2061 elseif ($fieldName === 'preferred_language') {
2062 $form->add('select', $name, $title, array('' => ts('- select -')) + CRM_Contact_BAO_Contact
::buildOptions('preferred_language'));
2064 elseif ($fieldName == 'external_identifier') {
2065 $form->add('text', $name, $title, $attributes, $required);
2066 $contID = $contactId;
2068 $contID = $form->get('id');
2070 $form->addRule($name,
2071 ts('External ID already exists in Database.'),
2073 array('CRM_Contact_DAO_Contact', $contID, 'external_identifier')
2076 elseif ($fieldName === 'group') {
2077 CRM_Contact_Form_Edit_TagsAndGroups
::buildQuickForm($form, $contactId,
2078 CRM_Contact_Form_Edit_TagsAndGroups
::GROUP
,
2083 elseif ($fieldName === 'tag') {
2084 CRM_Contact_Form_Edit_TagsAndGroups
::buildQuickForm($form, $contactId,
2085 CRM_Contact_Form_Edit_TagsAndGroups
::TAG
,
2090 elseif (substr($fieldName, 0, 4) === 'url-') {
2091 $form->add('text', $name, $title, CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Website', 'url'), $required);
2092 $form->addRule($name, ts('Enter a valid web address beginning with \'http://\' or \'https://\'.'), 'url');
2094 // Note should be rendered as textarea
2095 elseif (substr($fieldName, -4) == 'note') {
2096 $form->add('textarea', $name, $title, $attributes, $required);
2098 elseif (substr($fieldName, 0, 6) === 'custom') {
2099 $customFieldID = CRM_Core_BAO_CustomField
::getKeyID($fieldName);
2100 if ($customFieldID) {
2101 CRM_Core_BAO_CustomField
::addQuickFormElement($form, $name, $customFieldID, FALSE, $required, $search, $title);
2104 elseif (substr($fieldName, 0, 14) === 'address_custom') {
2105 list($fName, $locTypeId) = CRM_Utils_System
::explode('-', $fieldName, 2);
2106 $customFieldID = CRM_Core_BAO_CustomField
::getKeyID(substr($fName, 8));
2107 if ($customFieldID) {
2108 CRM_Core_BAO_CustomField
::addQuickFormElement($form, $name, $customFieldID, FALSE, $required, $search, $title);
2111 elseif (in_array($fieldName, array(
2117 $form->addDateTime($name, $title, $required, array('formatType' => 'activityDateTime'));
2119 elseif ($fieldName == 'send_receipt') {
2120 $form->addElement('checkbox', $name, $title);
2122 elseif ($fieldName == 'soft_credit') {
2123 $form->addEntityRef("soft_credit_contact_id[$rowNumber]", ts('Soft Credit To'), array('create' => TRUE));
2124 $form->addMoney("soft_credit_amount[{$rowNumber}]", ts('Amount'), FALSE, NULL, FALSE);
2126 elseif ($fieldName == 'product_name') {
2127 list($products, $options) = CRM_Contribute_BAO_Premium
::getPremiumProductInfo();
2128 $sel = &$form->addElement('hierselect', $name, $title);
2130 '0' => ts('- select -'),
2132 $sel->setOptions(array($products, $options));
2134 elseif ($fieldName == 'payment_instrument') {
2135 $form->add('select', $name, $title,
2136 array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::paymentInstrument(), $required);
2138 elseif ($fieldName == 'financial_type') {
2139 $form->add('select', $name, $title,
2141 '' => ts('- select -'),
2142 ) + CRM_Contribute_PseudoConstant
::financialType(), $required
2145 elseif ($fieldName == 'contribution_status_id') {
2146 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus();
2147 $statusName = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
2153 unset($contributionStatuses[CRM_Utils_Array
::key($suppress, $statusName)]);
2156 $form->add('select', $name, $title,
2158 '' => ts('- select -'),
2159 ) +
$contributionStatuses, $required
2162 elseif ($fieldName == 'soft_credit_type') {
2163 $name = "soft_credit_type[$rowNumber]";
2164 $form->add('select', $name, $title,
2166 '' => ts('- select -'),
2167 ) + CRM_Core_OptionGroup
::values("soft_credit_type")
2169 //CRM-15350: choose SCT field default value as 'Gift' for membership use
2170 //else (for contribution), use configured SCT default value
2171 $SCTDefaultValue = CRM_Core_OptionGroup
::getDefaultValue("soft_credit_type");
2172 if ($field['field_type'] == 'Membership') {
2173 $SCTDefaultValue = CRM_Core_OptionGroup
::getValue('soft_credit_type', 'Gift', 'name');
2175 $form->addElement('hidden', 'sct_default_id', $SCTDefaultValue, array('id' => 'sct_default_id'));
2177 elseif ($fieldName == 'currency') {
2178 $form->addCurrency($name, $title, $required);
2180 elseif ($fieldName == 'contribution_page_id') {
2181 $form->add('select', $name, $title,
2183 '' => ts('- select -'),
2184 ) + CRM_Contribute_PseudoConstant
::contributionPage(), $required, 'class="big"'
2187 elseif ($fieldName == 'participant_register_date') {
2188 $form->addDateTime($name, $title, $required, array('formatType' => 'activityDateTime'));
2190 elseif ($fieldName == 'activity_status_id') {
2191 $form->add('select', $name, $title,
2193 '' => ts('- select -'),
2194 ) + CRM_Core_PseudoConstant
::activityStatus(), $required
2197 elseif ($fieldName == 'activity_engagement_level') {
2198 $form->add('select', $name, $title,
2200 '' => ts('- select -'),
2201 ) + CRM_Campaign_PseudoConstant
::engagementLevel(), $required
2204 elseif ($fieldName == 'activity_date_time') {
2205 $form->addDateTime($name, $title, $required, array('formatType' => 'activityDateTime'));
2207 elseif ($fieldName == 'participant_status') {
2209 if ($online == TRUE) {
2210 $cond = 'visibility_id = 1';
2212 $form->add('select', $name, $title,
2214 '' => ts('- select -'),
2215 ) + CRM_Event_PseudoConstant
::participantStatus(NULL, $cond, 'label'), $required
2218 elseif ($fieldName == 'participant_role') {
2219 if (!empty($field['is_multiple'])) {
2220 $form->addCheckBox($name, $title, CRM_Event_PseudoConstant
::participantRole(), NULL, NULL, NULL, NULL, ' ', TRUE);
2223 $form->add('select', $name, $title,
2225 '' => ts('- select -'),
2226 ) + CRM_Event_PseudoConstant
::participantRole(), $required
2230 elseif ($fieldName == 'world_region') {
2231 $form->add('select', $name, $title, CRM_Core_PseudoConstant
::worldRegion(), $required, $selectAttributes);
2233 elseif ($fieldName == 'signature_html') {
2234 $form->add('wysiwyg', $name, $title, CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Email', $fieldName));
2236 elseif ($fieldName == 'signature_text') {
2237 $form->add('textarea', $name, $title, CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Email', $fieldName));
2239 elseif (substr($fieldName, -11) == 'campaign_id') {
2240 if (CRM_Campaign_BAO_Campaign
::isCampaignEnable()) {
2241 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(CRM_Utils_Array
::value($contactId,
2242 $form->_componentCampaigns
2244 $form->add('select', $name, $title,
2246 '' => ts('- select -'),
2247 ) +
$campaigns, $required, 'class="crm-select2 big"'
2251 elseif ($fieldName == 'activity_details') {
2252 $form->add('wysiwyg', $fieldName, $title, array('rows' => 4, 'cols' => 60), $required);
2254 elseif ($fieldName == 'activity_duration') {
2255 $form->add('text', $name, $title, $attributes, $required);
2256 $form->addRule($name, ts('Please enter the duration as number of minutes (integers only).'), 'positiveInteger');
2259 if (substr($fieldName, 0, 3) === 'is_' or substr($fieldName, 0, 7) === 'do_not_') {
2260 $form->add('advcheckbox', $name, $title, $attributes, $required);
2263 $form->add('text', $name, $title, $attributes, $required);
2267 static $hiddenSubtype = FALSE;
2268 if (!$hiddenSubtype && CRM_Contact_BAO_ContactType
::isaSubType($field['field_type'])) {
2269 // In registration mode params are submitted via POST and we don't have any clue
2270 // about profile-id or the profile-type (which could be a subtype)
2271 // To generalize the behavior and simplify the process,
2272 // lets always add the hidden
2273 //subtype value if there is any, and we won't have to
2274 // compute it while processing.
2276 $form->addElement('hidden', $usedFor . '[contact_sub_type]', $field['field_type']);
2279 $form->addElement('hidden', 'contact_sub_type_hidden', $field['field_type']);
2281 $hiddenSubtype = TRUE;
2284 if (($view && $mode != CRM_Profile_Form
::MODE_SEARCH
) ||
$isShared) {
2285 $form->freeze($name);
2289 if (in_array($fieldName, array(
2290 'non_deductible_amount',
2295 $form->addRule($name, ts('Please enter a valid amount.'), 'money');
2298 if (!($rule == 'email' && $mode == CRM_Profile_Form
::MODE_SEARCH
)) {
2299 $form->addRule($name, ts('Please enter a valid %1', array(1 => $title)), $rule);
2305 * Set profile defaults.
2307 * @param int $contactId
2309 * @param array $fields
2310 * Associative array of fields.
2311 * @param array $defaults
2313 * @param bool $singleProfile
2314 * True for single profile else false(batch update).
2315 * @param int $componentId
2316 * Id for specific components like contribute, event etc.
2317 * @param null $component
2319 public static function setProfileDefaults(
2320 $contactId, &$fields, &$defaults,
2321 $singleProfile = TRUE, $componentId = NULL, $component = NULL
2323 if (!$componentId) {
2324 //get the contact details
2325 list($contactDetails, $options) = CRM_Contact_BAO_Contact
::getHierContactDetails($contactId, $fields);
2326 $details = CRM_Utils_Array
::value($contactId, $contactDetails);
2327 $multipleFields = array('website' => 'url');
2329 //start of code to set the default values
2330 foreach ($fields as $name => $field) {
2331 // skip pseudo fields
2332 if (substr($name, 0, 9) == 'phone_ext') {
2336 //set the field name depending upon the profile mode(single/batch)
2337 if ($singleProfile) {
2341 $fldName = "field[$contactId][$name]";
2344 if ($name == 'group') {
2345 CRM_Contact_Form_Edit_TagsAndGroups
::setDefaults($contactId, $defaults, CRM_Contact_Form_Edit_TagsAndGroups
::GROUP
, $fldName);
2347 if ($name == 'tag') {
2348 CRM_Contact_Form_Edit_TagsAndGroups
::setDefaults($contactId, $defaults, CRM_Contact_Form_Edit_TagsAndGroups
::TAG
, $fldName);
2351 if (!empty($details[$name]) ||
isset($details[$name])) {
2352 //to handle custom data (checkbox) to be written
2353 // to handle birth/deceased date, greeting_type and few other fields
2354 if (($name == 'birth_date') ||
($name == 'deceased_date')) {
2355 list($defaults[$fldName]) = CRM_Utils_Date
::setDateDefaults($details[$name], 'birth');
2357 elseif (in_array($name, CRM_Contact_BAO_Contact
::$_greetingTypes)) {
2358 $defaults[$fldName] = $details[$name . '_id'];
2359 $defaults[$name . '_custom'] = $details[$name . '_custom'];
2361 elseif ($name == 'preferred_communication_method') {
2362 $v = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $details[$name]);
2363 foreach ($v as $item) {
2365 $defaults[$fldName . "[$item]"] = 1;
2369 elseif ($name == 'contact_sub_type') {
2370 $defaults[$fldName] = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, trim($details[$name], CRM_Core_DAO
::VALUE_SEPARATOR
));
2372 elseif ($name == 'world_region') {
2373 $defaults[$fldName] = $details['worldregion_id'];
2375 elseif ($customFieldId = CRM_Core_BAO_CustomField
::getKeyID($name)) {
2376 //fix for custom fields
2377 $customFields = CRM_Core_BAO_CustomField
::getFields(CRM_Utils_Array
::value('contact_type', $details));
2379 // hack to add custom data for components
2380 $components = array('Contribution', 'Participant', 'Membership', 'Activity');
2381 foreach ($components as $value) {
2382 $customFields = CRM_Utils_Array
::crmArrayMerge($customFields,
2383 CRM_Core_BAO_CustomField
::getFieldsForImport($value)
2387 switch ($customFields[$customFieldId]['html_type']) {
2388 case 'Multi-Select State/Province':
2389 case 'Multi-Select Country':
2390 case 'AdvMulti-Select':
2391 case 'Multi-Select':
2392 $v = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $details[$name]);
2393 foreach ($v as $item) {
2395 $defaults[$fldName][$item] = $item;
2401 $v = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $details[$name]);
2402 foreach ($v as $item) {
2404 $defaults[$fldName][$item] = 1;
2405 // seems like we need this for QF style checkboxes in profile where its multiindexed
2407 $defaults["{$fldName}[{$item}]"] = 1;
2413 // CRM-6681, set defult values according to date and time format (if any).
2415 if (!empty($customFields[$customFieldId]['date_format'])) {
2416 $dateFormat = $customFields[$customFieldId]['date_format'];
2419 if (empty($customFields[$customFieldId]['time_format'])) {
2420 list($defaults[$fldName]) = CRM_Utils_Date
::setDateDefaults($details[$name], NULL,
2425 $timeElement = $fldName . '_time';
2426 if (substr($fldName, -1) == ']') {
2427 $timeElement = substr($fldName, 0, -1) . '_time]';
2429 list($defaults[$fldName], $defaults[$timeElement]) = CRM_Utils_Date
::setDateDefaults($details[$name],
2430 NULL, $dateFormat, $customFields[$customFieldId]['time_format']);
2435 $defaults[$fldName] = $details[$name];
2440 $defaults[$fldName] = $details[$name];
2444 $blocks = array('email', 'phone', 'im', 'openid');
2445 list($fieldName, $locTypeId, $phoneTypeId) = CRM_Utils_System
::explode('-', $name, 3);
2446 if (!in_array($fieldName, $multipleFields)) {
2447 if (is_array($details)) {
2448 foreach ($details as $key => $value) {
2449 // when we fixed CRM-5319 - get primary loc
2450 // type as per loc field and removed below code.
2451 $primaryLocationType = FALSE;
2452 if ($locTypeId == 'Primary') {
2453 if (is_array($value) && array_key_exists($fieldName, $value)) {
2454 $primaryLocationType = TRUE;
2455 if (in_array($fieldName, $blocks)) {
2456 $locTypeId = CRM_Contact_BAO_Contact
::getPrimaryLocationType($contactId, FALSE, $fieldName);
2459 $locTypeId = CRM_Contact_BAO_Contact
::getPrimaryLocationType($contactId, FALSE, 'address');
2464 // fixed for CRM-665
2465 if (is_numeric($locTypeId)) {
2466 if ($primaryLocationType ||
$locTypeId == CRM_Utils_Array
::value('location_type_id', $value)) {
2467 if (!empty($value[$fieldName])) {
2468 //to handle stateprovince and country
2469 if ($fieldName == 'state_province') {
2470 $defaults[$fldName] = $value['state_province_id'];
2472 elseif ($fieldName == 'county') {
2473 $defaults[$fldName] = $value['county_id'];
2475 elseif ($fieldName == 'country') {
2476 if (!isset($value['country_id']) ||
!$value['country_id']) {
2477 $config = CRM_Core_Config
::singleton();
2478 if ($config->defaultContactCountry
) {
2479 $defaults[$fldName] = $config->defaultContactCountry
;
2483 $defaults[$fldName] = $value['country_id'];
2486 elseif ($fieldName == 'phone') {
2488 if (isset($value['phone'][$phoneTypeId])) {
2489 $defaults[$fldName] = $value['phone'][$phoneTypeId];
2491 if (isset($value['phone_ext'][$phoneTypeId])) {
2492 $defaults[str_replace('phone', 'phone_ext', $fldName)] = $value['phone_ext'][$phoneTypeId];
2496 $phoneDefault = CRM_Utils_Array
::value('phone', $value);
2498 if (!is_array($phoneDefault)) {
2499 $defaults[$fldName] = $phoneDefault;
2503 elseif ($fieldName == 'email') {
2504 //adding the first email (currently we don't support multiple emails of same location type)
2505 $defaults[$fldName] = $value['email'];
2507 elseif ($fieldName == 'im') {
2508 //adding the first im (currently we don't support multiple ims of same location type)
2509 $defaults[$fldName] = $value['im'];
2510 $defaults[$fldName . '-provider_id'] = $value['im_provider_id'];
2513 $defaults[$fldName] = $value[$fieldName];
2516 elseif (substr($fieldName, 0, 14) === 'address_custom' &&
2517 CRM_Utils_Array
::value(substr($fieldName, 8), $value)
2519 $defaults[$fldName] = $value[substr($fieldName, 8)];
2527 if (is_array($details)) {
2528 if ($fieldName === 'url'
2529 && !empty($details['website'])
2530 && !empty($details['website'][$locTypeId])
2532 $defaults[$fldName] = CRM_Utils_Array
::value('url', $details['website'][$locTypeId]);
2540 //Handling Contribution Part of the batch profile
2541 if (CRM_Core_Permission
::access('CiviContribute') && $component == 'Contribute') {
2542 self
::setComponentDefaults($fields, $componentId, $component, $defaults);
2545 //Handling Event Participation Part of the batch profile
2546 if (CRM_Core_Permission
::access('CiviEvent') && $component == 'Event') {
2547 self
::setComponentDefaults($fields, $componentId, $component, $defaults);
2550 //Handling membership Part of the batch profile
2551 if (CRM_Core_Permission
::access('CiviMember') && $component == 'Membership') {
2552 self
::setComponentDefaults($fields, $componentId, $component, $defaults);
2555 //Handling Activity Part of the batch profile
2556 if ($component == 'Activity') {
2557 self
::setComponentDefaults($fields, $componentId, $component, $defaults);
2562 * Get profiles by type eg: pure Individual etc
2564 * @param array $types
2565 * Associative array of types eg: types('Individual').
2566 * @param bool $onlyPure
2567 * True if only pure profiles are required.
2570 * associative array of profiles
2572 public static function getProfiles($types, $onlyPure = FALSE) {
2573 $profiles = array();
2574 $ufGroups = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_UFField', 'uf_group_id');
2576 CRM_Utils_Hook
::aclGroup(CRM_Core_Permission
::ADMIN
, NULL, 'civicrm_uf_group', $ufGroups, $ufGroups);
2578 // Exclude Batch Data Entry profiles - CRM-10901
2579 $batchProfiles = CRM_Core_BAO_UFGroup
::getBatchProfiles();
2581 foreach ($ufGroups as $id => $title) {
2582 $ptype = CRM_Core_BAO_UFField
::getProfileType($id, FALSE, $onlyPure);
2583 if (in_array($ptype, $types) && !array_key_exists($id, $batchProfiles)) {
2584 $profiles[$id] = $title;
2591 * Check whether a profile is valid combination of
2592 * required and/or optional profile types
2594 * @param array $required
2595 * Array of types those are required.
2596 * @param array $optional
2597 * Array of types those are optional.
2600 * associative array of profiles
2602 public static function getValidProfiles($required, $optional = NULL) {
2603 if (!is_array($required) ||
empty($required)) {
2607 $profiles = array();
2608 $ufGroups = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_UFField', 'uf_group_id');
2610 CRM_Utils_Hook
::aclGroup(CRM_Core_Permission
::ADMIN
, NULL, 'civicrm_uf_group', $ufGroups, $ufGroups);
2612 foreach ($ufGroups as $id => $title) {
2613 $type = CRM_Core_BAO_UFField
::checkValidProfileType($id, $required, $optional);
2615 $profiles[$id] = $title;
2623 * Check whether a profile is valid combination of
2624 * required profile fields
2626 * @param array $ufId
2627 * Integer id of the profile.
2628 * @param array $required
2629 * Array of fields those are required in the profile.
2632 * associative array of profiles
2634 public static function checkValidProfile($ufId, $required = NULL) {
2635 $validProfile = FALSE;
2637 return $validProfile;
2640 if (!CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $ufId, 'is_active')) {
2641 return $validProfile;
2644 $profileFields = self
::getFields($ufId, FALSE, CRM_Core_Action
::VIEW
, NULL,
2645 NULL, FALSE, NULL, FALSE, NULL,
2646 CRM_Core_Permission
::CREATE
, NULL
2649 $validProfile = array();
2650 if (!empty($profileFields)) {
2651 $fields = array_keys($profileFields);
2652 foreach ($fields as $val) {
2653 foreach ($required as $key => $field) {
2654 if (strpos($val, $field) === 0) {
2655 unset($required[$key]);
2660 $validProfile = (empty($required)) ?
TRUE : FALSE;
2663 return $validProfile;
2667 * Get default value for Register.
2669 * @param array $fields
2670 * @param array $defaults
2674 public static function setRegisterDefaults(&$fields, &$defaults) {
2675 $config = CRM_Core_Config
::singleton();
2676 foreach ($fields as $name => $field) {
2677 if (substr($name, 0, 8) == 'country-') {
2678 if (!empty($config->defaultContactCountry
)) {
2679 $defaults[$name] = $config->defaultContactCountry
;
2682 elseif (substr($name, 0, 15) == 'state_province-') {
2683 if (!empty($config->defaultContactStateProvince
)) {
2684 $defaults[$name] = $config->defaultContactStateProvince
;
2692 * make a copy of a profile, including
2693 * all the fields in the profile
2696 * The profile id to copy.
2700 public static function copy($id) {
2701 $fieldsFix = array('prefix' => array('title' => ts('Copy of ')));
2702 $copy = &CRM_Core_DAO
::copyGeneric('CRM_Core_DAO_UFGroup',
2708 if ($pos = strrpos($copy->name
, "_{$id}")) {
2709 $copy->name
= substr_replace($copy->name
, '', $pos);
2711 $copy->name
= CRM_Utils_String
::munge($copy->name
, '_', 56) . "_{$copy->id}";
2714 $copyUFJoin = &CRM_Core_DAO
::copyGeneric('CRM_Core_DAO_UFJoin',
2715 array('uf_group_id' => $id),
2716 array('uf_group_id' => $copy->id
),
2721 $copyUFField = &CRM_Core_DAO
::copyGeneric('CRM_Core_BAO_UFField',
2722 array('uf_group_id' => $id),
2723 array('uf_group_id' => $copy->id
)
2726 $maxWeight = CRM_Utils_Weight
::getMax('CRM_Core_DAO_UFJoin', NULL, 'weight');
2730 UPDATE civicrm_uf_join
2732 WHERE uf_group_id = %2
2733 AND ( entity_id IS NULL OR entity_id <= 0 )
2736 1 => array($maxWeight +
1, 'Integer'),
2737 2 => array($copy->id
, 'Integer'),
2739 CRM_Core_DAO
::executeQuery($query, $p);
2740 if ($copy->is_reserved
) {
2741 $query = "UPDATE civicrm_uf_group SET is_reserved = 0 WHERE id = %1";
2742 $params = array(1 => array($copy->id
, 'Integer'));
2743 CRM_Core_DAO
::executeQuery($query, $params);
2745 CRM_Utils_Hook
::copy('UFGroup', $copy);
2751 * Process that send notification e-mails
2753 * @param int $contactID
2755 * @param array $values
2756 * Associative array of name/value pair.
2760 public static function commonSendMail($contactID, &$values) {
2761 if (!$contactID ||
!$values) {
2765 $template = CRM_Core_Smarty
::singleton();
2767 $displayName = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
2772 self
::profileDisplay($values['id'], $values['values'], $template);
2773 $emailList = explode(',', $values['email']);
2775 $contactLink = CRM_Utils_System
::url('civicrm/contact/view',
2776 "reset=1&cid=$contactID",
2777 TRUE, NULL, FALSE, FALSE, TRUE
2780 //get the default domain email address.
2781 list($domainEmailName, $domainEmailAddress) = CRM_Core_BAO_Domain
::getNameAndEmail();
2783 if (!$domainEmailAddress ||
$domainEmailAddress == 'info@EXAMPLE.ORG') {
2784 $fixUrl = CRM_Utils_System
::url('civicrm/admin/domain', 'action=update&reset=1');
2785 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)));
2788 foreach ($emailList as $emailTo) {
2789 // FIXME: take the below out of the foreach loop
2790 CRM_Core_BAO_MessageTemplate
::sendTemplate(
2792 'groupName' => 'msg_tpl_workflow_uf',
2793 'valueName' => 'uf_notify',
2794 'contactId' => $contactID,
2795 'tplParams' => array(
2796 'displayName' => $displayName,
2797 'currentDate' => date('r'),
2798 'contactLink' => $contactLink,
2800 'from' => "$domainEmailName <$domainEmailAddress>",
2801 'toEmail' => $emailTo,
2808 * Given a contact id and a group id, returns the field values from the db
2809 * for this group and notify email only if group's notify field is
2810 * set and field values are not empty
2816 * @param array $params
2817 * @param bool $skipCheck
2821 public function checkFieldsEmptyValues($gid, $cid, $params, $skipCheck = FALSE) {
2823 if (CRM_Core_BAO_UFGroup
::filterUFGroups($gid, $cid) ||
$skipCheck) {
2825 $fields = CRM_Core_BAO_UFGroup
::getFields($gid, FALSE, CRM_Core_Action
::VIEW
);
2826 CRM_Core_BAO_UFGroup
::getValues($cid, $fields, $values, FALSE, $params, TRUE);
2828 $email = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $gid, 'notify');
2830 if (!empty($values) &&
2835 'values' => $values,
2846 * Assign uf fields to template.
2850 * @param array $values
2851 * @param CRM_Core_Smarty $template
2855 public function profileDisplay($gid, $values, $template) {
2856 $groupTitle = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $gid, 'title');
2857 $template->assign('grouptitle', $groupTitle);
2858 if (count($values)) {
2859 $template->assign('values', $values);
2864 * Format fields for dupe Contact Matching.
2866 * @param array $params
2868 * @param int $contactId
2871 * associated formatted array
2873 public static function formatFields($params, $contactId = NULL) {
2875 // get the primary location type id and email
2876 list($name, $primaryEmail, $primaryLocationType) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contactId);
2879 $defaultLocationType = CRM_Core_BAO_LocationType
::getDefault();
2880 $primaryLocationType = $defaultLocationType->id
;
2884 $locationType = array();
2886 $primaryLocation = 0;
2887 foreach ($params as $key => $value) {
2888 list($fieldName, $locTypeId, $phoneTypeId) = explode('-', $key);
2890 if ($locTypeId == 'Primary') {
2891 $locTypeId = $primaryLocationType;
2894 if (is_numeric($locTypeId)) {
2895 if (!in_array($locTypeId, $locationType)) {
2896 $locationType[$count] = $locTypeId;
2899 $loc = CRM_Utils_Array
::key($locTypeId, $locationType);
2901 $data['location'][$loc]['location_type_id'] = $locTypeId;
2903 // if we are getting in a new primary email, dont overwrite the new one
2904 if ($locTypeId == $primaryLocationType) {
2905 if (!empty($params['email-' . $primaryLocationType])) {
2906 $data['location'][$loc]['email'][$loc]['email'] = $fields['email-' . $primaryLocationType];
2908 elseif (isset($primaryEmail)) {
2909 $data['location'][$loc]['email'][$loc]['email'] = $primaryEmail;
2915 $data['location'][$loc]['is_primary'] = 1;
2917 if ($fieldName == 'phone') {
2919 $data['location'][$loc]['phone'][$loc]['phone_type_id'] = $phoneTypeId;
2922 $data['location'][$loc]['phone'][$loc]['phone_type_id'] = '';
2924 $data['location'][$loc]['phone'][$loc]['phone'] = $value;
2926 elseif ($fieldName == 'email') {
2927 $data['location'][$loc]['email'][$loc]['email'] = $value;
2929 elseif ($fieldName == 'im') {
2930 $data['location'][$loc]['im'][$loc]['name'] = $value;
2933 if ($fieldName === 'state_province') {
2934 $data['location'][$loc]['address']['state_province_id'] = $value;
2936 elseif ($fieldName === 'country') {
2937 $data['location'][$loc]['address']['country_id'] = $value;
2940 $data['location'][$loc]['address'][$fieldName] = $value;
2945 // TODO: prefix, suffix and gender translation may no longer be necessary - check inputs
2946 if ($key === 'individual_suffix') {
2947 $data['suffix_id'] = $value;
2949 elseif ($key === 'individual_prefix') {
2950 $data['prefix_id'] = $value;
2952 elseif ($key === 'gender') {
2953 $data['gender_id'] = $value;
2955 elseif (substr($key, 0, 6) === 'custom') {
2956 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
2958 if ($customFields[$customFieldID]['html_type'] == 'CheckBox') {
2959 $value = implode(CRM_Core_DAO
::VALUE_SEPARATOR
, array_keys($value));
2961 // fix the date field
2962 if ($customFields[$customFieldID]['data_type'] == 'Date') {
2963 $date = CRM_Utils_Date
::format($value);
2970 $data['custom'][$customFieldID] = array(
2973 'extends' => $customFields[$customFieldID]['extends'],
2974 'type' => $customFields[$customFieldID]['data_type'],
2975 'custom_field_id' => $customFieldID,
2979 elseif ($key == 'edit') {
2983 $data[$key] = $value;
2988 if (!$primaryLocation) {
2990 $data['location'][$loc]['email'][$loc]['email'] = $primaryEmail;
2997 * Calculate the profile type 'group_type' as per profile fields.
3001 * @param bool $includeTypeValues
3002 * @param int $ignoreFieldId
3003 * Ignore particular profile field.
3006 * list of calculated group type
3008 public static function calculateGroupType($gId, $includeTypeValues = FALSE, $ignoreFieldId = NULL) {
3009 //get the profile fields.
3010 $ufFields = self
::getFields($gId, FALSE, NULL, NULL, NULL, TRUE, NULL, TRUE);
3011 return self
::_calculateGroupType($ufFields, $includeTypeValues, $ignoreFieldId);
3015 * Calculate the profile type 'group_type' as per profile fields.
3018 * @param bool $includeTypeValues
3019 * @param int $ignoreFieldId
3020 * Ignore perticular profile field.
3023 * list of calculated group type
3025 public static function _calculateGroupType($ufFields, $includeTypeValues = FALSE, $ignoreFieldId = NULL) {
3026 $groupType = $groupTypeValues = $customFieldIds = array();
3027 if (!empty($ufFields)) {
3028 foreach ($ufFields as $fieldName => $fieldValue) {
3029 //ignore field from group type when provided.
3030 //in case of update profile field.
3031 if ($ignoreFieldId && ($ignoreFieldId == $fieldValue['field_id'])) {
3034 if (!in_array($fieldValue['field_type'], $groupType)) {
3035 $groupType[$fieldValue['field_type']] = $fieldValue['field_type'];
3038 if ($includeTypeValues && ($fldId = CRM_Core_BAO_CustomField
::getKeyID($fieldName))) {
3039 $customFieldIds[$fldId] = $fldId;
3044 if (!empty($customFieldIds)) {
3045 $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) . ')';
3047 $customGroups = CRM_Core_DAO
::executeQuery($query);
3048 while ($customGroups->fetch()) {
3049 if (!$customGroups->extends_entity_column_value
) {
3053 $groupTypeName = "{$customGroups->extends}Type";
3054 if ($customGroups->extends == 'Participant' && $customGroups->extends_entity_column_id
) {
3055 $groupTypeName = CRM_Core_OptionGroup
::getValue('custom_data_type', $customGroups->extends_entity_column_id
, 'value', 'String', 'name');
3058 foreach (explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $customGroups->extends_entity_column_value
) as $val) {
3060 $groupTypeValues[$groupTypeName][$val] = $val;
3065 if (!empty($groupTypeValues)) {
3066 $groupType = array_merge($groupType, $groupTypeValues);
3074 * Update the profile type 'group_type' as per profile fields including group types and group subtype values.
3075 * Build and store string like: group_type1,group_type2[VALUE_SEPERATOR]group_type1Type:1:2:3,group_type2Type:1:2
3078 * BirthDate + Email Individual,Contact
3079 * BirthDate + Subject Individual,Activity
3080 * BirthDate + Subject + SurveyOnlyField Individual,Activity\0ActivityType:28
3081 * BirthDate + Subject + SurveyOnlyField + PhoneOnlyField (Not allowed)
3082 * BirthDate + SurveyOnlyField Individual,Activity\0ActivityType:28
3083 * BirthDate + Subject + SurveyOrPhoneField Individual,Activity\0ActivityType:2:28
3084 * BirthDate + SurveyOrPhoneField Individual,Activity\0ActivityType:2:28
3085 * BirthDate + SurveyOrPhoneField + SurveyOnlyField Individual,Activity\0ActivityType:2:28
3086 * BirthDate + StudentField + Subject + SurveyOnlyField Individual,Activity,Student\0ActivityType:28
3089 * @param array $groupTypes
3090 * With key having group type names.
3094 public static function updateGroupTypes($gId, $groupTypes = array()) {
3095 if (!is_array($groupTypes) ||
!$gId) {
3099 // If empty group types set group_type as 'null'
3100 if (empty($groupTypes)) {
3101 return CRM_Core_DAO
::setFieldValue('CRM_Core_DAO_UFGroup', $gId, 'group_type', 'null');
3104 $componentGroupTypes = array('Contribution', 'Participant', 'Membership', 'Activity', 'Case');
3105 $validGroupTypes = array_merge(array(
3110 ), $componentGroupTypes, CRM_Contact_BAO_ContactType
::subTypes());
3112 $gTypes = $gTypeValues = array();
3114 $participantExtends = array('ParticipantRole', 'ParticipantEventName', 'ParticipantEventType');
3115 // Get valid group type and group subtypes
3116 foreach ($groupTypes as $groupType => $value) {
3117 if (in_array($groupType, $validGroupTypes) && !in_array($groupType, $gTypes)) {
3118 $gTypes[] = $groupType;
3123 if (in_array($groupType, $participantExtends)) {
3124 $subTypesOf = $groupType;
3126 elseif (strpos($groupType, 'Type') > 0) {
3127 $subTypesOf = substr($groupType, 0, strpos($groupType, 'Type'));
3133 if (!empty($value) &&
3134 (in_array($subTypesOf, $componentGroupTypes) ||
3135 in_array($subTypesOf, $participantExtends)
3138 $gTypeValues[$subTypesOf] = $groupType . ":" . implode(':', $value);
3142 if (empty($gTypes)) {
3146 // Build String to store group types and group subtypes
3147 $groupTypeString = implode(',', $gTypes);
3148 if (!empty($gTypeValues)) {
3149 $groupTypeString .= CRM_Core_DAO
::VALUE_SEPARATOR
. implode(',', $gTypeValues);
3152 return CRM_Core_DAO
::setFieldValue('CRM_Core_DAO_UFGroup', $gId, 'group_type', $groupTypeString);
3156 * Create a "group_type" string.
3158 * @param array $coreTypes
3159 * E.g. array('Individual','Contact','Student').
3160 * @param array $subTypes
3161 * E.g. array('ActivityType' => array(7, 11)).
3162 * @param string $delim
3165 * @throws CRM_Core_Exception
3167 public static function encodeGroupType($coreTypes, $subTypes, $delim = CRM_Core_DAO
::VALUE_SEPARATOR
) {
3168 $groupTypeExpr = '';
3170 $groupTypeExpr .= implode(',', $coreTypes);
3173 //CRM-15427 Allow Multiple subtype filtering
3174 //if (count($subTypes) > 1) {
3175 //throw new CRM_Core_Exception("Multiple subtype filtering is not currently supported by widget.");
3177 foreach ($subTypes as $subType => $subTypeIds) {
3178 $groupTypeExpr .= $delim . $subType . ':' . implode(':', $subTypeIds);
3181 return $groupTypeExpr;
3185 * setDefault componet specific profile fields.
3187 * @param array $fields
3189 * @param int $componentId
3191 * @param string $component
3193 * @param array $defaults
3194 * An array of default values.
3196 * @param bool $isStandalone
3200 public static function setComponentDefaults(&$fields, $componentId, $component, &$defaults, $isStandalone = FALSE) {
3201 if (!$componentId ||
3202 !in_array($component, array('Contribute', 'Membership', 'Event', 'Activity'))
3207 $componentBAO = $componentSubType = NULL;
3208 switch ($component) {
3210 $componentBAO = 'CRM_Member_BAO_Membership';
3211 $componentBAOName = 'Membership';
3212 $componentSubType = array('membership_type_id');
3216 $componentBAO = 'CRM_Contribute_BAO_Contribution';
3217 $componentBAOName = 'Contribution';
3218 $componentSubType = array('financial_type_id');
3222 $componentBAO = 'CRM_Event_BAO_Participant';
3223 $componentBAOName = 'Participant';
3224 $componentSubType = array('role_id', 'event_id', 'event_type_id');
3228 $componentBAO = 'CRM_Activity_BAO_Activity';
3229 $componentBAOName = 'Activity';
3230 $componentSubType = array('activity_type_id');
3235 $params = array('id' => $componentId);
3237 //get the component values.
3238 CRM_Core_DAO
::commonRetrieve($componentBAO, $params, $values);
3239 if ($componentBAOName == 'Participant') {
3240 $values +
= array('event_type_id' => CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $values['event_id'], 'event_type_id'));
3243 $formattedGroupTree = array();
3244 $dateTimeFields = array(
3245 'participant_register_date',
3246 'activity_date_time',
3251 'membership_start_date',
3252 'membership_end_date',
3255 foreach ($fields as $name => $field) {
3256 $fldName = $isStandalone ?
$name : "field[$componentId][$name]";
3257 if (in_array($name, $dateTimeFields)) {
3258 $timefldName = $isStandalone ?
"{$name}_time" : "field[$componentId][{$name}_time]";
3259 if (!empty($values[$name])) {
3260 list($defaults[$fldName], $defaults[$timefldName]) = CRM_Utils_Date
::setDateDefaults($values[$name]);
3263 elseif (array_key_exists($name, $values)) {
3264 $defaults[$fldName] = $values[$name];
3266 elseif ($name == 'participant_note') {
3267 $noteDetails = CRM_Core_BAO_Note
::getNote($componentId, 'civicrm_participant');
3268 $defaults[$fldName] = array_pop($noteDetails);
3270 elseif (in_array($name, array(
3272 'payment_instrument',
3273 'participant_status',
3276 $defaults[$fldName] = $values["{$name}_id"];
3278 elseif ($name == 'membership_type') {
3279 // since membership_type field is a hierselect -
3280 $defaults[$fldName][0]
3281 = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $values['membership_type_id'], 'member_of_contact_id', 'id');
3282 $defaults[$fldName][1] = $values['membership_type_id'];
3284 elseif ($name == 'membership_status') {
3285 $defaults[$fldName] = $values['status_id'];
3287 elseif ($customFieldInfo = CRM_Core_BAO_CustomField
::getKeyID($name, TRUE)) {
3288 if (empty($formattedGroupTree)) {
3289 //get the groupTree as per subTypes.
3290 $groupTree = array();
3291 foreach ($componentSubType as $subType) {
3292 $subTree = CRM_Core_BAO_CustomGroup
::getTree($componentBAOName, CRM_Core_DAO
::$_nullObject,
3293 $componentId, 0, $values[$subType]
3295 $groupTree = CRM_Utils_Array
::crmArrayMerge($groupTree, $subTree);
3297 $formattedGroupTree = CRM_Core_BAO_CustomGroup
::formatGroupTree($groupTree, 1, CRM_Core_DAO
::$_nullObject);
3298 CRM_Core_BAO_CustomGroup
::setDefaults($formattedGroupTree, $defaults);
3301 //FIX ME: We need to loop defaults, but once we move to custom_1_x convention this code can be simplified.
3302 foreach ($defaults as $customKey => $customValue) {
3303 if ($customFieldDetails = CRM_Core_BAO_CustomField
::getKeyID($customKey, TRUE)) {
3304 if ($name == 'custom_' . $customFieldDetails[0]) {
3306 //hack to set default for checkbox
3307 //basically this is for weired field name like field[33][custom_19]
3308 //we are converting this field name to array structure and assign value.
3311 foreach ($formattedGroupTree as $tree) {
3312 if (!empty($tree['fields'][$customFieldDetails[0]])) {
3313 if ('CheckBox' == CRM_Utils_Array
::value('html_type', $tree['fields'][$customFieldDetails[0]])) {
3315 $defaults['field'][$componentId][$name] = $customValue;
3318 elseif (CRM_Utils_Array
::value('data_type', $tree['fields'][$customFieldDetails[0]]) == 'Date') {
3321 // CRM-6681, $default contains formatted date, time values.
3322 $defaults[$fldName] = $customValue;
3323 if (!empty($defaults[$customKey . '_time'])) {
3324 $defaults['field'][$componentId][$name . '_time'] = $defaults[$customKey . '_time'];
3330 if (!$skipValue ||
$isStandalone) {
3331 $defaults[$fldName] = $customValue;
3333 unset($defaults[$customKey]);
3343 * @param array|string $profiles - name of profile(s) to create links for
3344 * @param array $appendProfiles
3345 * Name of profile(s) to append to each link.
3349 public static function getCreateLinks($profiles = '', $appendProfiles = array()) {
3350 // Default to contact profiles
3352 $profiles = array('new_individual', 'new_organization', 'new_household');
3354 $profiles = (array) $profiles;
3355 $toGet = array_merge($profiles, (array) $appendProfiles);
3356 $retrieved = civicrm_api3('uf_group', 'get', array(
3357 'name' => array('IN' => $toGet),
3360 $links = $append = array();
3361 if (!empty($retrieved['values'])) {
3362 foreach ($retrieved['values'] as $id => $profile) {
3363 if (in_array($profile['name'], $profiles)) {
3365 'label' => $profile['title'],
3366 'url' => CRM_Utils_System
::url('civicrm/profile/create', "reset=1&context=dialog&gid=$id",
3367 NULL, NULL, FALSE, FALSE, TRUE),
3368 'type' => ucfirst(str_replace('new_', '', $profile['name'])),
3375 foreach ($append as $id) {
3376 foreach ($links as &$link) {
3377 $link['url'] .= ",$id";
3385 * Retrieve groups of profiles.
3387 * @param int $profileID
3388 * Id of the profile.
3393 public static function profileGroups($profileID) {
3394 $groupTypes = array();
3395 $profileTypes = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $profileID, 'group_type');
3396 if ($profileTypes) {
3397 $groupTypeParts = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $profileTypes);
3398 $groupTypes = explode(',', $groupTypeParts[0]);
3404 * Alter contact params by filtering existing subscribed groups and returns
3405 * unsubscribed groups array for subscription.
3407 * @param array $params
3409 * @param int $contactId
3413 * This contains array of groups for subscription
3415 public static function getDoubleOptInGroupIds(&$params, $contactId = NULL) {
3416 $config = CRM_Core_Config
::singleton();
3417 $subscribeGroupIds = array();
3419 // process further only if profileDoubleOptIn enabled and if groups exist
3420 if (!array_key_exists('group', $params) ||
3421 !self
::isProfileDoubleOptin() ||
3422 CRM_Utils_System
::isNull($params['group'])
3424 return $subscribeGroupIds;
3427 //check if contact email exist.
3429 foreach ($params as $name => $value) {
3430 if (strpos($name, 'email-') !== FALSE) {
3436 //Proceed furthur only if email present
3438 return $subscribeGroupIds;
3441 //do check for already subscriptions.
3442 $contactGroups = array();
3446 FROM civicrm_group_contact
3447 WHERE status = 'Added'
3448 AND contact_id = %1";
3450 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array($contactId, 'Integer')));
3451 while ($dao->fetch()) {
3452 $contactGroups[$dao->group_id
] = $dao->group_id
;
3456 //since we don't have names, compare w/ label.
3457 $mailingListGroupType = array_search('Mailing List', CRM_Core_OptionGroup
::values('group_type'));
3459 //actual processing start.
3460 foreach ($params['group'] as $groupId => $isSelected) {
3461 //unset group those are not selected.
3463 unset($params['group'][$groupId]);
3467 $groupTypes = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
3468 CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group', $groupId, 'group_type', 'id')
3470 //get only mailing type group and unset it from params
3471 if (in_array($mailingListGroupType, $groupTypes) && !in_array($groupId, $contactGroups)) {
3472 $subscribeGroupIds[$groupId] = $groupId;
3473 unset($params['group'][$groupId]);
3477 return $subscribeGroupIds;
3481 * Check if we are rendering mixed profiles.
3483 * @param array $profileIds
3484 * Associated array of profile ids.
3487 * true if profile is mixed
3489 public static function checkForMixProfiles($profileIds) {
3490 $mixProfile = FALSE;
3492 $contactTypes = array('Individual', 'Household', 'Organization');
3493 $subTypes = CRM_Contact_BAO_ContactType
::subTypes();
3495 $components = array('Contribution', 'Participant', 'Membership', 'Activity');
3497 $typeCount = array('ctype' => array(), 'subtype' => array());
3498 foreach ($profileIds as $gid) {
3499 $profileType = CRM_Core_BAO_UFField
::getProfileType($gid);
3500 // ignore profile of type Contact
3501 if ($profileType == 'Contact') {
3504 if (in_array($profileType, $contactTypes)) {
3505 if (!isset($typeCount['ctype'][$profileType])) {
3506 $typeCount['ctype'][$profileType] = 1;
3509 // check if we are rendering profile of different contact types
3510 if (count($typeCount['ctype']) == 2) {
3515 elseif (in_array($profileType, $components)) {
3520 if (!isset($typeCount['subtype'][$profileType])) {
3521 $typeCount['subtype'][$profileType] = 1;
3523 // check if we are rendering profile of different contact sub types
3524 if (count($typeCount['subtype']) == 2) {
3534 * Determine of we show overlay profile or not.
3537 * true if profile should be shown else false
3539 public static function showOverlayProfile() {
3540 $showOverlay = TRUE;
3542 // get the id of overlay profile
3543 $overlayProfileId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', 'summary_overlay', 'id', 'name');
3544 $query = "SELECT count(id) FROM civicrm_uf_field WHERE uf_group_id = {$overlayProfileId} AND visibility IN ('Public Pages', 'Public Pages and Listings') ";
3546 $count = CRM_Core_DAO
::singleValueQuery($query);
3548 //check if there are no public fields and use is anonymous
3549 $session = CRM_Core_Session
::singleton();
3550 if (!$count && !$session->get('userID')) {
3551 $showOverlay = FALSE;
3554 return $showOverlay;
3558 * Get group type values of the profile.
3560 * @param int $profileId
3561 * @param string $groupType
3566 public static function groupTypeValues($profileId, $groupType = NULL) {
3567 $groupTypeValue = array();
3568 $groupTypes = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $profileId, 'group_type');
3570 $groupTypeParts = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $groupTypes);
3571 if (empty($groupTypeParts[1])) {
3572 return $groupTypeValue;
3574 $participantExtends = array('ParticipantRole', 'ParticipantEventName', 'ParticipantEventType');
3576 foreach (explode(',', $groupTypeParts[1]) as $groupTypeValues) {
3578 $valueParts = explode(':', $groupTypeValues);
3580 ($valueParts[0] != "{$groupType}Type" ||
3581 ($groupType == 'Participant' &&
3582 !in_array($valueParts[0], $participantExtends)
3588 foreach ($valueParts as $val) {
3589 if (CRM_Utils_Rule
::integer($val)) {
3590 $values[$val] = $val;
3593 if (!empty($values)) {
3594 $typeName = substr($valueParts[0], 0, -4);
3595 if (in_array($valueParts[0], $participantExtends)) {
3596 $typeName = $valueParts[0];
3598 $groupTypeValue[$typeName] = $values;
3602 return $groupTypeValue;
3606 * @return bool|object
3608 public static function isProfileDoubleOptin() {
3609 // check for double optin
3610 $config = CRM_Core_Config
::singleton();
3611 if (in_array('CiviMail', $config->enableComponents
)) {
3612 return CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
3613 'profile_double_optin', NULL, FALSE
3620 * @return bool|object
3622 public static function isProfileAddToGroupDoubleOptin() {
3623 // check for add to group double optin
3624 $config = CRM_Core_Config
::singleton();
3625 if (in_array('CiviMail', $config->enableComponents
)) {
3626 return CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
3627 'profile_add_to_group_double_optin', NULL, FALSE
3634 * Get profiles used for batch entry.
3637 * profileIds profile ids
3639 public static function getBatchProfiles() {
3641 FROM civicrm_uf_group
3642 WHERE name IN ('contribution_batch_entry', 'membership_batch_entry')";
3643 $dao = CRM_Core_DAO
::executeQuery($query);
3644 $profileIds = array();
3645 while ($dao->fetch()) {
3646 $profileIds[$dao->id
] = $dao->id
;
3652 * @todo what do I do?
3654 * @param $destination
3655 * @param bool $returnMultiSummaryFields
3657 * @return array|null
3659 public static function shiftMultiRecordFields(&$source, &$destination, $returnMultiSummaryFields = FALSE) {
3660 $multiSummaryFields = $returnMultiSummaryFields ?
array() : NULL;
3661 foreach ($source as $field => $properties) {
3662 if (!CRM_Core_BAO_CustomField
::getKeyID($field)) {
3665 if (CRM_Core_BAO_CustomField
::isMultiRecordField($field)) {
3666 $destination[$field] = $properties;
3667 if ($returnMultiSummaryFields) {
3668 if ($properties['is_multi_summary']) {
3669 $multiSummaryFields[$field] = $properties;
3672 unset($source[$field]);
3675 return $multiSummaryFields;
3679 * This is function is used to format pseudo fields.
3681 * @param array $fields
3682 * Associated array of profile fields.
3685 public static function reformatProfileFields(&$fields) {
3686 //reformat fields array
3687 foreach ($fields as $name => $field) {
3688 //reformat phone and extension field
3689 if (substr($field['name'], 0, 13) == 'phone_and_ext') {
3690 $fieldSuffix = str_replace('phone_and_ext-', '', $field['name']);
3692 // retain existing element properties and just update and replace key
3693 CRM_Utils_Array
::crmReplaceKey($fields, $name, "phone-{$fieldSuffix}");
3694 $fields["phone-{$fieldSuffix}"]['name'] = "phone-{$fieldSuffix}";
3695 $fields["phone-{$fieldSuffix}"]['where'] = 'civicrm_phone.phone';
3697 // add additional phone extension field
3698 $fields["phone_ext-{$fieldSuffix}"] = $field;
3699 $fields["phone_ext-{$fieldSuffix}"]['title'] = $field['title'] . ' - ' . ts('Ext.');
3700 $fields["phone_ext-{$fieldSuffix}"]['name'] = "phone_ext-{$fieldSuffix}";
3701 $fields["phone_ext-{$fieldSuffix}"]['where'] = 'civicrm_phone.phone_ext';
3702 $fields["phone_ext-{$fieldSuffix}"]['skipDisplay'] = 1;
3703 //ignore required for extension field
3704 $fields["phone_ext-{$fieldSuffix}"]['is_required'] = 0;