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