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