projects / civicrm-core.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Merge pull request #2349 from eileenmcnaughton/CRM-14080
[civicrm-core.git] / CRM / Core / BAO / UFGroup.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
9 | |
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. |
13 | |
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. |
18 | |
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 +--------------------------------------------------------------------+
26 */
27
28 /**
29 *
30 * @package CRM
31 * @copyright CiviCRM LLC (c) 2004-2013
32 * $Id$
33 *
34 */
35
36 /**
37 *
38 */
39 class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup {
40 CONST PUBLIC_VISIBILITY = 1,
41 ADMIN_VISIBILITY = 2,
42 LISTINGS_VISIBILITY = 4;
43
44 /**
45 * cache the match clause used in this transaction
46 *
47 * @var string
48 */
49 static $_matchFields = NULL;
50
51 /**
52 * Takes a bunch of params that are needed to match certain criteria and
53 * retrieves the relevant objects. Typically the valid params are only
54 * contact_id. We'll tweak this function to be more full featured over a period
55 * of time. This is the inverse function of create. It also stores all the retrieved
56 * values in the default array
57 *
58 * @param array $params (reference) an assoc array of name/value pairs
59 * @param array $defaults (reference) an assoc array to hold the flattened values
60 *
61 * @return object CRM_Core_DAO_UFGroup object
62 * @access public
63 * @static
64 */
65 static function retrieve(&$params, &$defaults) {
66 return CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_UFGroup', $params, $defaults);
67 }
68
69 /**
70 * Retrieve the first non-generic contact type
71 *
72 * @param int $id id of uf_group
73 *
74 * @return string contact type
75 */
76 static function getContactType($id) {
77
78 $validTypes = array_filter(array_keys(CRM_Core_SelectValues::contactType()));
79 $validSubTypes = CRM_Contact_BAO_ContactType::subTypeInfo();
80
81 $typesParts = explode(CRM_Core_DAO::VALUE_SEPARATOR, CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $id, 'group_type'));
82 $types = explode(',', $typesParts[0]);
83
84 $cType = NULL;
85 foreach ($types as $type) {
86 if (in_array($type, $validTypes)) {
87 $cType = $type;
88 }
89 elseif (array_key_exists($type, $validSubTypes)) {
90 $cType = CRM_Utils_Array::value('parent', $validSubTypes[$type]);
91 }
92 if ($cType)
93 break;
94 }
95
96 return $cType;
97 }
98
99 /**
100 * Get the form title.
101 *
102 * @param int $id id of uf_form
103 *
104 * @return string title
105 *
106 * @access public
107 * @static
108 *
109 */
110 public static function getTitle($id) {
111 return CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $id, 'title');
112 }
113
114 /**
115 * update the is_active flag in the db
116 *
117 * @param int $id id of the database record
118 * @param boolean $is_active value we want to set the is_active field
119 *
120 * @return Object CRM_Core_DAO_UFGroup object on success, null otherwise
121 * @access public
122 * @static
123 */
124 static function setIsActive($id, $is_active) {
125 return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_UFGroup', $id, 'is_active', $is_active);
126 }
127
128 /**
129 * get all the registration fields
130 *
131 * @param int $action what action are we doing
132 * @param int $mode mode
133 *
134 * @return array the fields that are needed for registration
135 * @static
136 * @access public
137 */
138 static function getRegistrationFields($action, $mode, $ctype = NULL) {
139 if ($mode & CRM_Profile_Form::MODE_REGISTER) {
140 $ufGroups = CRM_Core_BAO_UFGroup::getModuleUFGroup('User Registration');
141 }
142 else {
143 $ufGroups = CRM_Core_BAO_UFGroup::getModuleUFGroup('Profile');
144 }
145
146 if (!is_array($ufGroups)) {
147 return FALSE;
148 }
149
150 $fields = array();
151
152 foreach ($ufGroups as $id => $title) {
153 if ($ctype) {
154 $fieldType = CRM_Core_BAO_UFField::getProfileType($id);
155 if (($fieldType != 'Contact') &&
156 ($fieldType != $ctype) &&
157 !CRM_Contact_BAO_ContactType::isExtendsContactType($fieldType, $ctype)
158 ) {
159 continue;
160 }
161 if (CRM_Contact_BAO_ContactType::isaSubType($fieldType)) {
162 $profileSubType = $fieldType;
163 }
164 }
165
166 $subset = self::getFields($id, TRUE, $action,
167 NULL, NULL, FALSE, NULL, TRUE, $ctype
168 );
169
170 // we do not allow duplicates. the first field is the winner
171 foreach ($subset as $name => $field) {
172 if (!CRM_Utils_Array::value($name, $fields)) {
173 $fields[$name] = $field;
174 }
175 }
176 }
177
178 return $fields;
179 }
180
181 /**
182 * get all the listing fields
183 *
184 * @param int $action what action are we doing
185 * @param int $visibility visibility of fields we are interested in
186 * @param bool $considerSelector whether to consider the in_selector parameter
187 * @param array $ufGroupIds
188 * @param boolean $searchable
189 *
190 * @return array the fields that are listings related
191 * @static
192 * @access public
193 */
194 static function getListingFields(
195 $action,
196 $visibility,
197 $considerSelector = FALSE,
198 $ufGroupIds = NULL,
199 $searchable = NULL,
200 $restrict = NULL,
201 $skipPermission = FALSE,
202 $permissionType = CRM_Core_Permission::SEARCH
203 ) {
204 if ($ufGroupIds) {
205 $subset = self::getFields($ufGroupIds, FALSE, $action,
206 $visibility, $searchable,
207 FALSE, $restrict,
208 $skipPermission,
209 NULL,
210 $permissionType
211 );
212 if ($considerSelector) {
213 // drop the fields not meant for the selector
214 foreach ($subset as $name => $field) {
215 if (!$field['in_selector']) {
216 unset($subset[$name]);
217 }
218 }
219 }
220 $fields = $subset;
221 }
222 else {
223 $ufGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_UFField', 'uf_group_id');
224
225 $fields = array();
226 foreach ($ufGroups as $id => $title) {
227 $subset = self::getFields($id, FALSE, $action,
228 $visibility, $searchable,
229 FALSE, $restrict,
230 $skipPermission,
231 NULL,
232 $permissionType
233 );
234 if ($considerSelector) {
235 // drop the fields not meant for the selector
236 foreach ($subset as $name => $field) {
237 if (!$field['in_selector'])unset($subset[$name]);
238 }
239 }
240 $fields = array_merge($fields, $subset);
241 }
242 }
243 return $fields;
244 }
245
246 /**
247 * Get all the fields that belong to the group with the name title,
248 * and format for use with buildProfile. This is the SQL analog of
249 * formatUFFields().
250 *
251 * @param mix $id the id of the UF group or ids of ufgroup
252 * @param int $register are we interested in registration fields
253 * @param int $action what action are we doing
254 * @param int $visibility visibility of fields we are interested in
255 * @param $searchable
256 * @param boolean $showall
257 * @param string $restrict should we restrict based on a specified profile type
258 *
259 * @return array the fields that belong to this ufgroup(s)
260 * @static
261 * @access public
262 */
263 static function getFields(
264 $id,
265 $register = FALSE,
266 $action = NULL,
267 $visibility = NULL,
268 $searchable = NULL,
269 $showAll = FALSE,
270 $restrict = NULL,
271 $skipPermission = FALSE,
272 $ctype = NULL,
273 $permissionType = CRM_Core_Permission::CREATE,
274 $orderBy = 'field_name',
275 $orderProfiles = NULL
276 ) {
277 if (!is_array($id)) {
278 $id = CRM_Utils_Type::escape($id, 'Positive');
279 $profileIds = array($id);
280 }
281 else {
282 $profileIds = $id;
283 }
284
285 $gids = implode(',', $profileIds);
286 $params = array();
287 if ($restrict) {
288 $query = "SELECT g.* from civicrm_uf_group g, civicrm_uf_join j
289 WHERE g.id IN ( {$gids} )
290 AND j.uf_group_id IN ( {$gids} )
291 AND j.module = %1
292 ";
293 $params = array(1 => array($restrict, 'String'));
294 }
295 else {
296 $query = "SELECT g.* from civicrm_uf_group g WHERE g.id IN ( {$gids} ) ";
297 }
298
299 if (!$showAll) {
300 $query .= " AND g.is_active = 1";
301 }
302
303 // add permissioning for profiles only if not registration
304 if (!$skipPermission) {
305 $permissionClause = CRM_Core_Permission::ufGroupClause($permissionType, 'g.');
306 $query .= " AND $permissionClause ";
307 }
308
309 if ($orderProfiles AND count($profileIds) > 1) {
310 $query .= " ORDER BY FIELD( g.id, {$gids} )";
311 }
312 $group = CRM_Core_DAO::executeQuery($query, $params);
313 $fields = array();
314 $validGroup = FALSE;
315
316 while ($group->fetch()) {
317 $validGroup = TRUE;
318 $query = self::createUFFieldQuery($group->id, $searchable, $showAll, $visibility, $orderBy);
319 $field = CRM_Core_DAO::executeQuery($query);
320
321 $profileType = CRM_Core_BAO_UFField::getProfileType($group->id);
322 $contactActivityProfile = CRM_Core_BAO_UFField::checkContactActivityProfileType($group->id);
323 $importableFields = self::getImportableFields($showAll, $profileType, $contactActivityProfile);
324 list($customFields, $addressCustomFields) = self::getCustomFields($ctype);
325
326 while ($field->fetch()) {
327 list($name, $formattedField) = self::formatUFField($group, $field, $customFields, $addressCustomFields, $importableFields, $permissionType);
328 if ($formattedField !== NULL) {
329 $fields[$name] = $formattedField;
330 }
331 }
332 $field->free();
333 }
334
335 if (empty($fields) && !$validGroup) {
336 CRM_Core_Error::fatal(ts('The requested Profile (gid=%1) is disabled OR it is not configured to be used for \'Profile\' listings in its Settings OR there is no Profile with that ID OR you do not have permission to access this profile. Please contact the site administrator if you need assistance.',
337 array(1 => implode(',', $profileIds))
338 ));
339 }
340 else {
341 self::reformatProfileFields($fields);
342 }
343
344 return $fields;
345 }
346
347 /**
348 * Format a list of UFFields for use with buildProfile. This is the in-memory analog
349 * of getFields().
350 *
351 * @param array $groupArr (mimic CRM_UF_DAO_UFGroup)
352 * @param array $fieldArrs list of fields (each mimics CRM_UF_DAO_UFField)
353 * @param bool $visibility visibility of fields we are interested in
354 * @param bool $searchable
355 * @param bool $showall
356 * @return array
357 * @see getFields
358 */
359 public static function formatUFFields(
360 $groupArr,
361 $fieldArrs,
362 $visibility = NULL,
363 $searchable = NULL,
364 $showAll = FALSE,
365 $ctype = NULL,
366 $permissionType = CRM_Core_Permission::CREATE
367 ) {
368 // $group = new CRM_Core_DAO_UFGroup();
369 // $group->copyValues($groupArr); // no... converts string('') to string('null')
370 $group = (object) $groupArr;
371
372 // Refactoring note: The $fieldArrs here may be slightly different than the $ufFields
373 // used by calculateGroupType, but I don't think the missing fields matter, and -- if
374 // they did -- the obvious fix would produce mutual recursion.
375 $ufGroupType = self::_calculateGroupType($fieldArrs);
376 $profileType = CRM_Core_BAO_UFField::calculateProfileType(implode(',',$ufGroupType));
377 $contactActivityProfile = CRM_Core_BAO_UFField::checkContactActivityProfileTypeByGroupType(implode(',',$ufGroupType));
378 $importableFields = self::getImportableFields($showAll, $profileType, $contactActivityProfile);
379 list($customFields, $addressCustomFields) = self::getCustomFields($ctype);
380
381 $formattedFields = array();
382 foreach ($fieldArrs as $fieldArr) {
383 $field = (object) $fieldArr;
384 if (!self::filterUFField($field, $searchable, $showAll, $visibility)) {
385 continue;
386 }
387
388 list($name, $formattedField) = self::formatUFField($group, $field, $customFields, $addressCustomFields, $importableFields, $permissionType);
389 if ($formattedField !== NULL) {
390 $formattedFields[$name] = $formattedField;
391 }
392 }
393 return $formattedFields;
394 }
395
396 /**
397 * Prepare a field for rendering with CRM_Core_BAO_UFGroup::buildProfile.
398 *
399 * @param CRM_Core_DAO_UFGroup|CRM_Core_DAO $group
400 * @param CRM_Core_DAO_UFField|CRM_Core_DAO $field
401 * @param array $addressCustomFields
402 * @param array $importableFields
403 * @param array $customFields
404 * @param int $permissionType eg CRM_Core_Permission::CREATE
405 * @return array
406 */
407 protected static function formatUFField(
408 $group,
409 $field,
410 $customFields,
411 $addressCustomFields,
412 $importableFields,
413 $permissionType = CRM_Core_Permission::CREATE
414 ) {
415 $name = $field->field_name;
416 $title = $field->label;
417
418 $addressCustom = FALSE;
419 if (in_array($permissionType, array(
420 CRM_Core_Permission::CREATE,
421 CRM_Core_Permission::EDIT,
422 )) &&
423 in_array($field->field_name, array_keys($addressCustomFields))
424 ) {
425 $addressCustom = TRUE;
426 $name = "address_{$name}";
427 }
428
429 if (!empty($field->location_type_id)) {
430 $name .= "-{$field->location_type_id}";
431 }
432 else {
433 $locationFields = self::getLocationFields();
434 if (in_array($field->field_name, $locationFields) || $addressCustom) {
435 $name .= '-Primary';
436 }
437 }
438
439 if (isset($field->phone_type_id)) {
440 $name .= "-{$field->phone_type_id}";
441 }
442
443 // No lie: this is bizarre; why do we need to mix so many UFGroup properties into UFFields?
444 // I guess to make field self sufficient with all the required data and avoid additional calls
445 $formattedField = array(
446 'name' => $name,
447 'groupTitle' => $group->title,
448 'groupName' => $group->name,
449 'groupHelpPre' => empty($group->help_pre) ? '' : $group->help_pre,
450 'groupHelpPost' => empty($group->help_post) ? '' : $group->help_post,
451 'title' => $title,
452 'where' => CRM_Utils_Array::value('where', CRM_Utils_Array::value($field->field_name, $importableFields)),
453 'attributes' => CRM_Core_DAO::makeAttribute(CRM_Utils_Array::value($field->field_name, $importableFields)),
454 'is_required' => $field->is_required,
455 'is_view' => $field->is_view,
456 'help_pre' => $field->help_pre,
457 'help_post' => $field->help_post,
458 'visibility' => $field->visibility,
459 'in_selector' => $field->in_selector,
460 'rule' => CRM_Utils_Array::value('rule', CRM_Utils_Array::value($field->field_name, $importableFields)),
461 'location_type_id' => isset($field->location_type_id) ? $field->location_type_id : NULL,
462 'phone_type_id' => isset($field->phone_type_id) ? $field->phone_type_id : NULL,
463 'group_id' => $group->id,
464 'add_to_group_id' => isset($group->add_to_group_id) ? $group->add_to_group_id : NULL,
465 'add_captcha' => isset($group->add_captcha) ? $group->add_captcha : NULL,
466 'field_type' => $field->field_type,
467 'field_id' => $field->id,
468 'pseudoconstant' => CRM_Utils_Array::value(
469 'pseudoconstant',
470 CRM_Utils_Array::value($field->field_name, $importableFields)
471 ),
472 // obsolete this when we remove the name / dbName discrepancy with gender/suffix/prefix
473 'dbName' => CRM_Utils_Array::value(
474 'dbName',
475 CRM_Utils_Array::value($field->field_name, $importableFields)
476 ),
477 'skipDisplay' => 0,
478 );
479
480 //adding custom field property
481 if (substr($field->field_name, 0, 6) == 'custom' ||
482 substr($field->field_name, 0, 14) === 'address_custom'
483 ) {
484 // if field is not present in customFields, that means the user
485 // DOES NOT HAVE permission to access that field
486 if (array_key_exists($field->field_name, $customFields)) {
487 $formattedField['is_search_range'] = $customFields[$field->field_name]['is_search_range'];
488 // fix for CRM-1994
489 $formattedField['options_per_line'] = $customFields[$field->field_name]['options_per_line'];
490 $formattedField['data_type'] = $customFields[$field->field_name]['data_type'];
491 $formattedField['html_type'] = $customFields[$field->field_name]['html_type'];
492
493 if (CRM_Utils_Array::value('html_type', $formattedField) == 'Select Date') {
494 $formattedField['date_format'] = $customFields[$field->field_name]['date_format'];
495 $formattedField['time_format'] = $customFields[$field->field_name]['time_format'];
496 }
497
498 $formattedField['is_multi_summary'] = $field->is_multi_summary;
499 return array($name, $formattedField);
500 }
501 else {
502 $formattedField = NULL;
503 return array($name, $formattedField);
504 }
505 }
506 return array($name, $formattedField);
507 }
508
509 /**
510 * Create a query to find all visible UFFields in a UFGroup
511 *
512 * This is the SQL-variant of checkUFFieldDisplayable().
513 *
514 * @param int $groupId
515 * @param bool $searchable
516 * @param bool $showAll
517 * @param int $visibility
518 * @param string $orderBy comma-delimited list of SQL columns
519 * @return string
520 */
521 protected static function createUFFieldQuery($groupId, $searchable, $showAll, $visibility, $orderBy) {
522 $where = " WHERE uf_group_id = {$groupId}";
523
524 if ($searchable) {
525 $where .= " AND is_searchable = 1";
526 }
527
528 if (!$showAll) {
529 $where .= " AND is_active = 1";
530 }
531
532 if ($visibility) {
533 $clause = array();
534 if ($visibility & self::PUBLIC_VISIBILITY) {
535 $clause[] = 'visibility = "Public Pages"';
536 }
537 if ($visibility & self::ADMIN_VISIBILITY) {
538 $clause[] = 'visibility = "User and User Admin Only"';
539 }
540 if ($visibility & self::LISTINGS_VISIBILITY) {
541 $clause[] = 'visibility = "Public Pages and Listings"';
542 }
543 if (!empty($clause)) {
544 $where .= ' AND ( ' . implode(' OR ', $clause) . ' ) ';
545 }
546 }
547
548 $query = "SELECT * FROM civicrm_uf_field $where ORDER BY weight";
549 if ($orderBy) {
550 $query .= ", " . $orderBy;
551 return $query;
552 }
553 return $query;
554 }
555
556 /**
557 * Create a query to find all visible UFFields in a UFGroup
558 *
559 * This is the PHP in-memory variant of createUFFieldQuery().
560 *
561 * @param CRM_Core_DAO_UFField|CRM_Core_DAO $field
562 * @param bool $searchable
563 * @param bool $showAll
564 * @param int $visibility
565 * @return bool TRUE if field is displayable
566 */
567 protected static function filterUFField($field, $searchable, $showAll, $visibility) {
568 if ($searchable && $field->is_searchable != 1) {
569 return FALSE;
570 }
571
572 if (!$showAll && $field->is_active != 1) {
573 return FALSE;
574 }
575
576 if ($visibility) {
577 $allowedVisibilities = array();
578 if ($visibility & self::PUBLIC_VISIBILITY) {
579 $allowedVisibilities[] = 'Public Pages';
580 }
581 if ($visibility & self::ADMIN_VISIBILITY) {
582 $allowedVisibilities[] = 'User and User Admin Only';
583 }
584 if ($visibility & self::LISTINGS_VISIBILITY) {
585 $allowedVisibilities[] = 'Public Pages and Listings';
586 }
587 // !empty($allowedVisibilities) seems silly to me, but it is equivalent to the pre-existing SQL
588 if (!empty($allowedVisibilities) && !in_array($field->visibility, $allowedVisibilities)) {
589 return FALSE;
590 }
591 }
592
593 return TRUE;
594 }
595
596 protected static function getImportableFields($showAll, $profileType, $contactActivityProfile) {
597 if (!$showAll) {
598 $importableFields = CRM_Contact_BAO_Contact::importableFields('All', FALSE, FALSE, FALSE, TRUE, TRUE);
599 }
600 else {
601 $importableFields = CRM_Contact_BAO_Contact::importableFields('All', FALSE, TRUE, FALSE, TRUE, TRUE);
602 }
603
604 if ($profileType == 'Activity' || $contactActivityProfile) {
605 $componentFields = CRM_Activity_BAO_Activity::getProfileFields();
606 }
607 else {
608 $componentFields = CRM_Core_Component::getQueryFields();
609 }
610
611 $importableFields = array_merge($importableFields, $componentFields);
612
613 $importableFields['group']['title'] = ts('Group(s)');
614 $importableFields['group']['where'] = NULL;
615 $importableFields['tag']['title'] = ts('Tag(s)');
616 $importableFields['tag']['where'] = NULL;
617 return $importableFields;
618 }
619
620 public static function getLocationFields() {
621 static $locationFields = array(
622 'street_address',
623 'supplemental_address_1',
624 'supplemental_address_2',
625 'city',
626 'postal_code',
627 'postal_code_suffix',
628 'geo_code_1',
629 'geo_code_2',
630 'state_province',
631 'country',
632 'county',
633 'phone',
634 'phone_and_ext',
635 'email',
636 'im',
637 'address_name',
638 'phone_ext',
639 );
640 return $locationFields;
641 }
642
643 protected static function getCustomFields($ctype) {
644 static $customFieldCache = array();
645 if (!isset($customFieldCache[$ctype])) {
646 $customFields = CRM_Core_BAO_CustomField::getFieldsForImport($ctype, FALSE, FALSE, FALSE, TRUE, TRUE);
647
648 // hack to add custom data for components
649 $components = array('Contribution', 'Participant', 'Membership', 'Activity');
650 foreach ($components as $value) {
651 $customFields = array_merge($customFields, CRM_Core_BAO_CustomField::getFieldsForImport($value));
652 }
653 $addressCustomFields = CRM_Core_BAO_CustomField::getFieldsForImport('Address');
654 $customFields = array_merge($customFields, $addressCustomFields);
655 $customFieldCache[$ctype] = array($customFields, $addressCustomFields);
656 }
657 return $customFieldCache[$ctype];
658 }
659
660 /**
661 * check the data validity
662 *
663 * @param int $userID the user id that we are actually editing
664 * @param string $title the title of the group we are interested in
665 * @pram boolean $register is this the registrtion form
666 * @param int $action the action of the form
667 *
668 * @return boolean true if form is valid
669 * @static
670 * @access public
671 */
672 static function isValid($userID, $title, $register = FALSE, $action = NULL) {
673 if ($register) {
674 $controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Dynamic',
675 ts('Dynamic Form Creator'),
676 $action
677 );
678 $controller->set('id', $userID);
679 $controller->set('register', 1);
680 $controller->process();
681 return $controller->validate();
682 }
683 else {
684 // make sure we have a valid group
685 $group = new CRM_Core_DAO_UFGroup();
686
687 $group->title = $title;
688
689 if ($group->find(TRUE) && $userID) {
690 $controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Dynamic', ts('Dynamic Form Creator'), $action);
691 $controller->set('gid', $group->id);
692 $controller->set('id', $userID);
693 $controller->set('register', 0);
694 $controller->process();
695 return $controller->validate();
696 }
697 return TRUE;
698 }
699 }
700
701 /**
702 * get the html for the form that represents this particular group
703 *
704 * @param int $userID the user id that we are actually editing
705 * @param string $title the title of the group we are interested in
706 * @param int $action the action of the form
707 * @param boolean $register is this the registration form
708 * @param boolean $reset should we reset the form?
709 * @param int $profileID do we have the profile ID?
710 *
711 * @return string the html for the form on success, otherwise empty string
712 * @static
713 * @access public
714 */
715 static function getEditHTML($userID,
716 $title,
717 $action = NULL,
718 $register = FALSE,
719 $reset = FALSE,
720 $profileID = NULL,
721 $doNotProcess = FALSE,
722 $ctype = NULL
723 ) {
724
725 if ($register) {
726 $controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Dynamic',
727 ts('Dynamic Form Creator'),
728 $action
729 );
730 if ($reset || $doNotProcess) {
731 // hack to make sure we do not process this form
732 $oldQFDefault = CRM_Utils_Array::value('_qf_default',
733 $_POST
734 );
735 unset($_POST['_qf_default']);
736 unset($_REQUEST['_qf_default']);
737 if ($reset) {
738 $controller->reset();
739 }
740 }
741
742 $controller->set('id', $userID);
743 $controller->set('register', 1);
744 $controller->set('skipPermission', 1);
745 $controller->set('ctype', $ctype);
746 $controller->process();
747 if ($doNotProcess || !empty($_POST)) {
748 $controller->validate();
749 }
750 $controller->setEmbedded(TRUE);
751
752 //CRM-5839 - though we want to process form, get the control back.
753 $controller->setSkipRedirection(($doNotProcess) ? FALSE : TRUE);
754
755 $controller->run();
756
757 // we are done processing so restore the POST/REQUEST vars
758 if (($reset || $doNotProcess) && $oldQFDefault) {
759 $_POST['_qf_default'] = $_REQUEST['_qf_default'] = $oldQFDefault;
760 }
761
762 $template = CRM_Core_Smarty::singleton();
763
764 // Hide CRM error messages if they are displayed using drupal form_set_error.
765 if (!empty($_POST)) {
766 $template->assign('suppressForm', TRUE);
767 }
768
769 return trim($template->fetch('CRM/Profile/Form/Dynamic.tpl'));
770 }
771 else {
772 if (!$profileID) {
773 // make sure we have a valid group
774 $group = new CRM_Core_DAO_UFGroup();
775
776 $group->title = $title;
777
778 if ($group->find(TRUE)) {
779 $profileID = $group->id;
780 }
781 }
782
783 if ($profileID) {
784 // make sure profileID and ctype match if ctype exists
785 if ($ctype) {
786 $profileType = CRM_Core_BAO_UFField::getProfileType($profileID);
787 if (CRM_Contact_BAO_ContactType::isaSubType($profileType)) {
788 $profileType = CRM_Contact_BAO_ContactType::getBasicType($profileType);
789 }
790
791 if (($profileType != 'Contact') && ($profileType != $ctype)) {
792 return NULL;
793 }
794 }
795
796 $controller = new CRM_Core_Controller_Simple('CRM_Profile_Form_Dynamic',
797 ts('Dynamic Form Creator'),
798 $action
799 );
800 if ($reset) {
801 $controller->reset();
802 }
803 $controller->set('gid', $profileID);
804 $controller->set('id', $userID);
805 $controller->set('register', 0);
806 $controller->set('skipPermission', 1);
807 if ($ctype) {
808 $controller->set('ctype', $ctype);
809 }
810 $controller->process();
811 $controller->setEmbedded(TRUE);
812
813 //CRM-5846 - give the control back to drupal.
814 $controller->setSkipRedirection(($doNotProcess) ? FALSE : TRUE);
815 $controller->run();
816
817 $template = CRM_Core_Smarty::singleton();
818
819 // Hide CRM error messages if they are displayed using drupal form_set_error.
820 if (!empty($_POST) && CRM_Core_Config::singleton()->userFramework == 'Drupal') {
821 if (arg(0) == 'user' || (arg(0) == 'admin' && arg(1) == 'people')) {
822 $template->assign('suppressForm', TRUE);
823 }
824 }
825
826 $templateFile = "CRM/Profile/Form/{$profileID}/Dynamic.tpl";
827 if (!$template->template_exists($templateFile)) {
828 $templateFile = 'CRM/Profile/Form/Dynamic.tpl';
829 }
830 return trim($template->fetch($templateFile));
831 }
832 else {
833 $userEmail = CRM_Contact_BAO_Contact_Location::getEmailDetails($userID);
834
835 // if post not empty then only proceed
836 if (!empty($_POST)) {
837 // get the new email
838 $config = CRM_Core_Config::singleton();
839 $email = CRM_Utils_Array::value('mail', $_POST);
840
841 if (CRM_Utils_Rule::email($email) && ($email != $userEmail[1])) {
842 CRM_Core_BAO_UFMatch::updateContactEmail($userID, $email);
843 }
844 }
845 }
846 }
847 return '';
848 }
849
850 /**
851 * searches for a contact in the db with similar attributes
852 *
853 * @param array $params the list of values to be used in the where clause
854 * @param int $id the current contact id (hence excluded from matching)
855 * @param boolean $flatten should we flatten the input params
856 *
857 * @return contact_id if found, null otherwise
858 * @access public
859 * @static
860 */
861 public static function findContact(&$params, $id = NULL, $contactType = 'Individual') {
862 $dedupeParams = CRM_Dedupe_Finder::formatParams($params, $contactType);
863 $dedupeParams['check_permission'] = CRM_Utils_Array::value('check_permission', $params, TRUE);
864 $ids = CRM_Dedupe_Finder::dupesByParams($dedupeParams, $contactType, 'Supervised', array($id));
865 if (!empty($ids)) {
866 return implode(',', $ids);
867 }
868 else {
869 return NULL;
870 }
871 }
872
873 /**
874 * Given a contact id and a field set, return the values from the db
875 * for this contact
876 *
877 * @param int $id the contact id
878 * @param array $fields the profile fields of interest
879 * @param array $values the values for the above fields
880 * @param boolean $searchable searchable or not
881 * @param array $componentWhere component condition
882 * @param boolean $absolute return urls in absolute form (useful when sending an email)
883 *
884 * @return void
885 * @access public
886 * @static
887 */
888 public static function getValues($cid, &$fields, &$values,
889 $searchable = TRUE, $componentWhere = NULL,
890 $absolute = FALSE, $additionalWhereClause = NULL
891 ) {
892 if (empty($cid) && empty($componentWhere)) {
893 return NULL;
894 }
895
896 // get the contact details (hier)
897 $returnProperties = CRM_Contact_BAO_Contact::makeHierReturnProperties($fields);
898 $params = $cid ? array(array('contact_id', '=', $cid, 0, 0)) : array();
899
900 // add conditions specified by components. eg partcipant_id etc
901 if (!empty($componentWhere)) {
902 $params = array_merge($params, $componentWhere);
903 }
904
905 $query = new CRM_Contact_BAO_Query($params, $returnProperties, $fields);
906 $options = &$query->_options;
907
908 $details = $query->searchQuery( 0, 0, NULL, FALSE, FALSE,
909 FALSE, FALSE, FALSE, $additionalWhereClause);
910 if (!$details->fetch()) {
911 return;
912 }
913 $query->convertToPseudoNames($details);
914 $config = CRM_Core_Config::singleton();
915
916 $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
917 $imProviders = CRM_Core_PseudoConstant::get('CRM_Core_DAO_IM', 'provider_id');
918 $websiteTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Website', 'website_type_id');
919
920 $multipleFields = array('url');
921 $nullIndex = $nullValueIndex = ' ';
922
923 //start of code to set the default values
924 foreach ($fields as $name => $field) {
925 // fix for CRM-3962
926 if ($name == 'id') {
927 $name = 'contact_id';
928 }
929
930 // skip fields that should not be displayed separately
931 if (CRM_Utils_Array::value('skipDisplay', $field)) {
932 continue;
933 }
934
935 $index = $field['title'];
936 //handle for the label not set for the field
937 if (empty($field['title'])) {
938 $index = $nullIndex;
939 $nullIndex .= $nullIndex;
940 }
941
942 //handle the case to avoid re-write where the profile field labels are the same
943 if (CRM_Utils_Array::value($index, $values)) {
944 $index .= $nullValueIndex;
945 $nullValueIndex .= $nullValueIndex;
946 }
947 $params[$index] = $values[$index] = '';
948 $customFieldName = NULL;
949 // hack for CRM-665
950 if (isset($details->$name) || $name == 'group' || $name == 'tag') {
951 // to handle gender / suffix / prefix
952 if (in_array(substr($name, 0, -3), array('gender', 'prefix', 'suffix'))) {
953 $values[$index] = CRM_Core_PseudoConstant::getLabel('CRM_Contact_DAO_Contact', $name, $details->$name);
954 $params[$index] = $details->$name;
955 }
956 elseif (in_array($name, CRM_Contact_BAO_Contact::$_greetingTypes)) {
957 $dname = $name . '_display';
958 $values[$index] = $details->$dname;
959 $name = $name . '_id';
960 $params[$index] = $details->$name;
961 }
962 elseif (in_array($name, array(
963 'state_province', 'country', 'county'))) {
964 $values[$index] = $details->$name;
965 $idx = $name . '_id';
966 $params[$index] = $details->$idx;
967 }
968 elseif ($name === 'preferred_communication_method') {
969 $communicationFields = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'preferred_communication_method');
970 $compref = array();
971 $pref = explode(CRM_Core_DAO::VALUE_SEPARATOR, $details->$name);
972
973 foreach ($pref as $k) {
974 if ($k) {
975 $compref[] = $communicationFields[$k];
976 }
977 }
978 $params[$index] = $details->$name;
979 $values[$index] = implode(',', $compref);
980 }
981 elseif ($name === 'preferred_language') {
982 $params[$index] = $details->$name;
983 $values[$index] = CRM_Core_PseudoConstant::getLabel('CRM_Contact_DAO_Contact', 'preferred_language', $details->$name);
984 }
985 elseif ($name == 'group') {
986 $groups = CRM_Contact_BAO_GroupContact::getContactGroup($cid, 'Added', NULL, FALSE, TRUE);
987 $title = $ids = array();
988
989 foreach ($groups as $g) {
990 // CRM-8362: User and User Admin visibility groups should be included in display if user has
991 // VIEW permission on that group
992 $groupPerm = CRM_Contact_BAO_Group::checkPermission($g['group_id'], $g['title']);
993
994 if ($g['visibility'] != 'User and User Admin Only' ||
995 CRM_Utils_Array::key(CRM_Core_Permission::VIEW, $groupPerm)
996 ) {
997 $title[] = $g['title'];
998 if ($g['visibility'] == 'Public Pages') {
999 $ids[] = $g['group_id'];
1000 }
1001 }
1002 }
1003 $values[$index] = implode(', ', $title);
1004 $params[$index] = implode(',', $ids);
1005 }
1006 elseif ($name == 'tag') {
1007 $entityTags = CRM_Core_BAO_EntityTag::getTag($cid);
1008 $allTags = CRM_Core_PseudoConstant::get('CRM_Core_DAO_EntityTag', 'tag_id', array('onlyActive' => FALSE));
1009 $title = array();
1010 foreach ($entityTags as $tagId) {
1011 $title[] = $allTags[$tagId];
1012 }
1013 $values[$index] = implode(', ', $title);
1014 $params[$index] = implode(',', $entityTags);
1015 }
1016 elseif ($name == 'activity_status_id') {
1017 $activityStatus = CRM_Core_PseudoConstant::activityStatus();
1018 $values[$index] = $activityStatus[$details->$name];
1019 $params[$index] = $details->$name;
1020 }
1021 elseif ($name == 'activity_date_time') {
1022 $values[$index] = CRM_Utils_Date::customFormat($details->$name);
1023 $params[$index] = $details->$name;
1024 }
1025 elseif ($name == 'contact_sub_type') {
1026 $contactSubTypeNames = explode(CRM_Core_DAO::VALUE_SEPARATOR, $details->$name);
1027 if (!empty($contactSubTypeNames)) {
1028 $contactSubTypeLabels = array();
1029 // get all contact subtypes
1030 $allContactSubTypes = CRM_Contact_BAO_ContactType::subTypeInfo();
1031 // build contact subtype labels array
1032 foreach( $contactSubTypeNames as $cstName ) {
1033 if ($cstName) {
1034 $contactSubTypeLabels[] = $allContactSubTypes[$cstName]['label'];
1035 }
1036 }
1037 $values[$index] = implode(',', $contactSubTypeLabels);
1038 }
1039
1040 $params[$index] = $details->$name;
1041 }
1042 else {
1043 if (substr($name, 0, 7) === 'do_not_' || substr($name, 0, 3) === 'is_') {
1044 if ($details->$name) {
1045 $values[$index] = '[ x ]';
1046 }
1047 }
1048 else {
1049 if ($cfID = CRM_Core_BAO_CustomField::getKeyID($name)) {
1050 $htmlType = $field['html_type'];
1051
1052 // field_type is only set when we are retrieving profile values
1053 // when sending email, we call the same function to get custom field
1054 // values etc, i.e. emulating a profile
1055 $fieldType = CRM_Utils_Array::value('field_type', $field);
1056
1057 if ($htmlType == 'File') {
1058 $entityId = $cid;
1059 if (!$cid &&
1060 $fieldType == 'Activity' &&
1061 CRM_Utils_Array::value(2, $componentWhere[0])
1062 ) {
1063 $entityId = $componentWhere[0][2];
1064 }
1065
1066 $fileURL = CRM_Core_BAO_CustomField::getFileURL($entityId,
1067 $cfID,
1068 NULL,
1069 $absolute
1070 );
1071 $params[$index] = $values[$index] = $fileURL['file_url'];
1072 }
1073 else {
1074 $customVal = NULL;
1075 if (isset($dao) && property_exists($dao, 'data_type') &&
1076 ($dao->data_type == 'Int' ||
1077 $dao->data_type == 'Boolean'
1078 )
1079 ) {
1080 $customVal = (int )($details->{$name});
1081 }
1082 elseif (isset($dao) && property_exists($dao, 'data_type')
1083 && $dao->data_type == 'Float'
1084 ) {
1085 $customVal = (float )($details->{$name});
1086 }
1087 elseif (!CRM_Utils_System::isNull(explode(CRM_Core_DAO::VALUE_SEPARATOR,
1088 $details->{$name}
1089 ))) {
1090 $customVal = $details->{$name};
1091 }
1092
1093 //CRM-4582
1094 if (CRM_Utils_System::isNull($customVal)) {
1095 continue;
1096 }
1097
1098 $params[$index] = $customVal;
1099 $values[$index] = CRM_Core_BAO_CustomField::getDisplayValue($customVal,
1100 $cfID,
1101 $options
1102 );
1103 if ($htmlType == 'Autocomplete-Select') {
1104 $params[$index] = $values[$index];
1105 }
1106 if (CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField',
1107 $cfID, 'is_search_range'
1108 )) {
1109 $customFieldName = "{$name}_from";
1110 }
1111 }
1112 }
1113 elseif ($name == 'image_URL') {
1114 list($width, $height) = getimagesize($details->$name);
1115 list($thumbWidth, $thumbHeight) = CRM_Contact_BAO_Contact::getThumbSize($width, $height);
1116
1117 $image_URL = '<img src="' . $details->$name . '" height= ' . $thumbHeight . ' width= ' . $thumbWidth . ' />';
1118 $values[$index] = "<a href='#' onclick='contactImagePopUp(\"{$details->$name}\", {$width}, {$height});'>{$image_URL}</a>";
1119 }
1120 elseif (in_array($name, array(
1121 'birth_date', 'deceased_date', 'membership_start_date', 'membership_end_date', 'join_date'))) {
1122 $values[$index] = CRM_Utils_Date::customFormat($details->$name);
1123 $params[$index] = CRM_Utils_Date::isoToMysql($details->$name);
1124 }
1125 else {
1126 $dao = '';
1127 if ($index == 'Campaign') {
1128 $dao = 'CRM_Campaign_DAO_Campaign';
1129 }
1130 elseif ($index == 'Contribution Page') {
1131 $dao = 'CRM_Contribute_DAO_ContributionPage';
1132 }
1133 if ($dao) {
1134 $value = CRM_Core_DAO::getFieldValue($dao, $details->$name, 'title');
1135 }
1136 else {
1137 $value = $details->$name;
1138 }
1139 $values[$index] = $value;
1140 }
1141 }
1142 }
1143 }
1144 elseif (strpos($name, '-') !== FALSE) {
1145 list($fieldName, $id, $type) = CRM_Utils_System::explode('-', $name, 3);
1146
1147 if (!in_array($fieldName, $multipleFields)) {
1148 if ($id == 'Primary') {
1149 // fix for CRM-1543
1150 // not sure why we'd every use Primary location type id
1151 // we need to fix the source if we are using it
1152 // $locationTypeName = CRM_Contact_BAO_Contact::getPrimaryLocationType( $cid );
1153 $locationTypeName = 1;
1154 }
1155 else {
1156 $locationTypeName = CRM_Utils_Array::value($id, $locationTypes);
1157 }
1158
1159 if (!$locationTypeName) {
1160 continue;
1161 }
1162
1163 $detailName = "{$locationTypeName}-{$fieldName}";
1164 $detailName = str_replace(' ', '_', $detailName);
1165
1166 if (in_array($fieldName, array(
1167 'phone', 'im', 'email', 'openid'))) {
1168 if ($type) {
1169 $detailName .= "-{$type}";
1170 }
1171 }
1172
1173 if (in_array($fieldName, array(
1174 'state_province', 'country', 'county'))) {
1175 $values[$index] = $details->$detailName;
1176 $idx = $detailName . '_id';
1177 $params[$index] = $details->$idx;
1178 }
1179 elseif ($fieldName == 'im') {
1180 $providerId = $detailName . '-provider_id';
1181 if (isset($imProviders[$details->$providerId])) {
1182 $values[$index] = $details->$detailName . " (" . $imProviders[$details->$providerId] . ")";
1183 }
1184 else {
1185 $values[$index] = $details->$detailName;
1186 }
1187 $params[$index] = $details->$detailName;
1188 }
1189 elseif ($fieldName == 'phone') {
1190 $phoneExtField = str_replace('phone', 'phone_ext', $detailName);
1191 if (isset($details->$phoneExtField)) {
1192 $values[$index] = $details->$detailName . " (" . $details->$phoneExtField . ")";
1193 }
1194 else {
1195 $values[$index] = $details->$detailName;
1196 }
1197 $params[$index] = $details->$detailName;
1198 }
1199 else {
1200 $values[$index] = $params[$index] = $details->$detailName;
1201 }
1202 }
1203 else {
1204 $detailName = "website-{$id}-{$fieldName}";
1205 $url = CRM_Utils_System::fixURL($details->$detailName);
1206 if ($details->$detailName) {
1207 $websiteTypeId = "website-{$id}-website_type_id";
1208 $websiteType = $websiteTypes[$details->$websiteTypeId];
1209 $values[$index] = "<a href=\"$url\">{$details->$detailName} ( {$websiteType} )</a>";
1210 }
1211 else {
1212 $values[$index] = '';
1213 }
1214 }
1215 }
1216
1217 if ((CRM_Utils_Array::value('visibility', $field) == 'Public Pages and Listings') &&
1218 CRM_Core_Permission::check('profile listings and forms')
1219 ) {
1220
1221 if (CRM_Utils_System::isNull($params[$index])) {
1222 $params[$index] = $values[$index];
1223 }
1224 if (!isset($params[$index])) {
1225 continue;
1226 }
1227 if (!$customFieldName) {
1228 $fieldName = $field['name'];
1229 }
1230 else {
1231 $fieldName = $customFieldName;
1232 }
1233
1234 $url = NULL;
1235 if (CRM_Core_BAO_CustomField::getKeyID($field['name'])) {
1236 $htmlType = $field['html_type'];
1237 if ($htmlType == 'Link') {
1238 $url = $params[$index];
1239 }
1240 elseif (in_array($htmlType, array(
1241 'CheckBox', 'Multi-Select', 'AdvMulti-Select',
1242 'Multi-Select State/Province', 'Multi-Select Country',
1243 ))) {
1244 $valSeperator = CRM_Core_DAO::VALUE_SEPARATOR;
1245 $selectedOptions = explode($valSeperator, $params[$index]);
1246
1247 foreach ($selectedOptions as $key => $multiOption) {
1248 if ($multiOption) {
1249 $url[] = CRM_Utils_System::url('civicrm/profile',
1250 'reset=1&force=1&gid=' . $field['group_id'] . '&' .
1251 urlencode($fieldName) .
1252 '=' .
1253 urlencode($multiOption)
1254 );
1255 }
1256 }
1257 }
1258 else {
1259 $url = CRM_Utils_System::url('civicrm/profile',
1260 'reset=1&force=1&gid=' . $field['group_id'] . '&' .
1261 urlencode($fieldName) .
1262 '=' .
1263 urlencode($params[$index])
1264 );
1265 }
1266 }
1267 else {
1268 $url = CRM_Utils_System::url('civicrm/profile',
1269 'reset=1&force=1&gid=' . $field['group_id'] . '&' .
1270 urlencode($fieldName) .
1271 '=' .
1272 urlencode($params[$index])
1273 );
1274 }
1275
1276 if ($url &&
1277 !empty($values[$index]) &&
1278 $searchable
1279 ) {
1280
1281 if (is_array($url) && !empty($url)) {
1282 $links = array();
1283 $eachMultiValue = explode(', ', $values[$index]);
1284 foreach ($eachMultiValue as $key => $valueLabel) {
1285 $links[] = '<a href="' . $url[$key] . '">' . $valueLabel . '</a>';
1286 }
1287 $values[$index] = implode(', ', $links);
1288 }
1289 else {
1290 $values[$index] = '<a href="' . $url . '">' . $values[$index] . '</a>';
1291 }
1292 }
1293 }
1294 }
1295 }
1296
1297 /**
1298 * Check if profile Group used by any module.
1299 *
1300 * @param int $id profile Id
1301 *
1302 * @return boolean
1303 *
1304 * @access public
1305 * @static
1306 *
1307 */
1308 public static function usedByModule($id) {
1309 //check whether this group is used by any module(check uf join records)
1310 $sql = "SELECT id
1311 FROM civicrm_uf_join
1312 WHERE civicrm_uf_join.uf_group_id=$id";
1313
1314 $dao = new CRM_Core_DAO();
1315 $dao->query($sql);
1316 if ($dao->fetch()) {
1317 return TRUE;
1318 }
1319 else {
1320 return FALSE;
1321 }
1322 }
1323
1324 /**
1325 * Delete the profile Group.
1326 *
1327 * @param int $id profile Id
1328 *
1329 * @return boolean
1330 *
1331 * @access public
1332 * @static
1333 *
1334 */
1335 public static function del($id) {
1336 //check whether this group contains any profile fields
1337 $profileField = new CRM_Core_DAO_UFField();
1338 $profileField->uf_group_id = $id;
1339 $profileField->find();
1340 while ($profileField->fetch()) {
1341 CRM_Core_BAO_UFField::del($profileField->id);
1342 }
1343
1344 //delete records from uf join table
1345 $ufJoin = new CRM_Core_DAO_UFJoin();
1346 $ufJoin->uf_group_id = $id;
1347 $ufJoin->delete();
1348
1349 //delete profile group
1350 $group = new CRM_Core_DAO_UFGroup();
1351 $group->id = $id;
1352 $group->delete();
1353 return 1;
1354 }
1355
1356 /**
1357 * function to add the UF Group
1358 *
1359 * @param array $params reference array contains the values submitted by the form
1360 * @param array $ids reference array contains the id
1361 *
1362 * @access public
1363 * @static
1364 *
1365 * @return object
1366 */
1367 static function add(&$params, $ids = array()) {
1368 $fields = array('is_active', 'add_captcha', 'is_map', 'is_update_dupe', 'is_edit_link', 'is_uf_link', 'is_cms_user');
1369 foreach ($fields as $field) {
1370 $params[$field] = CRM_Utils_Array::value($field, $params, FALSE);
1371 }
1372
1373 $params['limit_listings_group_id'] = CRM_Utils_Array::value('group', $params);
1374 $params['add_to_group_id'] = CRM_Utils_Array::value('add_contact_to_group', $params);
1375
1376 $ufGroup = new CRM_Core_DAO_UFGroup();
1377 $ufGroup->copyValues($params);
1378
1379 $ufGroupID = CRM_Utils_Array::value('ufgroup', $ids, CRM_Utils_Array::value('id', $params));
1380 if (!$ufGroupID) {
1381 $ufGroup->name = CRM_Utils_String::munge($ufGroup->title, '_', 56);
1382 }
1383 $ufGroup->id = $ufGroupID;
1384
1385 $ufGroup->save();
1386
1387 if (!$ufGroupID) {
1388 $ufGroup->name = $ufGroup->name . "_{$ufGroup->id}";
1389 $ufGroup->save();
1390 }
1391
1392 return $ufGroup;
1393 }
1394
1395 /**
1396 * Function to make uf join entries for an uf group
1397 *
1398 * @param array $params (reference) an assoc array of name/value pairs
1399 * @param int $ufGroupId ufgroup id
1400 *
1401 * @return void
1402 * @access public
1403 * @static
1404 */
1405 static function createUFJoin(&$params, $ufGroupId) {
1406 $groupTypes = CRM_Utils_Array::value('uf_group_type', $params);
1407
1408 // get ufjoin records for uf group
1409 $ufGroupRecord = CRM_Core_BAO_UFGroup::getUFJoinRecord($ufGroupId);
1410
1411 // get the list of all ufgroup types
1412 $allUFGroupType = CRM_Core_SelectValues::ufGroupTypes();
1413
1414 // this fix is done to prevent warning generated by array_key_exits incase of empty array is given as input
1415 if (!is_array($groupTypes)) {
1416 $groupTypes = array();
1417 }
1418
1419 // this fix is done to prevent warning generated by array_key_exits incase of empty array is given as input
1420 if (!is_array($ufGroupRecord)) {
1421 $ufGroupRecord = array();
1422 }
1423
1424 // check which values has to be inserted/deleted for contact
1425 $menuRebuild = FALSE;
1426 foreach ($allUFGroupType as $key => $value) {
1427 $joinParams = array();
1428 $joinParams['uf_group_id'] = $ufGroupId;
1429 $joinParams['module'] = $key;
1430 if ($key == 'User Account') {
1431 $menuRebuild = TRUE;
1432 }
1433 if (array_key_exists($key, $groupTypes) && !in_array($key, $ufGroupRecord)) {
1434 // insert a new record
1435 CRM_Core_BAO_UFGroup::addUFJoin($joinParams);
1436 }
1437 elseif (!array_key_exists($key, $groupTypes) && in_array($key, $ufGroupRecord)) {
1438 // delete a record for existing ufgroup
1439 CRM_Core_BAO_UFGroup::delUFJoin($joinParams);
1440 }
1441 }
1442
1443 //update the weight
1444 $query = "
1445 UPDATE civicrm_uf_join
1446 SET weight = %1
1447 WHERE uf_group_id = %2
1448 AND ( entity_id IS NULL OR entity_id <= 0 )
1449 ";
1450 $p = array(1 => array($params['weight'], 'Integer'),
1451 2 => array($ufGroupId, 'Integer'),
1452 );
1453 CRM_Core_DAO::executeQuery($query, $p);
1454
1455 // do a menu rebuild if we are on drupal, so it gets all the new menu entries
1456 // for user account
1457 $config = CRM_Core_Config::singleton();
1458 if ($menuRebuild &&
1459 $config->userSystem->is_drupal
1460 ) {
1461 menu_rebuild();
1462 }
1463 }
1464
1465 /**
1466 * Function to get the UF Join records for an ufgroup id
1467 *
1468 * @params int $ufGroupId uf group id
1469 * @params int $displayName if set return display name in array
1470 * @params int $status if set return module other than default modules (User Account/User registration/Profile)
1471 *
1472 * @return array $ufGroupJoinRecords
1473 *
1474 * @access public
1475 * @static
1476 */
1477 public static function getUFJoinRecord($ufGroupId = NULL, $displayName = NULL, $status = NULL) {
1478 if ($displayName) {
1479 $UFGroupType = array();
1480 $UFGroupType = CRM_Core_SelectValues::ufGroupTypes();
1481 }
1482
1483 $ufJoin = array();
1484 $dao = new CRM_Core_DAO_UFJoin();
1485
1486 if ($ufGroupId) {
1487 $dao->uf_group_id = $ufGroupId;
1488 }
1489
1490 $dao->find();
1491 $ufJoin = array();
1492
1493 while ($dao->fetch()) {
1494 if (!$displayName) {
1495 $ufJoin[$dao->id] = $dao->module;
1496 }
1497 else {
1498 if (isset($UFGroupType[$dao->module])) {
1499 // skip the default modules
1500 if (!$status) {
1501 $ufJoin[$dao->id] = $UFGroupType[$dao->module];
1502 }
1503 // added for CRM-1475
1504 }
1505 elseif (!CRM_Utils_Array::key($dao->module, $ufJoin)) {
1506 $ufJoin[$dao->id] = $dao->module;
1507 }
1508 }
1509 }
1510 return $ufJoin;
1511 }
1512
1513 /**
1514 * Function takes an associative array and creates a ufjoin record for ufgroup
1515 *
1516 * @param array $params (reference) an assoc array of name/value pairs
1517 *
1518 * @return object CRM_Core_BAO_UFJoin object
1519 * @access public
1520 * @static
1521 */
1522 static function addUFJoin(&$params) {
1523 $ufJoin = new CRM_Core_DAO_UFJoin();
1524 $ufJoin->copyValues($params);
1525 $ufJoin->save();
1526 return $ufJoin;
1527 }
1528
1529 /**
1530 * Function to delete the uf join record for an uf group
1531 *
1532 * @param array $params (reference) an assoc array of name/value pairs
1533 *
1534 * @return void
1535 * @access public
1536 * @static
1537 */
1538 static function delUFJoin(&$params) {
1539 $ufJoin = new CRM_Core_DAO_UFJoin();
1540 $ufJoin->copyValues($params);
1541 $ufJoin->delete();
1542 }
1543
1544 /**
1545 * Function to get the weight for ufjoin record
1546 *
1547 * @param int $ufGroupId if $ufGroupId get update weight or add weight
1548 *
1549 * @return int weight of the UFGroup
1550 * @access public
1551 * @static
1552 */
1553 static function getWeight($ufGroupId = NULL) {
1554 //calculate the weight
1555 $p = array();
1556 if (!$ufGroupId) {
1557 $queryString = "SELECT ( MAX(civicrm_uf_join.weight)+1) as new_weight
1558 FROM civicrm_uf_join
1559 WHERE module = 'User Registration' OR module = 'User Account' OR module = 'Profile'";
1560 }
1561 else {
1562 $queryString = "SELECT MAX(civicrm_uf_join.weight) as new_weight
1563 FROM civicrm_uf_join
1564 WHERE civicrm_uf_join.uf_group_id = %1
1565 AND ( entity_id IS NULL OR entity_id <= 0 )";
1566 $p[1] = array($ufGroupId, 'Integer');
1567 }
1568
1569 $dao = CRM_Core_DAO::executeQuery($queryString, $p);
1570 $dao->fetch();
1571 return ($dao->new_weight) ? $dao->new_weight : 1;
1572 }
1573
1574 /**
1575 * Function to get the uf group for a module
1576 *
1577 * @param string $moduleName module name
1578 * @param int $count no to increment the weight
1579 * @param bool $skipPermision - whether to add permission clause
1580 * @param int $op - which operation (view, edit, create, etc) to check permission for
1581 * @param array|NULL $returnFields list of UFGroup fields to return; NULL for default
1582 *
1583 * @return array $ufGroups array of ufgroups for a module
1584 * @access public
1585 * @static
1586 */
1587 public static function getModuleUFGroup($moduleName = NULL, $count = 0, $skipPermission = TRUE, $op = CRM_Core_Permission::VIEW, $returnFields = NULL) {
1588 $selectFields = array('id', 'title', 'created_id', 'is_active', 'is_reserved', 'group_type');
1589
1590 if (!CRM_Core_Config::isUpgradeMode()) {
1591 // CRM-13555, since description field was added later (4.4), and to avoid any problems with upgrade
1592 $selectFields[] = 'description';
1593 }
1594
1595 if (!empty($returnFields)) {
1596 $selectFields = array_merge($returnFields, array_diff($selectFields, $returnFields));
1597 }
1598
1599 $queryString = 'SELECT civicrm_uf_group.' . implode(', civicrm_uf_group.', $selectFields) . '
1600 FROM civicrm_uf_group
1601 LEFT JOIN civicrm_uf_join ON (civicrm_uf_group.id = uf_group_id)';
1602 $p = array();
1603 if ($moduleName) {
1604 $queryString .= ' AND civicrm_uf_group.is_active = 1
1605 WHERE civicrm_uf_join.module = %2';
1606 $p[2] = array($moduleName, 'String');
1607 }
1608
1609
1610 // add permissioning for profiles only if not registration
1611 if (!$skipPermission) {
1612 $permissionClause = CRM_Core_Permission::ufGroupClause($op, 'civicrm_uf_group.');
1613 if (strpos($queryString, 'WHERE') !== FALSE) {
1614 $queryString .= " AND $permissionClause ";
1615 }
1616 else {
1617 $queryString .= " $permissionClause ";
1618 }
1619 }
1620
1621 $queryString .= ' ORDER BY civicrm_uf_join.weight, civicrm_uf_group.title';
1622 $dao = CRM_Core_DAO::executeQuery($queryString, $p);
1623
1624 $ufGroups = array();
1625 while ($dao->fetch()) {
1626 //skip mix profiles in user Registration / User Account
1627 if (($moduleName == 'User Registration' || $moduleName == 'User Account') &&
1628 CRM_Core_BAO_UFField::checkProfileType($dao->id)
1629 ) {
1630 continue;
1631 }
1632 foreach ($selectFields as $key => $field) {
1633 if($field == 'id') {
1634 continue;
1635 }
1636 elseif ($field == 'name') {
1637 $ufGroups[$dao->id][$field] = $dao->title;
1638 continue;
1639 }
1640 $ufGroups[$dao->id][$field] = $dao->$field;
1641 }
1642 }
1643
1644 // Allow other modules to alter/override the UFGroups.
1645 CRM_Utils_Hook::buildUFGroupsForModule($moduleName, $ufGroups);
1646
1647 return $ufGroups;
1648 }
1649
1650 /**
1651 * Function to filter ufgroups based on logged in user contact type
1652 *
1653 * @params int $ufGroupId uf group id (profile id)
1654 *
1655 * @return boolean true or false
1656 * @static
1657 * @access public
1658 */
1659 static function filterUFGroups($ufGroupId, $contactID = NULL) {
1660 if (!$contactID) {
1661 $session = CRM_Core_Session::singleton();
1662 $contactID = $session->get('userID');
1663 }
1664
1665 if ($contactID) {
1666 //get the contact type
1667 $contactType = CRM_Contact_BAO_Contact::getContactType($contactID);
1668
1669 //match if exixting contact type is same as profile contact type
1670 $profileType = CRM_Core_BAO_UFField::getProfileType($ufGroupId);
1671
1672 if (CRM_Contact_BAO_ContactType::isaSubType($profileType)) {
1673 $profileType = CRM_Contact_BAO_ContactType::getBasicType($profileType);
1674 }
1675
1676 //allow special mix profiles for Contribution and Participant
1677 $specialProfiles = array('Contribution', 'Participant', 'Membership');
1678
1679 if (in_array($profileType, $specialProfiles)) {
1680 return TRUE;
1681 }
1682
1683 if (($contactType == $profileType) || $profileType == 'Contact') {
1684 return TRUE;
1685 }
1686 }
1687
1688 return FALSE;
1689 }
1690
1691 /**
1692 * Function to build profile form
1693 *
1694 * @params object $form form object
1695 * @params array $field array field properties
1696 * @params int $mode profile mode
1697 * @params int $contactID contact id
1698 *
1699 * @return null
1700 * @static
1701 * @access public
1702 */
1703 static function buildProfile(
1704 &$form,
1705 &$field,
1706 $mode,
1707 $contactId = NULL,
1708 $online = FALSE,
1709 $onBehalf = FALSE,
1710 $rowNumber = NULL ,
1711 $prefix = ''
1712 ) {
1713 $defaultValues = array();
1714 $fieldName = $field['name'];
1715 $title = $field['title'];
1716 $attributes = $field['attributes'];
1717 $rule = $field['rule'];
1718 $view = $field['is_view'];
1719 $required = ($mode == CRM_Profile_Form::MODE_SEARCH) ? FALSE : $field['is_required'];
1720 $search = ($mode == CRM_Profile_Form::MODE_SEARCH) ? TRUE : FALSE;
1721 $isShared = CRM_Utils_Array::value('is_shared', $field, 0);
1722
1723 // do not display view fields in drupal registration form
1724 // CRM-4632
1725 if ($view && $mode == CRM_Profile_Form::MODE_REGISTER) {
1726 return;
1727 }
1728
1729 if ($onBehalf) {
1730 $name = "onbehalf[$fieldName]";
1731 }
1732 elseif ($contactId && !$online) {
1733 $name = "field[$contactId][$fieldName]";
1734 }
1735 elseif ($rowNumber) {
1736 $name = "field[$rowNumber][$fieldName]";
1737 }
1738 elseif (!empty($prefix)) {
1739 $name = $prefix ."[$fieldName]";
1740 }
1741 else {
1742 $name = $fieldName;
1743 }
1744
1745 if ($fieldName == 'image_URL' && $mode == CRM_Profile_Form::MODE_EDIT) {
1746 $deleteExtra = ts('Are you sure you want to delete contact image.');
1747 $deleteURL = array(
1748 CRM_Core_Action::DELETE =>
1749 array(
1750 'name' => ts('Delete Contact Image'),
1751 'url' => 'civicrm/contact/image',
1752 'qs' => 'reset=1&id=%%id%%&gid=%%gid%%&action=delete',
1753 'extra' =>
1754 'onclick = "if (confirm( \'' . $deleteExtra . '\' ) ) this.href+=\'&amp;confirmed=1\'; else return false;"',
1755 ),
1756 );
1757 $deleteURL = CRM_Core_Action::formLink($deleteURL,
1758 CRM_Core_Action::DELETE,
1759 array('id' => $form->get('id'),
1760 'gid' => $form->get('gid'),
1761 ),
1762 ts('more'),
1763 FALSE,
1764 'contact.profileimage.delete',
1765 'Contact',
1766 $form->get('id')
1767 );
1768 $form->assign('deleteURL', $deleteURL);
1769 }
1770 $addressOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
1771 'address_options', TRUE, NULL, TRUE
1772 );
1773
1774 if (substr($fieldName, 0, 14) === 'state_province') {
1775 $form->add('select', $name, $title,
1776 array(
1777 '' => ts('- select -')) + CRM_Core_PseudoConstant::stateProvince(), $required
1778 );
1779 $config = CRM_Core_Config::singleton();
1780 if (!in_array($mode, array(
1781 CRM_Profile_Form::MODE_EDIT, CRM_Profile_Form::MODE_SEARCH)) &&
1782 $config->defaultContactStateProvince
1783 ) {
1784 $defaultValues[$name] = $config->defaultContactStateProvince;
1785 $form->setDefaults($defaultValues);
1786 }
1787 }
1788 elseif (substr($fieldName, 0, 7) === 'country') {
1789 $form->add('select', $name, $title,
1790 array(
1791 '' => ts('- select -')) + CRM_Core_PseudoConstant::country(), $required
1792 );
1793 $config = CRM_Core_Config::singleton();
1794 if (!in_array($mode, array(
1795 CRM_Profile_Form::MODE_EDIT, CRM_Profile_Form::MODE_SEARCH)) &&
1796 $config->defaultContactCountry
1797 ) {
1798 $defaultValues[$name] = $config->defaultContactCountry;
1799 $form->setDefaults($defaultValues);
1800 }
1801 }
1802 elseif (substr($fieldName, 0, 6) === 'county') {
1803 if ($addressOptions['county']) {
1804 $form->add('select', $name, $title,
1805 array(
1806 '' => ts('(choose state first)')), $required
1807 );
1808 }
1809 }
1810 elseif (substr($fieldName, 0, 9) === 'image_URL') {
1811 $form->add('file', $name, $title, $attributes, $required);
1812 $form->addUploadElement($name);
1813 }
1814 elseif (substr($fieldName, 0, 2) === 'im') {
1815 $form->add('text', $name, $title, $attributes, $required);
1816 if (!$contactId) {
1817 if ($onBehalf) {
1818 if (substr($name, -1) == ']') {
1819 $providerName = substr($name, 0, -1) . '-provider_id]';
1820 }
1821 $form->add('select', $providerName, NULL,
1822 array(
1823 '' => ts('- select -')) + CRM_Core_PseudoConstant::get('CRM_Core_DAO_IM', 'provider_id'), $required
1824 );
1825 }
1826 else {
1827 $form->add('select', $name . '-provider_id', $title,
1828 array(
1829 '' => ts('- select -')) + CRM_Core_PseudoConstant::get('CRM_Core_DAO_IM', 'provider_id'), $required
1830 );
1831 }
1832
1833 if ($view && $mode != CRM_Profile_Form::MODE_SEARCH) {
1834 $form->freeze($name . '-provider_id');
1835 }
1836 }
1837 }
1838 elseif (($fieldName === 'birth_date') || ($fieldName === 'deceased_date')) {
1839 $form->addDate($name, $title, $required, array('formatType' => 'birth'));
1840 }
1841 elseif (in_array($fieldName, array(
1842 'membership_start_date', 'membership_end_date', 'join_date'))) {
1843 $form->addDate($name, $title, $required, array('formatType' => 'custom'));
1844 }
1845 elseif (CRM_Utils_Array::value('name',$field) == 'membership_type') {
1846 list($orgInfo, $types) = CRM_Member_BAO_MembershipType::getMembershipTypeInfo();
1847 $sel = &$form->addElement('hierselect', $name, $title);
1848 $select = array('' => ts('- select -') );
1849 if(count($orgInfo) == 1 && $field['is_required']) {
1850 // we only have one org - so we should default to it. Not sure about defaulting to first type
1851 // as it could be missed - so adding a select
1852 // however, possibly that is more similar to the membership form
1853 if(count($types[1]) > 1) {
1854 $types[1] = $select + $types[1];
1855 }
1856 }
1857 else {
1858 $orgInfo = $select + $orgInfo;
1859 }
1860 $sel->setOptions(array($orgInfo, $types));
1861 }
1862 elseif (CRM_Utils_Array::value('name',$field) == 'membership_status') {
1863 $form->add('select', $name, $title,
1864 array(
1865 '' => ts('- select -')) + CRM_Member_PseudoConstant::membershipStatus(NULL, NULL, 'label'), $required
1866 );
1867 }
1868 elseif ($fieldName === 'gender_id') {
1869 $genderOptions = array();
1870 $gender = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id');
1871 foreach ($gender as $key => $var) {
1872 $genderOptions[$key] = $form->createElement('radio', NULL, ts('Gender'), $var, $key);
1873 }
1874 $form->addGroup($genderOptions, $name, $title);
1875 if ($required) {
1876 $form->addRule($name, ts('%1 is a required field.', array(1 => $title)), 'required');
1877 }
1878 }
1879 elseif ($fieldName === 'prefix_id' || $fieldName === 'suffix_id') {
1880 $form->add('select', $name, $title,
1881 array(
1882 '' => ts('- select -')) + CRM_Core_PseudoConstant::get('CRM_Contact_BAO_Contact', $fieldName), $required
1883 );
1884 }
1885 elseif ($fieldName === 'contact_sub_type') {
1886 $gId = $form->get('gid') ? $form->get('gid') : CRM_Utils_Array::value('group_id', $field);
1887 if ($onBehalf) {
1888 $profileType = 'Organization';
1889 }
1890 else {
1891 $profileType = $gId ? CRM_Core_BAO_UFField::getProfileType($gId) : NULL;
1892 if ($profileType == 'Contact') {
1893 $profileType = 'Individual';
1894 }
1895 }
1896
1897 $setSubtype = FALSE;
1898 if (CRM_Contact_BAO_ContactType::isaSubType($profileType)) {
1899 $setSubtype = $profileType;
1900 $profileType = CRM_Contact_BAO_ContactType::getBasicType($profileType);
1901 }
1902
1903 $subtypes = $profileType ? CRM_Contact_BAO_ContactType::subTypePairs($profileType) : array();
1904
1905 if ($setSubtype) {
1906 $subtypeList = array();
1907 $subtypeList[$setSubtype] = $subtypes[$setSubtype];
1908 }
1909 else {
1910 $subtypeList = $subtypes;
1911 }
1912
1913 $sel = $form->add('select', $name, $title, $subtypeList, $required);
1914 $sel->setMultiple(TRUE);
1915 }
1916 elseif (in_array($fieldName, CRM_Contact_BAO_Contact::$_greetingTypes)) {
1917 //add email greeting, postal greeting, addressee, CRM-4575
1918 $gId = $form->get('gid') ? $form->get('gid') : CRM_Utils_Array::value('group_id', $field);
1919 $profileType = CRM_Core_BAO_UFField::getProfileType($gId, TRUE, FALSE, TRUE);
1920
1921 if (empty($profileType) || in_array($profileType, array(
1922 'Contact', 'Contribution', 'Participant', 'Membership'))) {
1923 $profileType = 'Individual';
1924 }
1925 if (CRM_Contact_BAO_ContactType::isaSubType($profileType)) {
1926 $profileType = CRM_Contact_BAO_ContactType::getBasicType($profileType);
1927 }
1928 $greeting = array(
1929 'contact_type' => $profileType,
1930 'greeting_type' => $fieldName,
1931 );
1932 $form->add('select', $name, $title,
1933 array(
1934 '' => ts('- select -')) + CRM_Core_PseudoConstant::greeting($greeting), $required
1935 );
1936 // add custom greeting element
1937 $form->add('text', $fieldName . '_custom', ts('Custom %1', array(1 => ucwords(str_replace('_', ' ', $fieldName)))),
1938 NULL, FALSE
1939 );
1940 }
1941 elseif ($fieldName === 'preferred_communication_method') {
1942 $communicationFields = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'preferred_communication_method');
1943 foreach ($communicationFields as $key => $var) {
1944 if ($key == '') {
1945 continue;
1946 }
1947 $communicationOptions[] = $form->createElement('checkbox', $key, NULL, $var);
1948 }
1949 $form->addGroup($communicationOptions, $name, $title, '<br/>');
1950 }
1951 elseif ($fieldName === 'preferred_mail_format') {
1952 $form->add('select', $name, $title, CRM_Core_SelectValues::pmf());
1953 }
1954 elseif ($fieldName === 'preferred_language') {
1955 $form->add('select', $name, $title, array('' => ts('- select -')) + CRM_Contact_BAO_Contact::buildOptions('preferred_language'));
1956 }
1957 elseif ($fieldName == 'external_identifier') {
1958 $form->add('text', $name, $title, $attributes, $required);
1959 $contID = $contactId;
1960 if (!$contID) {
1961 $contID = $form->get('id');
1962 }
1963 $form->addRule($name,
1964 ts('External ID already exists in Database.'),
1965 'objectExists',
1966 array('CRM_Contact_DAO_Contact', $contID, 'external_identifier')
1967 );
1968 }
1969 elseif ($fieldName === 'group') {
1970 CRM_Contact_Form_Edit_TagsAndGroups::buildQuickForm($form, $contactId,
1971 CRM_Contact_Form_Edit_TagsAndGroups::GROUP,
1972 TRUE, $required,
1973 $title, NULL, $name
1974 );
1975 }
1976 elseif ($fieldName === 'tag') {
1977 CRM_Contact_Form_Edit_TagsAndGroups::buildQuickForm($form, $contactId,
1978 CRM_Contact_Form_Edit_TagsAndGroups::TAG,
1979 FALSE, $required,
1980 NULL, $title, $name
1981 );
1982 }
1983 elseif (substr($fieldName, 0, 4) === 'url-') {
1984 $form->add('text', $name, $title,
1985 array_merge(CRM_Core_DAO::getAttribute('CRM_Core_DAO_Website', 'url'),
1986 array(
1987 'onfocus' => "if (!this.value) { this.value='http://';} else return false",
1988 'onblur' => "if ( this.value == 'http://') { this.value='';} else return false",
1989 )
1990 ), $required
1991 );
1992
1993 $form->addRule($name, ts('Enter a valid Website.'), 'url');
1994
1995 //Website type select
1996 if ($onBehalf) {
1997 if (substr($name, -1) == ']') {
1998 $websiteTypeName = substr($name, 0, -1) . '-website_type_id]';
1999 }
2000 $form->addElement('select', $websiteTypeName, NULL, CRM_Core_PseudoConstant::get('CRM_Core_DAO_Website', 'website_type_id'));
2001 }
2002 else {
2003 $form->addElement('select', $name . '-website_type_id', NULL, CRM_Core_PseudoConstant::get('CRM_Core_DAO_Website', 'website_type_id'));
2004 }
2005 }
2006 // Note should be rendered as textarea
2007 elseif (substr($fieldName, -4) == 'note') {
2008 $form->add('textarea', $name, $title, $attributes, $required);
2009 }
2010 elseif (substr($fieldName, 0, 6) === 'custom') {
2011 $customFieldID = CRM_Core_BAO_CustomField::getKeyID($fieldName);
2012 if ($customFieldID) {
2013 CRM_Core_BAO_CustomField::addQuickFormElement($form, $name, $customFieldID, FALSE, $required, $search, $title);
2014 }
2015 }
2016 elseif (substr($fieldName, 0, 14) === 'address_custom') {
2017 list($fName, $locTypeId) = CRM_Utils_System::explode('-', $fieldName, 2);
2018 $customFieldID = CRM_Core_BAO_CustomField::getKeyID(substr($fName, 8));
2019 if ($customFieldID) {
2020 CRM_Core_BAO_CustomField::addQuickFormElement($form, $name, $customFieldID, FALSE, $required, $search, $title);
2021 }
2022 }
2023 elseif (in_array($fieldName, array(
2024 'receive_date', 'receipt_date', 'thankyou_date', 'cancel_date'))) {
2025 $form->addDateTime($name, $title, $required, array('formatType' => 'activityDateTime'));
2026 }
2027 elseif ($fieldName == 'send_receipt') {
2028 $form->addElement('checkbox', $name, $title);
2029 }
2030 elseif ($fieldName == 'soft_credit') {
2031 CRM_Contact_Form_NewContact::buildQuickForm($form, $rowNumber, NULL, FALSE, 'soft_credit_');
2032 $form->addMoney("soft_credit_amount[{$rowNumber}]", ts('Amount'), FALSE, NULL, FALSE);
2033 }
2034 elseif ($fieldName == 'product_name') {
2035 list($products, $options) = CRM_Contribute_BAO_Premium::getPremiumProductInfo();
2036 $sel = &$form->addElement('hierselect', $name, $title);
2037 $products = array(
2038 '0' => ts('- select -')) + $products;
2039 $sel->setOptions(array($products, $options));
2040 }
2041 elseif ($fieldName == 'payment_instrument') {
2042 $form->add('select', $name, $title,
2043 array(''=>ts( '- select -' )) + CRM_Contribute_PseudoConstant::paymentInstrument( ), $required );
2044 }
2045 else if ($fieldName == 'financial_type' ) {
2046 $form->add('select', $name, $title,
2047 array(
2048 '' => ts('- select -')) + CRM_Contribute_PseudoConstant::financialType(), $required
2049 );
2050 }
2051 elseif ($fieldName == 'contribution_status_id') {
2052 $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus();
2053 $statusName = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
2054 foreach (array(
2055 'In Progress',
2056 'Overdue',
2057 'Refunded'
2058 ) as $suppress) {
2059 unset($contributionStatuses[CRM_Utils_Array::key($suppress, $statusName)]);
2060 }
2061
2062 $form->add('select', $name, $title,
2063 array(
2064 '' => ts('- select -')) + $contributionStatuses, $required
2065 );
2066 }
2067 elseif ($fieldName == 'soft_credit_type') {
2068 $form->add('select', $name, $title,
2069 array(
2070 '' => ts('- select -')) + CRM_Core_OptionGroup::values("soft_credit_type")
2071 );
2072 $form->addElement('hidden', 'sct_default_id',
2073 CRM_Core_OptionGroup::getDefaultValue("soft_credit_type"),
2074 array('id' => 'sct_default_id')
2075 );
2076 }
2077 elseif ($fieldName == 'currency') {
2078 $form->addCurrency($name, $title, $required);
2079 }
2080 elseif ($fieldName == 'contribution_page_id') {
2081 $form->add('select', $name, $title,
2082 array(
2083 '' => ts('- select -')) + CRM_Contribute_PseudoConstant::contributionPage(), $required, 'class="big"'
2084 );
2085 }
2086 elseif ($fieldName == 'participant_register_date') {
2087 $form->addDateTime($name, $title, $required, array('formatType' => 'activityDateTime'));
2088 }
2089 elseif ($fieldName == 'activity_status_id') {
2090 $form->add('select', $name, $title,
2091 array(
2092 '' => ts('- select -')) + CRM_Core_PseudoConstant::activityStatus(), $required
2093 );
2094 }
2095 elseif ($fieldName == 'activity_engagement_level') {
2096 $form->add('select', $name, $title,
2097 array(
2098 '' => ts('- select -')) + CRM_Campaign_PseudoConstant::engagementLevel(), $required
2099 );
2100 }
2101 elseif ($fieldName == 'activity_date_time') {
2102 $form->addDateTime($name, $title, $required, array('formatType' => 'activityDateTime'));
2103 }
2104 elseif ($fieldName == 'participant_status') {
2105 $cond = NULL;
2106 if ($online == TRUE) {
2107 $cond = 'visibility_id = 1';
2108 }
2109 $form->add('select', $name, $title,
2110 array(
2111 '' => ts('- select -')) + CRM_Event_PseudoConstant::participantStatus(NULL, $cond, 'label'), $required
2112 );
2113 }
2114 elseif ($fieldName == 'participant_role') {
2115 if (CRM_Utils_Array::value('is_multiple', $field)) {
2116 $form->addCheckBox($name, $title, CRM_Event_PseudoConstant::participantRole(), NULL, NULL, NULL, NULL, '&nbsp', TRUE);
2117 }
2118 else {
2119 $form->add('select', $name, $title,
2120 array(
2121 '' => ts('- select -')) + CRM_Event_PseudoConstant::participantRole(), $required
2122 );
2123 }
2124 }
2125 elseif ($fieldName == 'world_region') {
2126 $form->add('select', $name, $title,
2127 array(
2128 '' => ts('- select -')) + CRM_Core_PseudoConstant::worldRegion(), $required
2129 );
2130 }
2131 elseif ($fieldName == 'signature_html') {
2132 $form->addWysiwyg($name, $title, CRM_Core_DAO::getAttribute('CRM_Core_DAO_Email', $fieldName));
2133 }
2134 elseif ($fieldName == 'signature_text') {
2135 $form->add('textarea', $name, $title, CRM_Core_DAO::getAttribute('CRM_Core_DAO_Email', $fieldName));
2136 }
2137 elseif (substr($fieldName, -11) == 'campaign_id') {
2138 if (CRM_Campaign_BAO_Campaign::isCampaignEnable()) {
2139 $campaigns = CRM_Campaign_BAO_Campaign::getCampaigns(CRM_Utils_Array::value($contactId,
2140 $form->_componentCampaigns
2141 ));
2142 $form->add('select', $name, $title,
2143 array(
2144 '' => ts('- select -')) + $campaigns, $required, 'class="big"'
2145 );
2146 }
2147 }
2148 elseif ($fieldName == 'activity_details') {
2149 $form->addWysiwyg($fieldName, $title, array('rows' => 4, 'cols' => 60), $required);
2150 }
2151 elseif ($fieldName == 'activity_duration') {
2152 $form->add('text', $name, $title, $attributes, $required);
2153 $form->addRule($name, ts('Please enter the duration as number of minutes (integers only).'), 'positiveInteger');
2154 }
2155 else {
2156 if (substr($fieldName, 0, 3) === 'is_' or substr($fieldName, 0, 7) === 'do_not_') {
2157 $form->add('advcheckbox', $name, $title, $attributes, $required);
2158 }
2159 else {
2160 $form->add('text', $name, $title, $attributes, $required);
2161 }
2162 }
2163
2164 static $hiddenSubtype = FALSE;
2165 if (!$hiddenSubtype && CRM_Contact_BAO_ContactType::isaSubType($field['field_type'])) {
2166 // In registration mode params are submitted via POST and we don't have any clue
2167 // about profile-id or the profile-type (which could be a subtype)
2168 // To generalize the behavior and simplify the process,
2169 // lets always add the hidden
2170 //subtype value if there is any, and we won't have to
2171 // compute it while processing.
2172 if ($onBehalf) {
2173 $form->addElement('hidden', 'onbehalf[contact_sub_type]', $field['field_type']);
2174 }
2175 else {
2176 $form->addElement('hidden', 'contact_sub_type_hidden', $field['field_type']);
2177 }
2178 $hiddenSubtype = TRUE;
2179 }
2180
2181 if (($view && $mode != CRM_Profile_Form::MODE_SEARCH) || $isShared) {
2182 $form->freeze($name);
2183 }
2184
2185 //add the rules
2186 if (in_array($fieldName, array(
2187 'non_deductible_amount', 'total_amount', 'fee_amount', 'net_amount'))) {
2188 $form->addRule($name, ts('Please enter a valid amount.'), 'money');
2189 }
2190 $stateCountryMap = array();
2191 if (!empty($form->_stateCountryMap['state_province']) && !empty($form->_stateCountryMap['country'])) {
2192 foreach ($form->_stateCountryMap['state_province'] as $key => $value) {
2193 $stateCountryMap[$key]['state_province'] = $value;
2194 $stateCountryMap[$key]['country'] = $form->_stateCountryMap['country'][$key];
2195 }
2196 CRM_Core_BAO_Address::addStateCountryMap($stateCountryMap);
2197 }
2198 if ($rule) {
2199 if (!($rule == 'email' && $mode == CRM_Profile_Form::MODE_SEARCH)) {
2200 $form->addRule($name, ts('Please enter a valid %1', array(1 => $title)), $rule);
2201 }
2202 }
2203 }
2204
2205 /**
2206 * Function to set profile defaults
2207 *
2208 * @params int $contactId contact id
2209 * @params array $fields associative array of fields
2210 * @params array $defaults defaults array
2211 * @params boolean $singleProfile true for single profile else false(batch update)
2212 * @params int $componentId id for specific components like contribute, event etc
2213 *
2214 * @return null
2215 * @static
2216 * @access public
2217 */
2218 static function setProfileDefaults($contactId, &$fields, &$defaults,
2219 $singleProfile = TRUE, $componentId = NULL, $component = NULL
2220 ) {
2221 if (!$componentId) {
2222 //get the contact details
2223 list($contactDetails, $options) = CRM_Contact_BAO_Contact::getHierContactDetails($contactId, $fields);
2224 $details = CRM_Utils_Array::value($contactId, $contactDetails);
2225 $multipleFields = array('website' => 'url');
2226
2227 //start of code to set the default values
2228 foreach ($fields as $name => $field) {
2229 // skip pseudo fields
2230 if (substr($name, 0, 9) == 'phone_ext') {
2231 continue;
2232 }
2233
2234 //set the field name depending upon the profile mode(single/batch)
2235 if ($singleProfile) {
2236 $fldName = $name;
2237 }
2238 else {
2239 $fldName = "field[$contactId][$name]";
2240 }
2241
2242 if ($name == 'group') {
2243 CRM_Contact_Form_Edit_TagsAndGroups::setDefaults($contactId, $defaults, CRM_Contact_Form_Edit_TagsAndGroups::GROUP, $fldName);
2244 }
2245 if ($name == 'tag') {
2246 CRM_Contact_Form_Edit_TagsAndGroups::setDefaults($contactId, $defaults, CRM_Contact_Form_Edit_TagsAndGroups::TAG, $fldName);
2247 }
2248
2249 if (CRM_Utils_Array::value($name, $details) || isset($details[$name])) {
2250 //to handle custom data (checkbox) to be written
2251 // to handle birth/deceased date, greeting_type and few other fields
2252 if (($name == 'birth_date') || ($name == 'deceased_date')) {
2253 list($defaults[$fldName]) = CRM_Utils_Date::setDateDefaults($details[$name], 'birth');
2254 }
2255 elseif (in_array($name, CRM_Contact_BAO_Contact::$_greetingTypes)) {
2256 $defaults[$fldName] = $details[$name . '_id'];
2257 $defaults[$name . '_custom'] = $details[$name . '_custom'];
2258 }
2259 elseif ($name == 'preferred_communication_method') {
2260 $v = explode(CRM_Core_DAO::VALUE_SEPARATOR, $details[$name]);
2261 foreach ($v as $item) {
2262 if ($item) {
2263 $defaults[$fldName . "[$item]"] = 1;
2264 }
2265 }
2266 }
2267 elseif ($name == 'world_region') {
2268 $defaults[$fldName] = $details['worldregion_id'];
2269 }
2270 elseif ($customFieldId = CRM_Core_BAO_CustomField::getKeyID($name)) {
2271 //fix for custom fields
2272 $customFields = CRM_Core_BAO_CustomField::getFields(CRM_Utils_Array::value('contact_type', $details));
2273
2274 // hack to add custom data for components
2275 $components = array('Contribution', 'Participant', 'Membership', 'Activity');
2276 foreach ($components as $value) {
2277 $customFields = CRM_Utils_Array::crmArrayMerge($customFields,
2278 CRM_Core_BAO_CustomField::getFieldsForImport($value)
2279 );
2280 }
2281
2282 switch ($customFields[$customFieldId]['html_type']) {
2283 case 'Multi-Select State/Province':
2284 case 'Multi-Select Country':
2285 case 'AdvMulti-Select':
2286 case 'Multi-Select':
2287 $v = explode(CRM_Core_DAO::VALUE_SEPARATOR, $details[$name]);
2288 foreach ($v as $item) {
2289 if ($item) {
2290 $defaults[$fldName][$item] = $item;
2291 }
2292 }
2293 break;
2294
2295 case 'CheckBox':
2296 $v = explode(CRM_Core_DAO::VALUE_SEPARATOR, $details[$name]);
2297 foreach ($v as $item) {
2298 if ($item) {
2299 $defaults[$fldName][$item] = 1;
2300 // seems like we need this for QF style checkboxes in profile where its multiindexed
2301 // CRM-2969
2302 $defaults["{$fldName}[{$item}]"] = 1;
2303 }
2304 }
2305 break;
2306
2307 case 'Autocomplete-Select':
2308 if ($customFields[$customFieldId]['data_type'] == 'ContactReference') {
2309 if (is_numeric($details[$name])) {
2310 $defaults[$fldName . '_id'] = $details[$name];
2311 $defaults[$fldName] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $details[$name], 'sort_name');
2312 }
2313 }
2314 else {
2315 $label = CRM_Core_BAO_CustomOption::getOptionLabel($customFieldId, $details[$name]);
2316 $defaults[$fldName . '_id'] = $details[$name];
2317 $defaults[$fldName] = $label;
2318 }
2319 break;
2320
2321 case 'Select Date':
2322 // CRM-6681, set defult values according to date and time format (if any).
2323 $dateFormat = NULL;
2324 if (CRM_Utils_Array::value('date_format', $customFields[$customFieldId])) {
2325 $dateFormat = $customFields[$customFieldId]['date_format'];
2326 }
2327
2328 if (!CRM_Utils_Array::value('time_format', $customFields[$customFieldId])) {
2329 list($defaults[$fldName]) = CRM_Utils_Date::setDateDefaults($details[$name], NULL,
2330 $dateFormat
2331 );
2332 }
2333 else {
2334 $timeElement = $fldName . '_time';
2335 if (substr($fldName, -1) == ']') {
2336 $timeElement = substr($fldName, 0, -1) . '_time]';
2337 }
2338 list($defaults[$fldName], $defaults[$timeElement]) = CRM_Utils_Date::setDateDefaults($details[$name],
2339 NULL, $dateFormat, $customFields[$customFieldId]['time_format']);
2340 }
2341 break;
2342
2343 default:
2344 $defaults[$fldName] = $details[$name];
2345 break;
2346 }
2347 }
2348 else {
2349 $defaults[$fldName] = $details[$name];
2350 }
2351 }
2352 else {
2353 $blocks = array('email', 'phone', 'im', 'openid');
2354 list($fieldName, $locTypeId, $phoneTypeId) = CRM_Utils_System::explode('-', $name, 3);
2355 if (!in_array($fieldName, $multipleFields)) {
2356 if (is_array($details)) {
2357 foreach ($details as $key => $value) {
2358 // when we fixed CRM-5319 - get primary loc
2359 // type as per loc field and removed below code.
2360 $primaryLocationType = FALSE;
2361 if ($locTypeId == 'Primary') {
2362 if (is_array($value) && array_key_exists($fieldName, $value)){
2363 $primaryLocationType = TRUE;
2364 if (in_array($fieldName, $blocks)){
2365 $locTypeId = CRM_Contact_BAO_Contact::getPrimaryLocationType($contactId, FALSE, $fieldName);
2366 }
2367 else{
2368 $locTypeId = CRM_Contact_BAO_Contact::getPrimaryLocationType($contactId, FALSE, 'address');
2369 }
2370 }
2371 }
2372
2373 // fixed for CRM-665
2374 if (is_numeric($locTypeId)) {
2375 if ($primaryLocationType || $locTypeId == CRM_Utils_Array::value('location_type_id', $value)) {
2376 if (CRM_Utils_Array::value($fieldName, $value)) {
2377 //to handle stateprovince and country
2378 if ($fieldName == 'state_province') {
2379 $defaults[$fldName] = $value['state_province_id'];
2380 }
2381 elseif ($fieldName == 'county') {
2382 $defaults[$fldName] = $value['county_id'];
2383 }
2384 elseif ($fieldName == 'country') {
2385 if (!isset($value['country_id']) || !$value['country_id']) {
2386 $config = CRM_Core_Config::singleton();
2387 if ($config->defaultContactCountry) {
2388 $defaults[$fldName] = $config->defaultContactCountry;
2389 }
2390 }
2391 else {
2392 $defaults[$fldName] = $value['country_id'];
2393 }
2394 }
2395 elseif ($fieldName == 'phone') {
2396 if ($phoneTypeId) {
2397 if (isset($value['phone'][$phoneTypeId])) {
2398 $defaults[$fldName] = $value['phone'][$phoneTypeId];
2399 }
2400 if (isset($value['phone_ext'][$phoneTypeId])) {
2401 $defaults[str_replace('phone', 'phone_ext', $fldName)] = $value['phone_ext'][$phoneTypeId];
2402 }
2403 }
2404 else {
2405 $phoneDefault = CRM_Utils_Array::value('phone', $value);
2406 // CRM-9216
2407 if (!is_array($phoneDefault)) {
2408 $defaults[$fldName] = $phoneDefault;
2409 }
2410 }
2411 }
2412 elseif ($fieldName == 'email') {
2413 //adding the first email (currently we don't support multiple emails of same location type)
2414 $defaults[$fldName] = $value['email'];
2415 }
2416 elseif ($fieldName == 'im') {
2417 //adding the first im (currently we don't support multiple ims of same location type)
2418 $defaults[$fldName] = $value['im'];
2419 $defaults[$fldName . '-provider_id'] = $value['im_provider_id'];
2420 }
2421 else {
2422 $defaults[$fldName] = $value[$fieldName];
2423 }
2424 }
2425 elseif (substr($fieldName, 0, 14) === 'address_custom' &&
2426 CRM_Utils_Array::value(substr($fieldName, 8), $value)
2427 ) {
2428 $defaults[$fldName] = $value[substr($fieldName, 8)];
2429 }
2430 }
2431 }
2432 }
2433 }
2434 }
2435 else {
2436 if (is_array($details)) {
2437 if ($fieldName === 'url') {
2438 if (!empty($details['website'])) {
2439 foreach ($details['website'] as $val) {
2440 $defaults[$fldName] = CRM_Utils_Array::value('url', $val);
2441 $defaults[$fldName . '-website_type_id'] = $val['website_type_id'];
2442 }
2443 }
2444 }
2445 }
2446 }
2447 }
2448 }
2449 }
2450
2451 //Handling Contribution Part of the batch profile
2452 if (CRM_Core_Permission::access('CiviContribute') && $component == 'Contribute') {
2453 self::setComponentDefaults($fields, $componentId, $component, $defaults);
2454 }
2455
2456 //Handling Event Participation Part of the batch profile
2457 if (CRM_Core_Permission::access('CiviEvent') && $component == 'Event') {
2458 self::setComponentDefaults($fields, $componentId, $component, $defaults);
2459 }
2460
2461 //Handling membership Part of the batch profile
2462 if (CRM_Core_Permission::access('CiviMember') && $component == 'Membership') {
2463 self::setComponentDefaults($fields, $componentId, $component, $defaults);
2464 }
2465
2466 //Handling Activity Part of the batch profile
2467 if ($component == 'Activity') {
2468 self::setComponentDefaults($fields, $componentId, $component, $defaults);
2469 }
2470 }
2471
2472 /**
2473 * Function to get profiles by type eg: pure Individual etc
2474 *
2475 * @param array $types associative array of types eg: types('Individual')
2476 * @param boolean $onlyPure true if only pure profiles are required
2477 *
2478 * @return array $profiles associative array of profiles
2479 * @static
2480 * @access public
2481 */
2482 static function getProfiles($types, $onlyPure = FALSE) {
2483 $profiles = array();
2484 $ufGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_UFField', 'uf_group_id');
2485
2486 CRM_Utils_Hook::aclGroup(CRM_Core_Permission::ADMIN, NULL, 'civicrm_uf_group', $ufGroups, $ufGroups);
2487
2488 // Exclude Batch Data Entry profiles - CRM-10901
2489 $batchProfiles = CRM_Core_BAO_UFGroup::getBatchProfiles();
2490
2491 foreach ($ufGroups as $id => $title) {
2492 $ptype = CRM_Core_BAO_UFField::getProfileType($id, FALSE, $onlyPure);
2493 if (in_array($ptype, $types) && !array_key_exists($id, $batchProfiles)) {
2494 $profiles[$id] = $title;
2495 }
2496 }
2497 return $profiles;
2498 }
2499
2500 /**
2501 * Function to check whether a profile is valid combination of
2502 * required and/or optional profile types
2503 *
2504 * @param array $required array of types those are required
2505 * @param array $optional array of types those are optional
2506 *
2507 * @return array $profiles associative array of profiles
2508 * @static
2509 * @access public
2510 */
2511 static function getValidProfiles($required, $optional = NULL) {
2512 if (!is_array($required) || empty($required)) {
2513 return;
2514 }
2515
2516 $profiles = array();
2517 $ufGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_UFField', 'uf_group_id');
2518
2519 CRM_Utils_Hook::aclGroup(CRM_Core_Permission::ADMIN, NULL, 'civicrm_uf_group', $ufGroups, $ufGroups);
2520
2521 foreach ($ufGroups as $id => $title) {
2522 $type = CRM_Core_BAO_UFField::checkValidProfileType($id, $required, $optional);
2523 if ($type) {
2524 $profiles[$id] = $title;
2525 }
2526 }
2527
2528 return $profiles;
2529 }
2530
2531 /**
2532 * Function to check whether a profile is valid combination of
2533 * required profile fields
2534 *
2535 * @param array $ufId integer id of the profile
2536 * @param array $required array of fields those are required in the profile
2537 *
2538 * @return array $profiles associative array of profiles
2539 * @static
2540 * @access public
2541 */
2542 static function checkValidProfile($ufId, $required = NULL) {
2543 $validProfile = FALSE;
2544 if (!$ufId) {
2545 return $validProfile;
2546 }
2547
2548 if (!CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $ufId, 'is_active')) {
2549 return $validProfile;
2550 }
2551
2552 $profileFields = self::getFields($ufId, FALSE, CRM_Core_Action::VIEW, NULL,
2553 NULL, FALSE, NULL, FALSE, NULL,
2554 CRM_Core_Permission::CREATE, NULL
2555 );
2556
2557 $validProfile = array();
2558 if (!empty($profileFields)) {
2559 $fields = array_keys($profileFields);
2560 foreach ($fields as $val) {
2561 foreach ($required as $key => $field) {
2562 if (strpos($val, $field) === 0) {
2563 unset($required[$key]);
2564 }
2565 }
2566 }
2567
2568 $validProfile = (empty($required)) ? TRUE : FALSE;
2569 }
2570
2571 return $validProfile;
2572 }
2573
2574 /**
2575 * Function to get default value for Register.
2576 *
2577 * @return $defaults
2578 * @static
2579 * @access public
2580 */
2581 static function setRegisterDefaults(&$fields, &$defaults) {
2582 $config = CRM_Core_Config::singleton();
2583 foreach ($fields as $name => $field) {
2584 if (substr($name, 0, 8) == 'country-') {
2585 if (!empty($config->defaultContactCountry)) {
2586 $defaults[$name] = $config->defaultContactCountry;
2587 }
2588 }
2589 elseif (substr($name, 0, 15) == 'state_province-') {
2590 if (!empty($config->defaultContactStateProvince)) {
2591 $defaults[$name] = $config->defaultContactStateProvince;
2592 }
2593 }
2594 }
2595 return $defaults;
2596 }
2597
2598 /**
2599 * This function is to make a copy of a profile, including
2600 * all the fields in the profile
2601 *
2602 * @param int $id the profile id to copy
2603 *
2604 * @return void
2605 * @access public
2606 */
2607 static function copy($id) {
2608 $fieldsFix = array('prefix' => array('title' => ts('Copy of ')));
2609 $copy = &CRM_Core_DAO::copyGeneric('CRM_Core_DAO_UFGroup',
2610 array('id' => $id),
2611 NULL,
2612 $fieldsFix
2613 );
2614
2615 if ($pos = strrpos($copy->name, "_{$id}")) {
2616 $copy->name = substr_replace($copy->name, '', $pos);
2617 }
2618 $copy->name = CRM_Utils_String::munge($copy->name, '_', 56) . "_{$copy->id}";
2619 $copy->save();
2620
2621 $copyUFJoin = &CRM_Core_DAO::copyGeneric('CRM_Core_DAO_UFJoin',
2622 array('uf_group_id' => $id),
2623 array('uf_group_id' => $copy->id),
2624 NULL,
2625 'entity_table'
2626 );
2627
2628 $copyUFField = &CRM_Core_DAO::copyGeneric('CRM_Core_BAO_UFField',
2629 array('uf_group_id' => $id),
2630 array('uf_group_id' => $copy->id)
2631 );
2632
2633 $maxWeight = CRM_Utils_Weight::getMax('CRM_Core_DAO_UFJoin', NULL, 'weight');
2634
2635 //update the weight
2636 $query = "
2637 UPDATE civicrm_uf_join
2638 SET weight = %1
2639 WHERE uf_group_id = %2
2640 AND ( entity_id IS NULL OR entity_id <= 0 )
2641 ";
2642 $p = array(1 => array($maxWeight + 1, 'Integer'),
2643 2 => array($copy->id, 'Integer'),
2644 );
2645 CRM_Core_DAO::executeQuery($query, $p);
2646 if ($copy->is_reserved) {
2647 $query = "UPDATE civicrm_uf_group SET is_reserved = 0 WHERE id = %1";
2648 $params = array(1 => array($copy->id, 'Integer'));
2649 CRM_Core_DAO::executeQuery($query, $params);
2650 }
2651 CRM_Utils_Hook::copy('UFGroup', $copy);
2652
2653 return $copy;
2654 }
2655
2656 /**
2657 * Process that send notification e-mails
2658 *
2659 * @params int $contactId contact id
2660 * @params array $values associative array of name/value pair
2661 *
2662 * @return void
2663 * @access public
2664 */
2665
2666 static function commonSendMail($contactID, &$values) {
2667 if (!$contactID || !$values) {
2668 return;
2669
2670 }
2671 $template = CRM_Core_Smarty::singleton();
2672
2673 $displayName = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
2674 $contactID,
2675 'display_name'
2676 );
2677
2678 self::profileDisplay($values['id'], $values['values'], $template);
2679 $emailList = explode(',', $values['email']);
2680
2681 $contactLink = CRM_Utils_System::url('civicrm/contact/view',
2682 "reset=1&cid=$contactID",
2683 TRUE, NULL, FALSE, FALSE, TRUE
2684 );
2685
2686 //get the default domain email address.
2687 list($domainEmailName, $domainEmailAddress) = CRM_Core_BAO_Domain::getNameAndEmail();
2688
2689 if (!$domainEmailAddress || $domainEmailAddress == 'info@EXAMPLE.ORG') {
2690 $fixUrl = CRM_Utils_System::url('civicrm/admin/domain', 'action=update&reset=1');
2691 CRM_Core_Error::fatal(ts('The site administrator needs to enter a valid \'FROM Email Address\' in <a href="%1">Administer CiviCRM &raquo; Communications &raquo; FROM Email Addresses</a>. The email address used may need to be a valid mail account with your email service provider.', array(1 => $fixUrl)));
2692 }
2693
2694 foreach ($emailList as $emailTo) {
2695 // FIXME: take the below out of the foreach loop
2696 CRM_Core_BAO_MessageTemplate::sendTemplate(
2697 array(
2698 'groupName' => 'msg_tpl_workflow_uf',
2699 'valueName' => 'uf_notify',
2700 'contactId' => $contactID,
2701 'tplParams' => array(
2702 'displayName' => $displayName,
2703 'currentDate' => date('r'),
2704 'contactLink' => $contactLink,
2705 ),
2706 'from' => "$domainEmailName <$domainEmailAddress>",
2707 'toEmail' => $emailTo,
2708 )
2709 );
2710 }
2711 }
2712
2713 /**
2714 * Given a contact id and a group id, returns the field values from the db
2715 * for this group and notify email only if group's notify field is
2716 * set and field values are not empty
2717 *
2718 * @params $gid group id
2719 * @params $cid contact id
2720 * @params $params associative array
2721 *
2722 * @return array
2723 * @access public
2724 */
2725 function checkFieldsEmptyValues($gid, $cid, $params, $skipCheck = FALSE) {
2726 if ($gid) {
2727 if (CRM_Core_BAO_UFGroup::filterUFGroups($gid, $cid) || $skipCheck) {
2728 $values = array();
2729 $fields = CRM_Core_BAO_UFGroup::getFields($gid, FALSE, CRM_Core_Action::VIEW);
2730 CRM_Core_BAO_UFGroup::getValues($cid, $fields, $values, FALSE, $params, TRUE);
2731
2732 $email = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $gid, 'notify');
2733
2734 if (!empty($values) &&
2735 !empty($email)
2736 ) {
2737 $val = array(
2738 'id' => $gid,
2739 'values' => $values,
2740 'email' => $email,
2741 );
2742 return $val;
2743 }
2744 }
2745 }
2746 return NULL;
2747 }
2748
2749 /**
2750 * Function to assign uf fields to template
2751 *
2752 * @params int $gid group id
2753 * @params array $values associative array of fields
2754 *
2755 * @return void
2756 * @access public
2757 */
2758 function profileDisplay($gid, $values, $template) {
2759 $groupTitle = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $gid, 'title');
2760 $template->assign('grouptitle', $groupTitle);
2761 if (count($values)) {
2762 $template->assign('values', $values);
2763 }
2764 }
2765
2766 /**
2767 * Format fields for dupe Contact Matching
2768 *
2769 * @param array $params associated array
2770 *
2771 * @return array $data assoicated formatted array
2772 * @access public
2773 * @static
2774 */
2775 static function formatFields($params, $contactId = NULL) {
2776 if ($contactId) {
2777 // get the primary location type id and email
2778 list($name, $primaryEmail, $primaryLocationType) = CRM_Contact_BAO_Contact_Location::getEmailDetails($contactId);
2779 }
2780 else {
2781 $defaultLocationType = CRM_Core_BAO_LocationType::getDefault();
2782 $primaryLocationType = $defaultLocationType->id;
2783 }
2784
2785 $data = array();
2786 $locationType = array();
2787 $count = 1;
2788 $primaryLocation = 0;
2789 foreach ($params as $key => $value) {
2790 list($fieldName, $locTypeId, $phoneTypeId) = explode('-', $key);
2791
2792 if ($locTypeId == 'Primary') {
2793 $locTypeId = $primaryLocationType;
2794 }
2795
2796 if (is_numeric($locTypeId)) {
2797 if (!in_array($locTypeId, $locationType)) {
2798 $locationType[$count] = $locTypeId;
2799 $count++;
2800 }
2801 $loc = CRM_Utils_Array::key($locTypeId, $locationType);
2802
2803 $data['location'][$loc]['location_type_id'] = $locTypeId;
2804
2805 // if we are getting in a new primary email, dont overwrite the new one
2806 if ($locTypeId == $primaryLocationType) {
2807 if (CRM_Utils_Array::value('email-' . $primaryLocationType, $params)) {
2808 $data['location'][$loc]['email'][$loc]['email'] = $fields['email-' . $primaryLocationType];
2809 }
2810 elseif (isset($primaryEmail)) {
2811 $data['location'][$loc]['email'][$loc]['email'] = $primaryEmail;
2812 }
2813 $primaryLocation++;
2814 }
2815
2816 if ($loc == 1) {
2817 $data['location'][$loc]['is_primary'] = 1;
2818 }
2819 if ($fieldName == 'phone') {
2820 if ($phoneTypeId) {
2821 $data['location'][$loc]['phone'][$loc]['phone_type_id'] = $phoneTypeId;
2822 }
2823 else {
2824 $data['location'][$loc]['phone'][$loc]['phone_type_id'] = '';
2825 }
2826 $data['location'][$loc]['phone'][$loc]['phone'] = $value;
2827 }
2828 elseif ($fieldName == 'email') {
2829 $data['location'][$loc]['email'][$loc]['email'] = $value;
2830 }
2831 elseif ($fieldName == 'im') {
2832 $data['location'][$loc]['im'][$loc]['name'] = $value;
2833 }
2834 else {
2835 if ($fieldName === 'state_province') {
2836 $data['location'][$loc]['address']['state_province_id'] = $value;
2837 }
2838 elseif ($fieldName === 'country') {
2839 $data['location'][$loc]['address']['country_id'] = $value;
2840 }
2841 else {
2842 $data['location'][$loc]['address'][$fieldName] = $value;
2843 }
2844 }
2845 }
2846 else {
2847 // TODO: prefix, suffix and gender translation may no longer be necessary - check inputs
2848 if ($key === 'individual_suffix') {
2849 $data['suffix_id'] = $value;
2850 }
2851 elseif ($key === 'individual_prefix') {
2852 $data['prefix_id'] = $value;
2853 }
2854 elseif ($key === 'gender') {
2855 $data['gender_id'] = $value;
2856 }
2857 elseif (substr($key, 0, 6) === 'custom') {
2858 if ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($key)) {
2859 //fix checkbox
2860 if ($customFields[$customFieldID]['html_type'] == 'CheckBox') {
2861 $value = implode(CRM_Core_DAO::VALUE_SEPARATOR, array_keys($value));
2862 }
2863 // fix the date field
2864 if ($customFields[$customFieldID]['data_type'] == 'Date') {
2865 $date = CRM_Utils_Date::format($value);
2866 if (!$date) {
2867 $date = '';
2868 }
2869 $value = $date;
2870 }
2871
2872 $data['custom'][$customFieldID] = array(
2873 'id' => $id,
2874 'value' => $value,
2875 'extends' => $customFields[$customFieldID]['extends'],
2876 'type' => $customFields[$customFieldID]['data_type'],
2877 'custom_field_id' => $customFieldID,
2878 );
2879 }
2880 }
2881 elseif ($key == 'edit') {
2882 continue;
2883 }
2884 else {
2885 $data[$key] = $value;
2886 }
2887 }
2888 }
2889
2890 if (!$primaryLocation) {
2891 $loc++;
2892 $data['location'][$loc]['email'][$loc]['email'] = $primaryEmail;
2893 }
2894
2895
2896 return $data;
2897 }
2898
2899 /**
2900 * calculate the profile type 'group_type' as per profile fields.
2901 *
2902 * @param int $gid profile id
2903 * @param int $ignoreFieldId ignore particular profile field
2904 *
2905 * @return array list of calculated group type
2906 */
2907 static function calculateGroupType($gId, $includeTypeValues = FALSE, $ignoreFieldId = NULL) {
2908 //get the profile fields.
2909 $ufFields = self::getFields($gId, FALSE, NULL, NULL, NULL, TRUE, NULL, TRUE);
2910 return self::_calculateGroupType($ufFields, $includeTypeValues, $ignoreFieldId);
2911 }
2912
2913 /**
2914 * calculate the profile type 'group_type' as per profile fields.
2915 *
2916 * @param int $gid profile id
2917 * @param int $ignoreFieldId ignore perticular profile field
2918 *
2919 * @return array list of calculated group type
2920 */
2921 static function _calculateGroupType($ufFields, $includeTypeValues = FALSE, $ignoreFieldId = NULL) {
2922 $groupType = $groupTypeValues = $customFieldIds = array();
2923 if (!empty($ufFields)) {
2924 foreach ($ufFields as $fieldName => $fieldValue) {
2925 //ignore field from group type when provided.
2926 //in case of update profile field.
2927 if ($ignoreFieldId && ($ignoreFieldId == $fieldValue['field_id'])) {
2928 continue;
2929 }
2930 if (!in_array($fieldValue['field_type'], $groupType)) {
2931 $groupType[$fieldValue['field_type']] = $fieldValue['field_type'];
2932 }
2933
2934 if ($includeTypeValues && ($fldId = CRM_Core_BAO_CustomField::getKeyID($fieldName))) {
2935 $customFieldIds[$fldId] = $fldId;
2936 }
2937 }
2938 }
2939
2940 if (!empty($customFieldIds)) {
2941 $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) . ')';
2942
2943 $customGroups = CRM_Core_DAO::executeQuery($query);
2944 while ($customGroups->fetch()) {
2945 if (!$customGroups->extends_entity_column_value) {
2946 continue;
2947 }
2948
2949 $groupTypeName = "{$customGroups->extends}Type";
2950 if ($customGroups->extends == 'Participant' && $customGroups->extends_entity_column_id) {
2951 $groupTypeName = CRM_Core_OptionGroup::getValue('custom_data_type', $customGroups->extends_entity_column_id, 'value', 'String', 'name');
2952 }
2953
2954 foreach (explode(CRM_Core_DAO::VALUE_SEPARATOR, $customGroups->extends_entity_column_value) as $val) {
2955 if ($val) {
2956 $groupTypeValues[$groupTypeName][$val] = $val;
2957 }
2958 }
2959 }
2960
2961 if (!empty($groupTypeValues)) {
2962 $groupType = array_merge($groupType, $groupTypeValues);
2963 }
2964 }
2965
2966 return $groupType;
2967 }
2968
2969 /**
2970 * Update the profile type 'group_type' as per profile fields including group types and group subtype values.
2971 * Build and store string like: group_type1,group_type2[VALUE_SEPERATOR]group_type1Type:1:2:3,group_type2Type:1:2
2972 *
2973 * FIELDS GROUP_TYPE
2974 * BirthDate + Email Individual,Contact
2975 * BirthDate + Subject Individual,Activity
2976 * BirthDate + Subject + SurveyOnlyField Individual,Activity\0ActivityType:28
2977 * BirthDate + Subject + SurveyOnlyField + PhoneOnlyField (Not allowed)
2978 * BirthDate + SurveyOnlyField Individual,Activity\0ActivityType:28
2979 * BirthDate + Subject + SurveyOrPhoneField Individual,Activity\0ActivityType:2:28
2980 * BirthDate + SurveyOrPhoneField Individual,Activity\0ActivityType:2:28
2981 * BirthDate + SurveyOrPhoneField + SurveyOnlyField Individual,Activity\0ActivityType:2:28
2982 * BirthDate + StudentField + Subject + SurveyOnlyField Individual,Activity,Student\0ActivityType:28
2983 *
2984 * @param Integer $gid profile id
2985 * @param Array $groupTypes With key having group type names
2986 *
2987 * @return Boolean
2988 */
2989 static function updateGroupTypes($gId, $groupTypes = array(
2990 )) {
2991 if (!is_array($groupTypes) || !$gId) {
2992 return FALSE;
2993 }
2994
2995 // If empty group types set group_type as 'null'
2996 if (empty($groupTypes)) {
2997 return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_UFGroup', $gId, 'group_type', 'null');
2998 }
2999
3000 $componentGroupTypes = array('Contribution', 'Participant', 'Membership', 'Activity');
3001 $validGroupTypes = array_merge(array('Contact', 'Individual', 'Organization', 'Household'), $componentGroupTypes, CRM_Contact_BAO_ContactType::subTypes());
3002
3003 $gTypes = $gTypeValues = array();
3004
3005 $participantExtends = array('ParticipantRole', 'ParticipantEventName', 'ParticipantEventType');
3006 // Get valid group type and group subtypes
3007 foreach ($groupTypes as $groupType => $value) {
3008 if (in_array($groupType, $validGroupTypes) && !in_array($groupType, $gTypes)) {
3009 $gTypes[] = $groupType;
3010 }
3011
3012 $subTypesOf = NULL;
3013
3014 if (in_array($groupType, $participantExtends)) {
3015 $subTypesOf = $groupType;
3016 }
3017 elseif (strpos($groupType, 'Type') > 0) {
3018 $subTypesOf = substr($groupType, 0, strpos($groupType, 'Type'));
3019 }
3020 else {
3021 continue;
3022 }
3023
3024 if (!empty($value) &&
3025 (in_array($subTypesOf, $componentGroupTypes) ||
3026 in_array($subTypesOf, $participantExtends)
3027 )
3028 ) {
3029 $gTypeValues[$subTypesOf] = $groupType . ":" . implode(':', $value);
3030 }
3031 }
3032
3033 if (empty($gTypes)) {
3034 return FALSE;
3035 }
3036
3037 // Build String to store group types and group subtypes
3038 $groupTypeString = implode(',', $gTypes);
3039 if (!empty($gTypeValues)) {
3040 $groupTypeString .= CRM_Core_DAO::VALUE_SEPARATOR . implode(',', $gTypeValues);
3041 }
3042
3043 return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_UFGroup', $gId, 'group_type', $groupTypeString);
3044 }
3045
3046 /**
3047 * Create a "group_type" string
3048 *
3049 * @param array $coreTypes e.g. array('Individual','Contact','Student')
3050 * @param array $subTypes e.g. array('ActivityType' => array(7, 11))
3051 * @param string $delim
3052 * @throws CRM_Core_Exception
3053 */
3054 static function encodeGroupType($coreTypes, $subTypes, $delim = CRM_Core_DAO::VALUE_SEPARATOR) {
3055 $groupTypeExpr = '';
3056 if ($coreTypes) {
3057 $groupTypeExpr .= implode(',', $coreTypes);
3058 }
3059 if ($subTypes) {
3060 if (count($subTypes) > 1) {
3061 throw new CRM_Core_Exception("Multiple subtype filtering is not currently supported by widget.");
3062 }
3063 foreach ($subTypes as $subType => $subTypeIds) {
3064 $groupTypeExpr .= $delim . $subType . ':' . implode(':', $subTypeIds);
3065 }
3066 }
3067 return $groupTypeExpr;
3068 }
3069
3070 /**
3071 * This function is used to setDefault componet specific profile fields.
3072 *
3073 * @param array $fields profile fields.
3074 * @param int $componentId componetID
3075 * @param string $component component name
3076 * @param array $defaults an array of default values.
3077 *
3078 * @return void.
3079 */
3080 public static function setComponentDefaults(&$fields, $componentId, $component, &$defaults, $isStandalone = FALSE) {
3081 if (!$componentId ||
3082 !in_array($component, array('Contribute', 'Membership', 'Event', 'Activity'))
3083 ) {
3084 return;
3085 }
3086
3087 $componentBAO = $componentSubType = NULL;
3088 switch ($component) {
3089 case 'Membership':
3090 $componentBAO = 'CRM_Member_BAO_Membership';
3091 $componentBAOName = 'Membership';
3092 $componentSubType = array('membership_type_id');
3093 break;
3094
3095 case 'Contribute':
3096 $componentBAO = 'CRM_Contribute_BAO_Contribution';
3097 $componentBAOName = 'Contribution';
3098 $componentSubType = array( 'financial_type_id' );
3099 break;
3100
3101 case 'Event':
3102 $componentBAO = 'CRM_Event_BAO_Participant';
3103 $componentBAOName = 'Participant';
3104 $componentSubType = array('role_id', 'event_id');
3105 break;
3106
3107 case 'Activity':
3108 $componentBAO = 'CRM_Activity_BAO_Activity';
3109 $componentBAOName = 'Activity';
3110 $componentSubType = array('activity_type_id');
3111 break;
3112 }
3113
3114 $values = array();
3115 $params = array('id' => $componentId);
3116
3117 //get the component values.
3118 CRM_Core_DAO::commonRetrieve($componentBAO, $params, $values);
3119
3120 $formattedGroupTree = array();
3121 $dateTimeFields = array('participant_register_date', 'activity_date_time', 'receive_date', 'receipt_date', 'cancel_date', 'thankyou_date', 'membership_start_date', 'membership_end_date', 'join_date');
3122 foreach ($fields as $name => $field) {
3123 $fldName = $isStandalone ? $name : "field[$componentId][$name]";
3124 if (in_array($name, $dateTimeFields)) {
3125 $timefldName = $isStandalone ? "{$name}_time" : "field[$componentId][{$name}_time]";
3126 if (CRM_Utils_Array::value($name, $values)) {
3127 list($defaults[$fldName], $defaults[$timefldName]) = CRM_Utils_Date::setDateDefaults($values[$name]);
3128 }
3129 }
3130 elseif (array_key_exists($name, $values)) {
3131 $defaults[$fldName] = $values[$name];
3132 }
3133 elseif ($name == 'participant_note') {
3134 $noteDetails = CRM_Core_BAO_Note::getNote($componentId, 'civicrm_participant');
3135 $defaults[$fldName] = array_pop($noteDetails);
3136 }
3137 elseif (in_array($name, array(
3138 'financial_type', 'payment_instrument', 'participant_status', 'participant_role'))) {
3139 $defaults[$fldName] = $values["{$name}_id"];
3140 }
3141 elseif ($name == 'membership_type') {
3142 // since membership_type field is a hierselect -
3143 $defaults[$fldName][0] =
3144 CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',$values['membership_type_id'],'member_of_contact_id','id');
3145 $defaults[$fldName][1] = $values['membership_type_id'];
3146 }
3147 elseif ($name == 'membership_status') {
3148 $defaults[$fldName] = $values['status_id'];
3149 }
3150 elseif ($customFieldInfo = CRM_Core_BAO_CustomField::getKeyID($name, TRUE)) {
3151 if (empty($formattedGroupTree)) {
3152 //get the groupTree as per subTypes.
3153 $groupTree = array();
3154 foreach ($componentSubType as $subType) {
3155 $subTree = CRM_Core_BAO_CustomGroup::getTree($componentBAOName, CRM_Core_DAO::$_nullObject,
3156 $componentId, 0, $values[$subType]
3157 );
3158 $groupTree = CRM_Utils_Array::crmArrayMerge($groupTree, $subTree);
3159 }
3160 $formattedGroupTree = CRM_Core_BAO_CustomGroup::formatGroupTree($groupTree, 1, CRM_Core_DAO::$_nullObject);
3161 CRM_Core_BAO_CustomGroup::setDefaults($formattedGroupTree, $defaults);
3162 }
3163
3164 //FIX ME: We need to loop defaults, but once we move to custom_1_x convention this code can be simplified.
3165 foreach ($defaults as $customKey => $customValue) {
3166 if ($customFieldDetails = CRM_Core_BAO_CustomField::getKeyID($customKey, TRUE)) {
3167 if ($name == 'custom_' . $customFieldDetails[0]) {
3168
3169 //hack to set default for checkbox
3170 //basically this is for weired field name like field[33][custom_19]
3171 //we are converting this field name to array structure and assign value.
3172 $skipValue = FALSE;
3173
3174 foreach ($formattedGroupTree as $tree) {
3175 if ('CheckBox' == CRM_Utils_Array::value('html_type', $tree['fields'][$customFieldDetails[0]])) {
3176 $skipValue = TRUE;
3177 $defaults['field'][$componentId][$name] = $customValue;
3178 break;
3179 }
3180 elseif (CRM_Utils_Array::value('data_type', $tree['fields'][$customFieldDetails[0]]) == 'Date') {
3181 $skipValue = TRUE;
3182
3183 // CRM-6681, $default contains formatted date, time values.
3184 $defaults[$fldName] = $customValue;
3185 if (CRM_Utils_Array::value($customKey . '_time', $defaults)) {
3186 $defaults['field'][$componentId][$name . '_time'] = $defaults[$customKey . '_time'];
3187 }
3188 }
3189 }
3190
3191 if (!$skipValue || $isStandalone) {
3192 $defaults[$fldName] = $customValue;
3193 }
3194 unset($defaults[$customKey]);
3195 break;
3196 }
3197 }
3198 }
3199 }
3200 }
3201 }
3202
3203 /**
3204 * Function to retrieve reserved profiles
3205 *
3206 * @param string $name name if the reserve profile
3207 * @param array $extraProfiles associated array of profile id's that needs to merge
3208 *
3209 * @return array $reservedProfiles returns associated array
3210 * @static
3211 */
3212 static function getReservedProfiles($type = 'Contact', $extraProfiles = NULL) {
3213 $reservedProfiles = array();
3214 $profileNames = array();
3215 if ($type == 'Contact') {
3216 $whereClause = 'name IN ( "new_individual", "new_organization", "new_household" )';
3217 if (CRM_Contact_BAO_ContactType::isActive('Individual')) {
3218 $profileNames[] = '"new_individual"';
3219 }
3220 if (CRM_Contact_BAO_ContactType::isActive('Household')) {
3221 $profileNames[] = '"new_household"';
3222 }
3223 if (CRM_Contact_BAO_ContactType::isActive('Organization')) {
3224 $profileNames[] = '"new_organization"';
3225 }
3226 }
3227 if (!empty($profileNames)) {
3228 $whereClause = 'name IN ( ' . implode(',', $profileNames) . ' ) AND is_reserved = 1';
3229 }
3230 else {
3231 $whereClause = 'is_reserved = 1';
3232 }
3233
3234 $query = "SELECT id, title FROM civicrm_uf_group WHERE {$whereClause}";
3235
3236 $dao = CRM_Core_DAO::executeQuery($query);
3237 while ($dao->fetch()) {
3238 $key = $dao->id;
3239 if ($extraProfiles) {
3240 $key .= ',' . implode(',', $extraProfiles);
3241 }
3242 $reservedProfiles[$key] = $dao->title;
3243 }
3244 return $reservedProfiles;
3245 }
3246
3247 /**
3248 * Function to retrieve groups of profiles
3249 *
3250 * @param integer $profileID id of the profile
3251 *
3252 * @return array returns array
3253 * @static
3254 */
3255 static function profileGroups($profileID) {
3256 $groupTypes = array();
3257 $profileTypes = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $profileID, 'group_type');
3258 if ($profileTypes) {
3259 $groupTypeParts = explode(CRM_Core_DAO::VALUE_SEPARATOR, $profileTypes);
3260 $groupTypes = explode(',', $groupTypeParts[0]);
3261 }
3262 return $groupTypes;
3263 }
3264
3265 /**
3266 * Function to alter contact params by filtering existing subscribed groups and returns
3267 * unsubscribed groups array for subscription.
3268 *
3269 * @param array $params contact params
3270 * @param int $contactId user contact id
3271 *
3272 * @return array $subscribeGroupIds This contains array of groups for subscription
3273 */
3274 static function getDoubleOptInGroupIds(&$params, $contactId = NULL) {
3275 $config = CRM_Core_Config::singleton();
3276 $subscribeGroupIds = array();
3277
3278 // process further only if profileDoubleOptIn enabled and if groups exist
3279 if (!array_key_exists('group', $params) ||
3280 !self::isProfileDoubleOptin() ||
3281 CRM_Utils_System::isNull($params['group'])
3282 ) {
3283 return $subscribeGroupIds;
3284 }
3285
3286 //check if contact email exist.
3287 $hasEmails = FALSE;
3288 foreach ($params as $name => $value) {
3289 if (strpos($name, 'email-') !== FALSE) {
3290 $hasEmails = TRUE;
3291 break;
3292 }
3293 }
3294
3295 //Proceed furthur only if email present
3296 if (!$hasEmails) {
3297 return $subscribeGroupIds;
3298 }
3299
3300 //do check for already subscriptions.
3301 $contactGroups = array();
3302 if ($contactId) {
3303 $query = "
3304 SELECT group_id
3305 FROM civicrm_group_contact
3306 WHERE status = 'Added'
3307 AND contact_id = %1";
3308
3309 $dao = CRM_Core_DAO::executeQuery($query, array(1 => array($contactId, 'Integer')));
3310 while ($dao->fetch()) {
3311 $contactGroups[$dao->group_id] = $dao->group_id;
3312 }
3313 }
3314
3315 //since we don't have names, compare w/ label.
3316 $mailingListGroupType = array_search('Mailing List', CRM_Core_OptionGroup::values('group_type'));
3317
3318 //actual processing start.
3319 foreach ($params['group'] as $groupId => $isSelected) {
3320 //unset group those are not selected.
3321 if (!$isSelected) {
3322 unset($params['group'][$groupId]);
3323 continue;
3324 }
3325
3326 $groupTypes = explode(CRM_Core_DAO::VALUE_SEPARATOR,
3327 CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group', $groupId, 'group_type', 'id')
3328 );
3329 //get only mailing type group and unset it from params
3330 if (in_array($mailingListGroupType, $groupTypes) && !in_array($groupId, $contactGroups)) {
3331 $subscribeGroupIds[$groupId] = $groupId;
3332 unset($params['group'][$groupId]);
3333 }
3334 }
3335
3336 return $subscribeGroupIds;
3337 }
3338
3339 /**
3340 * Function to check if we are rendering mixed profiles
3341 *
3342 * @param array $profileIds associated array of profile ids
3343 *
3344 * @return boolean $mixProfile true if profile is mixed
3345 * @static
3346 * @access public
3347 */
3348 static function checkForMixProfiles($profileIds) {
3349 $mixProfile = FALSE;
3350
3351 $contactTypes = array('Individual', 'Household', 'Organization');
3352 $subTypes = CRM_Contact_BAO_ContactType::subTypes();
3353
3354 $components = array('Contribution', 'Participant', 'Membership', 'Activity');
3355
3356 $typeCount = array('ctype' => array(), 'subtype' => array());
3357 foreach ($profileIds as $gid) {
3358 $profileType = CRM_Core_BAO_UFField::getProfileType($gid);
3359 // ignore profile of type Contact
3360 if ($profileType == 'Contact') {
3361 continue;
3362 }
3363 if (in_array($profileType, $contactTypes)) {
3364 if (!isset($typeCount['ctype'][$profileType])) {
3365 $typeCount['ctype'][$profileType] = 1;
3366 }
3367
3368 // check if we are rendering profile of different contact types
3369 if (count($typeCount['ctype']) == 2) {
3370 $mixProfile = TRUE;
3371 break;
3372 }
3373 }
3374 elseif (in_array($profileType, $components)) {
3375 $mixProfile = TRUE;
3376 break;
3377 }
3378 else {
3379 if (!isset($typeCount['subtype'][$profileType])) {
3380 $typeCount['subtype'][$profileType] = 1;
3381 }
3382 // check if we are rendering profile of different contact sub types
3383 if (count($typeCount['subtype']) == 2) {
3384 $mixProfile = TRUE;
3385 break;
3386 }
3387 }
3388 }
3389 return $mixProfile;
3390 }
3391
3392 /**
3393 * Funtion to determine of we show overlay profile or not
3394 *
3395 * @return boolean true if profile should be shown else false
3396 * @static
3397 * @access public
3398 */
3399 static function showOverlayProfile() {
3400 $showOverlay = TRUE;
3401
3402 // get the id of overlay profile
3403 $overlayProfileId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', 'summary_overlay', 'id', 'name');
3404 $query = "SELECT count(id) FROM civicrm_uf_field WHERE uf_group_id = {$overlayProfileId} AND visibility IN ('Public Pages', 'Public Pages and Listings') ";
3405
3406 $count = CRM_Core_DAO::singleValueQuery($query);
3407
3408 //check if there are no public fields and use is anonymous
3409 $session = CRM_Core_Session::singleton();
3410 if (!$count && !$session->get('userID')) {
3411 $showOverlay = FALSE;
3412 }
3413
3414 return $showOverlay;
3415 }
3416
3417 /**
3418 * function to get group type values of the profile
3419 *
3420 * @params Integer $profileId Profile Id
3421 * @params String $groupType Group Type
3422 *
3423 * @return Array group type values
3424 * @static
3425 * @access public
3426 */
3427 static function groupTypeValues($profileId, $groupType = NULL) {
3428 $groupTypeValue = array();
3429 $groupTypes = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $profileId, 'group_type');
3430
3431 $groupTypeParts = explode(CRM_Core_DAO::VALUE_SEPARATOR, $groupTypes);
3432 if (!CRM_Utils_Array::value(1, $groupTypeParts)) {
3433 return $groupTypeValue;
3434 }
3435 $participantExtends = array('ParticipantRole', 'ParticipantEventName', 'ParticipantEventType');
3436
3437 foreach (explode(',', $groupTypeParts[1]) as $groupTypeValues) {
3438 $values = array();
3439 $valueParts = explode(':', $groupTypeValues);
3440 if ($groupType &&
3441 ($valueParts[0] != "{$groupType}Type" ||
3442 ($groupType == 'Participant' &&
3443 !in_array($valueParts[0], $participantExtends)
3444 )
3445 )
3446 ) {
3447 continue;
3448 }
3449 foreach ($valueParts as $val) {
3450 if (CRM_Utils_Rule::integer($val)) {
3451 $values[$val] = $val;
3452 }
3453 }
3454 if (!empty($values)) {
3455 $typeName = substr($valueParts[0], 0, -4);
3456 if (in_array($valueParts[0], $participantExtends)) {
3457 $typeName = $valueParts[0];
3458 }
3459 $groupTypeValue[$typeName] = $values;
3460 }
3461 }
3462
3463 return $groupTypeValue;
3464 }
3465
3466 static function isProfileDoubleOptin() {
3467 // check for double optin
3468 $config = CRM_Core_Config::singleton();
3469 if (in_array('CiviMail', $config->enableComponents)) {
3470 return CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME,
3471 'profile_double_optin', NULL, FALSE
3472 );
3473 }
3474 return FALSE;
3475 }
3476
3477 static function isProfileAddToGroupDoubleOptin() {
3478 // check for add to group double optin
3479 $config = CRM_Core_Config::singleton();
3480 if (in_array('CiviMail', $config->enableComponents)) {
3481 return CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME,
3482 'profile_add_to_group_double_optin', NULL, FALSE
3483 );
3484 }
3485 return FALSE;
3486 }
3487
3488 /**
3489 * get profiles used for batch entry
3490 *
3491 * @return array profileIds profile ids
3492 * @static
3493 */
3494 static function getBatchProfiles() {
3495 $query = "SELECT id
3496 FROM civicrm_uf_group
3497 WHERE name IN ('contribution_batch_entry', 'membership_batch_entry')";
3498 $dao = CRM_Core_DAO::executeQuery( $query );
3499 $profileIds = array();
3500 while( $dao->fetch() ) {
3501 $profileIds[$dao->id] = $dao->id;
3502 }
3503 return $profileIds;
3504 }
3505
3506 static function shiftMultiRecordFields(&$source, &$destination, $returnMultiSummaryFields = FALSE) {
3507 $multiSummaryFields = $returnMultiSummaryFields ? array( ) : NULL;
3508 foreach ($source as $field => $properties) {
3509 if (!CRM_Core_BAO_CustomField::getKeyID($field)) {
3510 continue;
3511 }
3512 if (CRM_Core_BAO_CustomField::isMultiRecordField($field)) {
3513 $destination[$field] = $properties;
3514 if ($returnMultiSummaryFields) {
3515 if ($properties['is_multi_summary']) {
3516 $multiSummaryFields[$field] = $properties;
3517 }
3518 }
3519 unset($source[$field]);
3520 }
3521 }
3522 return $multiSummaryFields;
3523 }
3524
3525 /**
3526 * This is function is used to format pseudo fields
3527 *
3528 * @param array $fields associated array of profile fields
3529 *
3530 * @static
3531 */
3532 static function reformatProfileFields(&$fields) {
3533 //reformat fields array
3534 foreach ($fields as $name => $field) {
3535 //reformat phone and extension field
3536 if ( substr($field['name'], 0, 13) == 'phone_and_ext') {
3537 $fieldSuffix = str_replace('phone_and_ext-', '', $field['name']);
3538
3539 // retain existing element properties and just update and replace key
3540 CRM_Utils_Array::crmReplaceKey($fields, $name, "phone-{$fieldSuffix}");
3541 $fields["phone-{$fieldSuffix}"]['name'] = "phone-{$fieldSuffix}";
3542 $fields["phone-{$fieldSuffix}"]['where'] = 'civicrm_phone.phone';
3543
3544 // add additional phone extension field
3545 $fields["phone_ext-{$fieldSuffix}"] = $field;
3546 $fields["phone_ext-{$fieldSuffix}"]['title'] = $field['title'] .' - '.ts('Ext.');
3547 $fields["phone_ext-{$fieldSuffix}"]['name'] = "phone_ext-{$fieldSuffix}";
3548 $fields["phone_ext-{$fieldSuffix}"]['where'] = 'civicrm_phone.phone_ext';
3549 $fields["phone_ext-{$fieldSuffix}"]['skipDisplay'] = 1;
3550 //ignore required for extension field
3551 $fields["phone_ext-{$fieldSuffix}"]['is_required'] = 0;
3552 }
3553 }
3554 }
3555 }