3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * Business objects for managing custom data fields.
21 class CRM_Core_BAO_CustomField
extends CRM_Core_DAO_CustomField
{
24 * Array to hold (formatted) fields for import
28 public static $_importFields = NULL;
31 * Build and retrieve the list of data types and descriptions.
34 * Data type => Description
36 public static function dataType() {
38 'String' => ts('Alphanumeric'),
39 'Int' => ts('Integer'),
40 'Float' => ts('Number'),
41 'Money' => ts('Money'),
44 'Boolean' => ts('Yes or No'),
45 'StateProvince' => ts('State/Province'),
46 'Country' => ts('Country'),
49 'ContactReference' => ts('Contact Reference'),
54 * Build the map of custom field's data types and there respective Util type
57 * Data data-type => CRM_Utils_Type
59 public static function dataToType() {
61 'String' => CRM_Utils_Type
::T_STRING
,
62 'Int' => CRM_Utils_Type
::T_INT
,
63 'Money' => CRM_Utils_Type
::T_MONEY
,
64 'Memo' => CRM_Utils_Type
::T_LONGTEXT
,
65 'Float' => CRM_Utils_Type
::T_FLOAT
,
66 'Date' => CRM_Utils_Type
::T_DATE
,
67 'DateTime' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
68 'Boolean' => CRM_Utils_Type
::T_BOOLEAN
,
69 'StateProvince' => CRM_Utils_Type
::T_INT
,
70 'File' => CRM_Utils_Type
::T_STRING
,
71 'Link' => CRM_Utils_Type
::T_STRING
,
72 'ContactReference' => CRM_Utils_Type
::T_INT
,
73 'Country' => CRM_Utils_Type
::T_INT
,
78 * Takes an associative array and creates a custom field object.
80 * This function is invoked from within the web form layer and also from the api layer
82 * @param array $params
83 * (reference) an assoc array of name/value pairs.
85 * @return CRM_Core_DAO_CustomField
87 public static function create($params) {
88 $changeSerialize = self
::getChangeSerialize($params);
89 $customField = self
::createCustomFieldRecord($params);
90 // When deserializing a field, the update needs to run before the schema change
91 if ($changeSerialize === 0) {
92 CRM_Core_DAO
::singleValueQuery(self
::getAlterSerializeSQL($customField));
94 $op = empty($params['id']) ?
'add' : 'modify';
95 self
::createField($customField, $op);
96 // When serializing a field, the update needs to run after the schema change
97 if ($changeSerialize === 1) {
98 CRM_Core_DAO
::singleValueQuery(self
::getAlterSerializeSQL($customField));
101 CRM_Utils_Hook
::post(($op === 'add' ?
'create' : 'edit'), 'CustomField', $customField->id
, $customField);
103 CRM_Utils_System
::flushCache();
104 // Flush caches is not aggressive about clearing the specific cache we know we want to clear
105 // so do it manually. Ideally we wouldn't need to clear others...
106 Civi
::cache('metadata')->clear();
112 * Create/ update several fields at once in a mysql efficient way.
114 * https://lab.civicrm.org/dev/core/issues/1093
116 * The intention is that apiv4 would expose any BAO with bulkSave as a new action.
118 * @param array $bulkParams
119 * Array of arrays as would be passed into create
120 * @param array $defaults
121 * Default parameters to be be merged into each of the params.
123 * @throws \CiviCRM_API3_Exception
125 public static function bulkSave($bulkParams, $defaults = []) {
126 $addedColumns = $sql = $customFields = $pre = $post = [];
127 foreach ($bulkParams as $index => $fieldParams) {
128 $params = array_merge($defaults, $fieldParams);
129 $changeSerialize = self
::getChangeSerialize($params);
130 $customField = self
::createCustomFieldRecord($params);
131 // Serialize/deserialize sql must run after/before the table is altered
132 if ($changeSerialize === 0) {
133 $pre[] = self
::getAlterSerializeSQL($customField);
135 if ($changeSerialize === 1) {
136 $post[] = self
::getAlterSerializeSQL($customField);
138 $fieldSQL = self
::getAlterFieldSQL($customField, empty($params['id']) ?
'add' : 'modify');
139 if (!isset($params['custom_group_id'])) {
140 $params['custom_group_id'] = civicrm_api3('CustomField', 'getvalue', ['id' => $customField->id
, 'return' => 'custom_group_id']);
142 $tableName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup', $customField->custom_group_id
, 'table_name');
143 $sql[$tableName][] = $fieldSQL;
144 $addedColumns[$tableName][] = $customField->name
;
145 $customFields[$index] = $customField;
148 foreach ($pre as $query) {
149 CRM_Core_DAO
::executeQuery($query);
152 foreach ($sql as $tableName => $statements) {
153 // CRM-7007: do not i18n-rewrite this query
154 CRM_Core_DAO
::executeQuery("ALTER TABLE $tableName " . implode(', ', $statements), [], TRUE, NULL, FALSE, FALSE);
156 if (CRM_Core_Config
::singleton()->logging
) {
157 $logging = new CRM_Logging_Schema();
158 $logging->fixSchemaDifferencesFor($tableName, ['ADD' => $addedColumns[$tableName]]);
161 Civi
::service('sql_triggers')->rebuild($tableName, TRUE);
164 foreach ($post as $query) {
165 CRM_Core_DAO
::executeQuery($query);
168 CRM_Utils_System
::flushCache();
169 foreach ($customFields as $index => $customField) {
170 CRM_Utils_Hook
::post(empty($bulkParams[$index]['id']) ?
'create' : 'edit', 'CustomField', $customField->id
, $customField);
175 * Fetch object based on array of properties.
177 * @param array $params
178 * An assoc array of name/value pairs.
179 * @param array $defaults
180 * (reference ) an assoc array to hold the flattened values.
182 * @return CRM_Core_DAO_CustomField
184 public static function retrieve($params, &$defaults) {
185 return CRM_Core_DAO
::commonRetrieve('CRM_Core_DAO_CustomField', $params, $defaults);
189 * Update the is_active flag in the db.
192 * Id of the database record.
193 * @param bool $is_active
194 * Value we want to set the is_active field.
197 * true if we found and updated the object, else false
199 public static function setIsActive($id, $is_active) {
201 CRM_Utils_System
::flushCache();
203 //enable-disable CustomField
204 CRM_Core_BAO_UFField
::setUFField($id, $is_active);
205 return CRM_Core_DAO
::setFieldValue('CRM_Core_DAO_CustomField', $id, 'is_active', $is_active);
209 * Get the field title.
217 public static function getTitle($id) {
218 return CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField', $id, 'label');
222 * @param string $context
225 public function getOptions($context = NULL) {
226 CRM_Core_DAO
::buildOptionsContext($context);
231 $cacheKey = "CRM_Core_BAO_CustomField_getOptions_{$this->id}_$context";
232 $cache = CRM_Utils_Cache
::singleton();
233 $options = $cache->get($cacheKey);
234 if (!isset($options)) {
235 if (!$this->data_type ||
!$this->custom_group_id
) {
239 // This will hold the list of options in format key => label
242 if (!empty($this->option_group_id
)) {
243 $options = CRM_Core_OptionGroup
::valuesByID(
244 $this->option_group_id
, FALSE, FALSE, FALSE, $context == 'validate' ?
'name' : 'label', !($context == 'validate' ||
$context == 'get')
247 elseif ($this->data_type
=== 'StateProvince') {
248 $options = CRM_Core_PseudoConstant
::stateProvince();
250 elseif ($this->data_type
=== 'Country') {
251 $options = $context == 'validate' ? CRM_Core_PseudoConstant
::countryIsoCode() : CRM_Core_PseudoConstant
::country();
253 elseif ($this->data_type
=== 'Boolean') {
254 $options = $context == 'validate' ?
[0, 1] : CRM_Core_SelectValues
::boolean();
256 CRM_Utils_Hook
::customFieldOptions($this->id
, $options, FALSE);
257 CRM_Utils_Hook
::fieldOptions($this->getEntity(), "custom_{$this->id}", $options, ['context' => $context]);
258 $cache->set($cacheKey, $options);
266 public static function buildOptions($fieldName, $context = NULL, $props = []) {
267 $options = parent
::buildOptions($fieldName, $context, $props);
268 // This provides legacy support for APIv3, allowing no-longer-existent html types
269 if ($fieldName == 'html_type' && isset($props['version']) && $props['version'] == 3) {
270 $options['Multi-Select'] = 'Multi-Select';
271 $options['Select Country'] = 'Select Country';
272 $options['Multi-Select Country'] = 'Multi-Select Country';
273 $options['Select State/Province'] = 'Select State/Province';
274 $options['Multi-Select State/Province'] = 'Multi-Select State/Province';
280 * Store and return an array of all active custom fields.
282 * @param string $customDataType
283 * Type of Custom Data; 'ANY' is a synonym for "all contact data types".
284 * @param bool $showAll
285 * If true returns all fields (includes disabled fields).
286 * @param bool $inline
287 * If true returns all inline fields (includes disabled fields).
288 * @param int $customDataSubType
289 * Custom Data sub type value.
290 * @param int $customDataSubName
291 * Custom Data sub name value.
292 * @param bool $onlyParent
293 * Return only top level custom data, for eg, only Participant and ignore subname and subtype.
294 * @param bool $onlySubType
295 * Return only custom data for subtype.
296 * @param bool $checkPermission
297 * If false, do not include permissioning clause.
300 * an array of active custom fields.
301 * @throws \CRM_Core_Exception
303 public static function &getFields(
304 $customDataType = 'Individual',
307 $customDataSubType = NULL,
308 $customDataSubName = NULL,
310 $onlySubType = FALSE,
311 $checkPermission = TRUE
313 if (empty($customDataType)) {
314 $customDataType = ['Contact', 'Individual', 'Organization', 'Household'];
316 if ($customDataType === 'ANY') {
317 // NULL should have been respected but the line above broke that.
318 // boo for us not having enough unit tests back them.
319 $customDataType = NULL;
321 if ($customDataType && !is_array($customDataType)) {
323 if (in_array($customDataType, CRM_Contact_BAO_ContactType
::subTypes())) {
324 // This is the case when getFieldsForImport() requires fields
325 // limited strictly to a subtype.
326 $customDataSubType = $customDataType;
327 $customDataType = CRM_Contact_BAO_ContactType
::getBasicType($customDataType);
331 if (in_array($customDataType, array_keys(CRM_Core_SelectValues
::customGroupExtends()))) {
332 // this makes the method flexible to support retrieving fields
333 // for multiple extends value.
334 $customDataType = [$customDataType];
338 $customDataSubType = CRM_Utils_Array
::explodePadded($customDataSubType);
340 if (is_array($customDataType)) {
341 $cacheKey = implode('_', $customDataType);
344 $cacheKey = $customDataType;
347 $cacheKey .= !empty($customDataSubType) ?
('_' . implode('_', $customDataSubType)) : '_0';
348 $cacheKey .= $customDataSubName ?
"{$customDataSubName}_" : '_0';
349 $cacheKey .= $showAll ?
'_1' : '_0';
350 $cacheKey .= $inline ?
'_1_' : '_0_';
351 $cacheKey .= $onlyParent ?
'_1_' : '_0_';
352 $cacheKey .= $onlySubType ?
'_1_' : '_0_';
353 $cacheKey .= $checkPermission ?
'_1_' . CRM_Core_Session
::getLoggedInContactID() . '_' : '_0_0_';
354 $cacheKey .= '_' . CRM_Core_Config
::domainID() . '_';
356 $cgTable = CRM_Core_DAO_CustomGroup
::getTableName();
358 // also get the permission stuff here
359 if ($checkPermission) {
360 $permissionClause = CRM_Core_Permission
::customGroupClause(CRM_Core_Permission
::VIEW
,
365 $permissionClause = '(1)';
368 // lets md5 permission clause and take first 8 characters
369 $cacheKey .= substr(md5($permissionClause), 0, 8);
371 if (strlen($cacheKey) > 40) {
372 $cacheKey = md5($cacheKey);
375 if (!self
::$_importFields ||
376 CRM_Utils_Array
::value($cacheKey, self
::$_importFields) === NULL
378 if (!self
::$_importFields) {
379 self
::$_importFields = [];
382 // check if we can retrieve from database cache
383 $fields = Civi
::Cache('fields')->get("custom importableFields $cacheKey");
385 if ($fields === NULL) {
388 if (is_array($customDataType)) {
390 foreach ($customDataType as $dataType) {
391 if (in_array($dataType, array_keys(CRM_Core_SelectValues
::customGroupExtends()))) {
392 if (in_array($dataType, ['Individual', 'Household', 'Organization'])) {
393 $val = "'" . CRM_Utils_Type
::escape($dataType, 'String') . "', 'Contact' ";
396 $val = "'" . CRM_Utils_Type
::escape($dataType, 'String') . "'";
398 $value = $value ?
$value . ", {$val}" : $val;
402 $extends = "AND $cgTable.extends IN ( $value ) ";
406 if (!empty($customDataType) && empty($extends)) {
407 // $customDataType specified a filter, but there is no corresponding SQL ($extends)
408 self
::$_importFields[$cacheKey] = [];
409 return self
::$_importFields[$cacheKey];
413 $extends .= " AND $cgTable.extends_entity_column_value IS NULL AND $cgTable.extends_entity_column_id IS NULL ";
415 // Temporary hack - in 5.27 a new field is added to civicrm_custom_field. There is a high
416 // risk this function is called before the upgrade page can be reached and if
417 // so it will potentially result in fatal error.
418 $serializeField = CRM_Core_BAO_Domain
::isDBVersionAtLeast('5.27.alpha1') ?
"custom_field.serialize," : '';
420 $query = "SELECT custom_field.id, custom_field.label,
422 custom_field.data_type,
423 custom_field.html_type,
424 custom_field.default_value,
425 custom_field.options_per_line, custom_field.text_length,
426 custom_field.custom_group_id,
427 custom_field.is_required,
428 custom_field.column_name,
429 $cgTable.extends, custom_field.is_search_range,
430 $cgTable.extends_entity_column_value,
431 $cgTable.extends_entity_column_id,
432 custom_field.is_view,
433 custom_field.option_group_id,
434 custom_field.date_format,
435 custom_field.time_format,
436 $cgTable.is_multiple,
439 og.name as option_group_name
440 FROM civicrm_custom_field custom_field
442 ON custom_field.custom_group_id = $cgTable.id
443 LEFT JOIN civicrm_option_group og
444 ON custom_field.option_group_id = og.id
448 $query .= " AND custom_field.is_active = 1 AND $cgTable.is_active = 1 ";
452 $query .= " AND $cgTable.style = 'Inline' ";
455 //get the custom fields for specific type in
456 //combination with fields those support any type.
457 if (!empty($customDataSubType)) {
459 foreach ($customDataSubType as $subtype) {
460 $subtype = CRM_Core_DAO
::VALUE_SEPARATOR
. CRM_Utils_Type
::escape($subtype, 'String') . CRM_Core_DAO
::VALUE_SEPARATOR
;
461 $subtypeClause[] = "$cgTable.extends_entity_column_value LIKE '%{$subtype}%'";
464 $subtypeClause[] = "$cgTable.extends_entity_column_value IS NULL";
466 $query .= " AND ( " . implode(' OR ', $subtypeClause) . " )";
469 if ($customDataSubName) {
470 $query .= " AND ( $cgTable.extends_entity_column_id = $customDataSubName ) ";
473 // also get the permission stuff here
474 if ($checkPermission) {
475 $permissionClause = CRM_Core_Permission
::customGroupClause(CRM_Core_Permission
::VIEW
,
480 $permissionClause = '(1)';
483 $query .= " $extends AND $permissionClause
484 ORDER BY $cgTable.weight, $cgTable.title,
485 custom_field.weight, custom_field.label";
487 $dao = CRM_Core_DAO
::executeQuery($query);
490 while (($dao->fetch()) != NULL) {
491 $regexp = preg_replace('/[.,;:!?]/', '', NULL);
492 $fields[$dao->id
]['id'] = $dao->id
;
493 $fields[$dao->id
]['label'] = $dao->label
;
494 // This seems broken, but not in a new way.
495 $fields[$dao->id
]['headerPattern'] = '/' . preg_quote($regexp, '/') . '/';
496 // To support the consolidation of various functions & their expectations.
497 $fields[$dao->id
]['title'] = $dao->label
;
498 $fields[$dao->id
]['custom_field_id'] = $dao->id
;
499 $fields[$dao->id
]['groupTitle'] = $dao->title
;
500 $fields[$dao->id
]['data_type'] = $dao->data_type
;
501 $fields[$dao->id
]['name'] = 'custom_' . $dao->id
;
502 $fields[$dao->id
]['type'] = CRM_Utils_Array
::value($dao->data_type
, self
::dataToType());
503 $fields[$dao->id
]['html_type'] = $dao->html_type
;
504 $fields[$dao->id
]['default_value'] = $dao->default_value
;
505 $fields[$dao->id
]['text_length'] = $dao->text_length
;
506 $fields[$dao->id
]['options_per_line'] = $dao->options_per_line
;
507 $fields[$dao->id
]['custom_group_id'] = $dao->custom_group_id
;
508 $fields[$dao->id
]['extends'] = $dao->extends;
509 $fields[$dao->id
]['is_search_range'] = $dao->is_search_range
;
510 $fields[$dao->id
]['extends_entity_column_value'] = $dao->extends_entity_column_value
;
511 $fields[$dao->id
]['extends_entity_column_id'] = $dao->extends_entity_column_id
;
512 $fields[$dao->id
]['is_view'] = $dao->is_view
;
513 $fields[$dao->id
]['is_multiple'] = $dao->is_multiple
;
514 $fields[$dao->id
]['option_group_id'] = $dao->option_group_id
;
515 $fields[$dao->id
]['date_format'] = $dao->date_format
;
516 $fields[$dao->id
]['time_format'] = $dao->time_format
;
517 $fields[$dao->id
]['is_required'] = $dao->is_required
;
518 $fields[$dao->id
]['table_name'] = $dao->table_name
;
519 $fields[$dao->id
]['column_name'] = $dao->column_name
;
520 $fields[$dao->id
]['serialize'] = $serializeField ?
$dao->serialize
: (int) self
::isSerialized($dao);
521 $fields[$dao->id
]['where'] = $dao->table_name
. '.' . $dao->column_name
;
522 // Probably we should use a different fn to get the extends tables but this is a refactor so not changing that now.
523 $fields[$dao->id
]['extends_table'] = array_key_exists($dao->extends, CRM_Core_BAO_CustomQuery
::$extendsMap) ? CRM_Core_BAO_CustomQuery
::$extendsMap[$dao->extends] : '';
524 if (in_array($dao->extends, CRM_Contact_BAO_ContactType
::subTypes())) {
525 // if $extends is a subtype, refer contact table
526 $fields[$dao->id
]['extends_table'] = 'civicrm_contact';
528 // Search table is used by query object searches..
529 $fields[$dao->id
]['search_table'] = ($fields[$dao->id
]['extends_table'] == 'civicrm_contact') ?
'contact_a' : $fields[$dao->id
]['extends_table'];
530 self
::getOptionsForField($fields[$dao->id
], $dao->option_group_name
);
533 Civi
::cache('fields')->set("custom importableFields $cacheKey", $fields);
535 self
::$_importFields[$cacheKey] = $fields;
538 return self
::$_importFields[$cacheKey];
542 * Return the field ids and names (with groups) for import purpose.
544 * @param int|string $contactType Contact type
545 * @param bool $showAll
546 * If true returns all fields (includes disabled fields).
547 * @param bool $onlyParent
548 * Return fields ONLY related to basic types.
549 * @param bool $search
550 * When called from search and multiple records need to be returned.
551 * @param bool $checkPermission
552 * If false, do not include permissioning clause.
554 * @param bool $withMultiple
558 public static function getFieldsForImport(
559 $contactType = 'Individual',
563 $checkPermission = TRUE,
564 $withMultiple = FALSE
566 // Note: there are situations when we want getFieldsForImport() return fields related
567 // ONLY to basic contact types, but NOT subtypes. And thats where $onlyParent is helpful
568 $fields = &self
::getFields($contactType,
578 $importableFields = [];
579 foreach ($fields as $id => $values) {
580 // for now we should not allow multiple fields in profile / export etc, hence unsetting
582 (!empty($values['is_multiple']) && !$withMultiple)
586 if (!empty($values['text_length'])) {
587 $values['maxlength'] = (int) $values['text_length'];
590 /* generate the key for the fields array */
593 $importableFields[$key] = $values;
594 $importableFields[$key]['import'] = 1;
597 return $importableFields;
601 * Get the field id from an import key.
611 public static function getKeyID($key, $all = FALSE) {
613 if (preg_match('/^custom_(\d+)_?(-?\d+)?$/', $key, $match)) {
620 CRM_Utils_Array
::value(2, $match),
624 return $all ?
[NULL, NULL] : NULL;
628 * Use the cache to get all values of a specific custom field.
630 * @param int $fieldID
631 * The custom field ID.
633 * @return CRM_Core_BAO_CustomField
635 * @throws CRM_Core_Exception
637 public static function getFieldObject($fieldID) {
638 $field = new CRM_Core_BAO_CustomField();
640 // check if we can get the field values from the system cache
641 $cacheKey = "CRM_Core_DAO_CustomField_{$fieldID}";
642 $cache = CRM_Utils_Cache
::singleton();
643 $fieldValues = $cache->get($cacheKey);
644 if (empty($fieldValues)) {
645 $field->id
= $fieldID;
646 if (!$field->find(TRUE)) {
647 throw new CRM_Core_Exception('Cannot find Custom Field');
651 CRM_Core_DAO
::storeValues($field, $fieldValues);
653 $cache->set($cacheKey, $fieldValues);
656 $field->copyValues($fieldValues);
663 * Add a custom field to an existing form.
665 * @param CRM_Core_Form $qf
666 * Form object (reference).
667 * @param string $elementName
668 * Name of the custom field.
669 * @param int $fieldId
670 * @param bool $useRequired
671 * True if required else false.
672 * @param bool $search
673 * True if used for search else false.
674 * @param string $label
675 * Label for custom field.
676 * @return \HTML_QuickForm_Element|null
677 * @throws \CiviCRM_API3_Exception
679 public static function addQuickFormElement(
680 $qf, $elementName, $fieldId, $useRequired = TRUE, $search = FALSE, $label = NULL
682 $field = self
::getFieldObject($fieldId);
683 $widget = $field->html_type
;
685 $customFieldAttributes = [];
687 if (!isset($label)) {
688 $label = $field->label
;
691 // DAO stores attributes as a string, but it's hard to manipulate and
692 // CRM_Core_Form::add() wants them as an array.
693 $fieldAttributes = self
::attributesFromString($field->attributes
);
695 // Custom field HTML should indicate group+field name
696 $groupName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup', $field->custom_group_id
);
697 $fieldAttributes['data-crm-custom'] = $groupName . ':' . $field->name
;
699 // Fixed for Issue CRM-2183
700 if ($widget == 'TextArea' && $search) {
704 $placeholder = $search ?
ts('- any %1 -', [1 => $label]) : ts('- select %1 -', [1 => $label]);
706 if (in_array($widget, [
711 $options = $field->getOptions($search ?
'search' : 'create');
713 // Consolidate widget types to simplify the below switch statement
718 // Search field is always multi-select
719 if ($search ||
(self
::isSerialized($field) && $widget === 'Select')) {
720 $fieldAttributes['class'] = ltrim(($fieldAttributes['class'] ??
'') . ' huge');
721 $fieldAttributes['multiple'] = 'multiple';
722 $fieldAttributes['placeholder'] = $placeholder;
725 // Add data for popup link. Normally this is handled by CRM_Core_Form->addSelect
726 $canEditOptions = CRM_Core_Permission
::check('administer CiviCRM');
727 if ($field->option_group_id
&& !$search && $canEditOptions) {
728 $customFieldAttributes +
= [
729 'data-api-entity' => $field->getEntity(),
730 'data-api-field' => 'custom_' . $field->id
,
731 'data-option-edit-path' => 'civicrm/admin/options/' . CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', $field->option_group_id
),
733 $fieldAttributes = array_merge($fieldAttributes, $customFieldAttributes);
737 $rangeDataTypes = ['Int', 'Float', 'Money'];
739 // at some point in time we might want to split the below into small functions
744 if ($field->is_search_range
&& $search && in_array($field->data_type
, $rangeDataTypes)) {
745 $qf->add('text', $elementName . '_from', $label . ' ' . ts('From'), $fieldAttributes);
746 $qf->add('text', $elementName . '_to', ts('To'), $fieldAttributes);
749 if ($field->text_length
) {
750 $fieldAttributes['maxlength'] = $field->text_length
;
751 if ($field->text_length
< 20) {
752 $fieldAttributes['size'] = $field->text_length
;
755 $element = $qf->add('text', $elementName, $label,
757 $useRequired && !$search
763 $fieldAttributes['rows'] = $field->note_rows ??
4;
764 $fieldAttributes['cols'] = $field->note_columns ??
60;
766 if ($field->text_length
) {
767 $fieldAttributes['maxlength'] = $field->text_length
;
769 $element = $qf->add('textarea',
773 $useRequired && !$search
778 //CRM-18379: Fix for date range of 'Select Date' custom field when include in profile.
779 $minYear = isset($field->start_date_years
) ?
(date('Y') - $field->start_date_years
) : NULL;
780 $maxYear = isset($field->end_date_years
) ?
(date('Y') +
$field->end_date_years
) : NULL;
783 'date' => $field->date_format
,
784 'minDate' => isset($minYear) ?
$minYear . '-01-01' : NULL,
785 //CRM-18487 - max date should be the last date of the year.
786 'maxDate' => isset($maxYear) ?
$maxYear . '-12-31' : NULL,
787 'time' => $field->time_format ?
$field->time_format
* 12 : FALSE,
789 if ($field->is_search_range
&& $search) {
790 $qf->add('datepicker', $elementName . '_from', $label, $fieldAttributes +
array('placeholder' => ts('From')), FALSE, $params);
791 $qf->add('datepicker', $elementName . '_to', NULL, $fieldAttributes +
array('placeholder' => ts('To')), FALSE, $params);
794 $element = $qf->add('datepicker', $elementName, $label, $fieldAttributes, $useRequired && !$search, $params);
799 if ($field->is_search_range
&& $search && in_array($field->data_type
, $rangeDataTypes)) {
800 $qf->add('text', $elementName . '_from', $label . ' ' . ts('From'), $fieldAttributes);
801 $qf->add('text', $elementName . '_to', ts('To'), $fieldAttributes);
804 $fieldAttributes = array_merge($fieldAttributes, $customFieldAttributes);
805 if ($search ||
empty($useRequired)) {
806 $fieldAttributes['allowClear'] = TRUE;
808 $qf->addRadio($elementName, $label, $options, $fieldAttributes, NULL, $useRequired);
812 // For all select elements
814 $fieldAttributes['class'] = ltrim(($fieldAttributes['class'] ??
'') . ' crm-select2');
816 if (empty($fieldAttributes['multiple'])) {
817 $options = ['' => $placeholder] +
$options;
819 $element = $qf->add('select', $elementName, $label, $options, $useRequired && !$search, $fieldAttributes);
821 // Add and/or option for fields that store multiple values
822 if ($search && self
::isSerialized($field)) {
823 $qf->addRadio($elementName . '_operator', '', [
826 ], [], NULL, FALSE, [
827 'or' => ['title' => ts('Results may contain any of the selected options')],
828 'and' => ['title' => ts('Results must have all of the selected options')],
830 $qf->setDefaults([$elementName . '_operator' => 'or']);
836 foreach ($options as $v => $l) {
837 // TODO: I'm not sure if this is supposed to exclude whatever might be
838 // in $field->attributes (available in array format as
839 // $fieldAttributes). Leaving as-is for now.
840 $check[] = &$qf->addElement('advcheckbox', $v, NULL, $l, $customFieldAttributes);
843 $group = $element = $qf->addGroup($check, $elementName, $label);
844 $optionEditKey = 'data-option-edit-path';
845 if (isset($customFieldAttributes[$optionEditKey])) {
846 $group->setAttribute($optionEditKey, $customFieldAttributes[$optionEditKey]);
849 if ($useRequired && !$search) {
850 $qf->addRule($elementName, ts('%1 is a required field.', [1 => $label]), 'required');
855 // we should not build upload file in search mode
860 strtolower($field->html_type
),
864 $useRequired && !$search
866 $qf->addUploadElement($elementName);
869 case 'RichTextEditor':
870 $fieldAttributes['rows'] = $field->note_rows
;
871 $fieldAttributes['cols'] = $field->note_columns
;
872 if ($field->text_length
) {
873 $fieldAttributes['maxlength'] = $field->text_length
;
875 $element = $qf->add('wysiwyg', $elementName, $label, $fieldAttributes, $useRequired && !$search);
878 case 'Autocomplete-Select':
879 static $customUrls = [];
880 if ($field->data_type
== 'ContactReference') {
881 // break if contact does not have permission to access ContactReference
882 if (!CRM_Core_Permission
::check('access contact reference fields')) {
885 $fieldAttributes['class'] = ltrim(($fieldAttributes['class'] ??
'') . ' crm-form-contact-reference huge');
886 $fieldAttributes['data-api-entity'] = 'Contact';
887 if (!empty($field->serialize
) ||
$search) {
888 $fieldAttributes['multiple'] = TRUE;
890 $element = $qf->add('text', $elementName, $label, $fieldAttributes, $useRequired && !$search);
892 $urlParams = "context=customfield&id={$field->id}";
893 $idOfelement = $elementName;
894 // dev/core#362 if in an onbehalf profile clean up the name to get rid of square brackets that break the select 2 js
895 // However this caused regression https://lab.civicrm.org/dev/core/issues/619 so it has been hacked back to
896 // only affecting on behalf - next time someone looks at this code it should be with a view to overhauling it
897 // rather than layering on more hacks.
898 if (substr($elementName, 0, 8) === 'onbehalf' && strpos($elementName, '[') && strpos($elementName, ']')) {
899 $idOfelement = substr(substr($elementName, (strpos($elementName, '[') +
1)), 0, -1);
901 $customUrls[$idOfelement] = CRM_Utils_System
::url('civicrm/ajax/contactref',
908 // FIXME: This won't work with customFieldOptions hook
909 $fieldAttributes +
= [
910 'entity' => 'OptionValue',
911 'placeholder' => $placeholder,
912 'multiple' => $search ?
TRUE : !empty($field->serialize
),
914 'params' => ['option_group_id' => $field->option_group_id
, 'is_active' => 1],
917 $element = $qf->addEntityRef($elementName, $label, $fieldAttributes, $useRequired && !$search);
920 $qf->assign('customUrls', $customUrls);
924 switch ($field->data_type
) {
926 // integers will have numeric rule applied to them.
927 if ($field->is_search_range
&& $search && $widget != 'Select') {
928 $qf->addRule($elementName . '_from', ts('%1 From must be an integer (whole number).', [1 => $label]), 'integer');
929 $qf->addRule($elementName . '_to', ts('%1 To must be an integer (whole number).', [1 => $label]), 'integer');
931 elseif ($widget == 'Text') {
932 $qf->addRule($elementName, ts('%1 must be an integer (whole number).', [1 => $label]), 'integer');
937 if ($field->is_search_range
&& $search) {
938 $qf->addRule($elementName . '_from', ts('%1 From must be a number (with or without decimal point).', [1 => $label]), 'numeric');
939 $qf->addRule($elementName . '_to', ts('%1 To must be a number (with or without decimal point).', [1 => $label]), 'numeric');
941 elseif ($widget == 'Text') {
942 $qf->addRule($elementName, ts('%1 must be a number (with or without decimal point).', [1 => $label]), 'numeric');
947 if ($field->is_search_range
&& $search) {
948 $qf->addRule($elementName . '_from', ts('%1 From must in proper money format. (decimal point/comma/space is allowed).', [1 => $label]), 'money');
949 $qf->addRule($elementName . '_to', ts('%1 To must in proper money format. (decimal point/comma/space is allowed).', [1 => $label]), 'money');
951 elseif ($widget == 'Text') {
952 $qf->addRule($elementName, ts('%1 must be in proper money format. (decimal point/comma/space is allowed).', [1 => $label]), 'money');
957 $element->setAttribute('class', "url");
958 $qf->addRule($elementName, ts('Enter a valid web address beginning with \'http://\' or \'https://\'.'), 'wikiURL');
961 if ($field->is_view
&& !$search) {
962 $qf->freeze($elementName);
968 * Take a string of HTML element attributes and turn it into an associative
971 * @param string $attrString
972 * The attributes as a string, e.g. `rows=3 cols=40`.
975 * The attributes as an array, e.g. `['rows' => 3, 'cols' => 40]`.
977 public static function attributesFromString($attrString) {
979 foreach (explode(' ', $attrString) as $at) {
980 if (strpos($at, '=')) {
981 list($k, $v) = explode('=', $at);
982 $attributes[$k] = trim($v, ' "');
989 * Delete the Custom Field.
991 * @param object $field
994 public static function deleteField($field) {
995 CRM_Utils_System
::flushCache();
997 // first delete the custom option group and values associated with this field
998 if ($field->option_group_id
) {
999 //check if option group is related to any other field, if
1000 //not delete the option group and related option values
1001 self
::checkOptionGroup($field->option_group_id
);
1003 // next drop the column from the custom value table
1004 self
::createField($field, 'delete');
1007 CRM_Core_BAO_UFField
::delUFField($field->id
);
1008 CRM_Core_BAO_Mapping
::removeFieldFromMapping('custom_' . $field->id
);
1009 CRM_Utils_Weight
::correctDuplicateWeights('CRM_Core_DAO_CustomField');
1011 CRM_Utils_Hook
::post('delete', 'CustomField', $field->id
, $field);
1015 * @param string|int|array|null $value
1016 * @param CRM_Core_BAO_CustomField|int|array|string $field
1017 * @param int $entityId
1021 * @throws \CRM_Core_Exception
1023 public static function displayValue($value, $field, $entityId = NULL) {
1024 $field = is_array($field) ?
$field['id'] : $field;
1025 $fieldId = is_object($field) ?
$field->id
: (int) str_replace('custom_', '', $field);
1028 throw new CRM_Core_Exception('CRM_Core_BAO_CustomField::displayValue requires a field id');
1031 if (!is_a($field, 'CRM_Core_BAO_CustomField')) {
1032 $field = self
::getFieldObject($fieldId);
1035 $fieldInfo = ['options' => $field->getOptions()] +
(array) $field;
1037 $displayValue = self
::formatDisplayValue($value, $fieldInfo, $entityId);
1039 // Call hook to alter display value.
1040 CRM_Utils_Hook
::alterCustomFieldDisplayValue($displayValue, $value, $entityId, $fieldInfo);
1042 return $displayValue;
1046 * Lower-level logic for rendering a custom field value
1048 * @param string|array $value
1049 * @param array $field
1050 * @param int|null $entityId
1054 private static function formatDisplayValue($value, $field, $entityId = NULL) {
1056 if (self
::isSerialized($field) && !is_array($value)) {
1057 $value = CRM_Utils_Array
::explodePadded($value);
1060 if ($field['html_type'] == 'CheckBox' && $value) {
1061 $value = CRM_Utils_Array
::convertCheckboxFormatToArray($value);
1064 $display = is_array($value) ?
implode(', ', $value) : (string) $value;
1066 switch ($field['html_type']) {
1069 case 'Autocomplete-Select':
1072 if ($field['data_type'] == 'ContactReference' && (is_array($value) ||
is_numeric($value))) {
1074 foreach ((array) $value as $contactId) {
1075 $displayNames[] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $contactId, 'display_name');
1077 $display = implode(', ', $displayNames);
1079 elseif ($field['data_type'] == 'ContactReference') {
1082 elseif (is_array($value)) {
1084 foreach ($value as $key => $val) {
1085 $v[] = $field['options'][$val] ??
NULL;
1087 $display = implode(', ', $v);
1090 $display = CRM_Utils_Array
::value($value, $field['options'], '');
1091 // For float type (see Number and Money) $value would be decimal like
1092 // 1.00 (because it is stored in db as decimal), while options array
1093 // key would be integer like 1. In this case expression on line above
1094 // would return empty string (default value), despite the fact that
1095 // matching option exists in the array.
1096 // In such cases we could just get intval($value) and fetch matching
1097 // option again, but this would not work if key is float like 5.6.
1098 // So we need to truncate trailing zeros to make it work as expected.
1099 if ($display === '' && strpos($value, '.') !== FALSE) {
1100 // Use round() to truncate trailing zeros, e.g:
1101 // 10.00 -> 10, 10.60 -> 10.6, 10.69 -> 10.69.
1102 $value = (string) round($value, 5);
1103 $display = $field['options'][$value] ??
'';
1109 $customFormat = NULL;
1111 // FIXME: Are there any legitimate reasons why $value would be an array?
1112 // Or should we throw an exception here if it is?
1113 $value = is_array($value) ? CRM_Utils_Array
::first($value) : $value;
1115 $actualPHPFormats = CRM_Utils_Date
::datePluginToPHPFormats();
1116 $format = $field['date_format'] ??
NULL;
1119 if (array_key_exists($format, $actualPHPFormats)) {
1120 $customTimeFormat = (array) $actualPHPFormats[$format];
1121 switch (CRM_Utils_Array
::value('time_format', $field)) {
1123 $customTimeFormat[] = 'g:iA';
1127 $customTimeFormat[] = 'G:i';
1131 //If time is not selected remove time from value.
1132 $value = $value ?
date('Y-m-d', strtotime($value)) : '';
1134 $customFormat = implode(" ", $customTimeFormat);
1137 $display = CRM_Utils_Date
::processDate($value, NULL, FALSE, $customFormat);
1141 // In the context of displaying a profile, show file/image
1144 if (CRM_Utils_Rule
::positiveInteger($value)) {
1148 $fileId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_File', $value, 'id', 'uri');
1150 $url = self
::getFileURL($entityId, $field['id'], $fileId);
1152 $display = $url['file_url'];
1156 // In other contexts show a paperclip icon
1157 if (CRM_Utils_Rule
::integer($value)) {
1158 $icons = CRM_Core_BAO_File
::paperIconAttachment('*', $value);
1160 $file_description = '';
1162 $file_description = civicrm_api3('File', 'getvalue', ['return' => "description", 'id' => $value]);
1164 catch (CiviCRM_API3_Exception
$dontcare) {
1168 $display = "{$icons[$value]}{$file_description}";
1171 //CRM-18396, if filename is passed instead
1179 $display = $display ?
"<a href=\"$display\" target=\"_blank\">$display</a>" : $display;
1183 $display = nl2br($display);
1187 if ($field['data_type'] == 'Money' && isset($value)) {
1188 // $value can also be an array(while using IN operator from search builder or api).
1189 foreach ((array) $value as $val) {
1190 $disp[] = CRM_Utils_Money
::formatLocaleNumericRoundedForDefaultCurrency($val);
1192 $display = implode(', ', $disp);
1200 * Set default values for custom data used in profile.
1202 * @param int $customFieldId
1204 * @param string $elementName
1205 * Custom field name.
1206 * @param array $defaults
1207 * Associated array of fields.
1208 * @param int $contactId
1212 * @param mixed $value
1213 * If passed - dont fetch value from db,.
1214 * just format the given value
1216 public static function setProfileDefaults(
1224 //get the type of custom field
1225 $customField = new CRM_Core_BAO_CustomField();
1226 $customField->id
= $customFieldId;
1227 $customField->find(TRUE);
1230 if ($mode == CRM_Profile_Form
::MODE_CREATE
) {
1231 $value = $customField->default_value
;
1235 if (!isset($value)) {
1236 $info = self
::getTableColumnGroup($customFieldId);
1237 $query = "SELECT {$info[0]}.{$info[1]} as value FROM {$info[0]} WHERE {$info[0]}.entity_id = {$contactId}";
1238 $result = CRM_Core_DAO
::executeQuery($query);
1239 if ($result->fetch()) {
1240 $value = $result->value
;
1244 if ($customField->data_type
== 'Country') {
1246 $config = CRM_Core_Config
::singleton();
1247 if ($config->defaultContactCountry
) {
1248 $value = CRM_Core_BAO_Country
::defaultContactCountry();
1254 //set defaults if mode is registration
1255 if (!trim($value) &&
1257 (!in_array($mode, [CRM_Profile_Form
::MODE_EDIT
, CRM_Profile_Form
::MODE_SEARCH
]))
1259 $value = $customField->default_value
;
1262 if ($customField->data_type
== 'Money' && isset($value)) {
1263 $value = number_format($value, 2);
1265 if (self
::isSerialized($customField) && $value) {
1266 $customOption = CRM_Core_BAO_CustomOption
::getCustomOption($customFieldId, FALSE);
1267 $defaults[$elementName] = [];
1268 $checkedValue = CRM_Utils_Array
::explodePadded($value);
1269 foreach ($customOption as $val) {
1270 if (in_array($val['value'], $checkedValue)) {
1271 if ($customField->html_type
== 'CheckBox') {
1272 $defaults[$elementName][$val['value']] = 1;
1275 $defaults[$elementName][$val['value']] = $val['value'];
1281 $defaults[$elementName] = $value;
1288 * @param int $contactID
1290 * @param int $fileID
1291 * @param bool $absolute
1293 * @param string $multiRecordWhereClause
1297 public static function getFileURL($contactID, $cfID, $fileID = NULL, $absolute = FALSE, $multiRecordWhereClause = NULL) {
1300 $params = ['id' => $cfID];
1302 CRM_Core_DAO
::commonRetrieve('CRM_Core_DAO_CustomField', $params, $defaults);
1303 $columnName = $defaults['column_name'];
1305 //table name of custom data
1306 $tableName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup',
1307 $defaults['custom_group_id'],
1311 //query to fetch id from civicrm_file
1312 if ($multiRecordWhereClause) {
1313 $query = "SELECT {$columnName} FROM {$tableName} where entity_id = {$contactID} AND {$multiRecordWhereClause}";
1316 $query = "SELECT {$columnName} FROM {$tableName} where entity_id = {$contactID}";
1318 $fileID = CRM_Core_DAO
::singleValueQuery($query);
1323 $fileType = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_File',
1328 $result['file_id'] = $fileID;
1330 if ($fileType == 'image/jpeg' ||
1331 $fileType == 'image/pjpeg' ||
1332 $fileType == 'image/gif' ||
1333 $fileType == 'image/x-png' ||
1334 $fileType == 'image/png'
1336 $entityId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_EntityFile',
1341 list($path) = CRM_Core_BAO_File
::path($fileID, $entityId);
1342 $fileHash = CRM_Core_BAO_File
::generateFileHash($entityId, $fileID);
1343 $url = CRM_Utils_System
::url('civicrm/file',
1344 "reset=1&id=$fileID&eid=$entityId&fcs=$fileHash",
1345 $absolute, NULL, TRUE, TRUE
1347 $result['file_url'] = CRM_Utils_File
::getFileURL($path, $fileType, $url);
1349 // for non image files
1351 $uri = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_File',
1355 $fileHash = CRM_Core_BAO_File
::generateFileHash($contactID, $fileID);
1356 $url = CRM_Utils_System
::url('civicrm/file',
1357 "reset=1&id=$fileID&eid=$contactID&fcs=$fileHash",
1358 $absolute, NULL, TRUE, TRUE
1360 $result['file_url'] = CRM_Utils_File
::getFileURL($uri, $fileType, $url);
1368 * Format custom fields before inserting.
1370 * @param int $customFieldId
1372 * @param array $customFormatted
1374 * @param mixed $value
1375 * Value of custom field.
1376 * @param string $customFieldExtend
1377 * Custom field extends.
1378 * @param int $customValueId
1379 * Custom option value id.
1380 * @param int $entityId
1381 * Entity id (contribution, membership...).
1382 * @param bool $inline
1383 * Consider inline custom groups only.
1384 * @param bool $checkPermission
1385 * If false, do not include permissioning clause.
1386 * @param bool $includeViewOnly
1387 * If true, fields marked 'View Only' are included. Required for APIv3.
1389 * @return array|NULL
1390 * formatted custom field array
1392 public static function formatCustomField(
1393 $customFieldId, &$customFormatted, $value,
1394 $customFieldExtend, $customValueId = NULL,
1397 $checkPermission = TRUE,
1398 $includeViewOnly = FALSE
1400 //get the custom fields for the entity
1401 //subtype and basic type
1402 $customDataSubType = NULL;
1403 if ($customFieldExtend) {
1404 // This is the case when getFieldsForImport() requires fields
1405 // of subtype and its parent.CRM-5143
1406 // CRM-16065 - Custom field set data not being saved if contact has more than one contact sub type
1407 $customDataSubType = array_intersect(CRM_Contact_BAO_ContactType
::subTypes(), (array) $customFieldExtend);
1408 if (!empty($customDataSubType) && is_array($customDataSubType)) {
1409 $customFieldExtend = CRM_Contact_BAO_ContactType
::getBasicType($customDataSubType);
1410 if (is_array($customFieldExtend)) {
1411 $customFieldExtend = array_unique(array_values($customFieldExtend));
1416 $customFields = CRM_Core_BAO_CustomField
::getFields($customFieldExtend,
1426 if (!array_key_exists($customFieldId, $customFields)) {
1430 // return if field is a 'code' field
1431 if (!$includeViewOnly && !empty($customFields[$customFieldId]['is_view'])) {
1435 list($tableName, $columnName, $groupID) = self
::getTableColumnGroup($customFieldId);
1437 if (!$customValueId &&
1438 // we always create new entites for is_multiple unless specified
1439 !$customFields[$customFieldId]['is_multiple'] &&
1445 WHERE entity_id={$entityId}";
1447 $customValueId = CRM_Core_DAO
::singleValueQuery($query);
1450 //fix checkbox, now check box always submits values
1451 if ($customFields[$customFieldId]['html_type'] == 'CheckBox') {
1453 // Note that only during merge this is not an array, and you can directly use value
1454 if (is_array($value)) {
1455 $selectedValues = [];
1456 foreach ($value as $selId => $val) {
1458 $selectedValues[] = $selId;
1461 if (!empty($selectedValues)) {
1462 $value = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1464 ) . CRM_Core_DAO
::VALUE_SEPARATOR
;
1472 elseif (self
::isSerialized($customFields[$customFieldId])) {
1473 // Select2 v3 returns a comma-separated string.
1474 if ($customFields[$customFieldId]['html_type'] == 'Autocomplete-Select' && is_string($value)) {
1475 $value = explode(',', $value);
1478 $value = $value ? CRM_Utils_Array
::implodePadded($value) : '';
1481 if (self
::isSerialized($customFields[$customFieldId]) &&
1482 $customFields[$customFieldId]['data_type'] == 'String' &&
1483 !empty($customFields[$customFieldId]['text_length']) &&
1486 // lets make sure that value is less than the length, else we'll
1487 // be losing some data, CRM-7481
1488 if (strlen($value) >= $customFields[$customFieldId]['text_length']) {
1489 // need to do a few things here
1491 // 1. lets find a new length
1492 $newLength = $customFields[$customFieldId]['text_length'];
1493 $minLength = strlen($value);
1494 while ($newLength < $minLength) {
1495 $newLength = $newLength * 2;
1498 // set the custom field meta data to have a length larger than value
1499 // alter the custom value table column to match this length
1500 CRM_Core_BAO_SchemaHandler
::alterFieldLength($customFieldId, $tableName, $columnName, $newLength);
1505 if ($customFields[$customFieldId]['data_type'] == 'Date') {
1506 if (!CRM_Utils_System
::isNull($value)) {
1507 $format = $customFields[$customFieldId]['date_format'];
1508 $date = CRM_Utils_Date
::processDate($value, NULL, FALSE, 'YmdHis', $format);
1513 if ($customFields[$customFieldId]['data_type'] == 'Float' ||
1514 $customFields[$customFieldId]['data_type'] == 'Money'
1520 if ($customFields[$customFieldId]['data_type'] == 'Money') {
1521 $value = CRM_Utils_Rule
::cleanMoney($value);
1525 if (($customFields[$customFieldId]['data_type'] == 'StateProvince' ||
1526 $customFields[$customFieldId]['data_type'] == 'Country'
1536 if ($customFields[$customFieldId]['data_type'] == 'File') {
1537 if (empty($value)) {
1541 $config = CRM_Core_Config
::singleton();
1543 // If we are already passing the file id as a value then retrieve and set the file data
1544 if (CRM_Utils_Rule
::integer($value)) {
1545 $fileDAO = new CRM_Core_DAO_File();
1546 $fileDAO->id
= $value;
1547 $fileDAO->find(TRUE);
1550 $fName = $fileDAO->uri
;
1551 $mimeType = $fileDAO->mime_type
;
1555 $fName = $value['name'];
1556 $mimeType = $value['type'];
1559 $filename = pathinfo($fName, PATHINFO_BASENAME
);
1561 // rename this file to go into the secure directory only if
1562 // user has uploaded new file not existing verfied on the basis of $fileID
1563 if (empty($fileID) && !rename($fName, $config->customFileUploadDir
. $filename)) {
1564 CRM_Core_Error
::statusBounce(ts('Could not move custom file to custom upload directory'));
1567 if ($customValueId && empty($fileID)) {
1572 $params = [1 => [$customValueId, 'Integer']];
1573 $fileID = CRM_Core_DAO
::singleValueQuery($query, $params);
1576 $fileDAO = new CRM_Core_DAO_File();
1579 $fileDAO->id
= $fileID;
1582 $fileDAO->uri
= $filename;
1583 $fileDAO->mime_type
= $mimeType;
1584 $fileDAO->upload_date
= date('YmdHis');
1586 $fileID = $fileDAO->id
;
1590 if (!is_array($customFormatted)) {
1591 $customFormatted = [];
1594 if (!array_key_exists($customFieldId, $customFormatted)) {
1595 $customFormatted[$customFieldId] = [];
1599 if ($customValueId) {
1600 $index = $customValueId;
1603 if (!array_key_exists($index, $customFormatted[$customFieldId])) {
1604 $customFormatted[$customFieldId][$index] = [];
1606 $customFormatted[$customFieldId][$index] = [
1607 'id' => $customValueId > 0 ?
$customValueId : NULL,
1609 'type' => $customFields[$customFieldId]['data_type'],
1610 'custom_field_id' => $customFieldId,
1611 'custom_group_id' => $groupID,
1612 'table_name' => $tableName,
1613 'column_name' => $columnName,
1614 'file_id' => $fileID,
1615 'is_multiple' => $customFields[$customFieldId]['is_multiple'],
1618 //we need to sort so that custom fields are created in the order of entry
1619 krsort($customFormatted[$customFieldId]);
1620 return $customFormatted;
1624 * Get default custom table schema.
1626 * @param array $params
1630 public static function defaultCustomTableSchema($params) {
1631 // add the id and extends_id
1632 $collation = CRM_Core_BAO_SchemaHandler
::getInUseCollation();
1633 $characterSet = 'utf8';
1634 if (stripos($collation, 'utf8mb4') !== FALSE) {
1635 $characterSet = 'utf8mb4';
1638 'name' => $params['name'],
1639 'is_multiple' => $params['is_multiple'],
1640 'attributes' => "ENGINE=InnoDB DEFAULT CHARACTER SET {$characterSet} COLLATE {$collation}",
1644 'type' => 'int unsigned',
1647 'attributes' => 'AUTO_INCREMENT',
1648 'comment' => 'Default MySQL primary key',
1651 'name' => 'entity_id',
1652 'type' => 'int unsigned',
1654 'comment' => 'Table that this extends',
1655 'fk_table_name' => $params['extends_name'],
1656 'fk_field_name' => 'id',
1657 'fk_attributes' => 'ON DELETE CASCADE',
1662 // If on MySQL 5.6 include ROW_FORMAT=DYNAMIC to fix unit tests
1663 $databaseVersion = CRM_Utils_SQL
::getDatabaseVersion();
1664 if (version_compare($databaseVersion, '5.7', '<') && version_compare($databaseVersion, '5.6', '>=')) {
1665 $table['attributes'] = $table['attributes'] . ' ROW_FORMAT=DYNAMIC';
1668 if (!$params['is_multiple']) {
1669 $table['indexes'] = [
1672 'field_name_1' => 'entity_id',
1680 * Create custom field.
1682 * @param CRM_Core_DAO_CustomField $field
1683 * @param string $operation
1685 public static function createField($field, $operation) {
1686 $sql = str_repeat(' ', 8);
1687 $tableName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup', $field->custom_group_id
, 'table_name');
1688 $sql .= "ALTER TABLE " . $tableName;
1689 $sql .= self
::getAlterFieldSQL($field, $operation);
1691 // CRM-7007: do not i18n-rewrite this query
1692 CRM_Core_DAO
::executeQuery($sql, [], TRUE, NULL, FALSE, FALSE);
1694 $config = CRM_Core_Config
::singleton();
1695 if ($config->logging
) {
1696 // CRM-16717 not sure why this was originally limited to add.
1697 // For example custom tables can have field length changes - which need to flow through to logging.
1698 // Are there any modifies we DON'T was to call this function for (& shouldn't it be clever enough to cope?)
1699 if ($operation === 'add' ||
$operation === 'modify') {
1700 $logging = new CRM_Logging_Schema();
1701 $logging->fixSchemaDifferencesFor($tableName, [trim(strtoupper($operation)) => [$field->column_name
]]);
1705 Civi
::service('sql_triggers')->rebuild($tableName, TRUE);
1709 * @param CRM_Core_DAO_CustomField $field
1710 * @param string $operation add|modify|delete
1714 public static function getAlterFieldSQL($field, $operation) {
1715 $params = self
::prepareCreateParams($field, $operation);
1716 // Let's suppress the required flag, since that can cause an sql issue... for unknown reasons since we are calling
1717 // a function only used by Custom Field creation...
1718 $params['required'] = FALSE;
1719 return CRM_Core_BAO_SchemaHandler
::getFieldAlterSQL($params);
1723 * Get query to reformat existing values for a field when changing its serialize attribute
1725 * @param CRM_Core_DAO_CustomField $field
1728 private static function getAlterSerializeSQL($field) {
1729 $table = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup', $field->custom_group_id
, 'table_name');
1730 $col = $field->column_name
;
1731 $sp = CRM_Core_DAO
::VALUE_SEPARATOR
;
1732 if ($field->serialize
) {
1733 return "UPDATE `$table` SET `$col` = CONCAT('$sp', `$col`, '$sp') WHERE `$col` IS NOT NULL AND `$col` NOT LIKE '$sp%' AND `$col` != ''";
1736 return "UPDATE `$table` SET `$col` = SUBSTRING_INDEX(SUBSTRING(`$col`, 2), '$sp', 1) WHERE `$col` LIKE '$sp%'";
1741 * Determine whether it would be safe to move a field.
1743 * @param int $fieldID
1744 * FK to civicrm_custom_field.
1745 * @param int $newGroupID
1746 * FK to civicrm_custom_group.
1749 * array(string) or TRUE
1751 public static function _moveFieldValidate($fieldID, $newGroupID) {
1754 $field = new CRM_Core_DAO_CustomField();
1755 $field->id
= $fieldID;
1756 if (!$field->find(TRUE)) {
1757 $errors['fieldID'] = 'Invalid ID for custom field';
1761 $oldGroup = new CRM_Core_DAO_CustomGroup();
1762 $oldGroup->id
= $field->custom_group_id
;
1763 if (!$oldGroup->find(TRUE)) {
1764 $errors['fieldID'] = 'Invalid ID for old custom group';
1768 $newGroup = new CRM_Core_DAO_CustomGroup();
1769 $newGroup->id
= $newGroupID;
1770 if (!$newGroup->find(TRUE)) {
1771 $errors['newGroupID'] = 'Invalid ID for new custom group';
1777 FROM civicrm_custom_field a
1778 INNER JOIN civicrm_custom_field b
1780 AND a.label = b.label
1781 AND b.custom_group_id = %2
1784 1 => [$field->id
, 'Integer'],
1785 2 => [$newGroup->id
, 'Integer'],
1787 $count = CRM_Core_DAO
::singleValueQuery($query, $params);
1789 $errors['newGroupID'] = ts('A field of the same label exists in the destination group');
1792 $tableName = $oldGroup->table_name
;
1793 $columnName = $field->column_name
;
1798 WHERE $columnName is not null
1800 $count = CRM_Core_DAO
::singleValueQuery($query);
1804 FROM civicrm_custom_group
1805 WHERE id IN ( %1, %2 )
1808 1 => [$oldGroup->id
, 'Integer'],
1809 2 => [$newGroup->id
, 'Integer'],
1812 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1814 while ($dao->fetch()) {
1815 $extends[] = $dao->extends;
1817 if ($extends[0] != $extends[1]) {
1818 $errors['newGroupID'] = ts('The destination group extends a different entity type.');
1822 return empty($errors) ?
TRUE : $errors;
1826 * Move a custom data field from one group (table) to another.
1828 * @param int $fieldID
1829 * FK to civicrm_custom_field.
1830 * @param int $newGroupID
1831 * FK to civicrm_custom_group.
1833 * @throws CRM_Core_Exception
1835 public static function moveField($fieldID, $newGroupID) {
1836 $validation = self
::_moveFieldValidate($fieldID, $newGroupID);
1837 if (TRUE !== $validation) {
1838 throw new CRM_Core_Exception(implode(' ', $validation));
1840 $field = new CRM_Core_DAO_CustomField();
1841 $field->id
= $fieldID;
1844 $newGroup = new CRM_Core_DAO_CustomGroup();
1845 $newGroup->id
= $newGroupID;
1846 $newGroup->find(TRUE);
1848 $oldGroup = new CRM_Core_DAO_CustomGroup();
1849 $oldGroup->id
= $field->custom_group_id
;
1850 $oldGroup->find(TRUE);
1853 $add->custom_group_id
= $newGroup->id
;
1854 self
::createField($add, 'add');
1856 $sql = "INSERT INTO {$newGroup->table_name} (entity_id, `{$field->column_name}`)
1857 SELECT entity_id, `{$field->column_name}` FROM {$oldGroup->table_name}
1858 ON DUPLICATE KEY UPDATE `{$field->column_name}` = {$oldGroup->table_name}.`{$field->column_name}`
1860 CRM_Core_DAO
::executeQuery($sql);
1863 $del->custom_group_id
= $oldGroup->id
;
1864 self
::createField($del, 'delete');
1868 CRM_Utils_System
::flushCache();
1872 * Create an option value for a custom field option group ID.
1874 * @param array $params
1875 * @param string $value
1876 * @param \CRM_Core_DAO_OptionGroup $optionGroup
1877 * @param string $index
1878 * @param string $dataType
1880 protected static function createOptionValue(&$params, $value, CRM_Core_DAO_OptionGroup
$optionGroup, $index, $dataType) {
1881 if (strlen(trim($value))) {
1882 $optionValue = new CRM_Core_DAO_OptionValue();
1883 $optionValue->option_group_id
= $optionGroup->id
;
1884 $optionValue->label
= $params['option_label'][$index];
1885 $optionValue->name
= $params['option_name'][$index] ?? CRM_Utils_String
::titleToVar($params['option_label'][$index]);
1886 switch ($dataType) {
1888 $optionValue->value
= CRM_Utils_Rule
::cleanMoney($value);
1892 $optionValue->value
= intval($value);
1896 $optionValue->value
= floatval($value);
1900 $optionValue->value
= trim($value);
1903 $optionValue->weight
= $params['option_weight'][$index];
1904 $optionValue->is_active
= $params['option_status'][$index] ??
FALSE;
1905 $optionValue->description
= $params['option_description'][$index] ??
NULL;
1906 $optionValue->color
= $params['option_color'][$index] ??
NULL;
1907 $optionValue->icon
= $params['option_icon'][$index] ??
NULL;
1908 $optionValue->save();
1913 * Prepare for the create operation.
1915 * Munge params, create the option values if needed.
1917 * This could be called by a single create or a batchCreate.
1919 * @param array $params
1923 protected static function prepareCreate($params) {
1924 $op = empty($params['id']) ?
'create' : 'edit';
1925 CRM_Utils_Hook
::pre($op, 'CustomField', CRM_Utils_Array
::value('id', $params), $params);
1926 $params['is_append_field_id_to_column_name'] = !isset($params['column_name']);
1927 if ($op === 'create') {
1928 CRM_Core_DAO
::setCreateDefaults($params, self
::getDefaults());
1929 if (!isset($params['column_name'])) {
1930 // if add mode & column_name not present, calculate it.
1931 $params['column_name'] = strtolower(CRM_Utils_String
::munge($params['label'], '_', 32));
1933 if (!isset($params['name'])) {
1934 $params['name'] = CRM_Utils_String
::munge($params['label'], '_', 64);
1938 $params['column_name'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField', $params['id'], 'column_name');
1941 $htmlType = $params['html_type'] ??
NULL;
1942 $dataType = $params['data_type'] ??
NULL;
1944 if ($htmlType === 'Select Date' && empty($params['date_format'])) {
1945 $params['date_format'] = Civi
::settings()->get('dateInputFormat');
1948 // Checkboxes are always serialized in current schema
1949 if ($htmlType == 'CheckBox') {
1950 $params['serialize'] = CRM_Core_DAO
::SERIALIZE_SEPARATOR_BOOKEND
;
1953 if (!empty($params['serialize'])) {
1954 if (isset($params['default_checkbox_option'])) {
1956 foreach (array_keys($params['default_checkbox_option']) as $k => $v) {
1957 if ($params['option_value'][$v]) {
1958 $defaultArray[] = $params['option_value'][$v];
1962 if (!empty($defaultArray)) {
1963 // also add the separator before and after the value per new convention (CRM-1604)
1964 $params['default_value'] = CRM_Utils_Array
::implodePadded($defaultArray);
1968 if (!empty($params['default_option']) && isset($params['option_value'][$params['default_option']])) {
1969 $params['default_value'] = $params['option_value'][$params['default_option']];
1974 // create any option group & values if required
1975 $allowedOptionTypes = ['String', 'Int', 'Float', 'Money'];
1976 if ($htmlType != 'Text' && in_array($dataType, $allowedOptionTypes)) {
1977 //CRM-16659: if option_value then create an option group for this custom field.
1978 if ($params['option_type'] == 1 && (empty($params['option_group_id']) ||
!empty($params['option_value']))) {
1979 // first create an option group for this custom group
1980 $optionGroup = new CRM_Core_DAO_OptionGroup();
1981 $optionGroup->name
= "{$params['column_name']}_" . date('YmdHis');
1982 $optionGroup->title
= $params['label'];
1983 $optionGroup->is_active
= 1;
1984 // Don't set reserved as it's not a built-in option group and may be useful for other custom fields.
1985 $optionGroup->is_reserved
= 0;
1986 $optionGroup->data_type
= $dataType;
1987 $optionGroup->save();
1988 $params['option_group_id'] = $optionGroup->id
;
1989 if (!empty($params['option_value']) && is_array($params['option_value'])) {
1990 foreach ($params['option_value'] as $k => $v) {
1991 self
::createOptionValue($params, $v, $optionGroup, $k, $dataType);
1997 // Remove option group IDs from fields changed to Text html_type.
1998 if ($htmlType == 'Text') {
1999 $params['option_group_id'] = '';
2002 // check for orphan option groups
2003 if (!empty($params['option_group_id'])) {
2004 if (!empty($params['id'])) {
2005 self
::fixOptionGroups($params['id'], $params['option_group_id']);
2008 // if we do not have a default value
2009 // retrieve it from one of the other custom fields which use this option group
2010 if (empty($params['default_value'])) {
2011 //don't insert only value separator as default value, CRM-4579
2012 $defaultValue = self
::getOptionGroupDefault($params['option_group_id'], !empty($params['serialize']));
2014 if (!CRM_Utils_System
::isNull(explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $defaultValue))) {
2015 $params['default_value'] = $defaultValue;
2020 // Set default textarea attributes
2021 if ($op == 'create' && !isset($params['attributes']) && $htmlType == 'TextArea') {
2022 $params['attributes'] = 'rows=4, cols=60';
2028 * Create database entry for custom field and related option groups.
2030 * @param array $params
2032 * @return CRM_Core_DAO_CustomField
2034 protected static function createCustomFieldRecord($params) {
2035 $transaction = new CRM_Core_Transaction();
2036 $params = self
::prepareCreate($params);
2038 $customField = new CRM_Core_DAO_CustomField();
2039 $customField->copyValues($params);
2040 $customField->save();
2042 //create/drop the index when we toggle the is_searchable flag
2043 $op = empty($params['id']) ?
'add' : 'modify';
2044 if ($op !== 'modify') {
2045 if ($params['is_append_field_id_to_column_name']) {
2046 $params['column_name'] .= "_{$customField->id}";
2048 $customField->column_name
= $params['column_name'];
2049 $customField->save();
2052 // complete transaction - note that any table alterations include an implicit commit so this is largely meaningless.
2053 $transaction->commit();
2055 // make sure all values are present in the object for further processing
2056 $customField->find(TRUE);
2058 return $customField;
2065 protected static function getChangeSerialize($params) {
2066 if (isset($params['serialize']) && !empty($params['id'])) {
2067 if ($params['serialize'] != CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField', $params['id'], 'serialize')) {
2068 return (int) $params['serialize'];
2075 * Move custom data from one contact to another.
2077 * This is currently the start of a refactoring. The theory is each
2078 * entity could have a 'move' function with a DAO default one to fall back on.
2080 * At the moment this only does a small part of the process - ie deleting a file field that
2081 * is about to be overwritten. However, the goal is the whole process around the move for
2082 * custom data should be in here.
2084 * This is currently called by the merge class but it makes sense that api could
2085 * expose move actions as moving (e.g) contributions feels like a common
2086 * ask that should be handled by the form layer.
2088 * @param int $oldContactID
2089 * @param int $newContactID
2090 * @param int[] $fieldIDs
2091 * Optional list field ids to move.
2093 * @throws \CiviCRM_API3_Exception
2094 * @throws \Exception
2096 public function move($oldContactID, $newContactID, $fieldIDs) {
2097 if (empty($fieldIDs)) {
2100 $fields = civicrm_api3('CustomField', 'get', ['id' => ['IN' => $fieldIDs], 'return' => ['custom_group_id.is_multiple', 'custom_group_id.table_name', 'column_name', 'data_type'], 'options' => ['limit' => 0]])['values'];
2102 foreach ($fieldIDs as $fieldID) {
2103 $return[] = 'custom_' . $fieldID;
2105 $oldContact = civicrm_api3('Contact', 'getsingle', ['id' => $oldContactID, 'return' => $return]);
2106 $newContact = civicrm_api3('Contact', 'getsingle', ['id' => $newContactID, 'return' => $return]);
2108 // The moveAllBelongings function has functionality to move custom fields. It doesn't work very well...
2109 // @todo handle all fields here but more immediately Country since that is broken at the moment.
2110 $fieldTypesNotHandledInMergeAttempt = ['File'];
2111 foreach ($fields as $field) {
2112 $isMultiple = !empty($field['custom_group_id.is_multiple']);
2113 if ($field['data_type'] === 'File' && !$isMultiple) {
2114 if (!empty($oldContact['custom_' . $field['id']]) && !empty($newContact['custom_' . $field['id']])) {
2115 CRM_Core_BAO_File
::deleteFileReferences($oldContact['custom_' . $field['id']], $oldContactID, $field['id']);
2117 if (!empty($oldContact['custom_' . $field['id']])) {
2118 CRM_Core_DAO
::executeQuery("
2119 UPDATE civicrm_entity_file
2120 SET entity_id = $newContactID
2121 WHERE file_id = {$oldContact['custom_' . $field['id']]}"
2125 if (in_array($field['data_type'], $fieldTypesNotHandledInMergeAttempt) && !$isMultiple) {
2126 CRM_Core_DAO
::executeQuery(
2127 "INSERT INTO {$field['custom_group_id.table_name']} (entity_id, `{$field['column_name']}`)
2128 VALUES ($newContactID, {$oldContact['custom_' . $field['id']]})
2129 ON DUPLICATE KEY UPDATE
2130 `{$field['column_name']}` = {$oldContact['custom_' . $field['id']]}
2137 * Get the database table name and column name for a custom field.
2139 * @param int $fieldID
2140 * The fieldID of the custom field.
2141 * @param bool $force
2142 * Force the sql to be run again (primarily used for tests).
2145 * fatal is fieldID does not exists, else array of tableName, columnName
2146 * @throws \CRM_Core_Exception
2148 public static function getTableColumnGroup($fieldID, $force = FALSE) {
2149 $cacheKey = "CRM_Core_DAO_CustomField_CustomGroup_TableColumn_{$fieldID}";
2150 $cache = CRM_Utils_Cache
::singleton();
2151 $fieldValues = $cache->get($cacheKey);
2152 if (empty($fieldValues) ||
$force) {
2154 SELECT cg.table_name, cf.column_name, cg.id
2155 FROM civicrm_custom_group cg,
2156 civicrm_custom_field cf
2157 WHERE cf.custom_group_id = cg.id
2159 $params = [1 => [$fieldID, 'Integer']];
2160 $dao = CRM_Core_DAO
::executeQuery($query, $params);
2162 if (!$dao->fetch()) {
2163 throw new CRM_Core_Exception("Cannot find table and column information for Custom Field " . $fieldID);
2165 $fieldValues = [$dao->table_name
, $dao->column_name
, $dao->id
];
2166 $cache->set($cacheKey, $fieldValues);
2168 return $fieldValues;
2172 * Get custom option groups.
2174 * @deprecated Use the API OptionGroup.get
2176 * @param array $includeFieldIds
2177 * Ids of custom fields for which option groups must be included.
2179 * Currently this is required in the cases where option groups are to be included
2180 * for inactive fields : CRM-5369
2184 public static function customOptionGroup($includeFieldIds = NULL) {
2185 static $customOptionGroup = NULL;
2187 $cacheKey = (empty($includeFieldIds)) ?
'onlyActive' : 'force';
2188 if ($cacheKey == 'force') {
2189 $customOptionGroup[$cacheKey] = NULL;
2192 if (empty($customOptionGroup[$cacheKey])) {
2193 $whereClause = '( g.is_active = 1 AND f.is_active = 1 )';
2195 //support for single as well as array format.
2196 if (!empty($includeFieldIds)) {
2197 if (is_array($includeFieldIds)) {
2198 $includeFieldIds = implode(',', $includeFieldIds);
2200 $whereClause .= "OR f.id IN ( $includeFieldIds )";
2204 SELECT g.id, g.title
2205 FROM civicrm_option_group g
2206 INNER JOIN civicrm_custom_field f ON ( g.id = f.option_group_id )
2207 WHERE {$whereClause}";
2209 $dao = CRM_Core_DAO
::executeQuery($query);
2210 while ($dao->fetch()) {
2211 $customOptionGroup[$cacheKey][$dao->id
] = $dao->title
;
2215 return $customOptionGroup[$cacheKey];
2219 * Get defaults for new entity.
2223 public static function getDefaults() {
2225 'is_required' => FALSE,
2226 'is_searchable' => FALSE,
2227 'in_selector' => FALSE,
2228 'is_search_range' => FALSE,
2229 //CRM-15792 - Custom field gets disabled if is_active not set
2230 // this would ideally be a mysql default.
2231 'is_active' => TRUE,
2237 * Fix orphan groups.
2239 * @param int $customFieldId
2241 * @param int $optionGroupId
2244 public static function fixOptionGroups($customFieldId, $optionGroupId) {
2245 // check if option group belongs to any custom Field else delete
2246 // get the current option group
2247 $currentOptionGroupId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
2251 // get the updated option group
2252 // if both are same return
2253 if (!$currentOptionGroupId ||
$currentOptionGroupId == $optionGroupId) {
2257 // check if option group is related to any other field
2258 self
::checkOptionGroup($currentOptionGroupId);
2262 * Check if option group is related to more than one custom field.
2264 * @param int $optionGroupId
2267 public static function checkOptionGroup($optionGroupId) {
2270 FROM civicrm_custom_field
2271 WHERE option_group_id = {$optionGroupId}";
2273 $count = CRM_Core_DAO
::singleValueQuery($query);
2276 //delete the option group
2277 CRM_Core_BAO_OptionGroup
::del($optionGroupId);
2282 * Get option group default.
2284 * @param int $optionGroupId
2285 * @param bool $serialize
2287 * @return null|string
2289 public static function getOptionGroupDefault($optionGroupId, $serialize) {
2291 SELECT default_value, serialize
2292 FROM civicrm_custom_field
2293 WHERE option_group_id = {$optionGroupId}
2294 AND default_value IS NOT NULL";
2296 $dao = CRM_Core_DAO
::executeQuery($query);
2297 while ($dao->fetch()) {
2298 if ($dao->serialize
== $serialize) {
2299 return $dao->default_value
;
2301 $defaultValue = $dao->default_value
;
2304 // Convert serialization
2305 if (isset($defaultValue) && $serialize) {
2306 return CRM_Utils_Array
::implodePadded([$defaultValue]);
2308 elseif (isset($defaultValue)) {
2309 return CRM_Utils_Array
::explodePadded($defaultValue)[0];
2315 * Post process function.
2317 * @param array $params
2318 * @param int $entityID
2319 * @param string $customFieldExtends
2320 * @param bool $inline
2321 * @param bool $checkPermissions
2325 public static function postProcess(
2328 $customFieldExtends,
2330 $checkPermissions = TRUE
2334 foreach ($params as $key => $value) {
2335 if ($customFieldInfo = CRM_Core_BAO_CustomField
::getKeyID($key, TRUE)) {
2337 // for autocomplete transfer hidden value instead of label
2338 if ($params[$key] && isset($params[$key . '_id'])) {
2339 $value = $params[$key . '_id'];
2342 // we need to append time with date
2343 if ($params[$key] && isset($params[$key . '_time'])) {
2344 $value .= ' ' . $params[$key . '_time'];
2347 CRM_Core_BAO_CustomField
::formatCustomField($customFieldInfo[0],
2350 $customFieldExtends,
2351 $customFieldInfo[1],
2362 * Get custom field ID from field/group name/title.
2364 * @param string $fieldName Field name or label
2365 * @param string|null $groupName (Optional) Group name or label
2366 * @param bool $fullString Whether to return "custom_123" or "123"
2368 * @return string|int|null
2369 * @throws \CiviCRM_API3_Exception
2371 public static function getCustomFieldID($fieldName, $groupName = NULL, $fullString = FALSE) {
2372 $cacheKey = $groupName . '.' . $fieldName;
2373 if (!isset(Civi
::$statics['CRM_Core_BAO_CustomField'][$cacheKey])) {
2374 $customFieldParams = [
2375 'name' => $fieldName,
2376 'label' => $fieldName,
2377 'options' => ['or' => [["name", "label"]]],
2381 $customFieldParams['custom_group_id.name'] = $groupName;
2382 $customFieldParams['custom_group_id.title'] = $groupName;
2383 $customFieldParams['options'] = ['or' => [["name", "label"], ["custom_group_id.name", "custom_group_id.title"]]];
2386 $field = civicrm_api3('CustomField', 'get', $customFieldParams);
2388 if (empty($field['id'])) {
2389 Civi
::$statics['CRM_Core_BAO_CustomField'][$cacheKey]['id'] = NULL;
2390 Civi
::$statics['CRM_Core_BAO_CustomField'][$cacheKey]['string'] = NULL;
2393 Civi
::$statics['CRM_Core_BAO_CustomField'][$cacheKey]['id'] = $field['id'];
2394 Civi
::$statics['CRM_Core_BAO_CustomField'][$cacheKey]['string'] = 'custom_' . $field['id'];
2399 return Civi
::$statics['CRM_Core_BAO_CustomField'][$cacheKey]['string'];
2401 return Civi
::$statics['CRM_Core_BAO_CustomField'][$cacheKey]['id'];
2405 * Given ID of a custom field, return its name as well as the name of the custom group it belongs to.
2411 public static function getNameFromID($ids) {
2412 if (is_array($ids)) {
2413 $ids = implode(',', $ids);
2416 SELECT f.id, f.name AS field_name, f.label AS field_label, g.name AS group_name, g.title AS group_title
2417 FROM civicrm_custom_field f
2418 INNER JOIN civicrm_custom_group g ON f.custom_group_id = g.id
2419 WHERE f.id IN ($ids)";
2421 $dao = CRM_Core_DAO
::executeQuery($sql);
2423 while ($dao->fetch()) {
2424 $result[$dao->id
] = [
2425 'field_name' => $dao->field_name
,
2426 'field_label' => $dao->field_label
,
2427 'group_name' => $dao->group_name
,
2428 'group_title' => $dao->group_title
,
2435 * Validate custom data.
2437 * @param array $params
2438 * Custom data submitted.
2439 * ie array( 'custom_1' => 'validate me' );
2442 * validation errors.
2444 public static function validateCustomData($params) {
2446 if (!is_array($params) ||
empty($params)) {
2450 //pick up profile fields.
2451 $profileFields = [];
2452 $ufGroupId = $params['ufGroupId'] ??
NULL;
2454 $profileFields = CRM_Core_BAO_UFGroup
::getFields($ufGroupId,
2456 CRM_Core_Action
::VIEW
2460 //lets start w/ params.
2461 foreach ($params as $key => $value) {
2462 $customFieldID = self
::getKeyID($key);
2463 if (!$customFieldID) {
2467 //load the structural info for given field.
2468 $field = new CRM_Core_DAO_CustomField();
2469 $field->id
= $customFieldID;
2470 if (!$field->find(TRUE)) {
2473 $dataType = $field->data_type
;
2475 $profileField = CRM_Utils_Array
::value($key, $profileFields, []);
2476 $fieldTitle = $profileField['title'] ??
NULL;
2477 $isRequired = $profileField['is_required'] ??
NULL;
2479 $fieldTitle = $field->label
;
2482 //no need to validate.
2483 if (CRM_Utils_System
::isNull($value) && !$isRequired) {
2487 //lets validate first for required field.
2488 if ($isRequired && CRM_Utils_System
::isNull($value)) {
2489 $errors[$key] = ts('%1 is a required field.', [1 => $fieldTitle]);
2493 //now time to take care of custom field form rules.
2494 $ruleName = $errorMsg = NULL;
2495 switch ($dataType) {
2497 $ruleName = 'integer';
2498 $errorMsg = ts('%1 must be an integer (whole number).',
2499 array(1 => $fieldTitle)
2504 $ruleName = 'money';
2505 $errorMsg = ts('%1 must in proper money format. (decimal point/comma/space is allowed).',
2506 array(1 => $fieldTitle)
2511 $ruleName = 'numeric';
2512 $errorMsg = ts('%1 must be a number (with or without decimal point).',
2513 array(1 => $fieldTitle)
2518 $ruleName = 'wikiURL';
2519 $errorMsg = ts('%1 must be valid Website.',
2520 array(1 => $fieldTitle)
2525 if ($ruleName && !CRM_Utils_System
::isNull($value)) {
2527 $funName = "CRM_Utils_Rule::{$ruleName}";
2528 if (is_callable($funName)) {
2529 $valid = call_user_func($funName, $value);
2532 $errors[$key] = $errorMsg;
2541 * Is this field a multi record field.
2543 * @param int $customId
2547 public static function isMultiRecordField($customId) {
2548 $isMultipleWithGid = FALSE;
2549 if (!is_numeric($customId)) {
2550 $customId = self
::getKeyID($customId);
2552 if (is_numeric($customId)) {
2553 $sql = "SELECT cg.id cgId
2554 FROM civicrm_custom_group cg
2555 INNER JOIN civicrm_custom_field cf
2556 ON cg.id = cf.custom_group_id
2557 WHERE cf.id = %1 AND cg.is_multiple = 1";
2558 $params[1] = [$customId, 'Integer'];
2559 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
2560 if ($dao->fetch()) {
2562 $isMultipleWithGid = $dao->cgId
;
2567 return $isMultipleWithGid;
2571 * Does this field type have any select options?
2573 * @param array $field
2577 public static function hasOptions($field) {
2578 // Fields retrieved via api are an array, or from the dao are an object. We'll accept either.
2579 $field = (array) $field;
2580 // This will include boolean fields with Yes/No options.
2581 if (in_array($field['html_type'], ['Radio', 'CheckBox'])) {
2584 // Do this before the "Select" string search because date fields have a "Select Date" html_type
2585 // and contactRef fields have an "Autocomplete-Select" html_type - contacts are an FK not an option list.
2586 if (in_array($field['data_type'], ['ContactReference', 'Date'])) {
2589 if (strpos($field['html_type'], 'Select') !== FALSE) {
2592 return !empty($field['option_group_id']);
2596 * Does this field store a serialized string?
2598 * @param CRM_Core_DAO_CustomField|array $field
2602 public static function isSerialized($field) {
2603 // Fields retrieved via api are an array, or from the dao are an object. We'll accept either.
2604 $html_type = is_object($field) ?
$field->html_type
: $field['html_type'];
2605 // APIv3 has a "legacy" mode where it returns old-style html_type of "Multi-Select"
2606 // If anyone is using this function in conjunction with legacy api output, we'll accomodate:
2607 if ($html_type === 'CheckBox' ||
strpos($html_type, 'Multi') !== FALSE) {
2610 // Otherwise this is the new standard as of 5.27
2611 return is_object($field) ?
!empty($field->serialize
) : !empty($field['serialize']);
2615 * Get api entity for this field
2619 public function getEntity() {
2620 $entity = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup', $this->custom_group_id
, 'extends');
2621 return in_array($entity, ['Individual', 'Household', 'Organization']) ?
'Contact' : $entity;
2625 * Set pseudoconstant properties for field metadata.
2627 * @param array $field
2628 * @param string|null $optionGroupName
2630 private static function getOptionsForField(&$field, $optionGroupName) {
2631 if ($optionGroupName) {
2632 $field['pseudoconstant'] = [
2633 'optionGroupName' => $optionGroupName,
2634 'optionEditPath' => 'civicrm/admin/options/' . $optionGroupName,
2637 elseif ($field['data_type'] == 'Boolean') {
2638 $field['pseudoconstant'] = [
2639 'callback' => 'CRM_Core_SelectValues::boolean',
2642 elseif ($field['data_type'] == 'Country') {
2643 $field['pseudoconstant'] = [
2644 'table' => 'civicrm_country',
2645 'keyColumn' => 'id',
2646 'labelColumn' => 'name',
2647 'nameColumn' => 'iso_code',
2650 elseif ($field['data_type'] == 'StateProvince') {
2651 $field['pseudoconstant'] = [
2652 'table' => 'civicrm_state_province',
2653 'keyColumn' => 'id',
2654 'labelColumn' => 'name',
2660 * @param CRM_Core_DAO_CustomField $field
2661 * @param 'add|modify|delete' $operation
2665 protected static function prepareCreateParams($field, $operation) {
2666 $tableName = CRM_Core_DAO
::getFieldValue(
2667 'CRM_Core_DAO_CustomGroup',
2668 $field->custom_group_id
,
2673 'table_name' => $tableName,
2674 'operation' => $operation,
2675 'name' => $field->column_name
,
2676 'type' => CRM_Core_BAO_CustomValueTable
::fieldToSQLType(
2680 'required' => $field->is_required
,
2681 'searchable' => $field->is_searchable
,
2684 // For adding/dropping FK constraints
2685 $params['fkName'] = CRM_Core_BAO_SchemaHandler
::getIndexName($tableName, $field->column_name
);
2688 'Country' => 'civicrm_country',
2689 'StateProvince' => 'civicrm_state_province',
2690 'ContactReference' => 'civicrm_contact',
2691 'File' => 'civicrm_file',
2693 if (isset($fkFields[$field->data_type
])) {
2694 // Serialized fields store value-separated strings which are incompatible with FK constraints
2695 if (!$field->serialize
) {
2696 $params['fk_table_name'] = $fkFields[$field->data_type
];
2697 $params['fk_field_name'] = 'id';
2698 $params['fk_attributes'] = 'ON DELETE SET NULL';
2701 if ($field->serialize
) {
2702 $params['type'] = 'varchar(255)';
2704 if (isset($field->default_value
)) {
2705 $params['default'] = "'{$field->default_value}'";