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']) && ($params['html_type'] == 'CheckBox' ||
strpos($params['html_type'], 'Multi-') === 0)) {
35 $params['serialize'] = 1;
36 $params['html_type'] = str_replace('Multi-', '', $params['html_type']);
39 // Array created for passing options in params.
40 if (isset($params['option_values']) && is_array($params['option_values'])) {
42 foreach ($params['option_values'] as $key => $value) {
43 // Translate simple key/value pairs into full-blown option values
44 if (!is_array($value)) {
53 $params['option_label'][$key] = $value['label'];
54 $params['option_value'][$key] = $value['value'];
55 $params['option_status'][$key] = $value['is_active'];
56 $params['option_weight'][$key] = $value['weight'];
60 $customField = CRM_Core_BAO_CustomField
::create($params);
61 _civicrm_api3_object_to_array_unique_fields($customField, $values[$customField->id
]);
62 _civicrm_api3_custom_field_flush_static_caches();
63 return civicrm_api3_create_success($values, $params, 'CustomField', $customField);
67 * Flush static caches in functions that might have stored available custom fields.
69 function _civicrm_api3_custom_field_flush_static_caches() {
70 civicrm_api('CustomField', 'getfields', ['version' => 3, 'cache_clear' => 1]);
71 CRM_Core_BAO_UFField
::getAvailableFieldsFlat(TRUE);
75 * Adjust Metadata for Create action.
77 * @param array $params
78 * Array of parameters determined by getfields.
80 function _civicrm_api3_custom_field_create_spec(&$params) {
81 $params['label']['api.required'] = 1;
82 $params['custom_group_id']['api.required'] = 1;
83 $params['is_active']['api.default'] = 1;
84 $params['option_values'] = [
85 'title' => 'Option Values',
86 'description' => "Pass an array of options (value => label) to create this field's option values",
88 // TODO: Why expose this to the api at all?
89 $params['option_type'] = [
90 'title' => 'Option Type',
91 'description' => 'This (boolean) field tells the BAO to create an option group for the field if the field type is appropriate',
93 'type' => CRM_Utils_Type
::T_BOOLEAN
,
95 $params['data_type']['api.default'] = 'String';
96 $params['is_active']['api.default'] = 1;
100 * Use this API to delete an existing custom field.
102 * @param array $params
103 * Array id of the field to be deleted.
107 function civicrm_api3_custom_field_delete($params) {
108 $field = new CRM_Core_BAO_CustomField();
109 $field->id
= $params['id'];
111 $customFieldDelete = CRM_Core_BAO_CustomField
::deleteField($field);
112 civicrm_api('CustomField', 'getfields', ['version' => 3, 'cache_clear' => 1]);
113 return $customFieldDelete ?
civicrm_api3_create_error('Error while deleting custom field') : civicrm_api3_create_success();
117 * Use this API to get existing custom fields.
119 * @param array $params
120 * Array to search on.
124 function civicrm_api3_custom_field_get($params) {
125 if (($params['legacy_html_type'] ??
TRUE) && !empty($params['return'])) {
126 if (is_array($params['return'])) {
127 $params['return'][] = 'serialize';
129 elseif (is_string($params['return'])) {
130 $params['return'] .= ',serialize';
134 $results = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
136 if (($params['legacy_html_type'] ??
TRUE) && !empty($results['values']) && is_array($results['values'])) {
137 foreach ($results['values'] as $id => $result) {
138 if (!empty($result['serialize']) && !empty($result['html_type'])) {
139 $results['values'][$id]['html_type'] = str_replace('Select', 'Multi-Select', $result['html_type']);
148 * Helper function to validate custom field value.
152 * @param string $fieldName
153 * Custom field name (eg: custom_8 ).
154 * @param mixed $value
155 * Field value to be validate.
156 * @param array $fieldDetails
158 * @param array $errors
159 * Collect validation errors.
163 * @todo remove this function - not in use but need to review functionality before
164 * removing as it might be useful in wrapper layer
166 function _civicrm_api3_custom_field_validate_field($fieldName, $value, $fieldDetails, &$errors = []) {
173 $dataType = $fieldDetails['data_type'];
174 $htmlType = $fieldDetails['html_type'];
178 if (!CRM_Utils_Rule
::integer($value)) {
179 $errors[$fieldName] = 'Invalid integer value for ' . $fieldName;
184 if (!CRM_Utils_Rule
::numeric($value)) {
185 $errors[$fieldName] = 'Invalid numeric value for ' . $fieldName;
190 if (!CRM_Utils_Rule
::money($value)) {
191 $errors[$fieldName] = 'Invalid numeric value for ' . $fieldName;
196 if (!CRM_Utils_Rule
::url($value)) {
197 $errors[$fieldName] = 'Invalid link for ' . $fieldName;
202 if ($value != '1' && $value != '0') {
203 $errors[$fieldName] = 'Invalid boolean (use 1 or 0) value for ' . $fieldName;
211 if ($htmlType != 'Multi-Select Country' && is_array($value)) {
212 $errors[$fieldName] = 'Invalid country for ' . $fieldName;
216 if (!is_array($value)) {
220 $query = "SELECT count(*) FROM civicrm_country WHERE id IN (" . implode(',', $value) . ")";
221 if (CRM_Core_DAO
::singleValueQuery($query) < count($value)) {
222 $errors[$fieldName] = 'Invalid country(s) for ' . $fieldName;
226 case 'StateProvince':
231 if ($htmlType != 'Multi-Select State/Province' && is_array($value)) {
232 $errors[$fieldName] = 'Invalid State/Province for ' . $fieldName;
236 if (!is_array($value)) {
242 FROM civicrm_state_province
243 WHERE id IN ('" . implode("','", $value) . "')";
244 if (CRM_Core_DAO
::singleValueQuery($query) < count($value)) {
245 $errors[$fieldName] = 'Invalid State/Province for ' . $fieldName;
249 case 'ContactReference':
254 if (in_array($htmlType, ['Select', 'Multi-Select', 'CheckBox', 'Radio'])
255 && !isset($errors[$fieldName])
257 $options = CRM_Core_OptionGroup
::valuesByID($fieldDetails['option_group_id']);
258 if (!is_array($value)) {
262 $invalidOptions = array_diff($value, array_keys($options));
263 if (!empty($invalidOptions)) {
264 $errors[$fieldName] = "Invalid option(s) for field '{$fieldName}': " . implode(',', $invalidOptions);
272 * CRM-15191 - Hack to ensure the cache gets cleared after updating a custom field.
274 * @param array $params
275 * Array per getfields metadata.
279 function civicrm_api3_custom_field_setvalue($params) {
280 require_once 'api/v3/Generic/Setvalue.php';
281 $result = civicrm_api3_generic_setValue(["entity" => 'CustomField', 'params' => $params]);
282 if (empty($result['is_error'])) {
283 CRM_Utils_System
::flushCache();