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 +--------------------------------------------------------------------+
13 * This api exposes CiviCRM custom field.
15 * @package CiviCRM_APIv3
19 * Create a 'custom field' within a custom field group.
21 * We also empty the static var in the getfields
22 * function after deletion so that the field is available for us (getfields manages date conversion
25 * @param array $params
26 * Array per getfields metadata.
31 function civicrm_api3_custom_field_create($params) {
33 // Legacy handling for old way of naming serialized fields
34 if (!empty($params['html_type'])) {
35 if ($params['html_type'] == 'CheckBox' ||
strpos($params['html_type'], 'Multi-') === 0) {
36 $params['serialize'] = 1;
38 $params['html_type'] = str_replace(['Multi-Select', 'Select Country', 'Select State/Province'], 'Select', $params['html_type']);
41 // Array created for passing options in params.
42 if (isset($params['option_values']) && is_array($params['option_values'])) {
44 foreach ($params['option_values'] as $key => $value) {
45 // Translate simple key/value pairs into full-blown option values
46 if (!is_array($value)) {
55 $params['option_label'][$key] = $value['label'];
56 $params['option_value'][$key] = $value['value'];
57 $params['option_status'][$key] = $value['is_active'];
58 $params['option_weight'][$key] = $value['weight'];
62 $customField = CRM_Core_BAO_CustomField
::create($params);
63 _civicrm_api3_object_to_array_unique_fields($customField, $values[$customField->id
]);
64 _civicrm_api3_custom_field_flush_static_caches();
65 return civicrm_api3_create_success($values, $params, 'CustomField', $customField);
69 * Flush static caches in functions that might have stored available custom fields.
71 function _civicrm_api3_custom_field_flush_static_caches() {
72 if (isset(\Civi
::$statics['CRM_Core_BAO_OptionGroup']['titles_by_name'])) {
73 unset(\Civi
::$statics['CRM_Core_BAO_OptionGroup']['titles_by_name']);
75 civicrm_api('CustomField', 'getfields', ['version' => 3, 'cache_clear' => 1]);
76 CRM_Core_BAO_UFField
::getAvailableFieldsFlat(TRUE);
80 * Adjust Metadata for Create action.
82 * @param array $params
83 * Array of parameters determined by getfields.
85 function _civicrm_api3_custom_field_create_spec(&$params) {
86 $params['label']['api.required'] = 1;
87 $params['custom_group_id']['api.required'] = 1;
88 $params['is_active']['api.default'] = 1;
89 $params['option_values'] = [
90 'title' => 'Option Values',
91 'description' => "Pass an array of options (value => label) to create this field's option values",
93 // TODO: Why expose this to the api at all?
94 $params['option_type'] = [
95 'title' => 'Option Type',
96 'description' => 'This (boolean) field tells the BAO to create an option group for the field if the field type is appropriate',
98 'type' => CRM_Utils_Type
::T_BOOLEAN
,
100 $params['data_type']['api.default'] = 'String';
101 $params['is_active']['api.default'] = 1;
105 * Use this API to delete an existing custom field.
107 * @param array $params
108 * Array id of the field to be deleted.
112 function civicrm_api3_custom_field_delete($params) {
113 $field = new CRM_Core_BAO_CustomField();
114 $field->id
= $params['id'];
116 $customFieldDelete = CRM_Core_BAO_CustomField
::deleteField($field);
117 civicrm_api('CustomField', 'getfields', ['version' => 3, 'cache_clear' => 1]);
118 return $customFieldDelete ?
civicrm_api3_create_error('Error while deleting custom field') : civicrm_api3_create_success();
122 * Use this API to get existing custom fields.
124 * @param array $params
125 * Array to search on.
129 function civicrm_api3_custom_field_get($params) {
130 // Legacy handling for serialize property
131 $handleLegacy = (($params['legacy_html_type'] ??
!isset($params['serialize'])) && CRM_Core_BAO_Domain
::isDBVersionAtLeast('5.27.alpha1'));
132 if ($handleLegacy && !empty($params['return'])) {
133 if (!is_array($params['return'])) {
134 $params['return'] = explode(',', str_replace(' ', '', $params['return']));
136 if (!in_array('serialize', $params['return'])) {
137 $params['return'][] = 'serialize';
139 if (!in_array('data_type', $params['return'])) {
140 $params['return'][] = 'data_type';
144 'Select State/Province' => 'StateProvince',
145 'Select Country' => 'Country',
147 if ($handleLegacy && !empty($params['html_type'])) {
148 $serializedTypes = ['CheckBox', 'Multi-Select', 'Multi-Select Country', 'Multi-Select State/Province'];
149 if (is_string($params['html_type'])) {
150 if (strpos($params['html_type'], 'Multi-Select') === 0) {
151 $params['html_type'] = str_replace('Multi-Select', 'Select', $params['html_type']);
152 $params['serialize'] = 1;
154 elseif (!in_array($params['html_type'], $serializedTypes)) {
155 $params['serialize'] = 0;
157 if (isset($legacyDataTypes[$params['html_type']])) {
158 $params['data_type'] = $legacyDataTypes[$params['html_type']];
159 unset($params['html_type']);
162 elseif (is_array($params['html_type']) && !empty($params['html_type']['IN'])) {
163 $excludeNonSerialized = !array_diff($params['html_type']['IN'], $serializedTypes);
164 $onlyNonSerialized = !array_intersect($params['html_type']['IN'], $serializedTypes);
165 $params['html_type']['IN'] = array_map(function($val) {
166 return str_replace(['Multi-Select', 'Select Country', 'Select State/Province'], 'Select', $val);
167 }, $params['html_type']['IN']);
168 if ($excludeNonSerialized) {
169 $params['serialize'] = 1;
171 if ($onlyNonSerialized) {
172 $params['serialize'] = 0;
177 $results = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
179 if ($handleLegacy && !empty($results['values']) && is_array($results['values'])) {
180 foreach ($results['values'] as $id => &$result) {
181 if (!empty($result['html_type'])) {
182 if (in_array($result['data_type'], $legacyDataTypes)) {
183 $result['html_type'] = array_search($result['data_type'], $legacyDataTypes);
185 if (!empty($result['serialize']) && $result['html_type'] !== 'Autocomplete-Select') {
186 $result['html_type'] = str_replace('Select', 'Multi-Select', $result['html_type']);
196 * Helper function to validate custom field value.
200 * @param string $fieldName
201 * Custom field name (eg: custom_8 ).
202 * @param mixed $value
203 * Field value to be validate.
204 * @param array $fieldDetails
206 * @param array $errors
207 * Collect validation errors.
211 * @todo remove this function - not in use but need to review functionality before
212 * removing as it might be useful in wrapper layer
214 function _civicrm_api3_custom_field_validate_field($fieldName, $value, $fieldDetails, &$errors = []) {
221 $dataType = $fieldDetails['data_type'];
222 $htmlType = $fieldDetails['html_type'];
226 if (!CRM_Utils_Rule
::integer($value)) {
227 $errors[$fieldName] = 'Invalid integer value for ' . $fieldName;
232 if (!CRM_Utils_Rule
::numeric($value)) {
233 $errors[$fieldName] = 'Invalid numeric value for ' . $fieldName;
238 if (!CRM_Utils_Rule
::money($value)) {
239 $errors[$fieldName] = 'Invalid numeric value for ' . $fieldName;
244 if (!CRM_Utils_Rule
::url($value)) {
245 $errors[$fieldName] = 'Invalid link for ' . $fieldName;
250 if ($value != '1' && $value != '0') {
251 $errors[$fieldName] = 'Invalid boolean (use 1 or 0) value for ' . $fieldName;
259 if ($htmlType != 'Multi-Select Country' && is_array($value)) {
260 $errors[$fieldName] = 'Invalid country for ' . $fieldName;
264 if (!is_array($value)) {
268 $query = "SELECT count(*) FROM civicrm_country WHERE id IN (" . implode(',', $value) . ")";
269 if (CRM_Core_DAO
::singleValueQuery($query) < count($value)) {
270 $errors[$fieldName] = 'Invalid country(s) for ' . $fieldName;
274 case 'StateProvince':
279 if ($htmlType != 'Multi-Select State/Province' && is_array($value)) {
280 $errors[$fieldName] = 'Invalid State/Province for ' . $fieldName;
284 if (!is_array($value)) {
290 FROM civicrm_state_province
291 WHERE id IN ('" . implode("','", $value) . "')";
292 if (CRM_Core_DAO
::singleValueQuery($query) < count($value)) {
293 $errors[$fieldName] = 'Invalid State/Province for ' . $fieldName;
297 case 'ContactReference':
302 if (in_array($htmlType, ['Select', 'Multi-Select', 'CheckBox', 'Radio'])
303 && !isset($errors[$fieldName])
305 $options = CRM_Core_OptionGroup
::valuesByID($fieldDetails['option_group_id']);
306 if (!is_array($value)) {
310 $invalidOptions = array_diff($value, array_keys($options));
311 if (!empty($invalidOptions)) {
312 $errors[$fieldName] = "Invalid option(s) for field '{$fieldName}': " . implode(',', $invalidOptions);
320 * CRM-15191 - Hack to ensure the cache gets cleared after updating a custom field.
322 * @param array $params
323 * Array per getfields metadata.
327 function civicrm_api3_custom_field_setvalue($params) {
328 require_once 'api/v3/Generic/Setvalue.php';
329 $result = civicrm_api3_generic_setValue(["entity" => 'CustomField', 'params' => $params]);
330 if (empty($result['is_error'])) {
331 CRM_Utils_System
::flushCache();