projects / civicrm-core.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Merge pull request #2387 from pratik-joshi/CRM-13973
[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 (empty($fields[$name])) {
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 (!empty($field['skipDisplay'])) {
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 (!empty($values[$index])) {
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' && !empty($componentWhere[0][2])) {
1061 $entityId = $componentWhere[0][2];
1062 }
1063
1064 $fileURL = CRM_Core_BAO_CustomField::getFileURL($entityId,
1065 $cfID,
1066 NULL,
1067 $absolute
1068 );
1069 $params[$index] = $values[$index] = $fileURL['file_url'];
1070 }
1071 else {
1072 $customVal = NULL;
1073 if (isset($dao) && property_exists($dao, 'data_type') &&
1074 ($dao->data_type == 'Int' ||
1075 $dao->data_type == 'Boolean'
1076 )
1077 ) {
1078 $customVal = (int )($details->{$name});
1079 }
1080 elseif (isset($dao) && property_exists($dao, 'data_type')
1081 && $dao->data_type == 'Float'
1082 ) {
1083 $customVal = (float )($details->{$name});
1084 }
1085 elseif (!CRM_Utils_System::isNull(explode(CRM_Core_DAO::VALUE_SEPARATOR,
1086 $details->{$name}
1087 ))) {
1088 $customVal = $details->{$name};
1089 }
1090
1091 //CRM-4582
1092 if (CRM_Utils_System::isNull($customVal)) {
1093 continue;
1094 }
1095
1096 $params[$index] = $customVal;
1097 $values[$index] = CRM_Core_BAO_CustomField::getDisplayValue($customVal,
1098 $cfID,
1099 $options
1100 );
1101 if ($htmlType == 'Autocomplete-Select') {
1102 $params[$index] = $values[$index];
1103 }
1104 if (CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField',
1105 $cfID, 'is_search_range'
1106 )) {
1107 $customFieldName = "{$name}_from";
1108 }
1109 }
1110 }
1111 elseif ($name == 'image_URL') {
1112 list($width, $height) = getimagesize($details->$name);
1113 list($thumbWidth, $thumbHeight) = CRM_Contact_BAO_Contact::getThumbSize($width, $height);
1114
1115 $image_URL = '<img src="' . $details->$name . '" height= ' . $thumbHeight . ' width= ' . $thumbWidth . ' />';
1116 $values[$index] = "<a href='#' onclick='contactImagePopUp(\"{$details->$name}\", {$width}, {$height});'>{$image_URL}</a>";
1117 }
1118 elseif (in_array($name, array(
1119 'birth_date', 'deceased_date', 'membership_start_date', 'membership_end_date', 'join_date'))) {
1120 $values[$index] = CRM_Utils_Date::customFormat($details->$name);
1121 $params[$index] = CRM_Utils_Date::isoToMysql($details->$name);
1122 }
1123 else {
1124 $dao = '';
1125 if ($index == 'Campaign') {
1126 $dao = 'CRM_Campaign_DAO_Campaign';
1127 }
1128 elseif ($index == 'Contribution Page') {
1129 $dao = 'CRM_Contribute_DAO_ContributionPage';
1130 }
1131 if ($dao) {
1132 $value = CRM_Core_DAO::getFieldValue($dao, $details->$name, 'title');
1133 }
1134 else {
1135 $value = $details->$name;
1136 }
1137 $values[$index] = $value;
1138 }
1139 }
1140 }
1141 }
1142 elseif (strpos($name, '-') !== FALSE) {
1143 list($fieldName, $id, $type) = CRM_Utils_System::explode('-', $name, 3);
1144
1145 if (!in_array($fieldName, $multipleFields)) {
1146 if ($id == 'Primary') {
1147 // fix for CRM-1543
1148 // not sure why we'd every use Primary location type id
1149 // we need to fix the source if we are using it
1150 // $locationTypeName = CRM_Contact_BAO_Contact::getPrimaryLocationType( $cid );
1151 $locationTypeName = 1;
1152 }
1153 else {
1154 $locationTypeName = CRM_Utils_Array::value($id, $locationTypes);
1155 }
1156
1157 if (!$locationTypeName) {
1158 continue;
1159 }
1160
1161 $detailName = "{$locationTypeName}-{$fieldName}";
1162 $detailName = str_replace(' ', '_', $detailName);
1163
1164 if (in_array($fieldName, array(
1165 'phone', 'im', 'email', 'openid'))) {
1166 if ($type) {
1167 $detailName .= "-{$type}";
1168 }
1169 }
1170
1171 if (in_array($fieldName, array(
1172 'state_province', 'country', 'county'))) {
1173 $values[$index] = $details->$detailName;
1174 $idx = $detailName . '_id';
1175 $params[$index] = $details->$idx;
1176 }
1177 elseif ($fieldName == 'im') {
1178 $providerId = $detailName . '-provider_id';
1179 if (isset($imProviders[$details->$providerId])) {
1180 $values[$index] = $details->$detailName . " (" . $imProviders[$details->$providerId] . ")";
1181 }
1182 else {
1183 $values[$index] = $details->$detailName;
1184 }
1185 $params[$index] = $details->$detailName;
1186 }
1187 elseif ($fieldName == 'phone') {
1188 $phoneExtField = str_replace('phone', 'phone_ext', $detailName);
1189 if (isset($details->$phoneExtField)) {
1190 $values[$index] = $details->$detailName . " (" . $details->$phoneExtField . ")";
1191 }
1192 else {
1193 $values[$index] = $details->$detailName;
1194 }
1195 $params[$index] = $details->$detailName;
1196 }
1197 else {
1198 $values[$index] = $params[$index] = $details->$detailName;
1199 }
1200 }
1201 else {
1202 $detailName = "website-{$id}-{$fieldName}";
1203 $url = CRM_Utils_System::fixURL($details->$detailName);
1204 if ($details->$detailName) {
1205 $websiteTypeId = "website-{$id}-website_type_id";
1206 $websiteType = $websiteTypes[$details->$websiteTypeId];
1207 $values[$index] = "<a href=\"$url\">{$details->$detailName} ( {$websiteType} )</a>";
1208 }
1209 else {
1210 $values[$index] = '';
1211 }
1212 }
1213 }
1214
1215 if ((CRM_Utils_Array::value('visibility', $field) == 'Public Pages and Listings') &&
1216 CRM_Core_Permission::check('profile listings and forms')
1217 ) {
1218
1219 if (CRM_Utils_System::isNull($params[$index])) {
1220 $params[$index] = $values[$index];
1221 }
1222 if (!isset($params[$index])) {
1223 continue;
1224 }
1225 if (!$customFieldName) {
1226 $fieldName = $field['name'];
1227 }
1228 else {
1229 $fieldName = $customFieldName;
1230 }
1231
1232 $url = NULL;
1233 if (CRM_Core_BAO_CustomField::getKeyID($field['name'])) {
1234 $htmlType = $field['html_type'];
1235 if ($htmlType == 'Link') {
1236 $url = $params[$index];
1237 }
1238 elseif (in_array($htmlType, array(
1239 'CheckBox', 'Multi-Select', 'AdvMulti-Select',
1240 'Multi-Select State/Province', 'Multi-Select Country',
1241 ))) {
1242 $valSeperator = CRM_Core_DAO::VALUE_SEPARATOR;
1243 $selectedOptions = explode($valSeperator, $params[$index]);
1244
1245 foreach ($selectedOptions as $key => $multiOption) {
1246 if ($multiOption) {
1247 $url[] = CRM_Utils_System::url('civicrm/profile',
1248 'reset=1&force=1&gid=' . $field['group_id'] . '&' .
1249 urlencode($fieldName) .
1250 '=' .
1251 urlencode($multiOption)
1252 );
1253 }
1254 }
1255 }
1256 else {
1257 $url = CRM_Utils_System::url('civicrm/profile',
1258 'reset=1&force=1&gid=' . $field['group_id'] . '&' .
1259 urlencode($fieldName) .
1260 '=' .
1261 urlencode($params[$index])
1262 );
1263 }
1264 }
1265 else {
1266 $url = CRM_Utils_System::url('civicrm/profile',
1267 'reset=1&force=1&gid=' . $field['group_id'] . '&' .
1268 urlencode($fieldName) .
1269 '=' .
1270 urlencode($params[$index])
1271 );
1272 }
1273
1274 if ($url &&
1275 !empty($values[$index]) &&
1276 $searchable
1277 ) {
1278
1279 if (is_array($url) && !empty($url)) {
1280 $links = array();
1281 $eachMultiValue = explode(', ', $values[$index]);
1282 foreach ($eachMultiValue as $key => $valueLabel) {
1283 $links[] = '<a href="' . $url[$key] . '">' . $valueLabel . '</a>';
1284 }
1285 $values[$index] = implode(', ', $links);
1286 }
1287 else {
1288 $values[$index] = '<a href="' . $url . '">' . $values[$index] . '</a>';
1289 }
1290 }
1291 }
1292 }
1293 }
1294
1295 /**
1296 * Check if profile Group used by any module.
1297 *
1298 * @param int $id profile Id
1299 *
1300 * @return boolean
1301 *
1302 * @access public
1303 * @static
1304 *
1305 */
1306 public static function usedByModule($id) {
1307 //check whether this group is used by any module(check uf join records)
1308 $sql = "SELECT id
1309 FROM civicrm_uf_join
1310 WHERE civicrm_uf_join.uf_group_id=$id";
1311
1312 $dao = new CRM_Core_DAO();
1313 $dao->query($sql);
1314 if ($dao->fetch()) {
1315 return TRUE;
1316 }
1317 else {
1318 return FALSE;
1319 }
1320 }
1321
1322 /**
1323 * Delete the profile Group.
1324 *
1325 * @param int $id profile Id
1326 *
1327 * @return boolean
1328 *
1329 * @access public
1330 * @static
1331 *
1332 */
1333 public static function del($id) {
1334 //check whether this group contains any profile fields
1335 $profileField = new CRM_Core_DAO_UFField();
1336 $profileField->uf_group_id = $id;
1337 $profileField->find();
1338 while ($profileField->fetch()) {
1339 CRM_Core_BAO_UFField::del($profileField->id);
1340 }
1341
1342 //delete records from uf join table
1343 $ufJoin = new CRM_Core_DAO_UFJoin();
1344 $ufJoin->uf_group_id = $id;
1345 $ufJoin->delete();
1346
1347 //delete profile group
1348 $group = new CRM_Core_DAO_UFGroup();
1349 $group->id = $id;
1350 $group->delete();
1351 return 1;
1352 }
1353
1354 /**
1355 * function to add the UF Group
1356 *
1357 * @param array $params reference array contains the values submitted by the form
1358 * @param array $ids reference array contains the id
1359 *
1360 * @access public
1361 * @static
1362 *
1363 * @return object
1364 */
1365 static function add(&$params, $ids = array()) {
1366 $fields = array('is_active', 'add_captcha', 'is_map', 'is_update_dupe', 'is_edit_link', 'is_uf_link', 'is_cms_user');
1367 foreach ($fields as $field) {
1368 $params[$field] = CRM_Utils_Array::value($field, $params, FALSE);
1369 }
1370
1371 $params['limit_listings_group_id'] = CRM_Utils_Array::value('group', $params);
1372 $params['add_to_group_id'] = CRM_Utils_Array::value('add_contact_to_group', $params);
1373
1374 $ufGroup = new CRM_Core_DAO_UFGroup();
1375 $ufGroup->copyValues($params);
1376
1377 $ufGroupID = CRM_Utils_Array::value('ufgroup', $ids, CRM_Utils_Array::value('id', $params));
1378 if (!$ufGroupID) {
1379 $ufGroup->name = CRM_Utils_String::munge($ufGroup->title, '_', 56);
1380 }
1381 $ufGroup->id = $ufGroupID;
1382
1383 $ufGroup->save();
1384
1385 if (!$ufGroupID) {
1386 $ufGroup->name = $ufGroup->name . "_{$ufGroup->id}";
1387 $ufGroup->save();
1388 }
1389
1390 return $ufGroup;
1391 }
1392
1393 /**
1394 * Function to make uf join entries for an uf group
1395 *
1396 * @param array $params (reference) an assoc array of name/value pairs
1397 * @param int $ufGroupId ufgroup id
1398 *
1399 * @return void
1400 * @access public
1401 * @static
1402 */
1403 static function createUFJoin(&$params, $ufGroupId) {
1404 $groupTypes = CRM_Utils_Array::value('uf_group_type', $params);
1405
1406 // get ufjoin records for uf group
1407 $ufGroupRecord = CRM_Core_BAO_UFGroup::getUFJoinRecord($ufGroupId);
1408
1409 // get the list of all ufgroup types
1410 $allUFGroupType = CRM_Core_SelectValues::ufGroupTypes();
1411
1412 // this fix is done to prevent warning generated by array_key_exits incase of empty array is given as input
1413 if (!is_array($groupTypes)) {
1414 $groupTypes = array();
1415 }
1416
1417 // this fix is done to prevent warning generated by array_key_exits incase of empty array is given as input
1418 if (!is_array($ufGroupRecord)) {
1419 $ufGroupRecord = array();
1420 }
1421
1422 // check which values has to be inserted/deleted for contact
1423 $menuRebuild = FALSE;
1424 foreach ($allUFGroupType as $key => $value) {
1425 $joinParams = array();
1426 $joinParams['uf_group_id'] = $ufGroupId;
1427 $joinParams['module'] = $key;
1428 if ($key == 'User Account') {
1429 $menuRebuild = TRUE;
1430 }
1431 if (array_key_exists($key, $groupTypes) && !in_array($key, $ufGroupRecord)) {
1432 // insert a new record
1433 CRM_Core_BAO_UFGroup::addUFJoin($joinParams);
1434 }
1435 elseif (!array_key_exists($key, $groupTypes) && in_array($key, $ufGroupRecord)) {
1436 // delete a record for existing ufgroup
1437 CRM_Core_BAO_UFGroup::delUFJoin($joinParams);
1438 }
1439 }
1440
1441 //update the weight
1442 $query = "
1443 UPDATE civicrm_uf_join
1444 SET weight = %1
1445 WHERE uf_group_id = %2
1446 AND ( entity_id IS NULL OR entity_id <= 0 )
1447 ";
1448 $p = array(1 => array($params['weight'], 'Integer'),
1449 2 => array($ufGroupId, 'Integer'),
1450 );
1451 CRM_Core_DAO::executeQuery($query, $p);
1452
1453 // do a menu rebuild if we are on drupal, so it gets all the new menu entries
1454 // for user account
1455 $config = CRM_Core_Config::singleton();
1456 if ($menuRebuild &&
1457 $config->userSystem->is_drupal
1458 ) {
1459 menu_rebuild();
1460 }
1461 }
1462
1463 /**
1464 * Function to get the UF Join records for an ufgroup id
1465 *
1466 * @params int $ufGroupId uf group id
1467 * @params int $displayName if set return display name in array
1468 * @params int $status if set return module other than default modules (User Account/User registration/Profile)
1469 *
1470 * @return array $ufGroupJoinRecords
1471 *
1472 * @access public
1473 * @static
1474 */
1475 public static function getUFJoinRecord($ufGroupId = NULL, $displayName = NULL, $status = NULL) {
1476 if ($displayName) {
1477 $UFGroupType = array();
1478 $UFGroupType = CRM_Core_SelectValues::ufGroupTypes();
1479 }
1480
1481 $ufJoin = array();
1482 $dao = new CRM_Core_DAO_UFJoin();
1483
1484 if ($ufGroupId) {
1485 $dao->uf_group_id = $ufGroupId;
1486 }
1487
1488 $dao->find();
1489 $ufJoin = array();
1490
1491 while ($dao->fetch()) {
1492 if (!$displayName) {
1493 $ufJoin[$dao->id] = $dao->module;
1494 }
1495 else {
1496 if (isset($UFGroupType[$dao->module])) {
1497 // skip the default modules
1498 if (!$status) {
1499 $ufJoin[$dao->id] = $UFGroupType[$dao->module];
1500 }
1501 // added for CRM-1475
1502 }
1503 elseif (!CRM_Utils_Array::key($dao->module, $ufJoin)) {
1504 $ufJoin[$dao->id] = $dao->module;
1505 }
1506 }
1507 }
1508 return $ufJoin;
1509 }
1510
1511 /**
1512 * Function takes an associative array and creates a ufjoin record for ufgroup
1513 *
1514 * @param array $params (reference) an assoc array of name/value pairs
1515 *
1516 * @return object CRM_Core_BAO_UFJoin object
1517 * @access public
1518 * @static
1519 */
1520 static function addUFJoin(&$params) {
1521 $ufJoin = new CRM_Core_DAO_UFJoin();
1522 $ufJoin->copyValues($params);
1523 $ufJoin->save();
1524 return $ufJoin;
1525 }
1526
1527 /**
1528 * Function to delete the uf join record for an uf group
1529 *
1530 * @param array $params (reference) an assoc array of name/value pairs
1531 *
1532 * @return void
1533 * @access public
1534 * @static
1535 */
1536 static function delUFJoin(&$params) {
1537 $ufJoin = new CRM_Core_DAO_UFJoin();
1538 $ufJoin->copyValues($params);
1539 $ufJoin->delete();
1540 }
1541
1542 /**
1543 * Function to get the weight for ufjoin record
1544 *
1545 * @param int $ufGroupId if $ufGroupId get update weight or add weight
1546 *
1547 * @return int weight of the UFGroup
1548 * @access public
1549 * @static
1550 */
1551 static function getWeight($ufGroupId = NULL) {
1552 //calculate the weight
1553 $p = array();
1554 if (!$ufGroupId) {
1555 $queryString = "SELECT ( MAX(civicrm_uf_join.weight)+1) as new_weight
1556 FROM civicrm_uf_join
1557 WHERE module = 'User Registration' OR module = 'User Account' OR module = 'Profile'";
1558 }
1559 else {
1560 $queryString = "SELECT MAX(civicrm_uf_join.weight) as new_weight
1561 FROM civicrm_uf_join
1562 WHERE civicrm_uf_join.uf_group_id = %1
1563 AND ( entity_id IS NULL OR entity_id <= 0 )";
1564 $p[1] = array($ufGroupId, 'Integer');
1565 }
1566
1567 $dao = CRM_Core_DAO::executeQuery($queryString, $p);
1568 $dao->fetch();
1569 return ($dao->new_weight) ? $dao->new_weight : 1;
1570 }
1571
1572 /**
1573 * Function to get the uf group for a module
1574 *
1575 * @param string $moduleName module name
1576 * @param int $count no to increment the weight
1577 * @param bool $skipPermision - whether to add permission clause
1578 * @param int $op - which operation (view, edit, create, etc) to check permission for
1579 * @param array|NULL $returnFields list of UFGroup fields to return; NULL for default
1580 *
1581 * @return array $ufGroups array of ufgroups for a module
1582 * @access public
1583 * @static
1584 */
1585 public static function getModuleUFGroup($moduleName = NULL, $count = 0, $skipPermission = TRUE, $op = CRM_Core_Permission::VIEW, $returnFields = NULL) {
1586 $selectFields = array('id', 'title', 'created_id', 'is_active', 'is_reserved', 'group_type');
1587
1588 if (!CRM_Core_Config::isUpgradeMode()) {
1589 // CRM-13555, since description field was added later (4.4), and to avoid any problems with upgrade
1590 $selectFields[] = 'description';
1591 }
1592
1593 if (!empty($returnFields)) {
1594 $selectFields = array_merge($returnFields, array_diff($selectFields, $returnFields));
1595 }
1596
1597 $queryString = 'SELECT civicrm_uf_group.' . implode(', civicrm_uf_group.', $selectFields) . '
1598 FROM civicrm_uf_group
1599 LEFT JOIN civicrm_uf_join ON (civicrm_uf_group.id = uf_group_id)';
1600 $p = array();
1601 if ($moduleName) {
1602 $queryString .= ' AND civicrm_uf_group.is_active = 1
1603 WHERE civicrm_uf_join.module = %2';
1604 $p[2] = array($moduleName, 'String');
1605 }
1606
1607
1608 // add permissioning for profiles only if not registration
1609 if (!$skipPermission) {
1610 $permissionClause = CRM_Core_Permission::ufGroupClause($op, 'civicrm_uf_group.');
1611 if (strpos($queryString, 'WHERE') !== FALSE) {
1612 $queryString .= " AND $permissionClause ";
1613 }
1614 else {
1615 $queryString .= " $permissionClause ";
1616 }
1617 }
1618
1619 $queryString .= ' ORDER BY civicrm_uf_join.weight, civicrm_uf_group.title';
1620 $dao = CRM_Core_DAO::executeQuery($queryString, $p);
1621
1622 $ufGroups = array();
1623 while ($dao->fetch()) {
1624 //skip mix profiles in user Registration / User Account
1625 if (($moduleName == 'User Registration' || $moduleName == 'User Account') &&
1626 CRM_Core_BAO_UFField::checkProfileType($dao->id)
1627 ) {
1628 continue;
1629 }
1630 foreach ($selectFields as $key => $field) {
1631 if($field == 'id') {
1632 continue;
1633 }
1634 elseif ($field == 'name') {
1635 $ufGroups[$dao->id][$field] = $dao->title;
1636 continue;
1637 }
1638 $ufGroups[$dao->id][$field] = $dao->$field;
1639 }
1640 }
1641
1642 // Allow other modules to alter/override the UFGroups.
1643 CRM_Utils_Hook::buildUFGroupsForModule($moduleName, $ufGroups);
1644
1645 return $ufGroups;
1646 }
1647
1648 /**
1649 * Function to filter ufgroups based on logged in user contact type
1650 *
1651 * @params int $ufGroupId uf group id (profile id)
1652 *
1653 * @return boolean true or false
1654 * @static
1655 * @access public
1656 */
1657 static function filterUFGroups($ufGroupId, $contactID = NULL) {
1658 if (!$contactID) {
1659 $session = CRM_Core_Session::singleton();
1660 $contactID = $session->get('userID');
1661 }
1662
1663 if ($contactID) {
1664 //get the contact type
1665 $contactType = CRM_Contact_BAO_Contact::getContactType($contactID);
1666
1667 //match if exixting contact type is same as profile contact type
1668 $profileType = CRM_Core_BAO_UFField::getProfileType($ufGroupId);
1669
1670 if (CRM_Contact_BAO_ContactType::isaSubType($profileType)) {
1671 $profileType = CRM_Contact_BAO_ContactType::getBasicType($profileType);
1672 }
1673
1674 //allow special mix profiles for Contribution and Participant
1675 $specialProfiles = array('Contribution', 'Participant', 'Membership');
1676
1677 if (in_array($profileType, $specialProfiles)) {
1678 return TRUE;
1679 }
1680
1681 if (($contactType == $profileType) || $profileType == 'Contact') {
1682 return TRUE;
1683 }
1684 }
1685
1686 return FALSE;
1687 }
1688
1689 /**
1690 * Function to build profile form
1691 *
1692 * @params object $form form object
1693 * @params array $field array field properties
1694 * @params int $mode profile mode
1695 * @params int $contactID contact id
1696 * @params string $usedFor for building up prefixed fieldname for special cases (e.g. onBehalf, Honor)
1697 *
1698 * @return null
1699 * @static
1700 * @access public
1701 */
1702 static function buildProfile(
1703 &$form,
1704 &$field,
1705 $mode,
1706 $contactId = NULL,
1707 $online = FALSE,
1708 $usedFor = NULL,
1709 $rowNumber = NULL ,
1710 $prefix = ''
1711 ) {
1712 $defaultValues = array();
1713 $fieldName = $field['name'];
1714 $title = $field['title'];
1715 $attributes = $field['attributes'];
1716 $rule = $field['rule'];
1717 $view = $field['is_view'];
1718 $required = ($mode == CRM_Profile_Form::MODE_SEARCH) ? FALSE : $field['is_required'];
1719 $search = ($mode == CRM_Profile_Form::MODE_SEARCH) ? TRUE : FALSE;
1720 $isShared = CRM_Utils_Array::value('is_shared', $field, 0);
1721
1722 // do not display view fields in drupal registration form
1723 // CRM-4632
1724 if ($view && $mode == CRM_Profile_Form::MODE_REGISTER) {
1725 return;
1726 }
1727
1728 if ($usedFor == 'onbehalf') {
1729 $name = "onbehalf[$fieldName]";
1730 }
1731 elseif ($usedFor == 'honor') {
1732 $name = "honor[$fieldName]";
1733 }
1734 elseif ($contactId && !$online) {
1735 $name = "field[$contactId][$fieldName]";
1736 }
1737 elseif ($rowNumber) {
1738 $name = "field[$rowNumber][$fieldName]";
1739 }
1740 elseif (!empty($prefix)) {
1741 $name = $prefix ."[$fieldName]";
1742 }
1743 else {
1744 $name = $fieldName;
1745 }
1746
1747 if ($fieldName == 'image_URL' && $mode == CRM_Profile_Form::MODE_EDIT) {
1748 $deleteExtra = ts('Are you sure you want to delete contact image.');
1749 $deleteURL = array(
1750 CRM_Core_Action::DELETE =>
1751 array(
1752 'name' => ts('Delete Contact Image'),
1753 'url' => 'civicrm/contact/image',
1754 'qs' => 'reset=1&id=%%id%%&gid=%%gid%%&action=delete',
1755 'extra' =>
1756 'onclick = "if (confirm( \'' . $deleteExtra . '\' ) ) this.href+=\'&amp;confirmed=1\'; else return false;"',
1757 ),
1758 );
1759 $deleteURL = CRM_Core_Action::formLink($deleteURL,
1760 CRM_Core_Action::DELETE,
1761 array('id' => $form->get('id'),
1762 'gid' => $form->get('gid'),
1763 ),
1764 ts('more'),
1765 FALSE,
1766 'contact.profileimage.delete',
1767 'Contact',
1768 $form->get('id')
1769 );
1770 $form->assign('deleteURL', $deleteURL);
1771 }
1772 $addressOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
1773 'address_options', TRUE, NULL, TRUE
1774 );
1775
1776 if (substr($fieldName, 0, 14) === 'state_province') {
1777 $form->add('select', $name, $title,
1778 array(
1779 '' => ts('- select -')) + CRM_Core_PseudoConstant::stateProvince(), $required
1780 );
1781 $config = CRM_Core_Config::singleton();
1782 if (!in_array($mode, array(
1783 CRM_Profile_Form::MODE_EDIT, CRM_Profile_Form::MODE_SEARCH)) &&
1784 $config->defaultContactStateProvince
1785 ) {
1786 $defaultValues[$name] = $config->defaultContactStateProvince;
1787 $form->setDefaults($defaultValues);
1788 }
1789 }
1790 elseif (substr($fieldName, 0, 7) === 'country') {
1791 $form->add('select', $name, $title,
1792 array(
1793 '' => ts('- select -')) + CRM_Core_PseudoConstant::country(), $required
1794 );
1795 $config = CRM_Core_Config::singleton();
1796 if (!in_array($mode, array(
1797 CRM_Profile_Form::MODE_EDIT, CRM_Profile_Form::MODE_SEARCH)) &&
1798 $config->defaultContactCountry
1799 ) {
1800 $defaultValues[$name] = $config->defaultContactCountry;
1801 $form->setDefaults($defaultValues);
1802 }
1803 }
1804 elseif (substr($fieldName, 0, 6) === 'county') {
1805 if ($addressOptions['county']) {
1806 $form->add('select', $name, $title,
1807 array(
1808 '' => ts('(choose state first)')), $required
1809 );
1810 }
1811 }
1812 elseif (substr($fieldName, 0, 9) === 'image_URL') {
1813 $form->add('file', $name, $title, $attributes, $required);
1814 $form->addUploadElement($name);
1815 }
1816 elseif (substr($fieldName, 0, 2) === 'im') {
1817 $form->add('text', $name, $title, $attributes, $required);
1818 if (!$contactId) {
1819 if ($usedFor) {
1820 if (substr($name, -1) == ']') {
1821 $providerName = substr($name, 0, -1) . '-provider_id]';
1822 }
1823 $form->add('select', $providerName, NULL,
1824 array(
1825 '' => ts('- select -')) + CRM_Core_PseudoConstant::get('CRM_Core_DAO_IM', 'provider_id'), $required
1826 );
1827 }
1828 else {
1829 $form->add('select', $name . '-provider_id', $title,
1830 array(
1831 '' => ts('- select -')) + CRM_Core_PseudoConstant::get('CRM_Core_DAO_IM', 'provider_id'), $required
1832 );
1833 }
1834
1835 if ($view && $mode != CRM_Profile_Form::MODE_SEARCH) {
1836 $form->freeze($name . '-provider_id');
1837 }
1838 }
1839 }
1840 elseif (($fieldName === 'birth_date') || ($fieldName === 'deceased_date')) {
1841 $form->addDate($name, $title, $required, array('formatType' => 'birth'));
1842 }
1843 elseif (in_array($fieldName, array(
1844 'membership_start_date', 'membership_end_date', 'join_date'))) {
1845 $form->addDate($name, $title, $required, array('formatType' => 'custom'));
1846 }
1847 elseif (CRM_Utils_Array::value('name',$field) == 'membership_type') {
1848 list($orgInfo, $types) = CRM_Member_BAO_MembershipType::getMembershipTypeInfo();
1849 $sel = &$form->addElement('hierselect', $name, $title);
1850 $select = array('' => ts('- select -') );
1851 if(count($orgInfo) == 1 && $field['is_required']) {
1852 // we only have one org - so we should default to it. Not sure about defaulting to first type
1853 // as it could be missed - so adding a select
1854 // however, possibly that is more similar to the membership form
1855 if(count($types[1]) > 1) {
1856 $types[1] = $select + $types[1];
1857 }
1858 }
1859 else {
1860 $orgInfo = $select + $orgInfo;
1861 }
1862 $sel->setOptions(array($orgInfo, $types));
1863 }
1864 elseif (CRM_Utils_Array::value('name',$field) == 'membership_status') {
1865 $form->add('select', $name, $title,
1866 array(
1867 '' => ts('- select -')) + CRM_Member_PseudoConstant::membershipStatus(NULL, NULL, 'label'), $required
1868 );
1869 }
1870 elseif ($fieldName === 'gender_id') {
1871 $genderOptions = array();
1872 $gender = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id');
1873 foreach ($gender as $key => $var) {
1874 $genderOptions[$key] = $form->createElement('radio', NULL, ts('Gender'), $var, $key);
1875 }
1876 $form->addGroup($genderOptions, $name, $title);
1877 if ($required) {
1878 $form->addRule($name, ts('%1 is a required field.', array(1 => $title)), 'required');
1879 }
1880 }
1881 elseif ($fieldName === 'prefix_id' || $fieldName === 'suffix_id') {
1882 $form->add('select', $name, $title,
1883 array(
1884 '' => ts('- select -')) + CRM_Core_PseudoConstant::get('CRM_Contact_BAO_Contact', $fieldName), $required
1885 );
1886 }
1887 elseif ($fieldName === 'contact_sub_type') {
1888 $gId = $form->get('gid') ? $form->get('gid') : CRM_Utils_Array::value('group_id', $field);
1889 if ($usedFor == 'onbehalf') {
1890 $profileType = 'Organization';
1891 }
1892 elseif ($usedFor == 'honor') {
1893 $profileType = CRM_Core_BAO_UFField::getProfileType($form->_params['honoree_profile_id']);
1894 }
1895 else {
1896 $profileType = $gId ? CRM_Core_BAO_UFField::getProfileType($gId) : NULL;
1897 if ($profileType == 'Contact') {
1898 $profileType = 'Individual';
1899 }
1900 }
1901
1902 $setSubtype = FALSE;
1903 if (CRM_Contact_BAO_ContactType::isaSubType($profileType)) {
1904 $setSubtype = $profileType;
1905 $profileType = CRM_Contact_BAO_ContactType::getBasicType($profileType);
1906 }
1907
1908 $subtypes = $profileType ? CRM_Contact_BAO_ContactType::subTypePairs($profileType) : array();
1909
1910 if ($setSubtype) {
1911 $subtypeList = array();
1912 $subtypeList[$setSubtype] = $subtypes[$setSubtype];
1913 }
1914 else {
1915 $subtypeList = $subtypes;
1916 }
1917
1918 $sel = $form->add('select', $name, $title, $subtypeList, $required);
1919 $sel->setMultiple(TRUE);
1920 }
1921 elseif (in_array($fieldName, CRM_Contact_BAO_Contact::$_greetingTypes)) {
1922 //add email greeting, postal greeting, addressee, CRM-4575
1923 $gId = $form->get('gid') ? $form->get('gid') : CRM_Utils_Array::value('group_id', $field);
1924 $profileType = CRM_Core_BAO_UFField::getProfileType($gId, TRUE, FALSE, TRUE);
1925
1926 if (empty($profileType) || in_array($profileType, array(
1927 'Contact', 'Contribution', 'Participant', 'Membership'))) {
1928 $profileType = 'Individual';
1929 }
1930 if (CRM_Contact_BAO_ContactType::isaSubType($profileType)) {
1931 $profileType = CRM_Contact_BAO_ContactType::getBasicType($profileType);
1932 }
1933 $greeting = array(
1934 'contact_type' => $profileType,
1935 'greeting_type' => $fieldName,
1936 );
1937 $form->add('select', $name, $title,
1938 array(
1939 '' => ts('- select -')) + CRM_Core_PseudoConstant::greeting($greeting), $required
1940 );
1941 // add custom greeting element
1942 $form->add('text', $fieldName . '_custom', ts('Custom %1', array(1 => ucwords(str_replace('_', ' ', $fieldName)))),
1943 NULL, FALSE
1944 );
1945 }
1946 elseif ($fieldName === 'preferred_communication_method') {
1947 $communicationFields = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'preferred_communication_method');
1948 foreach ($communicationFields as $key => $var) {
1949 if ($key == '') {
1950 continue;
1951 }
1952 $communicationOptions[] = $form->createElement('checkbox', $key, NULL, $var);
1953 }
1954 $form->addGroup($communicationOptions, $name, $title, '<br/>');
1955 }
1956 elseif ($fieldName === 'preferred_mail_format') {
1957 $form->add('select', $name, $title, CRM_Core_SelectValues::pmf());
1958 }
1959 elseif ($fieldName === 'preferred_language') {
1960 $form->add('select', $name, $title, array('' => ts('- select -')) + CRM_Contact_BAO_Contact::buildOptions('preferred_language'));
1961 }
1962 elseif ($fieldName == 'external_identifier') {
1963 $form->add('text', $name, $title, $attributes, $required);
1964 $contID = $contactId;
1965 if (!$contID) {
1966 $contID = $form->get('id');
1967 }
1968 $form->addRule($name,
1969 ts('External ID already exists in Database.'),
1970 'objectExists',
1971 array('CRM_Contact_DAO_Contact', $contID, 'external_identifier')
1972 );
1973 }
1974 elseif ($fieldName === 'group') {
1975 CRM_Contact_Form_Edit_TagsAndGroups::buildQuickForm($form, $contactId,
1976 CRM_Contact_Form_Edit_TagsAndGroups::GROUP,
1977 TRUE, $required,
1978 $title, NULL, $name
1979 );
1980 }
1981 elseif ($fieldName === 'tag') {
1982 CRM_Contact_Form_Edit_TagsAndGroups::buildQuickForm($form, $contactId,
1983 CRM_Contact_Form_Edit_TagsAndGroups::TAG,
1984 FALSE, $required,
1985 NULL, $title, $name
1986 );
1987 }
1988 elseif (substr($fieldName, 0, 4) === 'url-') {
1989 $form->add('text', $name, $title,
1990 array_merge(CRM_Core_DAO::getAttribute('CRM_Core_DAO_Website', 'url'),
1991 array(
1992 'onfocus' => "if (!this.value) { this.value='http://';} else return false",
1993 'onblur' => "if ( this.value == 'http://') { this.value='';} else return false",
1994 )
1995 ), $required
1996 );
1997
1998 $form->addRule($name, ts('Enter a valid Website.'), 'url');
1999
2000 //Website type select
2001 if ($usedFor) {
2002 if (substr($name, -1) == ']') {
2003 $websiteTypeName = substr($name, 0, -1) . '-website_type_id]';
2004 }
2005 $form->addElement('select', $websiteTypeName, NULL, CRM_Core_PseudoConstant::get('CRM_Core_DAO_Website', 'website_type_id'));
2006 }
2007 else {
2008 $form->addElement('select', $name . '-website_type_id', NULL, CRM_Core_PseudoConstant::get('CRM_Core_DAO_Website', 'website_type_id'));
2009 }
2010 }
2011 // Note should be rendered as textarea
2012 elseif (substr($fieldName, -4) == 'note') {
2013 $form->add('textarea', $name, $title, $attributes, $required);
2014 }
2015 elseif (substr($fieldName, 0, 6) === 'custom') {
2016 $customFieldID = CRM_Core_BAO_CustomField::getKeyID($fieldName);
2017 if ($customFieldID) {
2018 CRM_Core_BAO_CustomField::addQuickFormElement($form, $name, $customFieldID, FALSE, $required, $search, $title);
2019 }
2020 }
2021 elseif (substr($fieldName, 0, 14) === 'address_custom') {
2022 list($fName, $locTypeId) = CRM_Utils_System::explode('-', $fieldName, 2);
2023 $customFieldID = CRM_Core_BAO_CustomField::getKeyID(substr($fName, 8));
2024 if ($customFieldID) {
2025 CRM_Core_BAO_CustomField::addQuickFormElement($form, $name, $customFieldID, FALSE, $required, $search, $title);
2026 }
2027 }
2028 elseif (in_array($fieldName, array(
2029 'receive_date', 'receipt_date', 'thankyou_date', 'cancel_date'))) {
2030 $form->addDateTime($name, $title, $required, array('formatType' => 'activityDateTime'));
2031 }
2032 elseif ($fieldName == 'send_receipt') {
2033 $form->addElement('checkbox', $name, $title);
2034 }
2035 elseif ($fieldName == 'soft_credit') {
2036 CRM_Contact_Form_NewContact::buildQuickForm($form, $rowNumber, NULL, FALSE, 'soft_credit_');
2037 $form->addMoney("soft_credit_amount[{$rowNumber}]", ts('Amount'), FALSE, NULL, FALSE);
2038 }
2039 elseif ($fieldName == 'product_name') {
2040 list($products, $options) = CRM_Contribute_BAO_Premium::getPremiumProductInfo();
2041 $sel = &$form->addElement('hierselect', $name, $title);
2042 $products = array(
2043 '0' => ts('- select -')) + $products;
2044 $sel->setOptions(array($products, $options));
2045 }
2046 elseif ($fieldName == 'payment_instrument') {
2047 $form->add('select', $name, $title,
2048 array(''=>ts( '- select -' )) + CRM_Contribute_PseudoConstant::paymentInstrument( ), $required );
2049 }
2050 else if ($fieldName == 'financial_type' ) {
2051 $form->add('select', $name, $title,
2052 array(
2053 '' => ts('- select -')) + CRM_Contribute_PseudoConstant::financialType(), $required
2054 );
2055 }
2056 elseif ($fieldName == 'contribution_status_id') {
2057 $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus();
2058 $statusName = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
2059 foreach (array(
2060 'In Progress',
2061 'Overdue',
2062 'Refunded'
2063 ) as $suppress) {
2064 unset($contributionStatuses[CRM_Utils_Array::key($suppress, $statusName)]);
2065 }
2066
2067 $form->add('select', $name, $title,
2068 array(
2069 '' => ts('- select -')) + $contributionStatuses, $required
2070 );
2071 }
2072 elseif ($fieldName == 'soft_credit_type') {
2073 $form->add('select', $name, $title,
2074 array(
2075 '' => ts('- select -')) + CRM_Core_OptionGroup::values("soft_credit_type")
2076 );
2077 $form->addElement('hidden', 'sct_default_id',
2078 CRM_Core_OptionGroup::getDefaultValue("soft_credit_type"),
2079 array('id' => 'sct_default_id')
2080 );
2081 }
2082 elseif ($fieldName == 'currency') {
2083 $form->addCurrency($name, $title, $required);
2084 }
2085 elseif ($fieldName == 'contribution_page_id') {
2086 $form->add('select', $name, $title,
2087 array(
2088 '' => ts('- select -')) + CRM_Contribute_PseudoConstant::contributionPage(), $required, 'class="big"'
2089 );
2090 }
2091 elseif ($fieldName == 'participant_register_date') {
2092 $form->addDateTime($name, $title, $required, array('formatType' => 'activityDateTime'));
2093 }
2094 elseif ($fieldName == 'activity_status_id') {
2095 $form->add('select', $name, $title,
2096 array(
2097 '' => ts('- select -')) + CRM_Core_PseudoConstant::activityStatus(), $required
2098 );
2099 }
2100 elseif ($fieldName == 'activity_engagement_level') {
2101 $form->add('select', $name, $title,
2102 array(
2103 '' => ts('- select -')) + CRM_Campaign_PseudoConstant::engagementLevel(), $required
2104 );
2105 }
2106 elseif ($fieldName == 'activity_date_time') {
2107 $form->addDateTime($name, $title, $required, array('formatType' => 'activityDateTime'));
2108 }
2109 elseif ($fieldName == 'participant_status') {
2110 $cond = NULL;
2111 if ($online == TRUE) {
2112 $cond = 'visibility_id = 1';
2113 }
2114 $form->add('select', $name, $title,
2115 array(
2116 '' => ts('- select -')) + CRM_Event_PseudoConstant::participantStatus(NULL, $cond, 'label'), $required
2117 );
2118 }
2119 elseif ($fieldName == 'participant_role') {
2120 if (!empty($field['is_multiple'])) {
2121 $form->addCheckBox($name, $title, CRM_Event_PseudoConstant::participantRole(), NULL, NULL, NULL, NULL, '&nbsp', TRUE);
2122 }
2123 else {
2124 $form->add('select', $name, $title,
2125 array(
2126 '' => ts('- select -')) + CRM_Event_PseudoConstant::participantRole(), $required
2127 );
2128 }
2129 }
2130 elseif ($fieldName == 'world_region') {
2131 $form->add('select', $name, $title,
2132 array(
2133 '' => ts('- select -')) + CRM_Core_PseudoConstant::worldRegion(), $required
2134 );
2135 }
2136 elseif ($fieldName == 'signature_html') {
2137 $form->addWysiwyg($name, $title, CRM_Core_DAO::getAttribute('CRM_Core_DAO_Email', $fieldName));
2138 }
2139 elseif ($fieldName == 'signature_text') {
2140 $form->add('textarea', $name, $title, CRM_Core_DAO::getAttribute('CRM_Core_DAO_Email', $fieldName));
2141 }
2142 elseif (substr($fieldName, -11) == 'campaign_id') {
2143 if (CRM_Campaign_BAO_Campaign::isCampaignEnable()) {
2144 $campaigns = CRM_Campaign_BAO_Campaign::getCampaigns(CRM_Utils_Array::value($contactId,
2145 $form->_componentCampaigns
2146 ));
2147 $form->add('select', $name, $title,
2148 array(
2149 '' => ts('- select -')) + $campaigns, $required, 'class="big"'
2150 );
2151 }
2152 }
2153 elseif ($fieldName == 'activity_details') {
2154 $form->addWysiwyg($fieldName, $title, array('rows' => 4, 'cols' => 60), $required);
2155 }
2156 elseif ($fieldName == 'activity_duration') {
2157 $form->add('text', $name, $title, $attributes, $required);
2158 $form->addRule($name, ts('Please enter the duration as number of minutes (integers only).'), 'positiveInteger');
2159 }
2160 else {
2161 if (substr($fieldName, 0, 3) === 'is_' or substr($fieldName, 0, 7) === 'do_not_') {
2162 $form->add('advcheckbox', $name, $title, $attributes, $required);
2163 }
2164 else {
2165 $form->add('text', $name, $title, $attributes, $required);
2166 }
2167 }
2168
2169 static $hiddenSubtype = FALSE;
2170 if (!$hiddenSubtype && CRM_Contact_BAO_ContactType::isaSubType($field['field_type'])) {
2171 // In registration mode params are submitted via POST and we don't have any clue
2172 // about profile-id or the profile-type (which could be a subtype)
2173 // To generalize the behavior and simplify the process,
2174 // lets always add the hidden
2175 //subtype value if there is any, and we won't have to
2176 // compute it while processing.
2177 if ($usedFor) {
2178 $form->addElement('hidden', $usedFor . '[contact_sub_type]', $field['field_type']);
2179 }
2180 else {
2181 $form->addElement('hidden', 'contact_sub_type_hidden', $field['field_type']);
2182 }
2183 $hiddenSubtype = TRUE;
2184 }
2185
2186 if (($view && $mode != CRM_Profile_Form::MODE_SEARCH) || $isShared) {
2187 $form->freeze($name);
2188 }
2189
2190 //add the rules
2191 if (in_array($fieldName, array(
2192 'non_deductible_amount', 'total_amount', 'fee_amount', 'net_amount'))) {
2193 $form->addRule($name, ts('Please enter a valid amount.'), 'money');
2194 }
2195 $stateCountryMap = array();
2196 if (!empty($form->_stateCountryMap['state_province']) && !empty($form->_stateCountryMap['country'])) {
2197 foreach ($form->_stateCountryMap['state_province'] as $key => $value) {
2198 $stateCountryMap[$key]['state_province'] = $value;
2199 $stateCountryMap[$key]['country'] = $form->_stateCountryMap['country'][$key];
2200 }
2201 CRM_Core_BAO_Address::addStateCountryMap($stateCountryMap);
2202 }
2203 if ($rule) {
2204 if (!($rule == 'email' && $mode == CRM_Profile_Form::MODE_SEARCH)) {
2205 $form->addRule($name, ts('Please enter a valid %1', array(1 => $title)), $rule);
2206 }
2207 }
2208 }
2209
2210 /**
2211 * Function to set profile defaults
2212 *
2213 * @params int $contactId contact id
2214 * @params array $fields associative array of fields
2215 * @params array $defaults defaults array
2216 * @params boolean $singleProfile true for single profile else false(batch update)
2217 * @params int $componentId id for specific components like contribute, event etc
2218 *
2219 * @return null
2220 * @static
2221 * @access public
2222 */
2223 static function setProfileDefaults($contactId, &$fields, &$defaults,
2224 $singleProfile = TRUE, $componentId = NULL, $component = NULL
2225 ) {
2226 if (!$componentId) {
2227 //get the contact details
2228 list($contactDetails, $options) = CRM_Contact_BAO_Contact::getHierContactDetails($contactId, $fields);
2229 $details = CRM_Utils_Array::value($contactId, $contactDetails);
2230 $multipleFields = array('website' => 'url');
2231
2232 //start of code to set the default values
2233 foreach ($fields as $name => $field) {
2234 // skip pseudo fields
2235 if (substr($name, 0, 9) == 'phone_ext') {
2236 continue;
2237 }
2238
2239 //set the field name depending upon the profile mode(single/batch)
2240 if ($singleProfile) {
2241 $fldName = $name;
2242 }
2243 else {
2244 $fldName = "field[$contactId][$name]";
2245 }
2246
2247 if ($name == 'group') {
2248 CRM_Contact_Form_Edit_TagsAndGroups::setDefaults($contactId, $defaults, CRM_Contact_Form_Edit_TagsAndGroups::GROUP, $fldName);
2249 }
2250 if ($name == 'tag') {
2251 CRM_Contact_Form_Edit_TagsAndGroups::setDefaults($contactId, $defaults, CRM_Contact_Form_Edit_TagsAndGroups::TAG, $fldName);
2252 }
2253
2254 if (!empty($details[$name]) || isset($details[$name])) {
2255 //to handle custom data (checkbox) to be written
2256 // to handle birth/deceased date, greeting_type and few other fields
2257 if (($name == 'birth_date') || ($name == 'deceased_date')) {
2258 list($defaults[$fldName]) = CRM_Utils_Date::setDateDefaults($details[$name], 'birth');
2259 }
2260 elseif (in_array($name, CRM_Contact_BAO_Contact::$_greetingTypes)) {
2261 $defaults[$fldName] = $details[$name . '_id'];
2262 $defaults[$name . '_custom'] = $details[$name . '_custom'];
2263 }
2264 elseif ($name == 'preferred_communication_method') {
2265 $v = explode(CRM_Core_DAO::VALUE_SEPARATOR, $details[$name]);
2266 foreach ($v as $item) {
2267 if ($item) {
2268 $defaults[$fldName . "[$item]"] = 1;
2269 }
2270 }
2271 }
2272 elseif ($name == 'world_region') {
2273 $defaults[$fldName] = $details['worldregion_id'];
2274 }
2275 elseif ($customFieldId = CRM_Core_BAO_CustomField::getKeyID($name)) {
2276 //fix for custom fields
2277 $customFields = CRM_Core_BAO_CustomField::getFields(CRM_Utils_Array::value('contact_type', $details));
2278
2279 // hack to add custom data for components
2280 $components = array('Contribution', 'Participant', 'Membership', 'Activity');
2281 foreach ($components as $value) {
2282 $customFields = CRM_Utils_Array::crmArrayMerge($customFields,
2283 CRM_Core_BAO_CustomField::getFieldsForImport($value)
2284 );
2285 }
2286
2287 switch ($customFields[$customFieldId]['html_type']) {
2288 case 'Multi-Select State/Province':
2289 case 'Multi-Select Country':
2290 case 'AdvMulti-Select':
2291 case 'Multi-Select':
2292 $v = explode(CRM_Core_DAO::VALUE_SEPARATOR, $details[$name]);
2293 foreach ($v as $item) {
2294 if ($item) {
2295 $defaults[$fldName][$item] = $item;
2296 }
2297 }
2298 break;
2299
2300 case 'CheckBox':
2301 $v = explode(CRM_Core_DAO::VALUE_SEPARATOR, $details[$name]);
2302 foreach ($v as $item) {
2303 if ($item) {
2304 $defaults[$fldName][$item] = 1;
2305 // seems like we need this for QF style checkboxes in profile where its multiindexed
2306 // CRM-2969
2307 $defaults["{$fldName}[{$item}]"] = 1;
2308 }
2309 }
2310 break;
2311
2312 case 'Autocomplete-Select':
2313 if ($customFields[$customFieldId]['data_type'] == 'ContactReference') {
2314 if (is_numeric($details[$name])) {
2315 $defaults[$fldName . '_id'] = $details[$name];
2316 $defaults[$fldName] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $details[$name], 'sort_name');
2317 }
2318 }
2319 else {
2320 $label = CRM_Core_BAO_CustomOption::getOptionLabel($customFieldId, $details[$name]);
2321 $defaults[$fldName . '_id'] = $details[$name];
2322 $defaults[$fldName] = $label;
2323 }
2324 break;
2325
2326 case 'Select Date':
2327 // CRM-6681, set defult values according to date and time format (if any).
2328 $dateFormat = NULL;
2329 if (!empty($customFields[$customFieldId]['date_format'])) {
2330 $dateFormat = $customFields[$customFieldId]['date_format'];
2331 }
2332
2333 if (empty($customFields[$customFieldId]['time_format'])) {
2334 list($defaults[$fldName]) = CRM_Utils_Date::setDateDefaults($details[$name], NULL,
2335 $dateFormat
2336 );
2337 }
2338 else {
2339 $timeElement = $fldName . '_time';
2340 if (substr($fldName, -1) == ']') {
2341 $timeElement = substr($fldName, 0, -1) . '_time]';
2342 }
2343 list($defaults[$fldName], $defaults[$timeElement]) = CRM_Utils_Date::setDateDefaults($details[$name],
2344 NULL, $dateFormat, $customFields[$customFieldId]['time_format']);
2345 }
2346 break;
2347
2348 default:
2349 $defaults[$fldName] = $details[$name];
2350 break;
2351 }
2352 }
2353 else {
2354 $defaults[$fldName] = $details[$name];
2355 }
2356 }
2357 else {
2358 $blocks = array('email', 'phone', 'im', 'openid');
2359 list($fieldName, $locTypeId, $phoneTypeId) = CRM_Utils_System::explode('-', $name, 3);
2360 if (!in_array($fieldName, $multipleFields)) {
2361 if (is_array($details)) {
2362 foreach ($details as $key => $value) {
2363 // when we fixed CRM-5319 - get primary loc
2364 // type as per loc field and removed below code.
2365 $primaryLocationType = FALSE;
2366 if ($locTypeId == 'Primary') {
2367 if (is_array($value) && array_key_exists($fieldName, $value)){
2368 $primaryLocationType = TRUE;
2369 if (in_array($fieldName, $blocks)){
2370 $locTypeId = CRM_Contact_BAO_Contact::getPrimaryLocationType($contactId, FALSE, $fieldName);
2371 }
2372 else{
2373 $locTypeId = CRM_Contact_BAO_Contact::getPrimaryLocationType($contactId, FALSE, 'address');
2374 }
2375 }
2376 }
2377
2378 // fixed for CRM-665
2379 if (is_numeric($locTypeId)) {
2380 if ($primaryLocationType || $locTypeId == CRM_Utils_Array::value('location_type_id', $value)) {
2381 if (!empty($value[$fieldName])) {
2382 //to handle stateprovince and country
2383 if ($fieldName == 'state_province') {
2384 $defaults[$fldName] = $value['state_province_id'];
2385 }
2386 elseif ($fieldName == 'county') {
2387 $defaults[$fldName] = $value['county_id'];
2388 }
2389 elseif ($fieldName == 'country') {
2390 if (!isset($value['country_id']) || !$value['country_id']) {
2391 $config = CRM_Core_Config::singleton();
2392 if ($config->defaultContactCountry) {
2393 $defaults[$fldName] = $config->defaultContactCountry;
2394 }
2395 }
2396 else {
2397 $defaults[$fldName] = $value['country_id'];
2398 }
2399 }
2400 elseif ($fieldName == 'phone') {
2401 if ($phoneTypeId) {
2402 if (isset($value['phone'][$phoneTypeId])) {
2403 $defaults[$fldName] = $value['phone'][$phoneTypeId];
2404 }
2405 if (isset($value['phone_ext'][$phoneTypeId])) {
2406 $defaults[str_replace('phone', 'phone_ext', $fldName)] = $value['phone_ext'][$phoneTypeId];
2407 }
2408 }
2409 else {
2410 $phoneDefault = CRM_Utils_Array::value('phone', $value);
2411 // CRM-9216
2412 if (!is_array($phoneDefault)) {
2413 $defaults[$fldName] = $phoneDefault;
2414 }
2415 }
2416 }
2417 elseif ($fieldName == 'email') {
2418 //adding the first email (currently we don't support multiple emails of same location type)
2419 $defaults[$fldName] = $value['email'];
2420 }
2421 elseif ($fieldName == 'im') {
2422 //adding the first im (currently we don't support multiple ims of same location type)
2423 $defaults[$fldName] = $value['im'];
2424 $defaults[$fldName . '-provider_id'] = $value['im_provider_id'];
2425 }
2426 else {
2427 $defaults[$fldName] = $value[$fieldName];
2428 }
2429 }
2430 elseif (substr($fieldName, 0, 14) === 'address_custom' &&
2431 CRM_Utils_Array::value(substr($fieldName, 8), $value)
2432 ) {
2433 $defaults[$fldName] = $value[substr($fieldName, 8)];
2434 }
2435 }
2436 }
2437 }
2438 }
2439 }
2440 else {
2441 if (is_array($details)) {
2442 if ($fieldName === 'url') {
2443 if (!empty($details['website'])) {
2444 foreach ($details['website'] as $val) {
2445 $defaults[$fldName] = CRM_Utils_Array::value('url', $val);
2446 $defaults[$fldName . '-website_type_id'] = $val['website_type_id'];
2447 }
2448 }
2449 }
2450 }
2451 }
2452 }
2453 }
2454 }
2455
2456 //Handling Contribution Part of the batch profile
2457 if (CRM_Core_Permission::access('CiviContribute') && $component == 'Contribute') {
2458 self::setComponentDefaults($fields, $componentId, $component, $defaults);
2459 }
2460
2461 //Handling Event Participation Part of the batch profile
2462 if (CRM_Core_Permission::access('CiviEvent') && $component == 'Event') {
2463 self::setComponentDefaults($fields, $componentId, $component, $defaults);
2464 }
2465
2466 //Handling membership Part of the batch profile
2467 if (CRM_Core_Permission::access('CiviMember') && $component == 'Membership') {
2468 self::setComponentDefaults($fields, $componentId, $component, $defaults);
2469 }
2470
2471 //Handling Activity Part of the batch profile
2472 if ($component == 'Activity') {
2473 self::setComponentDefaults($fields, $componentId, $component, $defaults);
2474 }
2475 }
2476
2477 /**
2478 * Function to get profiles by type eg: pure Individual etc
2479 *
2480 * @param array $types associative array of types eg: types('Individual')
2481 * @param boolean $onlyPure true if only pure profiles are required
2482 *
2483 * @return array $profiles associative array of profiles
2484 * @static
2485 * @access public
2486 */
2487 static function getProfiles($types, $onlyPure = FALSE) {
2488 $profiles = array();
2489 $ufGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_UFField', 'uf_group_id');
2490
2491 CRM_Utils_Hook::aclGroup(CRM_Core_Permission::ADMIN, NULL, 'civicrm_uf_group', $ufGroups, $ufGroups);
2492
2493 // Exclude Batch Data Entry profiles - CRM-10901
2494 $batchProfiles = CRM_Core_BAO_UFGroup::getBatchProfiles();
2495
2496 foreach ($ufGroups as $id => $title) {
2497 $ptype = CRM_Core_BAO_UFField::getProfileType($id, FALSE, $onlyPure);
2498 if (in_array($ptype, $types) && !array_key_exists($id, $batchProfiles)) {
2499 $profiles[$id] = $title;
2500 }
2501 }
2502 return $profiles;
2503 }
2504
2505 /**
2506 * Function to check whether a profile is valid combination of
2507 * required and/or optional profile types
2508 *
2509 * @param array $required array of types those are required
2510 * @param array $optional array of types those are optional
2511 *
2512 * @return array $profiles associative array of profiles
2513 * @static
2514 * @access public
2515 */
2516 static function getValidProfiles($required, $optional = NULL) {
2517 if (!is_array($required) || empty($required)) {
2518 return;
2519 }
2520
2521 $profiles = array();
2522 $ufGroups = CRM_Core_PseudoConstant::get('CRM_Core_DAO_UFField', 'uf_group_id');
2523
2524 CRM_Utils_Hook::aclGroup(CRM_Core_Permission::ADMIN, NULL, 'civicrm_uf_group', $ufGroups, $ufGroups);
2525
2526 foreach ($ufGroups as $id => $title) {
2527 $type = CRM_Core_BAO_UFField::checkValidProfileType($id, $required, $optional);
2528 if ($type) {
2529 $profiles[$id] = $title;
2530 }
2531 }
2532
2533 return $profiles;
2534 }
2535
2536 /**
2537 * Function to check whether a profile is valid combination of
2538 * required profile fields
2539 *
2540 * @param array $ufId integer id of the profile
2541 * @param array $required array of fields those are required in the profile
2542 *
2543 * @return array $profiles associative array of profiles
2544 * @static
2545 * @access public
2546 */
2547 static function checkValidProfile($ufId, $required = NULL) {
2548 $validProfile = FALSE;
2549 if (!$ufId) {
2550 return $validProfile;
2551 }
2552
2553 if (!CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $ufId, 'is_active')) {
2554 return $validProfile;
2555 }
2556
2557 $profileFields = self::getFields($ufId, FALSE, CRM_Core_Action::VIEW, NULL,
2558 NULL, FALSE, NULL, FALSE, NULL,
2559 CRM_Core_Permission::CREATE, NULL
2560 );
2561
2562 $validProfile = array();
2563 if (!empty($profileFields)) {
2564 $fields = array_keys($profileFields);
2565 foreach ($fields as $val) {
2566 foreach ($required as $key => $field) {
2567 if (strpos($val, $field) === 0) {
2568 unset($required[$key]);
2569 }
2570 }
2571 }
2572
2573 $validProfile = (empty($required)) ? TRUE : FALSE;
2574 }
2575
2576 return $validProfile;
2577 }
2578
2579 /**
2580 * Function to get default value for Register.
2581 *
2582 * @return $defaults
2583 * @static
2584 * @access public
2585 */
2586 static function setRegisterDefaults(&$fields, &$defaults) {
2587 $config = CRM_Core_Config::singleton();
2588 foreach ($fields as $name => $field) {
2589 if (substr($name, 0, 8) == 'country-') {
2590 if (!empty($config->defaultContactCountry)) {
2591 $defaults[$name] = $config->defaultContactCountry;
2592 }
2593 }
2594 elseif (substr($name, 0, 15) == 'state_province-') {
2595 if (!empty($config->defaultContactStateProvince)) {
2596 $defaults[$name] = $config->defaultContactStateProvince;
2597 }
2598 }
2599 }
2600 return $defaults;
2601 }
2602
2603 /**
2604 * This function is to make a copy of a profile, including
2605 * all the fields in the profile
2606 *
2607 * @param int $id the profile id to copy
2608 *
2609 * @return void
2610 * @access public
2611 */
2612 static function copy($id) {
2613 $fieldsFix = array('prefix' => array('title' => ts('Copy of ')));
2614 $copy = &CRM_Core_DAO::copyGeneric('CRM_Core_DAO_UFGroup',
2615 array('id' => $id),
2616 NULL,
2617 $fieldsFix
2618 );
2619
2620 if ($pos = strrpos($copy->name, "_{$id}")) {
2621 $copy->name = substr_replace($copy->name, '', $pos);
2622 }
2623 $copy->name = CRM_Utils_String::munge($copy->name, '_', 56) . "_{$copy->id}";
2624 $copy->save();
2625
2626 $copyUFJoin = &CRM_Core_DAO::copyGeneric('CRM_Core_DAO_UFJoin',
2627 array('uf_group_id' => $id),
2628 array('uf_group_id' => $copy->id),
2629 NULL,
2630 'entity_table'
2631 );
2632
2633 $copyUFField = &CRM_Core_DAO::copyGeneric('CRM_Core_BAO_UFField',
2634 array('uf_group_id' => $id),
2635 array('uf_group_id' => $copy->id)
2636 );
2637
2638 $maxWeight = CRM_Utils_Weight::getMax('CRM_Core_DAO_UFJoin', NULL, 'weight');
2639
2640 //update the weight
2641 $query = "
2642 UPDATE civicrm_uf_join
2643 SET weight = %1
2644 WHERE uf_group_id = %2
2645 AND ( entity_id IS NULL OR entity_id <= 0 )
2646 ";
2647 $p = array(1 => array($maxWeight + 1, 'Integer'),
2648 2 => array($copy->id, 'Integer'),
2649 );
2650 CRM_Core_DAO::executeQuery($query, $p);
2651 if ($copy->is_reserved) {
2652 $query = "UPDATE civicrm_uf_group SET is_reserved = 0 WHERE id = %1";
2653 $params = array(1 => array($copy->id, 'Integer'));
2654 CRM_Core_DAO::executeQuery($query, $params);
2655 }
2656 CRM_Utils_Hook::copy('UFGroup', $copy);
2657
2658 return $copy;
2659 }
2660
2661 /**
2662 * Process that send notification e-mails
2663 *
2664 * @params int $contactId contact id
2665 * @params array $values associative array of name/value pair
2666 *
2667 * @return void
2668 * @access public
2669 */
2670
2671 static function commonSendMail($contactID, &$values) {
2672 if (!$contactID || !$values) {
2673 return;
2674
2675 }
2676 $template = CRM_Core_Smarty::singleton();
2677
2678 $displayName = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
2679 $contactID,
2680 'display_name'
2681 );
2682
2683 self::profileDisplay($values['id'], $values['values'], $template);
2684 $emailList = explode(',', $values['email']);
2685
2686 $contactLink = CRM_Utils_System::url('civicrm/contact/view',
2687 "reset=1&cid=$contactID",
2688 TRUE, NULL, FALSE, FALSE, TRUE
2689 );
2690
2691 //get the default domain email address.
2692 list($domainEmailName, $domainEmailAddress) = CRM_Core_BAO_Domain::getNameAndEmail();
2693
2694 if (!$domainEmailAddress || $domainEmailAddress == 'info@EXAMPLE.ORG') {
2695 $fixUrl = CRM_Utils_System::url('civicrm/admin/domain', 'action=update&reset=1');
2696 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)));
2697 }
2698
2699 foreach ($emailList as $emailTo) {
2700 // FIXME: take the below out of the foreach loop
2701 CRM_Core_BAO_MessageTemplate::sendTemplate(
2702 array(
2703 'groupName' => 'msg_tpl_workflow_uf',
2704 'valueName' => 'uf_notify',
2705 'contactId' => $contactID,
2706 'tplParams' => array(
2707 'displayName' => $displayName,
2708 'currentDate' => date('r'),
2709 'contactLink' => $contactLink,
2710 ),
2711 'from' => "$domainEmailName <$domainEmailAddress>",
2712 'toEmail' => $emailTo,
2713 )
2714 );
2715 }
2716 }
2717
2718 /**
2719 * Given a contact id and a group id, returns the field values from the db
2720 * for this group and notify email only if group's notify field is
2721 * set and field values are not empty
2722 *
2723 * @params $gid group id
2724 * @params $cid contact id
2725 * @params $params associative array
2726 *
2727 * @return array
2728 * @access public
2729 */
2730 function checkFieldsEmptyValues($gid, $cid, $params, $skipCheck = FALSE) {
2731 if ($gid) {
2732 if (CRM_Core_BAO_UFGroup::filterUFGroups($gid, $cid) || $skipCheck) {
2733 $values = array();
2734 $fields = CRM_Core_BAO_UFGroup::getFields($gid, FALSE, CRM_Core_Action::VIEW);
2735 CRM_Core_BAO_UFGroup::getValues($cid, $fields, $values, FALSE, $params, TRUE);
2736
2737 $email = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $gid, 'notify');
2738
2739 if (!empty($values) &&
2740 !empty($email)
2741 ) {
2742 $val = array(
2743 'id' => $gid,
2744 'values' => $values,
2745 'email' => $email,
2746 );
2747 return $val;
2748 }
2749 }
2750 }
2751 return NULL;
2752 }
2753
2754 /**
2755 * Function to assign uf fields to template
2756 *
2757 * @params int $gid group id
2758 * @params array $values associative array of fields
2759 *
2760 * @return void
2761 * @access public
2762 */
2763 function profileDisplay($gid, $values, $template) {
2764 $groupTitle = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $gid, 'title');
2765 $template->assign('grouptitle', $groupTitle);
2766 if (count($values)) {
2767 $template->assign('values', $values);
2768 }
2769 }
2770
2771 /**
2772 * Format fields for dupe Contact Matching
2773 *
2774 * @param array $params associated array
2775 *
2776 * @return array $data assoicated formatted array
2777 * @access public
2778 * @static
2779 */
2780 static function formatFields($params, $contactId = NULL) {
2781 if ($contactId) {
2782 // get the primary location type id and email
2783 list($name, $primaryEmail, $primaryLocationType) = CRM_Contact_BAO_Contact_Location::getEmailDetails($contactId);
2784 }
2785 else {
2786 $defaultLocationType = CRM_Core_BAO_LocationType::getDefault();
2787 $primaryLocationType = $defaultLocationType->id;
2788 }
2789
2790 $data = array();
2791 $locationType = array();
2792 $count = 1;
2793 $primaryLocation = 0;
2794 foreach ($params as $key => $value) {
2795 list($fieldName, $locTypeId, $phoneTypeId) = explode('-', $key);
2796
2797 if ($locTypeId == 'Primary') {
2798 $locTypeId = $primaryLocationType;
2799 }
2800
2801 if (is_numeric($locTypeId)) {
2802 if (!in_array($locTypeId, $locationType)) {
2803 $locationType[$count] = $locTypeId;
2804 $count++;
2805 }
2806 $loc = CRM_Utils_Array::key($locTypeId, $locationType);
2807
2808 $data['location'][$loc]['location_type_id'] = $locTypeId;
2809
2810 // if we are getting in a new primary email, dont overwrite the new one
2811 if ($locTypeId == $primaryLocationType) {
2812 if (!empty($params['email-' . $primaryLocationType])) {
2813 $data['location'][$loc]['email'][$loc]['email'] = $fields['email-' . $primaryLocationType];
2814 }
2815 elseif (isset($primaryEmail)) {
2816 $data['location'][$loc]['email'][$loc]['email'] = $primaryEmail;
2817 }
2818 $primaryLocation++;
2819 }
2820
2821 if ($loc == 1) {
2822 $data['location'][$loc]['is_primary'] = 1;
2823 }
2824 if ($fieldName == 'phone') {
2825 if ($phoneTypeId) {
2826 $data['location'][$loc]['phone'][$loc]['phone_type_id'] = $phoneTypeId;
2827 }
2828 else {
2829 $data['location'][$loc]['phone'][$loc]['phone_type_id'] = '';
2830 }
2831 $data['location'][$loc]['phone'][$loc]['phone'] = $value;
2832 }
2833 elseif ($fieldName == 'email') {
2834 $data['location'][$loc]['email'][$loc]['email'] = $value;
2835 }
2836 elseif ($fieldName == 'im') {
2837 $data['location'][$loc]['im'][$loc]['name'] = $value;
2838 }
2839 else {
2840 if ($fieldName === 'state_province') {
2841 $data['location'][$loc]['address']['state_province_id'] = $value;
2842 }
2843 elseif ($fieldName === 'country') {
2844 $data['location'][$loc]['address']['country_id'] = $value;
2845 }
2846 else {
2847 $data['location'][$loc]['address'][$fieldName] = $value;
2848 }
2849 }
2850 }
2851 else {
2852 // TODO: prefix, suffix and gender translation may no longer be necessary - check inputs
2853 if ($key === 'individual_suffix') {
2854 $data['suffix_id'] = $value;
2855 }
2856 elseif ($key === 'individual_prefix') {
2857 $data['prefix_id'] = $value;
2858 }
2859 elseif ($key === 'gender') {
2860 $data['gender_id'] = $value;
2861 }
2862 elseif (substr($key, 0, 6) === 'custom') {
2863 if ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($key)) {
2864 //fix checkbox
2865 if ($customFields[$customFieldID]['html_type'] == 'CheckBox') {
2866 $value = implode(CRM_Core_DAO::VALUE_SEPARATOR, array_keys($value));
2867 }
2868 // fix the date field
2869 if ($customFields[$customFieldID]['data_type'] == 'Date') {
2870 $date = CRM_Utils_Date::format($value);
2871 if (!$date) {
2872 $date = '';
2873 }
2874 $value = $date;
2875 }
2876
2877 $data['custom'][$customFieldID] = array(
2878 'id' => $id,
2879 'value' => $value,
2880 'extends' => $customFields[$customFieldID]['extends'],
2881 'type' => $customFields[$customFieldID]['data_type'],
2882 'custom_field_id' => $customFieldID,
2883 );
2884 }
2885 }
2886 elseif ($key == 'edit') {
2887 continue;
2888 }
2889 else {
2890 $data[$key] = $value;
2891 }
2892 }
2893 }
2894
2895 if (!$primaryLocation) {
2896 $loc++;
2897 $data['location'][$loc]['email'][$loc]['email'] = $primaryEmail;
2898 }
2899
2900
2901 return $data;
2902 }
2903
2904 /**
2905 * calculate the profile type 'group_type' as per profile fields.
2906 *
2907 * @param int $gid profile id
2908 * @param int $ignoreFieldId ignore particular profile field
2909 *
2910 * @return array list of calculated group type
2911 */
2912 static function calculateGroupType($gId, $includeTypeValues = FALSE, $ignoreFieldId = NULL) {
2913 //get the profile fields.
2914 $ufFields = self::getFields($gId, FALSE, NULL, NULL, NULL, TRUE, NULL, TRUE);
2915 return self::_calculateGroupType($ufFields, $includeTypeValues, $ignoreFieldId);
2916 }
2917
2918 /**
2919 * calculate the profile type 'group_type' as per profile fields.
2920 *
2921 * @param int $gid profile id
2922 * @param int $ignoreFieldId ignore perticular profile field
2923 *
2924 * @return array list of calculated group type
2925 */
2926 static function _calculateGroupType($ufFields, $includeTypeValues = FALSE, $ignoreFieldId = NULL) {
2927 $groupType = $groupTypeValues = $customFieldIds = array();
2928 if (!empty($ufFields)) {
2929 foreach ($ufFields as $fieldName => $fieldValue) {
2930 //ignore field from group type when provided.
2931 //in case of update profile field.
2932 if ($ignoreFieldId && ($ignoreFieldId == $fieldValue['field_id'])) {
2933 continue;
2934 }
2935 if (!in_array($fieldValue['field_type'], $groupType)) {
2936 $groupType[$fieldValue['field_type']] = $fieldValue['field_type'];
2937 }
2938
2939 if ($includeTypeValues && ($fldId = CRM_Core_BAO_CustomField::getKeyID($fieldName))) {
2940 $customFieldIds[$fldId] = $fldId;
2941 }
2942 }
2943 }
2944
2945 if (!empty($customFieldIds)) {
2946 $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) . ')';
2947
2948 $customGroups = CRM_Core_DAO::executeQuery($query);
2949 while ($customGroups->fetch()) {
2950 if (!$customGroups->extends_entity_column_value) {
2951 continue;
2952 }
2953
2954 $groupTypeName = "{$customGroups->extends}Type";
2955 if ($customGroups->extends == 'Participant' && $customGroups->extends_entity_column_id) {
2956 $groupTypeName = CRM_Core_OptionGroup::getValue('custom_data_type', $customGroups->extends_entity_column_id, 'value', 'String', 'name');
2957 }
2958
2959 foreach (explode(CRM_Core_DAO::VALUE_SEPARATOR, $customGroups->extends_entity_column_value) as $val) {
2960 if ($val) {
2961 $groupTypeValues[$groupTypeName][$val] = $val;
2962 }
2963 }
2964 }
2965
2966 if (!empty($groupTypeValues)) {
2967 $groupType = array_merge($groupType, $groupTypeValues);
2968 }
2969 }
2970
2971 return $groupType;
2972 }
2973
2974 /**
2975 * Update the profile type 'group_type' as per profile fields including group types and group subtype values.
2976 * Build and store string like: group_type1,group_type2[VALUE_SEPERATOR]group_type1Type:1:2:3,group_type2Type:1:2
2977 *
2978 * FIELDS GROUP_TYPE
2979 * BirthDate + Email Individual,Contact
2980 * BirthDate + Subject Individual,Activity
2981 * BirthDate + Subject + SurveyOnlyField Individual,Activity\0ActivityType:28
2982 * BirthDate + Subject + SurveyOnlyField + PhoneOnlyField (Not allowed)
2983 * BirthDate + SurveyOnlyField Individual,Activity\0ActivityType:28
2984 * BirthDate + Subject + SurveyOrPhoneField Individual,Activity\0ActivityType:2:28
2985 * BirthDate + SurveyOrPhoneField Individual,Activity\0ActivityType:2:28
2986 * BirthDate + SurveyOrPhoneField + SurveyOnlyField Individual,Activity\0ActivityType:2:28
2987 * BirthDate + StudentField + Subject + SurveyOnlyField Individual,Activity,Student\0ActivityType:28
2988 *
2989 * @param Integer $gid profile id
2990 * @param Array $groupTypes With key having group type names
2991 *
2992 * @return Boolean
2993 */
2994 static function updateGroupTypes($gId, $groupTypes = array(
2995 )) {
2996 if (!is_array($groupTypes) || !$gId) {
2997 return FALSE;
2998 }
2999
3000 // If empty group types set group_type as 'null'
3001 if (empty($groupTypes)) {
3002 return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_UFGroup', $gId, 'group_type', 'null');
3003 }
3004
3005 $componentGroupTypes = array('Contribution', 'Participant', 'Membership', 'Activity');
3006 $validGroupTypes = array_merge(array('Contact', 'Individual', 'Organization', 'Household'), $componentGroupTypes, CRM_Contact_BAO_ContactType::subTypes());
3007
3008 $gTypes = $gTypeValues = array();
3009
3010 $participantExtends = array('ParticipantRole', 'ParticipantEventName', 'ParticipantEventType');
3011 // Get valid group type and group subtypes
3012 foreach ($groupTypes as $groupType => $value) {
3013 if (in_array($groupType, $validGroupTypes) && !in_array($groupType, $gTypes)) {
3014 $gTypes[] = $groupType;
3015 }
3016
3017 $subTypesOf = NULL;
3018
3019 if (in_array($groupType, $participantExtends)) {
3020 $subTypesOf = $groupType;
3021 }
3022 elseif (strpos($groupType, 'Type') > 0) {
3023 $subTypesOf = substr($groupType, 0, strpos($groupType, 'Type'));
3024 }
3025 else {
3026 continue;
3027 }
3028
3029 if (!empty($value) &&
3030 (in_array($subTypesOf, $componentGroupTypes) ||
3031 in_array($subTypesOf, $participantExtends)
3032 )
3033 ) {
3034 $gTypeValues[$subTypesOf] = $groupType . ":" . implode(':', $value);
3035 }
3036 }
3037
3038 if (empty($gTypes)) {
3039 return FALSE;
3040 }
3041
3042 // Build String to store group types and group subtypes
3043 $groupTypeString = implode(',', $gTypes);
3044 if (!empty($gTypeValues)) {
3045 $groupTypeString .= CRM_Core_DAO::VALUE_SEPARATOR . implode(',', $gTypeValues);
3046 }
3047
3048 return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_UFGroup', $gId, 'group_type', $groupTypeString);
3049 }
3050
3051 /**
3052 * Create a "group_type" string
3053 *
3054 * @param array $coreTypes e.g. array('Individual','Contact','Student')
3055 * @param array $subTypes e.g. array('ActivityType' => array(7, 11))
3056 * @param string $delim
3057 * @throws CRM_Core_Exception
3058 */
3059 static function encodeGroupType($coreTypes, $subTypes, $delim = CRM_Core_DAO::VALUE_SEPARATOR) {
3060 $groupTypeExpr = '';
3061 if ($coreTypes) {
3062 $groupTypeExpr .= implode(',', $coreTypes);
3063 }
3064 if ($subTypes) {
3065 if (count($subTypes) > 1) {
3066 throw new CRM_Core_Exception("Multiple subtype filtering is not currently supported by widget.");
3067 }
3068 foreach ($subTypes as $subType => $subTypeIds) {
3069 $groupTypeExpr .= $delim . $subType . ':' . implode(':', $subTypeIds);
3070 }
3071 }
3072 return $groupTypeExpr;
3073 }
3074
3075 /**
3076 * This function is used to setDefault componet specific profile fields.
3077 *
3078 * @param array $fields profile fields.
3079 * @param int $componentId componetID
3080 * @param string $component component name
3081 * @param array $defaults an array of default values.
3082 *
3083 * @return void.
3084 */
3085 public static function setComponentDefaults(&$fields, $componentId, $component, &$defaults, $isStandalone = FALSE) {
3086 if (!$componentId ||
3087 !in_array($component, array('Contribute', 'Membership', 'Event', 'Activity'))
3088 ) {
3089 return;
3090 }
3091
3092 $componentBAO = $componentSubType = NULL;
3093 switch ($component) {
3094 case 'Membership':
3095 $componentBAO = 'CRM_Member_BAO_Membership';
3096 $componentBAOName = 'Membership';
3097 $componentSubType = array('membership_type_id');
3098 break;
3099
3100 case 'Contribute':
3101 $componentBAO = 'CRM_Contribute_BAO_Contribution';
3102 $componentBAOName = 'Contribution';
3103 $componentSubType = array( 'financial_type_id' );
3104 break;
3105
3106 case 'Event':
3107 $componentBAO = 'CRM_Event_BAO_Participant';
3108 $componentBAOName = 'Participant';
3109 $componentSubType = array('role_id', 'event_id');
3110 break;
3111
3112 case 'Activity':
3113 $componentBAO = 'CRM_Activity_BAO_Activity';
3114 $componentBAOName = 'Activity';
3115 $componentSubType = array('activity_type_id');
3116 break;
3117 }
3118
3119 $values = array();
3120 $params = array('id' => $componentId);
3121
3122 //get the component values.
3123 CRM_Core_DAO::commonRetrieve($componentBAO, $params, $values);
3124
3125 $formattedGroupTree = array();
3126 $dateTimeFields = array('participant_register_date', 'activity_date_time', 'receive_date', 'receipt_date', 'cancel_date', 'thankyou_date', 'membership_start_date', 'membership_end_date', 'join_date');
3127 foreach ($fields as $name => $field) {
3128 $fldName = $isStandalone ? $name : "field[$componentId][$name]";
3129 if (in_array($name, $dateTimeFields)) {
3130 $timefldName = $isStandalone ? "{$name}_time" : "field[$componentId][{$name}_time]";
3131 if (!empty($values[$name])) {
3132 list($defaults[$fldName], $defaults[$timefldName]) = CRM_Utils_Date::setDateDefaults($values[$name]);
3133 }
3134 }
3135 elseif (array_key_exists($name, $values)) {
3136 $defaults[$fldName] = $values[$name];
3137 }
3138 elseif ($name == 'participant_note') {
3139 $noteDetails = CRM_Core_BAO_Note::getNote($componentId, 'civicrm_participant');
3140 $defaults[$fldName] = array_pop($noteDetails);
3141 }
3142 elseif (in_array($name, array(
3143 'financial_type', 'payment_instrument', 'participant_status', 'participant_role'))) {
3144 $defaults[$fldName] = $values["{$name}_id"];
3145 }
3146 elseif ($name == 'membership_type') {
3147 // since membership_type field is a hierselect -
3148 $defaults[$fldName][0] =
3149 CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',$values['membership_type_id'],'member_of_contact_id','id');
3150 $defaults[$fldName][1] = $values['membership_type_id'];
3151 }
3152 elseif ($name == 'membership_status') {
3153 $defaults[$fldName] = $values['status_id'];
3154 }
3155 elseif ($customFieldInfo = CRM_Core_BAO_CustomField::getKeyID($name, TRUE)) {
3156 if (empty($formattedGroupTree)) {
3157 //get the groupTree as per subTypes.
3158 $groupTree = array();
3159 foreach ($componentSubType as $subType) {
3160 $subTree = CRM_Core_BAO_CustomGroup::getTree($componentBAOName, CRM_Core_DAO::$_nullObject,
3161 $componentId, 0, $values[$subType]
3162 );
3163 $groupTree = CRM_Utils_Array::crmArrayMerge($groupTree, $subTree);
3164 }
3165 $formattedGroupTree = CRM_Core_BAO_CustomGroup::formatGroupTree($groupTree, 1, CRM_Core_DAO::$_nullObject);
3166 CRM_Core_BAO_CustomGroup::setDefaults($formattedGroupTree, $defaults);
3167 }
3168
3169 //FIX ME: We need to loop defaults, but once we move to custom_1_x convention this code can be simplified.
3170 foreach ($defaults as $customKey => $customValue) {
3171 if ($customFieldDetails = CRM_Core_BAO_CustomField::getKeyID($customKey, TRUE)) {
3172 if ($name == 'custom_' . $customFieldDetails[0]) {
3173
3174 //hack to set default for checkbox
3175 //basically this is for weired field name like field[33][custom_19]
3176 //we are converting this field name to array structure and assign value.
3177 $skipValue = FALSE;
3178
3179 foreach ($formattedGroupTree as $tree) {
3180 if ('CheckBox' == CRM_Utils_Array::value('html_type', $tree['fields'][$customFieldDetails[0]])) {
3181 $skipValue = TRUE;
3182 $defaults['field'][$componentId][$name] = $customValue;
3183 break;
3184 }
3185 elseif (CRM_Utils_Array::value('data_type', $tree['fields'][$customFieldDetails[0]]) == 'Date') {
3186 $skipValue = TRUE;
3187
3188 // CRM-6681, $default contains formatted date, time values.
3189 $defaults[$fldName] = $customValue;
3190 if (!empty($defaults[$customKey . '_time'])) {
3191 $defaults['field'][$componentId][$name . '_time'] = $defaults[$customKey . '_time'];
3192 }
3193 }
3194 }
3195
3196 if (!$skipValue || $isStandalone) {
3197 $defaults[$fldName] = $customValue;
3198 }
3199 unset($defaults[$customKey]);
3200 break;
3201 }
3202 }
3203 }
3204 }
3205 }
3206 }
3207
3208 /**
3209 * Function to retrieve reserved profiles
3210 *
3211 * @param string $name name if the reserve profile
3212 * @param array $extraProfiles associated array of profile id's that needs to merge
3213 *
3214 * @return array $reservedProfiles returns associated array
3215 * @static
3216 */
3217 static function getReservedProfiles($type = 'Contact', $extraProfiles = NULL) {
3218 $reservedProfiles = array();
3219 $profileNames = array();
3220 if ($type == 'Contact') {
3221 $whereClause = 'name IN ( "new_individual", "new_organization", "new_household" )';
3222 if (CRM_Contact_BAO_ContactType::isActive('Individual')) {
3223 $profileNames[] = '"new_individual"';
3224 }
3225 if (CRM_Contact_BAO_ContactType::isActive('Household')) {
3226 $profileNames[] = '"new_household"';
3227 }
3228 if (CRM_Contact_BAO_ContactType::isActive('Organization')) {
3229 $profileNames[] = '"new_organization"';
3230 }
3231 }
3232 if (!empty($profileNames)) {
3233 $whereClause = 'name IN ( ' . implode(',', $profileNames) . ' ) AND is_reserved = 1';
3234 }
3235 else {
3236 $whereClause = 'is_reserved = 1';
3237 }
3238
3239 $query = "SELECT id, title FROM civicrm_uf_group WHERE {$whereClause}";
3240
3241 $dao = CRM_Core_DAO::executeQuery($query);
3242 while ($dao->fetch()) {
3243 $key = $dao->id;
3244 if ($extraProfiles) {
3245 $key .= ',' . implode(',', $extraProfiles);
3246 }
3247 $reservedProfiles[$key] = $dao->title;
3248 }
3249 return $reservedProfiles;
3250 }
3251
3252 /**
3253 * Function to retrieve groups of profiles
3254 *
3255 * @param integer $profileID id of the profile
3256 *
3257 * @return array returns array
3258 * @static
3259 */
3260 static function profileGroups($profileID) {
3261 $groupTypes = array();
3262 $profileTypes = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $profileID, 'group_type');
3263 if ($profileTypes) {
3264 $groupTypeParts = explode(CRM_Core_DAO::VALUE_SEPARATOR, $profileTypes);
3265 $groupTypes = explode(',', $groupTypeParts[0]);
3266 }
3267 return $groupTypes;
3268 }
3269
3270 /**
3271 * Function to alter contact params by filtering existing subscribed groups and returns
3272 * unsubscribed groups array for subscription.
3273 *
3274 * @param array $params contact params
3275 * @param int $contactId user contact id
3276 *
3277 * @return array $subscribeGroupIds This contains array of groups for subscription
3278 */
3279 static function getDoubleOptInGroupIds(&$params, $contactId = NULL) {
3280 $config = CRM_Core_Config::singleton();
3281 $subscribeGroupIds = array();
3282
3283 // process further only if profileDoubleOptIn enabled and if groups exist
3284 if (!array_key_exists('group', $params) ||
3285 !self::isProfileDoubleOptin() ||
3286 CRM_Utils_System::isNull($params['group'])
3287 ) {
3288 return $subscribeGroupIds;
3289 }
3290
3291 //check if contact email exist.
3292 $hasEmails = FALSE;
3293 foreach ($params as $name => $value) {
3294 if (strpos($name, 'email-') !== FALSE) {
3295 $hasEmails = TRUE;
3296 break;
3297 }
3298 }
3299
3300 //Proceed furthur only if email present
3301 if (!$hasEmails) {
3302 return $subscribeGroupIds;
3303 }
3304
3305 //do check for already subscriptions.
3306 $contactGroups = array();
3307 if ($contactId) {
3308 $query = "
3309 SELECT group_id
3310 FROM civicrm_group_contact
3311 WHERE status = 'Added'
3312 AND contact_id = %1";
3313
3314 $dao = CRM_Core_DAO::executeQuery($query, array(1 => array($contactId, 'Integer')));
3315 while ($dao->fetch()) {
3316 $contactGroups[$dao->group_id] = $dao->group_id;
3317 }
3318 }
3319
3320 //since we don't have names, compare w/ label.
3321 $mailingListGroupType = array_search('Mailing List', CRM_Core_OptionGroup::values('group_type'));
3322
3323 //actual processing start.
3324 foreach ($params['group'] as $groupId => $isSelected) {
3325 //unset group those are not selected.
3326 if (!$isSelected) {
3327 unset($params['group'][$groupId]);
3328 continue;
3329 }
3330
3331 $groupTypes = explode(CRM_Core_DAO::VALUE_SEPARATOR,
3332 CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group', $groupId, 'group_type', 'id')
3333 );
3334 //get only mailing type group and unset it from params
3335 if (in_array($mailingListGroupType, $groupTypes) && !in_array($groupId, $contactGroups)) {
3336 $subscribeGroupIds[$groupId] = $groupId;
3337 unset($params['group'][$groupId]);
3338 }
3339 }
3340
3341 return $subscribeGroupIds;
3342 }
3343
3344 /**
3345 * Function to check if we are rendering mixed profiles
3346 *
3347 * @param array $profileIds associated array of profile ids
3348 *
3349 * @return boolean $mixProfile true if profile is mixed
3350 * @static
3351 * @access public
3352 */
3353 static function checkForMixProfiles($profileIds) {
3354 $mixProfile = FALSE;
3355
3356 $contactTypes = array('Individual', 'Household', 'Organization');
3357 $subTypes = CRM_Contact_BAO_ContactType::subTypes();
3358
3359 $components = array('Contribution', 'Participant', 'Membership', 'Activity');
3360
3361 $typeCount = array('ctype' => array(), 'subtype' => array());
3362 foreach ($profileIds as $gid) {
3363 $profileType = CRM_Core_BAO_UFField::getProfileType($gid);
3364 // ignore profile of type Contact
3365 if ($profileType == 'Contact') {
3366 continue;
3367 }
3368 if (in_array($profileType, $contactTypes)) {
3369 if (!isset($typeCount['ctype'][$profileType])) {
3370 $typeCount['ctype'][$profileType] = 1;
3371 }
3372
3373 // check if we are rendering profile of different contact types
3374 if (count($typeCount['ctype']) == 2) {
3375 $mixProfile = TRUE;
3376 break;
3377 }
3378 }
3379 elseif (in_array($profileType, $components)) {
3380 $mixProfile = TRUE;
3381 break;
3382 }
3383 else {
3384 if (!isset($typeCount['subtype'][$profileType])) {
3385 $typeCount['subtype'][$profileType] = 1;
3386 }
3387 // check if we are rendering profile of different contact sub types
3388 if (count($typeCount['subtype']) == 2) {
3389 $mixProfile = TRUE;
3390 break;
3391 }
3392 }
3393 }
3394 return $mixProfile;
3395 }
3396
3397 /**
3398 * Funtion to determine of we show overlay profile or not
3399 *
3400 * @return boolean true if profile should be shown else false
3401 * @static
3402 * @access public
3403 */
3404 static function showOverlayProfile() {
3405 $showOverlay = TRUE;
3406
3407 // get the id of overlay profile
3408 $overlayProfileId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', 'summary_overlay', 'id', 'name');
3409 $query = "SELECT count(id) FROM civicrm_uf_field WHERE uf_group_id = {$overlayProfileId} AND visibility IN ('Public Pages', 'Public Pages and Listings') ";
3410
3411 $count = CRM_Core_DAO::singleValueQuery($query);
3412
3413 //check if there are no public fields and use is anonymous
3414 $session = CRM_Core_Session::singleton();
3415 if (!$count && !$session->get('userID')) {
3416 $showOverlay = FALSE;
3417 }
3418
3419 return $showOverlay;
3420 }
3421
3422 /**
3423 * function to get group type values of the profile
3424 *
3425 * @params Integer $profileId Profile Id
3426 * @params String $groupType Group Type
3427 *
3428 * @return Array group type values
3429 * @static
3430 * @access public
3431 */
3432 static function groupTypeValues($profileId, $groupType = NULL) {
3433 $groupTypeValue = array();
3434 $groupTypes = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $profileId, 'group_type');
3435
3436 $groupTypeParts = explode(CRM_Core_DAO::VALUE_SEPARATOR, $groupTypes);
3437 if (empty($groupTypeParts[1])) {
3438 return $groupTypeValue;
3439 }
3440 $participantExtends = array('ParticipantRole', 'ParticipantEventName', 'ParticipantEventType');
3441
3442 foreach (explode(',', $groupTypeParts[1]) as $groupTypeValues) {
3443 $values = array();
3444 $valueParts = explode(':', $groupTypeValues);
3445 if ($groupType &&
3446 ($valueParts[0] != "{$groupType}Type" ||
3447 ($groupType == 'Participant' &&
3448 !in_array($valueParts[0], $participantExtends)
3449 )
3450 )
3451 ) {
3452 continue;
3453 }
3454 foreach ($valueParts as $val) {
3455 if (CRM_Utils_Rule::integer($val)) {
3456 $values[$val] = $val;
3457 }
3458 }
3459 if (!empty($values)) {
3460 $typeName = substr($valueParts[0], 0, -4);
3461 if (in_array($valueParts[0], $participantExtends)) {
3462 $typeName = $valueParts[0];
3463 }
3464 $groupTypeValue[$typeName] = $values;
3465 }
3466 }
3467
3468 return $groupTypeValue;
3469 }
3470
3471 static function isProfileDoubleOptin() {
3472 // check for double optin
3473 $config = CRM_Core_Config::singleton();
3474 if (in_array('CiviMail', $config->enableComponents)) {
3475 return CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME,
3476 'profile_double_optin', NULL, FALSE
3477 );
3478 }
3479 return FALSE;
3480 }
3481
3482 static function isProfileAddToGroupDoubleOptin() {
3483 // check for add to group double optin
3484 $config = CRM_Core_Config::singleton();
3485 if (in_array('CiviMail', $config->enableComponents)) {
3486 return CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME,
3487 'profile_add_to_group_double_optin', NULL, FALSE
3488 );
3489 }
3490 return FALSE;
3491 }
3492
3493 /**
3494 * get profiles used for batch entry
3495 *
3496 * @return array profileIds profile ids
3497 * @static
3498 */
3499 static function getBatchProfiles() {
3500 $query = "SELECT id
3501 FROM civicrm_uf_group
3502 WHERE name IN ('contribution_batch_entry', 'membership_batch_entry')";
3503 $dao = CRM_Core_DAO::executeQuery( $query );
3504 $profileIds = array();
3505 while( $dao->fetch() ) {
3506 $profileIds[$dao->id] = $dao->id;
3507 }
3508 return $profileIds;
3509 }
3510
3511 static function shiftMultiRecordFields(&$source, &$destination, $returnMultiSummaryFields = FALSE) {
3512 $multiSummaryFields = $returnMultiSummaryFields ? array( ) : NULL;
3513 foreach ($source as $field => $properties) {
3514 if (!CRM_Core_BAO_CustomField::getKeyID($field)) {
3515 continue;
3516 }
3517 if (CRM_Core_BAO_CustomField::isMultiRecordField($field)) {
3518 $destination[$field] = $properties;
3519 if ($returnMultiSummaryFields) {
3520 if ($properties['is_multi_summary']) {
3521 $multiSummaryFields[$field] = $properties;
3522 }
3523 }
3524 unset($source[$field]);
3525 }
3526 }
3527 return $multiSummaryFields;
3528 }
3529
3530 /**
3531 * This is function is used to format pseudo fields
3532 *
3533 * @param array $fields associated array of profile fields
3534 *
3535 * @static
3536 */
3537 static function reformatProfileFields(&$fields) {
3538 //reformat fields array
3539 foreach ($fields as $name => $field) {
3540 //reformat phone and extension field
3541 if ( substr($field['name'], 0, 13) == 'phone_and_ext') {
3542 $fieldSuffix = str_replace('phone_and_ext-', '', $field['name']);
3543
3544 // retain existing element properties and just update and replace key
3545 CRM_Utils_Array::crmReplaceKey($fields, $name, "phone-{$fieldSuffix}");
3546 $fields["phone-{$fieldSuffix}"]['name'] = "phone-{$fieldSuffix}";
3547 $fields["phone-{$fieldSuffix}"]['where'] = 'civicrm_phone.phone';
3548
3549 // add additional phone extension field
3550 $fields["phone_ext-{$fieldSuffix}"] = $field;
3551 $fields["phone_ext-{$fieldSuffix}"]['title'] = $field['title'] .' - '.ts('Ext.');
3552 $fields["phone_ext-{$fieldSuffix}"]['name'] = "phone_ext-{$fieldSuffix}";
3553 $fields["phone_ext-{$fieldSuffix}"]['where'] = 'civicrm_phone.phone_ext';
3554 $fields["phone_ext-{$fieldSuffix}"]['skipDisplay'] = 1;
3555 //ignore required for extension field
3556 $fields["phone_ext-{$fieldSuffix}"]['is_required'] = 0;
3557 }
3558 }
3559 }
3560 }