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 $params['data_type']['api.default'] = 'String';
94 $params['is_active']['api.default'] = 1;
98 * Use this API to delete an existing custom field.
100 * @param array $params
101 * Array id of the field to be deleted.
105 function civicrm_api3_custom_field_delete($params) {
106 $field = new CRM_Core_BAO_CustomField();
107 $field->id
= $params['id'];
109 $customFieldDelete = CRM_Core_BAO_CustomField
::deleteField($field);
110 civicrm_api('CustomField', 'getfields', ['version' => 3, 'cache_clear' => 1]);
111 return $customFieldDelete ?
civicrm_api3_create_error('Error while deleting custom field') : civicrm_api3_create_success();
115 * Use this API to get existing custom fields.
117 * @param array $params
118 * Array to search on.
122 function civicrm_api3_custom_field_get($params) {
123 // Legacy handling for serialize property
124 $handleLegacy = (($params['legacy_html_type'] ??
!isset($params['serialize'])) && CRM_Core_BAO_Domain
::isDBVersionAtLeast('5.27.alpha1'));
125 if ($handleLegacy && !empty($params['return'])) {
126 if (!is_array($params['return'])) {
127 $params['return'] = explode(',', str_replace(' ', '', $params['return']));
129 if (!in_array('serialize', $params['return'])) {
130 $params['return'][] = 'serialize';
132 if (!in_array('data_type', $params['return'])) {
133 $params['return'][] = 'data_type';
137 'Select State/Province' => 'StateProvince',
138 'Select Country' => 'Country',
140 if ($handleLegacy && !empty($params['html_type'])) {
141 $serializedTypes = ['CheckBox', 'Multi-Select', 'Multi-Select Country', 'Multi-Select State/Province'];
142 if (is_string($params['html_type'])) {
143 if (strpos($params['html_type'], 'Multi-Select') === 0) {
144 $params['html_type'] = str_replace('Multi-Select', 'Select', $params['html_type']);
145 $params['serialize'] = 1;
147 elseif (!in_array($params['html_type'], $serializedTypes)) {
148 $params['serialize'] = 0;
150 if (isset($legacyDataTypes[$params['html_type']])) {
151 $params['data_type'] = $legacyDataTypes[$params['html_type']];
152 unset($params['html_type']);
155 elseif (is_array($params['html_type']) && !empty($params['html_type']['IN'])) {
156 $excludeNonSerialized = !array_diff($params['html_type']['IN'], $serializedTypes);
157 $onlyNonSerialized = !array_intersect($params['html_type']['IN'], $serializedTypes);
158 $params['html_type']['IN'] = array_map(function($val) {
159 return str_replace(['Multi-Select', 'Select Country', 'Select State/Province'], 'Select', $val);
160 }, $params['html_type']['IN']);
161 if ($excludeNonSerialized) {
162 $params['serialize'] = 1;
164 if ($onlyNonSerialized) {
165 $params['serialize'] = 0;
170 $results = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
172 if ($handleLegacy && !empty($results['values']) && is_array($results['values'])) {
173 foreach ($results['values'] as $id => &$result) {
174 if (!empty($result['html_type'])) {
175 if (in_array($result['data_type'], $legacyDataTypes)) {
176 $result['html_type'] = array_search($result['data_type'], $legacyDataTypes);
178 if (!empty($result['serialize']) && $result['html_type'] !== 'Autocomplete-Select') {
179 $result['html_type'] = str_replace('Select', 'Multi-Select', $result['html_type']);
189 * Helper function to validate custom field value.
193 * @param string $fieldName
194 * Custom field name (eg: custom_8 ).
195 * @param mixed $value
196 * Field value to be validate.
197 * @param array $fieldDetails
199 * @param array $errors
200 * Collect validation errors.
204 * @todo remove this function - not in use but need to review functionality before
205 * removing as it might be useful in wrapper layer
207 function _civicrm_api3_custom_field_validate_field($fieldName, $value, $fieldDetails, &$errors = []) {
214 $dataType = $fieldDetails['data_type'];
215 $htmlType = $fieldDetails['html_type'];
219 if (!CRM_Utils_Rule
::integer($value)) {
220 $errors[$fieldName] = 'Invalid integer value for ' . $fieldName;
225 if (!CRM_Utils_Rule
::numeric($value)) {
226 $errors[$fieldName] = 'Invalid numeric value for ' . $fieldName;
231 if (!CRM_Utils_Rule
::money($value)) {
232 $errors[$fieldName] = 'Invalid numeric value for ' . $fieldName;
237 if (!CRM_Utils_Rule
::url($value)) {
238 $errors[$fieldName] = 'Invalid link for ' . $fieldName;
243 if ($value != '1' && $value != '0') {
244 $errors[$fieldName] = 'Invalid boolean (use 1 or 0) value for ' . $fieldName;
252 if ($htmlType != 'Multi-Select Country' && is_array($value)) {
253 $errors[$fieldName] = 'Invalid country for ' . $fieldName;
257 if (!is_array($value)) {
261 $query = "SELECT count(*) FROM civicrm_country WHERE id IN (" . implode(',', $value) . ")";
262 if (CRM_Core_DAO
::singleValueQuery($query) < count($value)) {
263 $errors[$fieldName] = 'Invalid country(s) for ' . $fieldName;
267 case 'StateProvince':
272 if ($htmlType != 'Multi-Select State/Province' && is_array($value)) {
273 $errors[$fieldName] = 'Invalid State/Province for ' . $fieldName;
277 if (!is_array($value)) {
283 FROM civicrm_state_province
284 WHERE id IN ('" . implode("','", $value) . "')";
285 if (CRM_Core_DAO
::singleValueQuery($query) < count($value)) {
286 $errors[$fieldName] = 'Invalid State/Province for ' . $fieldName;
290 case 'ContactReference':
295 if (in_array($htmlType, ['Select', 'Multi-Select', 'CheckBox', 'Radio'])
296 && !isset($errors[$fieldName])
298 $options = CRM_Core_OptionGroup
::valuesByID($fieldDetails['option_group_id']);
299 if (!is_array($value)) {
303 $invalidOptions = array_diff($value, array_keys($options));
304 if (!empty($invalidOptions)) {
305 $errors[$fieldName] = "Invalid option(s) for field '{$fieldName}': " . implode(',', $invalidOptions);
313 * CRM-15191 - Hack to ensure the cache gets cleared after updating a custom field.
315 * @param array $params
316 * Array per getfields metadata.
320 function civicrm_api3_custom_field_setvalue($params) {
321 require_once 'api/v3/Generic/Setvalue.php';
322 $result = civicrm_api3_generic_setValue(["entity" => 'CustomField', 'params' => $params]);
323 if (empty($result['is_error'])) {
324 CRM_Utils_System
::flushCache();