projects / civicrm-core.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Merge branch '4.6' into master
[civicrm-core.git] / CRM / Core / BAO / CustomField.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
32 */
33
34 /**
35 * Business objects for managing custom data fields.
36 */
37 class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField {
38
39 /**
40 * Array for valid combinations of data_type & descriptions.
41 *
42 * @var array
43 */
44 public static $_dataType = NULL;
45
46 /**
47 * Array for valid combinations of data_type & html_type.
48 *
49 * @var array
50 */
51 public static $_dataToHtml = NULL;
52
53 /**
54 * Array to hold (formatted) fields for import
55 *
56 * @var array
57 */
58 public static $_importFields = NULL;
59
60 /**
61 * Build and retrieve the list of data types and descriptions.
62 *
63 * @return array
64 * Data type => Description
65 */
66 public static function &dataType() {
67 if (!(self::$_dataType)) {
68 self::$_dataType = array(
69 'String' => ts('Alphanumeric'),
70 'Int' => ts('Integer'),
71 'Float' => ts('Number'),
72 'Money' => ts('Money'),
73 'Memo' => ts('Note'),
74 'Date' => ts('Date'),
75 'Boolean' => ts('Yes or No'),
76 'StateProvince' => ts('State/Province'),
77 'Country' => ts('Country'),
78 'File' => ts('File'),
79 'Link' => ts('Link'),
80 'ContactReference' => ts('Contact Reference'),
81 );
82 }
83 return self::$_dataType;
84 }
85
86 /**
87 * Get data to html array.
88 *
89 * (Does this caching achieve anything?)
90 *
91 * @return array
92 */
93 public static function dataToHtml() {
94 if (!self::$_dataToHtml) {
95 self::$_dataToHtml = array(
96 array(
97 'Text' => 'Text',
98 'Select' => 'Select',
99 'Radio' => 'Radio',
100 'CheckBox' => 'CheckBox',
101 'Multi-Select' => 'Multi-Select',
102 'AdvMulti-Select' => 'AdvMulti-Select',
103 'Autocomplete-Select' => 'Autocomplete-Select',
104 ),
105 array('Text' => 'Text', 'Select' => 'Select', 'Radio' => 'Radio'),
106 array('Text' => 'Text', 'Select' => 'Select', 'Radio' => 'Radio'),
107 array('Text' => 'Text', 'Select' => 'Select', 'Radio' => 'Radio'),
108 array('TextArea' => 'TextArea', 'RichTextEditor' => 'RichTextEditor'),
109 array('Date' => 'Select Date'),
110 array('Radio' => 'Radio'),
111 array('StateProvince' => 'Select State/Province', 'Multi-Select' => 'Multi-Select State/Province'),
112 array('Country' => 'Select Country', 'Multi-Select' => 'Multi-Select Country'),
113 array('File' => 'File'),
114 array('Link' => 'Link'),
115 array('ContactReference' => 'Autocomplete-Select'),
116 );
117 }
118 return self::$_dataToHtml;
119 }
120
121 /**
122 * Takes an associative array and creates a custom field object.
123 *
124 * This function is invoked from within the web form layer and also from the api layer
125 *
126 * @param array $params
127 * (reference) an assoc array of name/value pairs.
128 *
129 * @return CRM_Core_DAO_CustomField
130 */
131 public static function create(&$params) {
132 $origParams = array_merge(array(), $params);
133
134 if (!isset($params['id'])) {
135 if (!isset($params['column_name'])) {
136 // if add mode & column_name not present, calculate it.
137 $params['column_name'] = strtolower(CRM_Utils_String::munge($params['label'], '_', 32));
138 }
139 if (!isset($params['name'])) {
140 $params['name'] = CRM_Utils_String::munge($params['label'], '_', 64);
141 }
142 }
143 else {
144 $params['column_name'] = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField',
145 $params['id'],
146 'column_name'
147 );
148 }
149 $columnName = $params['column_name'];
150
151 $indexExist = FALSE;
152 //as during create if field is_searchable we had created index.
153 if (!empty($params['id'])) {
154 $indexExist = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', $params['id'], 'is_searchable');
155 }
156
157 switch (CRM_Utils_Array::value('html_type', $params)) {
158 case 'Select Date':
159 if (empty($params['date_format'])) {
160 $config = CRM_Core_Config::singleton();
161 $params['date_format'] = $config->dateInputFormat;
162 }
163 break;
164
165 case 'CheckBox':
166 case 'AdvMulti-Select':
167 case 'Multi-Select':
168 if (isset($params['default_checkbox_option'])) {
169 $tempArray = array_keys($params['default_checkbox_option']);
170 $defaultArray = array();
171 foreach ($tempArray as $k => $v) {
172 if ($params['option_value'][$v]) {
173 $defaultArray[] = $params['option_value'][$v];
174 }
175 }
176
177 if (!empty($defaultArray)) {
178 // also add the separator before and after the value per new convention (CRM-1604)
179 $params['default_value'] = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR, $defaultArray) . CRM_Core_DAO::VALUE_SEPARATOR;
180 }
181 }
182 else {
183 if (!empty($params['default_option']) && isset($params['option_value'][$params['default_option']])
184 ) {
185 $params['default_value'] = $params['option_value'][$params['default_option']];
186 }
187 }
188 break;
189 }
190
191 $transaction = new CRM_Core_Transaction();
192 // create any option group & values if required
193 if ($params['html_type'] != 'Text' &&
194 in_array($params['data_type'], array(
195 'String',
196 'Int',
197 'Float',
198 'Money',
199 ))
200 ) {
201
202 $tableName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup',
203 $params['custom_group_id'],
204 'table_name'
205 );
206
207 //CRM-16659: if option_value then create an option group for this custom field.
208 if ($params['option_type'] == 1 && (empty($params['option_group_id']) || !empty($params['option_value']))) {
209 // first create an option group for this custom group
210 $optionGroup = new CRM_Core_DAO_OptionGroup();
211 $optionGroup->name = "{$columnName}_" . date('YmdHis');
212 $optionGroup->title = $params['label'];
213 $optionGroup->is_active = 1;
214 $optionGroup->save();
215 $params['option_group_id'] = $optionGroup->id;
216 if (!empty($params['option_value']) && is_array($params['option_value'])) {
217 foreach ($params['option_value'] as $k => $v) {
218 if (strlen(trim($v))) {
219 $optionValue = new CRM_Core_DAO_OptionValue();
220 $optionValue->option_group_id = $optionGroup->id;
221 $optionValue->label = $params['option_label'][$k];
222 $optionValue->name = CRM_Utils_String::titleToVar($params['option_label'][$k]);
223 switch ($params['data_type']) {
224 case 'Money':
225 $optionValue->value = CRM_Utils_Rule::cleanMoney($v);
226 break;
227
228 case 'Int':
229 $optionValue->value = intval($v);
230 break;
231
232 case 'Float':
233 $optionValue->value = floatval($v);
234 break;
235
236 default:
237 $optionValue->value = trim($v);
238 }
239
240 $optionValue->weight = $params['option_weight'][$k];
241 $optionValue->is_active = CRM_Utils_Array::value($k, $params['option_status'], FALSE);
242 $optionValue->save();
243 }
244 }
245 }
246 }
247 }
248
249 // check for orphan option groups
250 if (!empty($params['option_group_id'])) {
251 if (!empty($params['id'])) {
252 self::fixOptionGroups($params['id'], $params['option_group_id']);
253 }
254
255 // if we do not have a default value
256 // retrieve it from one of the other custom fields which use this option group
257 if (empty($params['default_value'])) {
258 //don't insert only value separator as default value, CRM-4579
259 $defaultValue = self::getOptionGroupDefault($params['option_group_id'],
260 $params['html_type']
261 );
262
263 if (!CRM_Utils_System::isNull(explode(CRM_Core_DAO::VALUE_SEPARATOR,
264 $defaultValue
265 ))
266 ) {
267 $params['default_value'] = $defaultValue;
268 }
269 }
270 }
271
272 // since we need to save option group id :)
273 if (!isset($params['attributes']) && strtolower($params['html_type']) == 'textarea') {
274 $params['attributes'] = 'rows=4, cols=60';
275 }
276
277 $customField = new CRM_Core_DAO_CustomField();
278 $customField->copyValues($params);
279 $customField->is_required = CRM_Utils_Array::value('is_required', $params, FALSE);
280 $customField->is_searchable = CRM_Utils_Array::value('is_searchable', $params, FALSE);
281 $customField->in_selector = CRM_Utils_Array::value('in_selector', $params, FALSE);
282 $customField->is_search_range = CRM_Utils_Array::value('is_search_range', $params, FALSE);
283 //CRM-15792 - Custom field gets disabled if is_active not set
284 $customField->is_active = CRM_Utils_Array::value('is_active', $params, TRUE);
285 $customField->is_view = CRM_Utils_Array::value('is_view', $params, FALSE);
286 $customField->save();
287
288 // make sure all values are present in the object for further processing
289 $customField->find(TRUE);
290
291 $triggerRebuild = CRM_Utils_Array::value('triggerRebuild', $params, TRUE);
292 //create/drop the index when we toggle the is_searchable flag
293 if (!empty($params['id'])) {
294 self::createField($customField, 'modify', $indexExist, $triggerRebuild);
295 }
296 else {
297 if (!isset($origParams['column_name'])) {
298 $columnName .= "_{$customField->id}";
299 $params['column_name'] = $columnName;
300 }
301 $customField->column_name = $columnName;
302 $customField->save();
303 // make sure all values are present in the object
304 $customField->find(TRUE);
305
306 $indexExist = FALSE;
307 self::createField($customField, 'add', $indexExist, $triggerRebuild);
308 }
309
310 // complete transaction
311 $transaction->commit();
312
313 CRM_Utils_System::flushCache();
314
315 return $customField;
316 }
317
318 /**
319 * Fetch object based on array of properties.
320 *
321 * @param array $params
322 * (reference ) an assoc array of name/value pairs.
323 * @param array $defaults
324 * (reference ) an assoc array to hold the flattened values.
325 *
326 * @return CRM_Core_DAO_CustomField
327 */
328 public static function retrieve(&$params, &$defaults) {
329 return CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_CustomField', $params, $defaults);
330 }
331
332 /**
333 * Update the is_active flag in the db.
334 *
335 * @param int $id
336 * Id of the database record.
337 * @param bool $is_active
338 * Value we want to set the is_active field.
339 *
340 * @return Object
341 * DAO object on success, null otherwise
342 */
343 public static function setIsActive($id, $is_active) {
344
345 CRM_Utils_System::flushCache();
346
347 //enable-disable CustomField
348 CRM_Core_BAO_UFField::setUFField($id, $is_active);
349 return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_CustomField', $id, 'is_active', $is_active);
350 }
351
352 /**
353 * Get the field title.
354 *
355 * @param int $id
356 * Id of field.
357 *
358 * @return string
359 * name
360 */
361 public static function getTitle($id) {
362 return CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', $id, 'label');
363 }
364
365 /**
366 * Store and return an array of all active custom fields.
367 *
368 * @param string $customDataType
369 * Type of Custom Data; empty is a synonym for "all contact data types".
370 * @param bool $showAll
371 * If true returns all fields (includes disabled fields).
372 * @param bool $inline
373 * If true returns all inline fields (includes disabled fields).
374 * @param int $customDataSubType
375 * Custom Data sub type value.
376 * @param int $customDataSubName
377 * Custom Data sub name value.
378 * @param bool $onlyParent
379 * Return only top level custom data, for eg, only Participant and ignore subname and subtype.
380 * @param bool $onlySubType
381 * Return only custom data for subtype.
382 * @param bool $checkPermission
383 * If false, do not include permissioning clause.
384 *
385 * @return array
386 * an array of active custom fields.
387 */
388 public static function &getFields(
389 $customDataType = 'Individual',
390 $showAll = FALSE,
391 $inline = FALSE,
392 $customDataSubType = NULL,
393 $customDataSubName = NULL,
394 $onlyParent = FALSE,
395 $onlySubType = FALSE,
396 $checkPermission = TRUE
397 ) {
398 if (empty($customDataType)) {
399 $customDataType = array('Contact', 'Individual', 'Organization', 'Household');
400 }
401 if ($customDataType && !is_array($customDataType)) {
402
403 if (in_array($customDataType, CRM_Contact_BAO_ContactType::subTypes())) {
404 // This is the case when getFieldsForImport() requires fields
405 // limited strictly to a subtype.
406 $customDataSubType = $customDataType;
407 $customDataType = CRM_Contact_BAO_ContactType::getBasicType($customDataType);
408 $onlySubType = TRUE;
409 }
410
411 if (in_array($customDataType, array_keys(CRM_Core_SelectValues::customGroupExtends()))) {
412 // this makes the method flexible to support retrieving fields
413 // for multiple extends value.
414 $customDataType = array($customDataType);
415 }
416 }
417
418 $customDataSubType = CRM_Utils_Array::explodePadded($customDataSubType);
419
420 if (is_array($customDataType)) {
421 $cacheKey = implode('_', $customDataType);
422 }
423 else {
424 $cacheKey = $customDataType;
425 }
426
427 $cacheKey .= !empty($customDataSubType) ? ('_' . implode('_', $customDataSubType)) : '_0';
428 $cacheKey .= $customDataSubName ? "{$customDataSubName}_" : '_0';
429 $cacheKey .= $showAll ? '_1' : '_0';
430 $cacheKey .= $inline ? '_1_' : '_0_';
431 $cacheKey .= $onlyParent ? '_1_' : '_0_';
432 $cacheKey .= $onlySubType ? '_1_' : '_0_';
433 $cacheKey .= $checkPermission ? '_1_' : '_0_';
434
435 $cgTable = CRM_Core_DAO_CustomGroup::getTableName();
436
437 // also get the permission stuff here
438 if ($checkPermission) {
439 $permissionClause = CRM_Core_Permission::customGroupClause(CRM_Core_Permission::VIEW,
440 "{$cgTable}."
441 );
442 }
443 else {
444 $permissionClause = '(1)';
445 }
446
447 // lets md5 permission clause and take first 8 characters
448 $cacheKey .= substr(md5($permissionClause), 0, 8);
449
450 if (strlen($cacheKey) > 40) {
451 $cacheKey = md5($cacheKey);
452 }
453
454 if (!self::$_importFields ||
455 CRM_Utils_Array::value($cacheKey, self::$_importFields) === NULL
456 ) {
457 if (!self::$_importFields) {
458 self::$_importFields = array();
459 }
460
461 // check if we can retrieve from database cache
462 $fields = CRM_Core_BAO_Cache::getItem('contact fields', "custom importableFields $cacheKey");
463
464 if ($fields === NULL) {
465 $cfTable = self::getTableName();
466
467 $extends = '';
468 if (is_array($customDataType)) {
469 $value = NULL;
470 foreach ($customDataType as $dataType) {
471 if (in_array($dataType, array_keys(CRM_Core_SelectValues::customGroupExtends()))) {
472 if (in_array($dataType, array('Individual', 'Household', 'Organization'))) {
473 $val = "'" . CRM_Utils_Type::escape($dataType, 'String') . "', 'Contact' ";
474 }
475 else {
476 $val = "'" . CRM_Utils_Type::escape($dataType, 'String') . "'";
477 }
478 $value = $value ? $value . ", {$val}" : $val;
479 }
480 }
481 if ($value) {
482 $extends = "AND $cgTable.extends IN ( $value ) ";
483 }
484 }
485
486 if (!empty($customDataType) && empty($extends)) {
487 // $customDataType specified a filter, but there is no corresponding SQL ($extends)
488 self::$_importFields[$cacheKey] = array();
489 return self::$_importFields[$cacheKey];
490 }
491
492 if ($onlyParent) {
493 $extends .= " AND $cgTable.extends_entity_column_value IS NULL AND $cgTable.extends_entity_column_id IS NULL ";
494 }
495
496 $query = "SELECT $cfTable.id, $cfTable.label,
497 $cgTable.title,
498 $cfTable.data_type,
499 $cfTable.html_type,
500 $cfTable.default_value,
501 $cfTable.options_per_line, $cfTable.text_length,
502 $cfTable.custom_group_id,
503 $cfTable.is_required,
504 $cgTable.extends, $cfTable.is_search_range,
505 $cgTable.extends_entity_column_value,
506 $cgTable.extends_entity_column_id,
507 $cfTable.is_view,
508 $cfTable.option_group_id,
509 $cfTable.date_format,
510 $cfTable.time_format,
511 $cgTable.is_multiple,
512 og.name as option_group_name
513 FROM $cfTable
514 INNER JOIN $cgTable
515 ON $cfTable.custom_group_id = $cgTable.id
516 LEFT JOIN civicrm_option_group og
517 ON $cfTable.option_group_id = og.id
518 WHERE ( 1 ) ";
519
520 if (!$showAll) {
521 $query .= " AND $cfTable.is_active = 1 AND $cgTable.is_active = 1 ";
522 }
523
524 if ($inline) {
525 $query .= " AND $cgTable.style = 'Inline' ";
526 }
527
528 //get the custom fields for specific type in
529 //combination with fields those support any type.
530 if (!empty($customDataSubType)) {
531 $subtypeClause = array();
532 foreach ($customDataSubType as $subtype) {
533 $subtype = CRM_Core_DAO::VALUE_SEPARATOR . $subtype . CRM_Core_DAO::VALUE_SEPARATOR;
534 $subtypeClause[] = "$cgTable.extends_entity_column_value LIKE '%{$subtype}%'";
535 }
536 if (!$onlySubType) {
537 $subtypeClause[] = "$cgTable.extends_entity_column_value IS NULL";
538 }
539 $query .= " AND ( " . implode(' OR ', $subtypeClause) . " )";
540 }
541
542 if ($customDataSubName) {
543 $query .= " AND ( $cgTable.extends_entity_column_id = $customDataSubName ) ";
544 }
545
546 // also get the permission stuff here
547 if ($checkPermission) {
548 $permissionClause = CRM_Core_Permission::customGroupClause(CRM_Core_Permission::VIEW,
549 "{$cgTable}.", TRUE
550 );
551 }
552 else {
553 $permissionClause = '(1)';
554 }
555
556 $query .= " $extends AND $permissionClause
557 ORDER BY $cgTable.weight, $cgTable.title,
558 $cfTable.weight, $cfTable.label";
559
560 $dao = CRM_Core_DAO::executeQuery($query);
561
562 $fields = array();
563 while (($dao->fetch()) != NULL) {
564 $fields[$dao->id]['label'] = $dao->label;
565 $fields[$dao->id]['groupTitle'] = $dao->title;
566 $fields[$dao->id]['data_type'] = $dao->data_type;
567 $fields[$dao->id]['html_type'] = $dao->html_type;
568 $fields[$dao->id]['default_value'] = $dao->default_value;
569 $fields[$dao->id]['text_length'] = $dao->text_length;
570 $fields[$dao->id]['options_per_line'] = $dao->options_per_line;
571 $fields[$dao->id]['custom_group_id'] = $dao->custom_group_id;
572 $fields[$dao->id]['extends'] = $dao->extends;
573 $fields[$dao->id]['is_search_range'] = $dao->is_search_range;
574 $fields[$dao->id]['extends_entity_column_value'] = $dao->extends_entity_column_value;
575 $fields[$dao->id]['extends_entity_column_id'] = $dao->extends_entity_column_id;
576 $fields[$dao->id]['is_view'] = $dao->is_view;
577 $fields[$dao->id]['is_multiple'] = $dao->is_multiple;
578 $fields[$dao->id]['option_group_id'] = $dao->option_group_id;
579 $fields[$dao->id]['date_format'] = $dao->date_format;
580 $fields[$dao->id]['time_format'] = $dao->time_format;
581 $fields[$dao->id]['is_required'] = $dao->is_required;
582 self::getOptionsForField($fields[$dao->id], $dao->option_group_name);
583 }
584
585 CRM_Core_BAO_Cache::setItem($fields,
586 'contact fields',
587 "custom importableFields $cacheKey"
588 );
589 }
590 self::$_importFields[$cacheKey] = $fields;
591 }
592
593 return self::$_importFields[$cacheKey];
594 }
595
596 /**
597 * Return the field ids and names (with groups) for import purpose.
598 *
599 * @param int|string $contactType Contact type
600 * @param bool $showAll
601 * If true returns all fields (includes disabled fields).
602 * @param bool $onlyParent
603 * Return fields ONLY related to basic types.
604 * @param bool $search
605 * When called from search and multiple records need to be returned.
606 * @param bool $checkPermission
607 * If false, do not include permissioning clause.
608 *
609 * @param bool $withMultiple
610 *
611 * @return array
612 */
613 public static function getFieldsForImport(
614 $contactType = 'Individual',
615 $showAll = FALSE,
616 $onlyParent = FALSE,
617 $search = FALSE,
618 $checkPermission = TRUE,
619 $withMultiple = FALSE
620 ) {
621 // Note: there are situations when we want getFieldsForImport() return fields related
622 // ONLY to basic contact types, but NOT subtypes. And thats where $onlyParent is helpful
623 $fields = &self::getFields($contactType,
624 $showAll,
625 FALSE,
626 NULL,
627 NULL,
628 $onlyParent,
629 FALSE,
630 $checkPermission
631 );
632
633 $importableFields = array();
634 foreach ($fields as $id => $values) {
635 // for now we should not allow multiple fields in profile / export etc, hence unsetting
636 if (!$search &&
637 (!empty($values['is_multiple']) && !$withMultiple)
638 ) {
639 continue;
640 }
641
642 /* generate the key for the fields array */
643
644 $key = "custom_$id";
645
646 $regexp = preg_replace('/[.,;:!?]/', '', CRM_Utils_Array::value(0, $values));
647 $importableFields[$key] = array(
648 'name' => $key,
649 'title' => CRM_Utils_Array::value('label', $values),
650 'headerPattern' => '/' . preg_quote($regexp, '/') . '/',
651 'import' => 1,
652 'custom_field_id' => $id,
653 'options_per_line' => CRM_Utils_Array::value('options_per_line', $values),
654 'text_length' => CRM_Utils_Array::value('text_length', $values, 255),
655 'data_type' => CRM_Utils_Array::value('data_type', $values),
656 'html_type' => CRM_Utils_Array::value('html_type', $values),
657 'is_search_range' => CRM_Utils_Array::value('is_search_range', $values),
658 );
659
660 // CRM-6681, pass date and time format when html_type = Select Date
661 if (CRM_Utils_Array::value('html_type', $values) == 'Select Date') {
662 $importableFields[$key]['date_format'] = CRM_Utils_Array::value('date_format', $values);
663 $importableFields[$key]['time_format'] = CRM_Utils_Array::value('time_format', $values);
664 }
665 }
666
667 return $importableFields;
668 }
669
670 /**
671 * Get the field id from an import key.
672 *
673 * @param string $key
674 * The key to parse.
675 *
676 * @param bool $all
677 *
678 * @return int|null
679 * The id (if exists)
680 */
681 public static function getKeyID($key, $all = FALSE) {
682 $match = array();
683 if (preg_match('/^custom_(\d+)_?(-?\d+)?$/', $key, $match)) {
684 if (!$all) {
685 return $match[1];
686 }
687 else {
688 return array(
689 $match[1],
690 CRM_Utils_Array::value(2, $match),
691 );
692 }
693 }
694 return $all ? array(NULL, NULL) : NULL;
695 }
696
697 /**
698 * Use the cache to get all values of a specific custom field.
699 *
700 * @param int $fieldID
701 * The custom field ID.
702 *
703 * @return CRM_Core_DAO_CustomField
704 * The field object.
705 */
706 public static function getFieldObject($fieldID) {
707 $field = new CRM_Core_DAO_CustomField();
708
709 // check if we can get the field values from the system cache
710 $cacheKey = "CRM_Core_DAO_CustomField_{$fieldID}";
711 $cache = CRM_Utils_Cache::singleton();
712 $fieldValues = $cache->get($cacheKey);
713 if (empty($fieldValues)) {
714 $field->id = $fieldID;
715 if (!$field->find(TRUE)) {
716 CRM_Core_Error::fatal();
717 }
718
719 $fieldValues = array();
720 CRM_Core_DAO::storeValues($field, $fieldValues);
721
722 $cache->set($cacheKey, $fieldValues);
723 }
724 else {
725 $field->copyValues($fieldValues);
726 }
727
728 return $field;
729 }
730
731 /**
732 * This function for building custom fields.
733 *
734 * @param CRM_Core_Form $qf
735 * Form object (reference).
736 * @param string $elementName
737 * Name of the custom field.
738 * @param int $fieldId
739 * @param bool $inactiveNeeded
740 * -deprecated.
741 * @param bool $useRequired
742 * True if required else false.
743 * @param bool $search
744 * True if used for search else false.
745 * @param string $label
746 * Label for custom field.
747 */
748 public static function addQuickFormElement(
749 &$qf,
750 $elementName,
751 $fieldId,
752 $inactiveNeeded = FALSE,
753 $useRequired = TRUE,
754 $search = FALSE,
755 $label = NULL
756 ) {
757 $field = self::getFieldObject($fieldId);
758 $widget = $field->html_type;
759
760 // Custom field HTML should indicate group+field name
761 $groupName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $field->custom_group_id);
762 $dataCrmCustomVal = $groupName . ':' . $field->name;
763 $dataCrmCustomAttr = 'data-crm-custom="' . $dataCrmCustomVal . '"';
764 $field->attributes .= $dataCrmCustomAttr;
765
766 // Fixed for Issue CRM-2183
767 if ($widget == 'TextArea' && $search) {
768 $widget = 'Text';
769 }
770
771 $placeholder = $search ? ts('- any -') : ($useRequired ? ts('- select -') : ts('- none -'));
772
773 // FIXME: Why are select state/country separate widget types?
774 $isSelect = (in_array($widget, array(
775 'Select',
776 'Multi-Select',
777 'Select State/Province',
778 'Multi-Select State/Province',
779 'Select Country',
780 'Multi-Select Country',
781 'AdvMulti-Select',
782 'CheckBox',
783 'Radio',
784 )));
785
786 if ($isSelect) {
787 $options = CRM_Utils_Array::value('values', civicrm_api3('contact', 'getoptions', array(
788 'field' => "custom_$fieldId",
789 'context' => $search ? 'search' : 'create',
790 ), array()));
791
792 // Consolidate widget types to simplify the below switch statement
793 if ($search || ($widget !== 'AdvMulti-Select' && strpos($widget, 'Select') !== FALSE)) {
794 $widget = 'Select';
795 }
796 $selectAttributes = array(
797 'data-crm-custom' => $dataCrmCustomVal,
798 'class' => 'crm-select2',
799 );
800 // Search field is always multi-select
801 if ($search || strpos($field->html_type, 'Multi') !== FALSE) {
802 $selectAttributes['class'] .= ' huge';
803 $selectAttributes['multiple'] = 'multiple';
804 $selectAttributes['placeholder'] = $placeholder;
805 }
806 // Add data for popup link. Normally this is handled by CRM_Core_Form->addSelect
807 if ($field->option_group_id && !$search && $widget == 'Select' && CRM_Core_Permission::check('administer CiviCRM')) {
808 $selectAttributes += array(
809 'data-api-entity' => 'contact',
810 // FIXME: This works because the getoptions api isn't picky about custom fields, but it's WRONG
811 'data-api-field' => 'custom_' . $field->id,
812 'data-option-edit-path' => 'civicrm/admin/options/' . CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', $field->option_group_id),
813 );
814 }
815 }
816
817 if (!isset($label)) {
818 $label = $field->label;
819 }
820
821 // at some point in time we might want to split the below into small functions
822
823 switch ($widget) {
824 case 'Text':
825 case 'Link':
826 if ($field->is_search_range && $search) {
827 $qf->add('text', $elementName . '_from', $label . ' ' . ts('From'), $field->attributes);
828 $qf->add('text', $elementName . '_to', ts('To'), $field->attributes);
829 }
830 else {
831 $element = &$qf->add('text', $elementName, $label,
832 $field->attributes,
833 $useRequired && !$search
834 );
835 }
836 break;
837
838 case 'TextArea':
839 $attributes = $dataCrmCustomAttr;
840 if ($field->note_rows) {
841 $attributes .= 'rows=' . $field->note_rows;
842 }
843 else {
844 $attributes .= 'rows=4';
845 }
846 if ($field->note_columns) {
847 $attributes .= ' cols=' . $field->note_columns;
848 }
849 else {
850 $attributes .= ' cols=60';
851 }
852 if ($field->text_length) {
853 $attributes .= ' maxlength=' . $field->text_length;
854 }
855 $element = &$qf->add('textarea',
856 $elementName,
857 $label,
858 $attributes,
859 $useRequired && !$search
860 );
861 break;
862
863 case 'Select Date':
864 if ($field->is_search_range && $search) {
865 $qf->addDate($elementName . '_from', $label . ' - ' . ts('From'), FALSE,
866 array(
867 'format' => $field->date_format,
868 'timeFormat' => $field->time_format,
869 'startOffset' => $field->start_date_years,
870 'endOffset' => $field->end_date_years,
871 'data-crm-custom' => $dataCrmCustomVal,
872 )
873 );
874
875 $qf->addDate($elementName . '_to', ts('To'), FALSE,
876 array(
877 'format' => $field->date_format,
878 'timeFormat' => $field->time_format,
879 'startOffset' => $field->start_date_years,
880 'endOffset' => $field->end_date_years,
881 'data-crm-custom' => $dataCrmCustomVal,
882 )
883 );
884 }
885 else {
886 $required = $useRequired && !$search;
887
888 $qf->addDate($elementName, $label, $required, array(
889 'format' => $field->date_format,
890 'timeFormat' => $field->time_format,
891 'startOffset' => $field->start_date_years,
892 'endOffset' => $field->end_date_years,
893 'data-crm-custom' => $dataCrmCustomVal,
894 ));
895 }
896 break;
897
898 case 'Radio':
899 $choice = array();
900 foreach ($options as $v => $l) {
901 $choice[] = $qf->createElement('radio', NULL, '', $l, (string) $v, $field->attributes);
902 }
903 $group = $qf->addGroup($choice, $elementName, $label);
904 if ($useRequired && !$search) {
905 $qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
906 }
907 else {
908 $group->setAttribute('allowClear', TRUE);
909 }
910 break;
911
912 // For all select elements
913 case 'Select':
914 if (empty($selectAttributes['multiple'])) {
915 $options = array('' => $placeholder) + $options;
916 }
917 $qf->add('select', $elementName, $label, $options, $useRequired && !$search, $selectAttributes);
918
919 // Add and/or option for fields that store multiple values
920 if ($search && self::isSerialized($field)) {
921
922 $operators = array(
923 $qf->createElement('radio', NULL, '', ts('Any'), 'or', array('title' => ts('Results may contain any of the selected options'))),
924 $qf->createElement('radio', NULL, '', ts('All'), 'and', array('title' => ts('Results must have all of the selected options'))),
925 );
926 $qf->addGroup($operators, $elementName . '_operator');
927 $qf->setDefaults(array($elementName . '_operator' => 'or'));
928 }
929 break;
930
931 case 'AdvMulti-Select':
932 $include =& $qf->addElement(
933 'advmultiselect',
934 $elementName,
935 $label, $options,
936 array(
937 'size' => 5,
938 'style' => '',
939 'class' => 'advmultiselect',
940 'data-crm-custom' => $dataCrmCustomVal,
941 )
942 );
943
944 $include->setButtonAttributes('add', array('value' => ts('Add >>')));
945 $include->setButtonAttributes('remove', array('value' => ts('<< Remove')));
946
947 if ($useRequired && !$search) {
948 $qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
949 }
950 break;
951
952 case 'CheckBox':
953 $check = array();
954 foreach ($options as $v => $l) {
955 $check[] = &$qf->addElement('advcheckbox', $v, NULL, $l, array('data-crm-custom' => $dataCrmCustomVal));
956 }
957 $qf->addGroup($check, $elementName, $label);
958 if ($useRequired && !$search) {
959 $qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
960 }
961 break;
962
963 case 'File':
964 // we should not build upload file in search mode
965 if ($search) {
966 return;
967 }
968 $qf->add(
969 strtolower($field->html_type),
970 $elementName,
971 $label,
972 $field->attributes,
973 $useRequired && !$search
974 );
975 $qf->addUploadElement($elementName);
976 break;
977
978 case 'RichTextEditor':
979 $attributes = array(
980 'rows' => $field->note_rows,
981 'cols' => $field->note_columns,
982 'data-crm-custom' => $dataCrmCustomVal,
983 );
984 if ($field->text_length) {
985 $attributes['maxlength'] = $field->text_length;
986 }
987 $qf->add('wysiwyg', $elementName, $label, $attributes, $search);
988 break;
989
990 case 'Autocomplete-Select':
991 static $customUrls = array();
992 // Fixme: why is this a string in the first place??
993 $attributes = array();
994 if ($field->attributes) {
995 foreach (explode(' ', $field->attributes) as $at) {
996 if (strpos($at, '=')) {
997 list($k, $v) = explode('=', $at);
998 $attributes[$k] = trim($v, ' "');
999 }
1000 }
1001 }
1002 if ($field->data_type == 'ContactReference') {
1003 $attributes['class'] = (isset($attributes['class']) ? $attributes['class'] . ' ' : '') . 'crm-form-contact-reference huge';
1004 $attributes['data-api-entity'] = 'contact';
1005 $qf->add('text', $elementName, $label, $attributes,
1006 $useRequired && !$search
1007 );
1008
1009 $urlParams = "context=customfield&id={$field->id}";
1010
1011 $customUrls[$elementName] = CRM_Utils_System::url('civicrm/ajax/contactref',
1012 $urlParams,
1013 FALSE, NULL, FALSE
1014 );
1015
1016 }
1017 else {
1018 // FIXME: This won't work with customFieldOptions hook
1019 $attributes += array(
1020 'entity' => 'option_value',
1021 'placeholder' => $placeholder,
1022 'multiple' => $search,
1023 'api' => array(
1024 'params' => array('option_group_id' => $field->option_group_id),
1025 ),
1026 );
1027 $qf->addEntityRef($elementName, $label, $attributes, $useRequired && !$search);
1028 }
1029
1030 $qf->assign('customUrls', $customUrls);
1031 break;
1032 }
1033
1034 switch ($field->data_type) {
1035 case 'Int':
1036 // integers will have numeric rule applied to them.
1037 if ($field->is_search_range && $search) {
1038 $qf->addRule($elementName . '_from', ts('%1 From must be an integer (whole number).', array(1 => $label)), 'integer');
1039 $qf->addRule($elementName . '_to', ts('%1 To must be an integer (whole number).', array(1 => $label)), 'integer');
1040 }
1041 elseif ($widget == 'Text') {
1042 $qf->addRule($elementName, ts('%1 must be an integer (whole number).', array(1 => $label)), 'integer');
1043 }
1044 break;
1045
1046 case 'Float':
1047 if ($field->is_search_range && $search) {
1048 $qf->addRule($elementName . '_from', ts('%1 From must be a number (with or without decimal point).', array(1 => $label)), 'numeric');
1049 $qf->addRule($elementName . '_to', ts('%1 To must be a number (with or without decimal point).', array(1 => $label)), 'numeric');
1050 }
1051 elseif ($widget == 'Text') {
1052 $qf->addRule($elementName, ts('%1 must be a number (with or without decimal point).', array(1 => $label)), 'numeric');
1053 }
1054 break;
1055
1056 case 'Money':
1057 if ($field->is_search_range && $search) {
1058 $qf->addRule($elementName . '_from', ts('%1 From must in proper money format. (decimal point/comma/space is allowed).', array(1 => $label)), 'money');
1059 $qf->addRule($elementName . '_to', ts('%1 To must in proper money format. (decimal point/comma/space is allowed).', array(1 => $label)), 'money');
1060 }
1061 elseif ($widget == 'Text') {
1062 $qf->addRule($elementName, ts('%1 must be in proper money format. (decimal point/comma/space is allowed).', array(1 => $label)), 'money');
1063 }
1064 break;
1065
1066 case 'Link':
1067 $element->setAttribute('class', "url");
1068 $qf->addRule($elementName, ts('Enter a valid web address beginning with \'http://\' or \'https://\'.'), 'wikiURL');
1069 break;
1070 }
1071 if ($field->is_view && !$search) {
1072 $qf->freeze($elementName);
1073 }
1074 }
1075
1076 /**
1077 * Delete the Custom Field.
1078 *
1079 * @param object $field
1080 * The field object.
1081 */
1082 public static function deleteField($field) {
1083 CRM_Utils_System::flushCache();
1084
1085 // first delete the custom option group and values associated with this field
1086 if ($field->option_group_id) {
1087 //check if option group is related to any other field, if
1088 //not delete the option group and related option values
1089 self::checkOptionGroup($field->option_group_id);
1090 }
1091
1092 // next drop the column from the custom value table
1093 self::createField($field, 'delete');
1094
1095 $field->delete();
1096 CRM_Core_BAO_UFField::delUFField($field->id);
1097 CRM_Utils_Weight::correctDuplicateWeights('CRM_Core_DAO_CustomField');
1098 }
1099
1100 /**
1101 * Find the display value for this field.
1102 *
1103 * @param mixed $value
1104 * The custom field value.
1105 * @param int $id
1106 * The custom field id.
1107 * @param array $options
1108 * The assoc array of option name/value pairs.
1109 *
1110 * @param int $contactID
1111 * @param int $fieldID
1112 *
1113 * @return string
1114 * the display value
1115 */
1116 public static function getDisplayValue($value, $id, &$options, $contactID = NULL, $fieldID = NULL) {
1117 $option = &$options[$id];
1118 $attributes = &$option['attributes'];
1119 $html_type = $attributes['html_type'];
1120 $data_type = $attributes['data_type'];
1121
1122 return self::getDisplayValueCommon($value,
1123 $option,
1124 $html_type,
1125 $data_type,
1126 $contactID,
1127 $fieldID
1128 );
1129 }
1130
1131 /**
1132 * Get display value.
1133 *
1134 * @param string $value
1135 * @param array $option
1136 * @param string $html_type
1137 * @param string $data_type
1138 * @param int $contactID
1139 * @param int $fieldID
1140 *
1141 * @return array|mixed|null|string
1142 */
1143 public static function getDisplayValueCommon(
1144 $value,
1145 &$option,
1146 $html_type,
1147 $data_type,
1148 $contactID = NULL,
1149 $fieldID = NULL
1150 ) {
1151 $display = $value;
1152
1153 if ($fieldID &&
1154 (($html_type == 'Radio' && $data_type != 'Boolean') ||
1155 ($html_type == 'Autocomplete-Select' && $data_type != 'ContactReference') ||
1156 $html_type == 'Select' ||
1157 $html_type == 'CheckBox' ||
1158 $html_type == 'AdvMulti-Select' ||
1159 $html_type == 'Multi-Select'
1160 )
1161 ) {
1162 CRM_Utils_Hook::customFieldOptions($fieldID, $option);
1163 }
1164
1165 switch ($html_type) {
1166 case 'Radio':
1167 if ($data_type == 'Boolean') {
1168 $options = array('No', 'Yes');
1169 }
1170 else {
1171 $options = $option;
1172 }
1173 if (is_array($value)) {
1174 $display = NULL;
1175 foreach ($value as $data) {
1176 $display .= $display ? ', ' . $options[$data] : $options[$data];
1177 }
1178 }
1179 else {
1180 $display = CRM_Utils_Array::value($value, $options);
1181 }
1182 break;
1183
1184 case 'Autocomplete-Select':
1185 if ($data_type == 'ContactReference' &&
1186 $value
1187 ) {
1188 $display = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $value, 'display_name');
1189 }
1190 elseif (is_array($value)) {
1191 $display = NULL;
1192 foreach ($value as $data) {
1193 $display .= $display ? ', ' . $option[$data] : $option[$data];
1194 }
1195 }
1196 else {
1197 $display = CRM_Utils_Array::value($value, $option);
1198 }
1199 break;
1200
1201 case 'Select':
1202 if (is_array($value)) {
1203 $display = NULL;
1204 foreach ($value as $data) {
1205 $display .= $display ? ', ' . $option[$data] : $option[$data];
1206 }
1207 }
1208 else {
1209 $display = CRM_Utils_Array::value($value, $option);
1210 }
1211 break;
1212
1213 case 'CheckBox':
1214 case 'AdvMulti-Select':
1215 case 'Multi-Select':
1216 if (is_array($value)) {
1217 if ($html_type == 'CheckBox') {
1218 // CRM-12989 fix
1219 CRM_Utils_Array::formatArrayKeys($value);
1220 }
1221
1222 $checkedData = $value;
1223 }
1224 else {
1225 $checkedData = explode(CRM_Core_DAO::VALUE_SEPARATOR,
1226 substr($value, 1, -1)
1227 );
1228 if ($html_type == 'CheckBox') {
1229 $newData = array();
1230 foreach ($checkedData as $v) {
1231 $v = str_replace(CRM_Core_DAO::VALUE_SEPARATOR, '', $v);
1232 $newData[] = $v;
1233 }
1234 $checkedData = $newData;
1235 }
1236 }
1237
1238 $v = array();
1239 foreach ($checkedData as $key => $val) {
1240 $v[] = CRM_Utils_Array::value($val, $option);
1241 }
1242 if (!empty($v)) {
1243 $display = implode(', ', $v);
1244 }
1245 break;
1246
1247 case 'Select Date':
1248 if (is_array($value)) {
1249 foreach ($value as $key => $val) {
1250 $display[$key] = CRM_Utils_Date::customFormat($val);
1251 }
1252 }
1253 else {
1254 // remove time element display if time is not set
1255 if (empty($option['attributes']['time_format'])) {
1256 $value = substr($value, 0, 10);
1257 }
1258 $display = CRM_Utils_Date::customFormat($value);
1259 }
1260 break;
1261
1262 case 'Select State/Province':
1263 case 'Multi-Select State/Province':
1264 case 'Select Country':
1265 case 'Multi-Select Country':
1266 if (strstr($html_type, 'State/Province')) {
1267 $option = CRM_Core_PseudoConstant::stateProvince(FALSE, FALSE);
1268 }
1269 else {
1270 $option = CRM_Core_PseudoConstant::country(FALSE, FALSE);
1271 }
1272 // process multi-select state/country field values
1273 if (!is_array($value)) {
1274 $value = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value);
1275 }
1276
1277 $display = NULL;
1278 foreach ($value as $data) {
1279 $display .= ($display && !empty($option[$data])) ? ', ' . $option[$data] : $option[$data];
1280 }
1281 break;
1282
1283 case 'File':
1284 // In the context of displaying a profile, show file/image
1285 if ($contactID && $value) {
1286 $url = self::getFileURL($contactID, $fieldID, $value);
1287 if ($url) {
1288 $display = $url['file_url'];
1289 }
1290 }
1291 // In other contexts show a paperclip icon
1292 elseif ($value) {
1293 $icons = CRM_Core_BAO_File::paperIconAttachment('*', $value);
1294 $display = $icons[$value];
1295 }
1296 break;
1297
1298 case 'TextArea':
1299 if (empty($value)) {
1300 $display = '';
1301 }
1302 else {
1303 $display = is_array($value) ? nl2br(implode(', ', $value)) : nl2br($value);
1304 }
1305 break;
1306
1307 case 'Link':
1308 case 'Text':
1309 if (empty($value)) {
1310 $display = '';
1311 }
1312 else {
1313 $display = is_array($value) ? implode(', ', $value) : $value;
1314 }
1315 }
1316 return $display ? $display : $value;
1317 }
1318
1319 /**
1320 * Set default values for custom data used in profile.
1321 *
1322 * @param int $customFieldId
1323 * Custom field id.
1324 * @param string $elementName
1325 * Custom field name.
1326 * @param array $defaults
1327 * Associated array of fields.
1328 * @param int $contactId
1329 * Contact id.
1330 * @param int $mode
1331 * Profile mode.
1332 * @param mixed $value
1333 * If passed - dont fetch value from db,.
1334 * just format the given value
1335 */
1336 public static function setProfileDefaults(
1337 $customFieldId,
1338 $elementName,
1339 &$defaults,
1340 $contactId = NULL,
1341 $mode = NULL,
1342 $value = NULL
1343 ) {
1344 //get the type of custom field
1345 $customField = new CRM_Core_BAO_CustomField();
1346 $customField->id = $customFieldId;
1347 $customField->find(TRUE);
1348
1349 if (!$contactId) {
1350 if ($mode == CRM_Profile_Form::MODE_CREATE) {
1351 $value = $customField->default_value;
1352 }
1353 }
1354 else {
1355 if (!isset($value)) {
1356 $info = self::getTableColumnGroup($customFieldId);
1357 $query = "SELECT {$info[0]}.{$info[1]} as value FROM {$info[0]} WHERE {$info[0]}.entity_id = {$contactId}";
1358 $result = CRM_Core_DAO::executeQuery($query);
1359 if ($result->fetch()) {
1360 $value = $result->value;
1361 }
1362 }
1363
1364 if ($customField->data_type == 'Country') {
1365 if (!$value) {
1366 $config = CRM_Core_Config::singleton();
1367 if ($config->defaultContactCountry) {
1368 $value = $config->defaultContactCountry();
1369 }
1370 }
1371 }
1372 }
1373
1374 //set defaults if mode is registration
1375 if (!trim($value) &&
1376 ($value !== 0) &&
1377 (!in_array($mode, array(CRM_Profile_Form::MODE_EDIT, CRM_Profile_Form::MODE_SEARCH)))
1378 ) {
1379 $value = $customField->default_value;
1380 }
1381
1382 if ($customField->data_type == 'Money' && isset($value)) {
1383 $value = number_format($value, 2);
1384 }
1385 switch ($customField->html_type) {
1386 case 'CheckBox':
1387 case 'AdvMulti-Select':
1388 case 'Multi-Select':
1389 $customOption = CRM_Core_BAO_CustomOption::getCustomOption($customFieldId, FALSE);
1390 $defaults[$elementName] = array();
1391 $checkedValue = explode(CRM_Core_DAO::VALUE_SEPARATOR,
1392 substr($value, 1, -1)
1393 );
1394 foreach ($customOption as $val) {
1395 if (in_array($val['value'], $checkedValue)) {
1396 if ($customField->html_type == 'CheckBox') {
1397 $defaults[$elementName][$val['value']] = 1;
1398 }
1399 elseif ($customField->html_type == 'Multi-Select' ||
1400 $customField->html_type == 'AdvMulti-Select'
1401 ) {
1402 $defaults[$elementName][$val['value']] = $val['value'];
1403 }
1404 }
1405 }
1406 break;
1407
1408 case 'Select Date':
1409 if ($value) {
1410 list($defaults[$elementName], $defaults[$elementName . '_time']) = CRM_Utils_Date::setDateDefaults(
1411 $value,
1412 NULL,
1413 $customField->date_format,
1414 $customField->time_format
1415 );
1416 }
1417 break;
1418
1419 case 'Autocomplete-Select':
1420 if ($customField->data_type == 'ContactReference') {
1421 if (is_numeric($value)) {
1422 $defaults[$elementName . '_id'] = $value;
1423 $defaults[$elementName] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $value, 'sort_name');
1424 }
1425 }
1426 else {
1427 $defaults[$elementName] = $value;
1428 }
1429 break;
1430
1431 default:
1432 $defaults[$elementName] = $value;
1433 }
1434 }
1435
1436 /**
1437 * Get file url.
1438 *
1439 * @param int $contactID
1440 * @param int $cfID
1441 * @param int $fileID
1442 * @param bool $absolute
1443 *
1444 * @param string $multiRecordWhereClause
1445 *
1446 * @return array
1447 */
1448 public static function getFileURL($contactID, $cfID, $fileID = NULL, $absolute = FALSE, $multiRecordWhereClause = NULL) {
1449 if ($contactID) {
1450 if (!$fileID) {
1451 $params = array('id' => $cfID);
1452 $defaults = array();
1453 CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_CustomField', $params, $defaults);
1454 $columnName = $defaults['column_name'];
1455
1456 //table name of custom data
1457 $tableName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup',
1458 $defaults['custom_group_id'],
1459 'table_name', 'id'
1460 );
1461
1462 //query to fetch id from civicrm_file
1463 if ($multiRecordWhereClause) {
1464 $query = "SELECT {$columnName} FROM {$tableName} where entity_id = {$contactID} AND {$multiRecordWhereClause}";
1465 }
1466 else {
1467 $query = "SELECT {$columnName} FROM {$tableName} where entity_id = {$contactID}";
1468 }
1469 $fileID = CRM_Core_DAO::singleValueQuery($query);
1470 }
1471
1472 $result = array();
1473 if ($fileID) {
1474 $fileType = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_File',
1475 $fileID,
1476 'mime_type',
1477 'id'
1478 );
1479 $result['file_id'] = $fileID;
1480
1481 if ($fileType == 'image/jpeg' ||
1482 $fileType == 'image/pjpeg' ||
1483 $fileType == 'image/gif' ||
1484 $fileType == 'image/x-png' ||
1485 $fileType == 'image/png'
1486 ) {
1487 $entityId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_EntityFile',
1488 $fileID,
1489 'entity_id',
1490 'id'
1491 );
1492 list($path) = CRM_Core_BAO_File::path($fileID, $entityId, NULL, NULL);
1493 list($imageWidth, $imageHeight) = getimagesize($path);
1494 list($imageThumbWidth, $imageThumbHeight) = CRM_Contact_BAO_Contact::getThumbSize($imageWidth, $imageHeight);
1495 $url = CRM_Utils_System::url('civicrm/file',
1496 "reset=1&id=$fileID&eid=$contactID",
1497 $absolute, NULL, TRUE, TRUE
1498 );
1499 $result['file_url'] = "
1500 <a href=\"$url\" class='crm-image-popup'>
1501 <img src=\"$url\" width=$imageThumbWidth height=$imageThumbHeight/>
1502 </a>";
1503 // for non image files
1504 }
1505 else {
1506 $uri = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_File',
1507 $fileID,
1508 'uri'
1509 );
1510 $url = CRM_Utils_System::url('civicrm/file',
1511 "reset=1&id=$fileID&eid=$contactID",
1512 $absolute, NULL, TRUE, TRUE
1513 );
1514 $result['file_url'] = "<a href=\"$url\">{$uri}</a>";
1515 }
1516 }
1517 return $result;
1518 }
1519 }
1520
1521 /**
1522 * Format custom fields before inserting.
1523 *
1524 * @param int $customFieldId
1525 * Custom field id.
1526 * @param array $customFormatted
1527 * Formatted array.
1528 * @param mixed $value
1529 * Value of custom field.
1530 * @param string $customFieldExtend
1531 * Custom field extends.
1532 * @param int $customValueId
1533 * Custom option value id.
1534 * @param int $entityId
1535 * Entity id (contribution, membership...).
1536 * @param bool $inline
1537 * Consider inline custom groups only.
1538 * @param bool $checkPermission
1539 * If false, do not include permissioning clause.
1540 * @param bool $includeViewOnly
1541 * If true, fields marked 'View Only' are included. Required for APIv3.
1542 *
1543 * @return array|NULL
1544 * formatted custom field array
1545 */
1546 public static function formatCustomField(
1547 $customFieldId, &$customFormatted, $value,
1548 $customFieldExtend, $customValueId = NULL,
1549 $entityId = NULL,
1550 $inline = FALSE,
1551 $checkPermission = TRUE,
1552 $includeViewOnly = FALSE
1553 ) {
1554 //get the custom fields for the entity
1555 //subtype and basic type
1556 $customDataSubType = NULL;
1557 if ($customFieldExtend) {
1558 // This is the case when getFieldsForImport() requires fields
1559 // of subtype and its parent.CRM-5143
1560 // CRM-16065 - Custom field set data not being saved if contact has more than one contact sub type
1561 $customDataSubType = array_intersect(CRM_Contact_BAO_ContactType::subTypes(), (array) $customFieldExtend);
1562 if (!empty($customDataSubType) && is_array($customDataSubType)) {
1563 $customFieldExtend = CRM_Contact_BAO_ContactType::getBasicType($customDataSubType);
1564 if (is_array($customFieldExtend)) {
1565 $customFieldExtend = array_unique(array_values($customFieldExtend));
1566 }
1567 }
1568 }
1569
1570 $customFields = CRM_Core_BAO_CustomField::getFields($customFieldExtend,
1571 FALSE,
1572 $inline,
1573 $customDataSubType,
1574 NULL,
1575 FALSE,
1576 FALSE,
1577 $checkPermission
1578 );
1579
1580 if (!array_key_exists($customFieldId, $customFields)) {
1581 return NULL;
1582 }
1583
1584 // return if field is a 'code' field
1585 if (!$includeViewOnly && !empty($customFields[$customFieldId]['is_view'])) {
1586 return NULL;
1587 }
1588
1589 list($tableName, $columnName, $groupID) = self::getTableColumnGroup($customFieldId);
1590
1591 if (!$customValueId &&
1592 // we always create new entites for is_multiple unless specified
1593 !$customFields[$customFieldId]['is_multiple'] &&
1594 $entityId
1595 ) {
1596 $query = "
1597 SELECT id
1598 FROM $tableName
1599 WHERE entity_id={$entityId}";
1600
1601 $customValueId = CRM_Core_DAO::singleValueQuery($query);
1602 }
1603
1604 //fix checkbox, now check box always submits values
1605 if ($customFields[$customFieldId]['html_type'] == 'CheckBox') {
1606 if ($value) {
1607 // Note that only during merge this is not an array, and you can directly use value
1608 if (is_array($value)) {
1609 $selectedValues = array();
1610 foreach ($value as $selId => $val) {
1611 if ($val) {
1612 $selectedValues[] = $selId;
1613 }
1614 }
1615 if (!empty($selectedValues)) {
1616 $value = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR,
1617 $selectedValues
1618 ) . CRM_Core_DAO::VALUE_SEPARATOR;
1619 }
1620 else {
1621 $value = '';
1622 }
1623 }
1624 }
1625 }
1626
1627 if ($customFields[$customFieldId]['html_type'] == 'Multi-Select' ||
1628 $customFields[$customFieldId]['html_type'] == 'AdvMulti-Select'
1629 ) {
1630 if ($value) {
1631 // Note that only during merge this is not an array,
1632 // and you can directly use value, CRM-4385
1633 if (is_array($value)) {
1634 $value = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR,
1635 array_values($value)
1636 ) . CRM_Core_DAO::VALUE_SEPARATOR;
1637 }
1638 }
1639 else {
1640 $value = '';
1641 }
1642 }
1643
1644 if (($customFields[$customFieldId]['html_type'] == 'Multi-Select' ||
1645 $customFields[$customFieldId]['html_type'] == 'AdvMulti-Select' ||
1646 $customFields[$customFieldId]['html_type'] == 'CheckBox'
1647 ) &&
1648 $customFields[$customFieldId]['data_type'] == 'String' &&
1649 !empty($customFields[$customFieldId]['text_length']) &&
1650 !empty($value)
1651 ) {
1652 // lets make sure that value is less than the length, else we'll
1653 // be losing some data, CRM-7481
1654 if (strlen($value) >= $customFields[$customFieldId]['text_length']) {
1655 // need to do a few things here
1656
1657 // 1. lets find a new length
1658 $newLength = $customFields[$customFieldId]['text_length'];
1659 $minLength = strlen($value);
1660 while ($newLength < $minLength) {
1661 $newLength = $newLength * 2;
1662 }
1663
1664 // set the custom field meta data to have a length larger than value
1665 // alter the custom value table column to match this length
1666 CRM_Core_BAO_SchemaHandler::alterFieldLength($customFieldId, $tableName, $columnName, $newLength);
1667 }
1668 }
1669
1670 $date = NULL;
1671 if ($customFields[$customFieldId]['data_type'] == 'Date') {
1672 if (!CRM_Utils_System::isNull($value)) {
1673 $format = $customFields[$customFieldId]['date_format'];
1674 $date = CRM_Utils_Date::processDate($value, NULL, FALSE, 'YmdHis', $format);
1675 }
1676 $value = $date;
1677 }
1678
1679 if ($customFields[$customFieldId]['data_type'] == 'Float' ||
1680 $customFields[$customFieldId]['data_type'] == 'Money'
1681 ) {
1682 if (!$value) {
1683 $value = 0;
1684 }
1685
1686 if ($customFields[$customFieldId]['data_type'] == 'Money') {
1687 $value = CRM_Utils_Rule::cleanMoney($value);
1688 }
1689 }
1690
1691 if (($customFields[$customFieldId]['data_type'] == 'StateProvince' ||
1692 $customFields[$customFieldId]['data_type'] == 'Country'
1693 ) &&
1694 empty($value)
1695 ) {
1696 // CRM-3415
1697 $value = 0;
1698 }
1699
1700 $fileId = NULL;
1701
1702 if ($customFields[$customFieldId]['data_type'] == 'File') {
1703 if (empty($value)) {
1704 return;
1705 }
1706
1707 $config = CRM_Core_Config::singleton();
1708
1709 $fName = $value['name'];
1710 $mimeType = $value['type'];
1711
1712 $filename = pathinfo($fName, PATHINFO_BASENAME);
1713
1714 // rename this file to go into the secure directory
1715 if (!rename($fName, $config->customFileUploadDir . $filename)) {
1716 CRM_Core_Error::statusBounce(ts('Could not move custom file to custom upload directory'));
1717 }
1718
1719 if ($customValueId) {
1720 $query = "
1721 SELECT $columnName
1722 FROM $tableName
1723 WHERE id = %1";
1724 $params = array(1 => array($customValueId, 'Integer'));
1725 $fileId = CRM_Core_DAO::singleValueQuery($query, $params);
1726 }
1727
1728 $fileDAO = new CRM_Core_DAO_File();
1729
1730 if ($fileId) {
1731 $fileDAO->id = $fileId;
1732 }
1733
1734 $fileDAO->uri = $filename;
1735 $fileDAO->mime_type = $mimeType;
1736 $fileDAO->upload_date = date('Ymdhis');
1737 $fileDAO->save();
1738 $fileId = $fileDAO->id;
1739 $value = $filename;
1740 }
1741
1742 if (!is_array($customFormatted)) {
1743 $customFormatted = array();
1744 }
1745
1746 if (!array_key_exists($customFieldId, $customFormatted)) {
1747 $customFormatted[$customFieldId] = array();
1748 }
1749
1750 $index = -1;
1751 if ($customValueId) {
1752 $index = $customValueId;
1753 }
1754
1755 if (!array_key_exists($index, $customFormatted[$customFieldId])) {
1756 $customFormatted[$customFieldId][$index] = array();
1757 }
1758 $customFormatted[$customFieldId][$index] = array(
1759 'id' => $customValueId > 0 ? $customValueId : NULL,
1760 'value' => $value,
1761 'type' => $customFields[$customFieldId]['data_type'],
1762 'custom_field_id' => $customFieldId,
1763 'custom_group_id' => $groupID,
1764 'table_name' => $tableName,
1765 'column_name' => $columnName,
1766 'file_id' => $fileId,
1767 'is_multiple' => $customFields[$customFieldId]['is_multiple'],
1768 );
1769
1770 //we need to sort so that custom fields are created in the order of entry
1771 krsort($customFormatted[$customFieldId]);
1772 return $customFormatted;
1773 }
1774
1775 /**
1776 * Get default custom table schema.
1777 *
1778 * @param array $params
1779 *
1780 * @return array
1781 */
1782 public static function defaultCustomTableSchema($params) {
1783 // add the id and extends_id
1784 $table = array(
1785 'name' => $params['name'],
1786 'is_multiple' => $params['is_multiple'],
1787 'attributes' => "ENGINE=InnoDB DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci",
1788 'fields' => array(
1789 array(
1790 'name' => 'id',
1791 'type' => 'int unsigned',
1792 'primary' => TRUE,
1793 'required' => TRUE,
1794 'attributes' => 'AUTO_INCREMENT',
1795 'comment' => 'Default MySQL primary key',
1796 ),
1797 array(
1798 'name' => 'entity_id',
1799 'type' => 'int unsigned',
1800 'required' => TRUE,
1801 'comment' => 'Table that this extends',
1802 'fk_table_name' => $params['extends_name'],
1803 'fk_field_name' => 'id',
1804 'fk_attributes' => 'ON DELETE CASCADE',
1805 ),
1806 ),
1807 );
1808
1809 if (!$params['is_multiple']) {
1810 $table['indexes'] = array(
1811 array(
1812 'unique' => TRUE,
1813 'field_name_1' => 'entity_id',
1814 ),
1815 );
1816 }
1817 return $table;
1818 }
1819
1820 /**
1821 * Create custom field.
1822 *
1823 * @param CRM_Core_DAO_CustomField $field
1824 * @param string $operation
1825 * @param bool $indexExist
1826 * @param bool $triggerRebuild
1827 */
1828 public static function createField($field, $operation, $indexExist = FALSE, $triggerRebuild = TRUE) {
1829 $tableName = CRM_Core_DAO::getFieldValue(
1830 'CRM_Core_DAO_CustomGroup',
1831 $field->custom_group_id,
1832 'table_name'
1833 );
1834
1835 $params = array(
1836 'table_name' => $tableName,
1837 'operation' => $operation,
1838 'name' => $field->column_name,
1839 'type' => CRM_Core_BAO_CustomValueTable::fieldToSQLType(
1840 $field->data_type,
1841 $field->text_length
1842 ),
1843 'required' => $field->is_required,
1844 'searchable' => $field->is_searchable,
1845 );
1846
1847 if ($operation == 'delete') {
1848 $fkName = "{$tableName}_{$field->column_name}";
1849 if (strlen($fkName) >= 48) {
1850 $fkName = substr($fkName, 0, 32) . '_' . substr(md5($fkName), 0, 16);
1851 }
1852 $params['fkName'] = $fkName;
1853 }
1854 if ($field->data_type == 'Country' && $field->html_type == 'Select Country') {
1855 $params['fk_table_name'] = 'civicrm_country';
1856 $params['fk_field_name'] = 'id';
1857 $params['fk_attributes'] = 'ON DELETE SET NULL';
1858 }
1859 elseif ($field->data_type == 'Country' && $field->html_type == 'Multi-Select Country') {
1860 $params['type'] = 'varchar(255)';
1861 }
1862 elseif ($field->data_type == 'StateProvince' && $field->html_type == 'Select State/Province') {
1863 $params['fk_table_name'] = 'civicrm_state_province';
1864 $params['fk_field_name'] = 'id';
1865 $params['fk_attributes'] = 'ON DELETE SET NULL';
1866 }
1867 elseif ($field->data_type == 'StateProvince' && $field->html_type == 'Multi-Select State/Province') {
1868 $params['type'] = 'varchar(255)';
1869 }
1870 elseif ($field->data_type == 'File') {
1871 $params['fk_table_name'] = 'civicrm_file';
1872 $params['fk_field_name'] = 'id';
1873 $params['fk_attributes'] = 'ON DELETE SET NULL';
1874 }
1875 elseif ($field->data_type == 'ContactReference') {
1876 $params['fk_table_name'] = 'civicrm_contact';
1877 $params['fk_field_name'] = 'id';
1878 $params['fk_attributes'] = 'ON DELETE SET NULL';
1879 }
1880 if (isset($field->default_value)) {
1881 $params['default'] = "'{$field->default_value}'";
1882 }
1883
1884 CRM_Core_BAO_SchemaHandler::alterFieldSQL($params, $indexExist, $triggerRebuild);
1885 }
1886
1887 /**
1888 * Determine whether it would be safe to move a field.
1889 *
1890 * @param int $fieldID
1891 * FK to civicrm_custom_field.
1892 * @param int $newGroupID
1893 * FK to civicrm_custom_group.
1894 *
1895 * @return array
1896 * array(string) or TRUE
1897 */
1898 public static function _moveFieldValidate($fieldID, $newGroupID) {
1899 $errors = array();
1900
1901 $field = new CRM_Core_DAO_CustomField();
1902 $field->id = $fieldID;
1903 if (!$field->find(TRUE)) {
1904 $errors['fieldID'] = 'Invalid ID for custom field';
1905 return $errors;
1906 }
1907
1908 $oldGroup = new CRM_Core_DAO_CustomGroup();
1909 $oldGroup->id = $field->custom_group_id;
1910 if (!$oldGroup->find(TRUE)) {
1911 $errors['fieldID'] = 'Invalid ID for old custom group';
1912 return $errors;
1913 }
1914
1915 $newGroup = new CRM_Core_DAO_CustomGroup();
1916 $newGroup->id = $newGroupID;
1917 if (!$newGroup->find(TRUE)) {
1918 $errors['newGroupID'] = 'Invalid ID for new custom group';
1919 return $errors;
1920 }
1921
1922 $query = "
1923 SELECT b.id
1924 FROM civicrm_custom_field a
1925 INNER JOIN civicrm_custom_field b
1926 WHERE a.id = %1
1927 AND a.label = b.label
1928 AND b.custom_group_id = %2
1929 ";
1930 $params = array(
1931 1 => array($field->id, 'Integer'),
1932 2 => array($newGroup->id, 'Integer'),
1933 );
1934 $count = CRM_Core_DAO::singleValueQuery($query, $params);
1935 if ($count > 0) {
1936 $errors['newGroupID'] = ts('A field of the same label exists in the destination group');
1937 }
1938
1939 $tableName = $oldGroup->table_name;
1940 $columnName = $field->column_name;
1941
1942 $query = "
1943 SELECT count(*)
1944 FROM $tableName
1945 WHERE $columnName is not null
1946 ";
1947 $count = CRM_Core_DAO::singleValueQuery($query,
1948 CRM_Core_DAO::$_nullArray
1949 );
1950 if ($count > 0) {
1951 $query = "
1952 SELECT extends
1953 FROM civicrm_custom_group
1954 WHERE id IN ( %1, %2 )
1955 ";
1956 $params = array(
1957 1 => array($oldGroup->id, 'Integer'),
1958 2 => array($newGroup->id, 'Integer'),
1959 );
1960
1961 $dao = CRM_Core_DAO::executeQuery($query, $params);
1962 $extends = array();
1963 while ($dao->fetch()) {
1964 $extends[] = $dao->extends;
1965 }
1966 if ($extends[0] != $extends[1]) {
1967 $errors['newGroupID'] = ts('The destination group extends a different entity type.');
1968 }
1969 }
1970
1971 return empty($errors) ? TRUE : $errors;
1972 }
1973
1974 /**
1975 * Move a custom data field from one group (table) to another.
1976 *
1977 * @param int $fieldID
1978 * FK to civicrm_custom_field.
1979 * @param int $newGroupID
1980 * FK to civicrm_custom_group.
1981 */
1982 public static function moveField($fieldID, $newGroupID) {
1983 $validation = self::_moveFieldValidate($fieldID, $newGroupID);
1984 if (TRUE !== $validation) {
1985 CRM_Core_Error::fatal(implode(' ', $validation));
1986 }
1987 $field = new CRM_Core_DAO_CustomField();
1988 $field->id = $fieldID;
1989 $field->find(TRUE);
1990
1991 $newGroup = new CRM_Core_DAO_CustomGroup();
1992 $newGroup->id = $newGroupID;
1993 $newGroup->find(TRUE);
1994
1995 $oldGroup = new CRM_Core_DAO_CustomGroup();
1996 $oldGroup->id = $field->custom_group_id;
1997 $oldGroup->find(TRUE);
1998
1999 $add = clone$field;
2000 $add->custom_group_id = $newGroup->id;
2001 self::createField($add, 'add');
2002
2003 $sql = "INSERT INTO {$newGroup->table_name} (entity_id, {$field->column_name})
2004 SELECT entity_id, {$field->column_name} FROM {$oldGroup->table_name}
2005 ON DUPLICATE KEY UPDATE {$field->column_name} = {$oldGroup->table_name}.{$field->column_name}
2006 ";
2007 CRM_Core_DAO::executeQuery($sql);
2008
2009 $del = clone$field;
2010 $del->custom_group_id = $oldGroup->id;
2011 self::createField($del, 'delete');
2012
2013 $add->save();
2014
2015 CRM_Utils_System::flushCache();
2016 }
2017
2018 /**
2019 * Get the database table name and column name for a custom field.
2020 *
2021 * @param int $fieldID
2022 * The fieldID of the custom field.
2023 * @param bool $force
2024 * Force the sql to be run again (primarily used for tests).
2025 *
2026 * @return array
2027 * fatal is fieldID does not exists, else array of tableName, columnName
2028 */
2029 public static function getTableColumnGroup($fieldID, $force = FALSE) {
2030 $cacheKey = "CRM_Core_DAO_CustomField_CustomGroup_TableColumn_{$fieldID}";
2031 $cache = CRM_Utils_Cache::singleton();
2032 $fieldValues = $cache->get($cacheKey);
2033 if (empty($fieldValues) || $force) {
2034 $query = "
2035 SELECT cg.table_name, cf.column_name, cg.id
2036 FROM civicrm_custom_group cg,
2037 civicrm_custom_field cf
2038 WHERE cf.custom_group_id = cg.id
2039 AND cf.id = %1";
2040 $params = array(1 => array($fieldID, 'Integer'));
2041 $dao = CRM_Core_DAO::executeQuery($query, $params);
2042
2043 if (!$dao->fetch()) {
2044 CRM_Core_Error::fatal();
2045 }
2046 $dao->free();
2047 $fieldValues = array($dao->table_name, $dao->column_name, $dao->id);
2048 $cache->set($cacheKey, $fieldValues);
2049 }
2050 return $fieldValues;
2051 }
2052
2053 /**
2054 * Get custom option groups.
2055 *
2056 * @param array $includeFieldIds
2057 * Ids of custom fields for which option groups must be included.
2058 *
2059 * Currently this is required in the cases where option groups are to be included
2060 * for inactive fields : CRM-5369
2061 *
2062 * @return mixed
2063 */
2064 public static function customOptionGroup($includeFieldIds = NULL) {
2065 static $customOptionGroup = NULL;
2066
2067 $cacheKey = (empty($includeFieldIds)) ? 'onlyActive' : 'force';
2068 if ($cacheKey == 'force') {
2069 $customOptionGroup[$cacheKey] = NULL;
2070 }
2071
2072 if (empty($customOptionGroup[$cacheKey])) {
2073 $whereClause = '( g.is_active = 1 AND f.is_active = 1 )';
2074
2075 //support for single as well as array format.
2076 if (!empty($includeFieldIds)) {
2077 if (is_array($includeFieldIds)) {
2078 $includeFieldIds = implode(',', $includeFieldIds);
2079 }
2080 $whereClause .= "OR f.id IN ( $includeFieldIds )";
2081 }
2082
2083 $query = "
2084 SELECT g.id, g.title
2085 FROM civicrm_option_group g
2086 INNER JOIN civicrm_custom_field f ON ( g.id = f.option_group_id )
2087 WHERE {$whereClause}";
2088
2089 $dao = CRM_Core_DAO::executeQuery($query);
2090 while ($dao->fetch()) {
2091 $customOptionGroup[$cacheKey][$dao->id] = $dao->title;
2092 }
2093 }
2094
2095 return $customOptionGroup[$cacheKey];
2096 }
2097
2098 /**
2099 * Fix orphan groups.
2100 *
2101 * @param int $customFieldId
2102 * Custom field id.
2103 * @param int $optionGroupId
2104 * Option group id.
2105 */
2106 public static function fixOptionGroups($customFieldId, $optionGroupId) {
2107 // check if option group belongs to any custom Field else delete
2108 // get the current option group
2109 $currentOptionGroupId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField',
2110 $customFieldId,
2111 'option_group_id'
2112 );
2113 // get the updated option group
2114 // if both are same return
2115 if ($currentOptionGroupId == $optionGroupId) {
2116 return;
2117 }
2118
2119 // check if option group is related to any other field
2120 self::checkOptionGroup($currentOptionGroupId);
2121 }
2122
2123 /**
2124 * Check if option group is related to more than one custom field.
2125 *
2126 * @param int $optionGroupId
2127 * Option group id.
2128 */
2129 public static function checkOptionGroup($optionGroupId) {
2130 $query = "
2131 SELECT count(*)
2132 FROM civicrm_custom_field
2133 WHERE option_group_id = {$optionGroupId}";
2134
2135 $count = CRM_Core_DAO::singleValueQuery($query);
2136
2137 if ($count < 2) {
2138 //delete the option group
2139 CRM_Core_BAO_OptionGroup::del($optionGroupId);
2140 }
2141 }
2142
2143 /**
2144 * Get option group default.
2145 *
2146 * @param int $optionGroupId
2147 * @param string $htmlType
2148 *
2149 * @return null|string
2150 */
2151 public static function getOptionGroupDefault($optionGroupId, $htmlType) {
2152 $query = "
2153 SELECT default_value, html_type
2154 FROM civicrm_custom_field
2155 WHERE option_group_id = {$optionGroupId}
2156 AND default_value IS NOT NULL
2157 ORDER BY html_type";
2158
2159 $dao = CRM_Core_DAO::executeQuery($query);
2160 $defaultValue = NULL;
2161 $defaultHTMLType = NULL;
2162 while ($dao->fetch()) {
2163 if ($dao->html_type == $htmlType) {
2164 return $dao->default_value;
2165 }
2166 if ($defaultValue == NULL) {
2167 $defaultValue = $dao->default_value;
2168 $defaultHTMLType = $dao->html_type;
2169 }
2170 }
2171
2172 // some conversions are needed if either the old or new has a html type which has potential
2173 // multiple default values.
2174 if (($htmlType == 'CheckBox' || $htmlType == 'Multi-Select') &&
2175 ($defaultHTMLType != 'CheckBox' && $defaultHTMLType != 'Multi-Select')
2176 ) {
2177 $defaultValue = CRM_Core_DAO::VALUE_SEPARATOR . $defaultValue . CRM_Core_DAO::VALUE_SEPARATOR;
2178 }
2179 elseif (($defaultHTMLType == 'CheckBox' || $defaultHTMLType == 'Multi-Select') &&
2180 ($htmlType != 'CheckBox' && $htmlType != 'Multi-Select')
2181 ) {
2182 $defaultValue = substr($defaultValue, 1, -1);
2183 $values = explode(CRM_Core_DAO::VALUE_SEPARATOR,
2184 substr($defaultValue, 1, -1)
2185 );
2186 $defaultValue = $values[0];
2187 }
2188
2189 return $defaultValue;
2190 }
2191
2192 /**
2193 * Post process function.
2194 *
2195 * @param array $params
2196 * @param int $entityID
2197 * @param string $customFieldExtends
2198 * @param bool $inline
2199 *
2200 * @return array
2201 */
2202 public static function postProcess(
2203 &$params,
2204 $entityID,
2205 $customFieldExtends,
2206 $inline = FALSE
2207 ) {
2208 $customData = array();
2209
2210 foreach ($params as $key => $value) {
2211 if ($customFieldInfo = CRM_Core_BAO_CustomField::getKeyID($key, TRUE)) {
2212
2213 // for autocomplete transfer hidden value instead of label
2214 if ($params[$key] && isset($params[$key . '_id'])) {
2215 $value = $params[$key . '_id'];
2216 }
2217
2218 // we need to append time with date
2219 if ($params[$key] && isset($params[$key . '_time'])) {
2220 $value .= ' ' . $params[$key . '_time'];
2221 }
2222
2223 CRM_Core_BAO_CustomField::formatCustomField($customFieldInfo[0],
2224 $customData,
2225 $value,
2226 $customFieldExtends,
2227 $customFieldInfo[1],
2228 $entityID,
2229 $inline
2230 );
2231 }
2232 }
2233 return $customData;
2234 }
2235
2236 /**
2237 * Build option.
2238 *
2239 * @param array $field
2240 * @param array $options
2241 *
2242 * @throws Exception
2243 */
2244 public static function buildOption($field, &$options) {
2245 // Fixme - adding anything but options to the $options array is a bad idea
2246 // What if an option had the key 'attributes'?
2247 $options['attributes'] = array(
2248 'label' => $field['label'],
2249 'data_type' => $field['data_type'],
2250 'html_type' => $field['html_type'],
2251 );
2252
2253 $optionGroupID = NULL;
2254 if (($field['html_type'] == 'CheckBox' ||
2255 $field['html_type'] == 'Radio' ||
2256 $field['html_type'] == 'Select' ||
2257 $field['html_type'] == 'AdvMulti-Select' ||
2258 $field['html_type'] == 'Multi-Select' ||
2259 ($field['html_type'] == 'Autocomplete-Select' && $field['data_type'] != 'ContactReference')
2260 )
2261 ) {
2262 if ($field['option_group_id']) {
2263 $optionGroupID = $field['option_group_id'];
2264 }
2265 elseif ($field['data_type'] != 'Boolean') {
2266 CRM_Core_Error::fatal();
2267 }
2268 }
2269
2270 // build the cache for custom values with options (label => value)
2271 if ($optionGroupID != NULL) {
2272 $query = "
2273 SELECT label, value
2274 FROM civicrm_option_value
2275 WHERE option_group_id = $optionGroupID
2276 ";
2277
2278 $dao = CRM_Core_DAO::executeQuery($query);
2279 while ($dao->fetch()) {
2280 if ($field['data_type'] == 'Int' || $field['data_type'] == 'Float') {
2281 $num = round($dao->value, 2);
2282 $options["$num"] = $dao->label;
2283 }
2284 else {
2285 $options[$dao->value] = $dao->label;
2286 }
2287 }
2288
2289 CRM_Utils_Hook::customFieldOptions($field['id'], $options);
2290 }
2291 }
2292
2293 /**
2294 * Get custom field ID.
2295 *
2296 * @param string $fieldLabel
2297 * @param null $groupTitle
2298 *
2299 * @return int|null
2300 */
2301 public static function getCustomFieldID($fieldLabel, $groupTitle = NULL) {
2302 $params = array(1 => array($fieldLabel, 'String'));
2303 if ($groupTitle) {
2304 $params[2] = array($groupTitle, 'String');
2305 $sql = "
2306 SELECT f.id
2307 FROM civicrm_custom_field f
2308 INNER JOIN civicrm_custom_group g ON f.custom_group_id = g.id
2309 WHERE ( f.label = %1 OR f.name = %1 )
2310 AND ( g.title = %2 OR g.name = %2 )
2311 ";
2312 }
2313 else {
2314 $sql = "
2315 SELECT f.id
2316 FROM civicrm_custom_field f
2317 WHERE ( f.label = %1 OR f.name = %1 )
2318 ";
2319 }
2320
2321 $dao = CRM_Core_DAO::executeQuery($sql, $params);
2322 if ($dao->fetch() &&
2323 $dao->N == 1
2324 ) {
2325 return $dao->id;
2326 }
2327 else {
2328 return NULL;
2329 }
2330 }
2331
2332 /**
2333 * Given ID of a custom field, return its name as well as the name of the custom group it belongs to.
2334 *
2335 * @param array $ids
2336 *
2337 * @return array
2338 */
2339 public static function getNameFromID($ids) {
2340 if (is_array($ids)) {
2341 $ids = implode(',', $ids);
2342 }
2343 $sql = "
2344 SELECT f.id, f.name AS field_name, f.label AS field_label, g.name AS group_name, g.title AS group_title
2345 FROM civicrm_custom_field f
2346 INNER JOIN civicrm_custom_group g ON f.custom_group_id = g.id
2347 WHERE f.id IN ($ids)";
2348
2349 $dao = CRM_Core_DAO::executeQuery($sql);
2350 $result = array();
2351 while ($dao->fetch()) {
2352 $result[$dao->id] = array(
2353 'field_name' => $dao->field_name,
2354 'field_label' => $dao->field_label,
2355 'group_name' => $dao->group_name,
2356 'group_title' => $dao->group_title,
2357 );
2358 }
2359 return $result;
2360 }
2361
2362 /**
2363 * Validate custom data.
2364 *
2365 * @param array $params
2366 * Custom data submitted.
2367 * ie array( 'custom_1' => 'validate me' );
2368 *
2369 * @return array
2370 * validation errors.
2371 */
2372 public static function validateCustomData($params) {
2373 $errors = array();
2374 if (!is_array($params) || empty($params)) {
2375 return $errors;
2376 }
2377
2378 //pick up profile fields.
2379 $profileFields = array();
2380 $ufGroupId = CRM_Utils_Array::value('ufGroupId', $params);
2381 if ($ufGroupId) {
2382 $profileFields = CRM_Core_BAO_UFGroup::getFields($ufGroupId,
2383 FALSE,
2384 CRM_Core_Action::VIEW
2385 );
2386 }
2387
2388 //lets start w/ params.
2389 foreach ($params as $key => $value) {
2390 $customFieldID = self::getKeyID($key);
2391 if (!$customFieldID) {
2392 continue;
2393 }
2394
2395 //load the structural info for given field.
2396 $field = new CRM_Core_DAO_CustomField();
2397 $field->id = $customFieldID;
2398 if (!$field->find(TRUE)) {
2399 continue;
2400 }
2401 $dataType = $field->data_type;
2402
2403 $profileField = CRM_Utils_Array::value($key, $profileFields, array());
2404 $fieldTitle = CRM_Utils_Array::value('title', $profileField);
2405 $isRequired = CRM_Utils_Array::value('is_required', $profileField);
2406 if (!$fieldTitle) {
2407 $fieldTitle = $field->label;
2408 }
2409
2410 //no need to validate.
2411 if (CRM_Utils_System::isNull($value) && !$isRequired) {
2412 continue;
2413 }
2414
2415 //lets validate first for required field.
2416 if ($isRequired && CRM_Utils_System::isNull($value)) {
2417 $errors[$key] = ts('%1 is a required field.', array(1 => $fieldTitle));
2418 continue;
2419 }
2420
2421 //now time to take care of custom field form rules.
2422 $ruleName = $errorMsg = NULL;
2423 switch ($dataType) {
2424 case 'Int':
2425 $ruleName = 'integer';
2426 $errorMsg = ts('%1 must be an integer (whole number).',
2427 array(1 => $fieldTitle)
2428 );
2429 break;
2430
2431 case 'Money':
2432 $ruleName = 'money';
2433 $errorMsg = ts('%1 must in proper money format. (decimal point/comma/space is allowed).',
2434 array(1 => $fieldTitle)
2435 );
2436 break;
2437
2438 case 'Float':
2439 $ruleName = 'numeric';
2440 $errorMsg = ts('%1 must be a number (with or without decimal point).',
2441 array(1 => $fieldTitle)
2442 );
2443 break;
2444
2445 case 'Link':
2446 $ruleName = 'wikiURL';
2447 $errorMsg = ts('%1 must be valid Website.',
2448 array(1 => $fieldTitle)
2449 );
2450 break;
2451 }
2452
2453 if ($ruleName && !CRM_Utils_System::isNull($value)) {
2454 $valid = FALSE;
2455 $funName = "CRM_Utils_Rule::{$ruleName}";
2456 if (is_callable($funName)) {
2457 $valid = call_user_func($funName, $value);
2458 }
2459 if (!$valid) {
2460 $errors[$key] = $errorMsg;
2461 }
2462 }
2463 }
2464
2465 return $errors;
2466 }
2467
2468 /**
2469 * Is this field a multi record field.
2470 *
2471 * @param int $customId
2472 *
2473 * @return bool
2474 */
2475 public static function isMultiRecordField($customId) {
2476 $isMultipleWithGid = FALSE;
2477 if (!is_numeric($customId)) {
2478 $customId = self::getKeyID($customId);
2479 }
2480 if (is_numeric($customId)) {
2481 $sql = "SELECT cg.id cgId
2482 FROM civicrm_custom_group cg
2483 INNER JOIN civicrm_custom_field cf
2484 ON cg.id = cf.custom_group_id
2485 WHERE cf.id = %1 AND cg.is_multiple = 1";
2486 $params[1] = array($customId, 'Integer');
2487 $dao = CRM_Core_DAO::executeQuery($sql, $params);
2488 if ($dao->fetch()) {
2489 if ($dao->cgId) {
2490 $isMultipleWithGid = $dao->cgId;
2491 }
2492 }
2493 }
2494
2495 return $isMultipleWithGid;
2496 }
2497
2498 /**
2499 * Does this field store a serialized string?
2500 *
2501 * @param array $field
2502 *
2503 * @return bool
2504 */
2505 public static function isSerialized($field) {
2506 // Fields retrieved via api are an array, or from the dao are an object. We'll accept either.
2507 $field = (array) $field;
2508 // FIXME: Currently the only way to know if data is serialized is by looking at the html_type. It would be cleaner to decouple this.
2509 return ($field['html_type'] == 'CheckBox' || strpos($field['html_type'], 'Multi') !== FALSE);
2510 }
2511
2512 /**
2513 * Get options for field.
2514 *
2515 * @param array $field
2516 * @param string|null $optionGroupName
2517 */
2518 private static function getOptionsForField(&$field, $optionGroupName) {
2519 if ($optionGroupName) {
2520 $field['pseudoconstant'] = array(
2521 'optionGroupName' => $optionGroupName,
2522 'optionEditPath' => 'civicrm/admin/options/' . $optionGroupName,
2523 );
2524 }
2525 elseif ($field['data_type'] == 'Boolean') {
2526 $field['pseudoconstant'] = array(
2527 'callback' => 'CRM_Core_SelectValues::boolean',
2528 );
2529 }
2530 elseif ($field['data_type'] == 'Country') {
2531 $field['pseudoconstant'] = array(
2532 'table' => 'civicrm_country',
2533 'keyColumn' => 'id',
2534 'labelColumn' => 'name',
2535 'nameColumn' => 'iso_code',
2536 );
2537 }
2538 elseif ($field['data_type'] == 'StateProvince') {
2539 $field['pseudoconstant'] = array(
2540 'table' => 'civicrm_state_province',
2541 'keyColumn' => 'id',
2542 'labelColumn' => 'name',
2543 );
2544 }
2545 }
2546
2547 }