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 // Array created for passing options in params.
34 if (isset($params['option_values']) && is_array($params['option_values'])) {
36 foreach ($params['option_values'] as $key => $value) {
37 // Translate simple key/value pairs into full-blown option values
38 if (!is_array($value)) {
47 $params['option_label'][$key] = $value['label'];
48 $params['option_value'][$key] = $value['value'];
49 $params['option_status'][$key] = $value['is_active'];
50 $params['option_weight'][$key] = $value['weight'];
54 $customField = CRM_Core_BAO_CustomField
::create($params);
55 _civicrm_api3_object_to_array_unique_fields($customField, $values[$customField->id
]);
56 _civicrm_api3_custom_field_flush_static_caches();
57 return civicrm_api3_create_success($values, $params, 'CustomField', $customField);
61 * Flush static caches in functions that might have stored available custom fields.
63 function _civicrm_api3_custom_field_flush_static_caches() {
64 civicrm_api('CustomField', 'getfields', ['version' => 3, 'cache_clear' => 1]);
65 CRM_Core_BAO_UFField
::getAvailableFieldsFlat(TRUE);
69 * Adjust Metadata for Create action.
71 * @param array $params
72 * Array of parameters determined by getfields.
74 function _civicrm_api3_custom_field_create_spec(&$params) {
75 $params['label']['api.required'] = 1;
76 $params['custom_group_id']['api.required'] = 1;
77 $params['is_active']['api.default'] = 1;
78 $params['option_values'] = [
79 'title' => 'Option Values',
80 'description' => "Pass an array of options (value => label) to create this field's option values",
82 // TODO: Why expose this to the api at all?
83 $params['option_type'] = [
84 'title' => 'Option Type',
85 'description' => 'This (boolean) field tells the BAO to create an option group for the field if the field type is appropriate',
87 'type' => CRM_Utils_Type
::T_BOOLEAN
,
89 $params['data_type']['api.default'] = 'String';
90 $params['is_active']['api.default'] = 1;
94 * Use this API to delete an existing custom field.
96 * @param array $params
97 * Array id of the field to be deleted.
101 function civicrm_api3_custom_field_delete($params) {
102 $field = new CRM_Core_BAO_CustomField();
103 $field->id
= $params['id'];
105 $customFieldDelete = CRM_Core_BAO_CustomField
::deleteField($field);
106 civicrm_api('CustomField', 'getfields', ['version' => 3, 'cache_clear' => 1]);
107 return $customFieldDelete ?
civicrm_api3_create_error('Error while deleting custom field') : civicrm_api3_create_success();
111 * Use this API to get existing custom fields.
113 * @param array $params
114 * Array to search on.
118 function civicrm_api3_custom_field_get($params) {
119 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
123 * Helper function to validate custom field value.
127 * @param string $fieldName
128 * Custom field name (eg: custom_8 ).
129 * @param mixed $value
130 * Field value to be validate.
131 * @param array $fieldDetails
133 * @param array $errors
134 * Collect validation errors.
138 * @todo remove this function - not in use but need to review functionality before
139 * removing as it might be useful in wrapper layer
141 function _civicrm_api3_custom_field_validate_field($fieldName, $value, $fieldDetails, &$errors = []) {
148 $dataType = $fieldDetails['data_type'];
149 $htmlType = $fieldDetails['html_type'];
153 if (!CRM_Utils_Rule
::integer($value)) {
154 $errors[$fieldName] = 'Invalid integer value for ' . $fieldName;
159 if (!CRM_Utils_Rule
::numeric($value)) {
160 $errors[$fieldName] = 'Invalid numeric value for ' . $fieldName;
165 if (!CRM_Utils_Rule
::money($value)) {
166 $errors[$fieldName] = 'Invalid numeric value for ' . $fieldName;
171 if (!CRM_Utils_Rule
::url($value)) {
172 $errors[$fieldName] = 'Invalid link for ' . $fieldName;
177 if ($value != '1' && $value != '0') {
178 $errors[$fieldName] = 'Invalid boolean (use 1 or 0) value for ' . $fieldName;
186 if ($htmlType != 'Multi-Select Country' && is_array($value)) {
187 $errors[$fieldName] = 'Invalid country for ' . $fieldName;
191 if (!is_array($value)) {
195 $query = "SELECT count(*) FROM civicrm_country WHERE id IN (" . implode(',', $value) . ")";
196 if (CRM_Core_DAO
::singleValueQuery($query) < count($value)) {
197 $errors[$fieldName] = 'Invalid country(s) for ' . $fieldName;
201 case 'StateProvince':
206 if ($htmlType != 'Multi-Select State/Province' && is_array($value)) {
207 $errors[$fieldName] = 'Invalid State/Province for ' . $fieldName;
211 if (!is_array($value)) {
217 FROM civicrm_state_province
218 WHERE id IN ('" . implode("','", $value) . "')";
219 if (CRM_Core_DAO
::singleValueQuery($query) < count($value)) {
220 $errors[$fieldName] = 'Invalid State/Province for ' . $fieldName;
224 case 'ContactReference':
229 if (in_array($htmlType, ['Select', 'Multi-Select', 'CheckBox', 'Radio'])
230 && !isset($errors[$fieldName])
232 $options = CRM_Core_OptionGroup
::valuesByID($fieldDetails['option_group_id']);
233 if (!is_array($value)) {
237 $invalidOptions = array_diff($value, array_keys($options));
238 if (!empty($invalidOptions)) {
239 $errors[$fieldName] = "Invalid option(s) for field '{$fieldName}': " . implode(',', $invalidOptions);
247 * CRM-15191 - Hack to ensure the cache gets cleared after updating a custom field.
249 * @param array $params
250 * Array per getfields metadata.
254 function civicrm_api3_custom_field_setvalue($params) {
255 require_once 'api/v3/Generic/Setvalue.php';
256 $result = civicrm_api3_generic_setValue(["entity" => 'CustomField', 'params' => $params]);
257 if (empty($result['is_error'])) {
258 CRM_Utils_System
::flushCache();