api/v3/CustomField.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   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  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * This api exposes CiviCRM custom field.
  14  *
  15  * @package CiviCRM_APIv3
  16  */
  17
  18 /**
  19  * Create a 'custom field' within a custom field group.
  20  *
  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
  23  * among other things
  24  *
  25  * @param array $params
  26  *   Array per getfields metadata.
  27  *
  28  * @return array
  29  *   API success array
  30  */
  31 function civicrm_api3_custom_field_create($params) {
  32
  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;
  37     }
  38     $params['html_type'] = str_replace(['Multi-Select', 'Select Country', 'Select State/Province'], 'Select', $params['html_type']);
  39   }
  40
  41   // Array created for passing options in params.
  42   if (isset($params['option_values']) && is_array($params['option_values'])) {
  43     $weight = 0;
  44     foreach ($params['option_values'] as $key => $value) {
  45       // Translate simple key/value pairs into full-blown option values
  46       if (!is_array($value)) {
  47         $value = [
  48           'label' => $value,
  49           'value' => $key,
  50           'is_active' => 1,
  51           'weight' => $weight,
  52         ];
  53         $key = $weight++;
  54       }
  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'];
  59     }
  60   }
  61   $values = [];
  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);
  66 }
  67
  68 /**
  69  * Flush static caches in functions that might have stored available custom fields.
  70  */
  71 function _civicrm_api3_custom_field_flush_static_caches() {
  72   civicrm_api('CustomField', 'getfields', ['version' => 3, 'cache_clear' => 1]);
  73   CRM_Core_BAO_UFField::getAvailableFieldsFlat(TRUE);
  74 }
  75
  76 /**
  77  * Adjust Metadata for Create action.
  78  *
  79  * @param array $params
  80  *   Array of parameters determined by getfields.
  81  */
  82 function _civicrm_api3_custom_field_create_spec(&$params) {
  83   $params['label']['api.required'] = 1;
  84   $params['custom_group_id']['api.required'] = 1;
  85   $params['is_active']['api.default'] = 1;
  86   $params['option_values'] = [
  87     'title' => 'Option Values',
  88     'description' => "Pass an array of options (value => label) to create this field's option values",
  89   ];
  90   // TODO: Why expose this to the api at all?
  91   $params['option_type'] = [
  92     'title' => 'Option Type',
  93     'description' => 'This (boolean) field tells the BAO to create an option group for the field if the field type is appropriate',
  94     'api.default' => 1,
  95     'type' => CRM_Utils_Type::T_BOOLEAN,
  96   ];
  97   $params['data_type']['api.default'] = 'String';
  98   $params['is_active']['api.default'] = 1;
  99 }
 100
 101 /**
 102  * Use this API to delete an existing custom field.
 103  *
 104  * @param array $params
 105  *   Array id of the field to be deleted.
 106  *
 107  * @return array
 108  */
 109 function civicrm_api3_custom_field_delete($params) {
 110   $field = new CRM_Core_BAO_CustomField();
 111   $field->id = $params['id'];
 112   $field->find(TRUE);
 113   $customFieldDelete = CRM_Core_BAO_CustomField::deleteField($field);
 114   civicrm_api('CustomField', 'getfields', ['version' => 3, 'cache_clear' => 1]);
 115   return $customFieldDelete ? civicrm_api3_create_error('Error while deleting custom field') : civicrm_api3_create_success();
 116 }
 117
 118 /**
 119  * Use this API to get existing custom fields.
 120  *
 121  * @param array $params
 122  *   Array to search on.
 123  *
 124  * @return array
 125  */
 126 function civicrm_api3_custom_field_get($params) {
 127   // Legacy handling for serialize property
 128   $handleLegacy = (($params['legacy_html_type'] ?? !isset($params['serialize'])) && CRM_Core_BAO_Domain::isDBVersionAtLeast('5.27.alpha1'));
 129   if ($handleLegacy && !empty($params['return'])) {
 130     if (!is_array($params['return'])) {
 131       $params['return'] = explode(',', str_replace(' ', '', $params['return']));
 132     }
 133     if (!in_array('serialize', $params['return'])) {
 134       $params['return'][] = 'serialize';
 135     }
 136     if (!in_array('data_type', $params['return'])) {
 137       $params['return'][] = 'data_type';
 138     }
 139   }
 140   $legacyDataTypes = [
 141     'Select State/Province' => 'StateProvince',
 142     'Select Country' => 'Country',
 143   ];
 144   if ($handleLegacy && !empty($params['html_type'])) {
 145     $serializedTypes = ['CheckBox', 'Multi-Select', 'Multi-Select Country', 'Multi-Select State/Province'];
 146     if (is_string($params['html_type'])) {
 147       if (strpos($params['html_type'], 'Multi-Select') === 0) {
 148         $params['html_type'] = str_replace('Multi-Select', 'Select', $params['html_type']);
 149         $params['serialize'] = 1;
 150       }
 151       elseif (!in_array($params['html_type'], $serializedTypes)) {
 152         $params['serialize'] = 0;
 153       }
 154       if (isset($legacyDataTypes[$params['html_type']])) {
 155         $params['data_type'] = $legacyDataTypes[$params['html_type']];
 156         unset($params['html_type']);
 157       }
 158     }
 159     elseif (is_array($params['html_type']) && !empty($params['html_type']['IN'])) {
 160       $excludeNonSerialized = !array_diff($params['html_type']['IN'], $serializedTypes);
 161       $onlyNonSerialized = !array_intersect($params['html_type']['IN'], $serializedTypes);
 162       $params['html_type']['IN'] = array_map(function($val) {
 163         return str_replace(['Multi-Select', 'Select Country', 'Select State/Province'], 'Select', $val);
 164       }, $params['html_type']['IN']);
 165       if ($excludeNonSerialized) {
 166         $params['serialize'] = 1;
 167       }
 168       if ($onlyNonSerialized) {
 169         $params['serialize'] = 0;
 170       }
 171     }
 172   }
 173
 174   $results = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 175
 176   if ($handleLegacy && !empty($results['values']) && is_array($results['values'])) {
 177     foreach ($results['values'] as $id => &$result) {
 178       if (!empty($result['html_type'])) {
 179         if (in_array($result['data_type'], $legacyDataTypes)) {
 180           $result['html_type'] = array_search($result['data_type'], $legacyDataTypes);
 181         }
 182         if (!empty($result['serialize']) && $result['html_type'] !== 'Autocomplete-Select') {
 183           $result['html_type'] = str_replace('Select', 'Multi-Select', $result['html_type']);
 184         }
 185       }
 186     }
 187   }
 188
 189   return $results;
 190 }
 191
 192 /**
 193  * Helper function to validate custom field value.
 194  *
 195  * @deprecated
 196  *
 197  * @param string $fieldName
 198  *   Custom field name (eg: custom_8 ).
 199  * @param mixed $value
 200  *   Field value to be validate.
 201  * @param array $fieldDetails
 202  *   Field Details.
 203  * @param array $errors
 204  *   Collect validation errors.
 205  *
 206  * @return array|NULL
 207  *   Validation errors
 208  * @todo remove this function - not in use but need to review functionality before
 209  * removing as it might be useful in wrapper layer
 210  */
 211 function _civicrm_api3_custom_field_validate_field($fieldName, $value, $fieldDetails, &$errors = []) {
 212   return NULL;
 213   //see comment block
 214   if (!$value) {
 215     return $errors;
 216   }
 217
 218   $dataType = $fieldDetails['data_type'];
 219   $htmlType = $fieldDetails['html_type'];
 220
 221   switch ($dataType) {
 222     case 'Int':
 223       if (!CRM_Utils_Rule::integer($value)) {
 224         $errors[$fieldName] = 'Invalid integer value for ' . $fieldName;
 225       }
 226       break;
 227
 228     case 'Float':
 229       if (!CRM_Utils_Rule::numeric($value)) {
 230         $errors[$fieldName] = 'Invalid numeric value for ' . $fieldName;
 231       }
 232       break;
 233
 234     case 'Money':
 235       if (!CRM_Utils_Rule::money($value)) {
 236         $errors[$fieldName] = 'Invalid numeric value for ' . $fieldName;
 237       }
 238       break;
 239
 240     case 'Link':
 241       if (!CRM_Utils_Rule::url($value)) {
 242         $errors[$fieldName] = 'Invalid link for ' . $fieldName;
 243       }
 244       break;
 245
 246     case 'Boolean':
 247       if ($value != '1' && $value != '0') {
 248         $errors[$fieldName] = 'Invalid boolean (use 1 or 0) value for ' . $fieldName;
 249       }
 250       break;
 251
 252     case 'Country':
 253       if (empty($value)) {
 254         break;
 255       }
 256       if ($htmlType != 'Multi-Select Country' && is_array($value)) {
 257         $errors[$fieldName] = 'Invalid country for ' . $fieldName;
 258         break;
 259       }
 260
 261       if (!is_array($value)) {
 262         $value = [$value];
 263       }
 264
 265       $query = "SELECT count(*) FROM civicrm_country WHERE id IN (" . implode(',', $value) . ")";
 266       if (CRM_Core_DAO::singleValueQuery($query) < count($value)) {
 267         $errors[$fieldName] = 'Invalid country(s) for ' . $fieldName;
 268       }
 269       break;
 270
 271     case 'StateProvince':
 272       if (empty($value)) {
 273         break;
 274       }
 275
 276       if ($htmlType != 'Multi-Select State/Province' && is_array($value)) {
 277         $errors[$fieldName] = 'Invalid State/Province for ' . $fieldName;
 278         break;
 279       }
 280
 281       if (!is_array($value)) {
 282         $value = [$value];
 283       }
 284
 285       $query = "
 286 SELECT count(*)
 287   FROM civicrm_state_province
 288  WHERE id IN ('" . implode("','", $value) . "')";
 289       if (CRM_Core_DAO::singleValueQuery($query) < count($value)) {
 290         $errors[$fieldName] = 'Invalid State/Province for ' . $fieldName;
 291       }
 292       break;
 293
 294     case 'ContactReference':
 295       //FIX ME
 296       break;
 297   }
 298
 299   if (in_array($htmlType, ['Select', 'Multi-Select', 'CheckBox', 'Radio'])
 300     && !isset($errors[$fieldName])
 301   ) {
 302     $options = CRM_Core_OptionGroup::valuesByID($fieldDetails['option_group_id']);
 303     if (!is_array($value)) {
 304       $value = [$value];
 305     }
 306
 307     $invalidOptions = array_diff($value, array_keys($options));
 308     if (!empty($invalidOptions)) {
 309       $errors[$fieldName] = "Invalid option(s) for field '{$fieldName}': " . implode(',', $invalidOptions);
 310     }
 311   }
 312
 313   return $errors;
 314 }
 315
 316 /**
 317  * CRM-15191 - Hack to ensure the cache gets cleared after updating a custom field.
 318  *
 319  * @param array $params
 320  *   Array per getfields metadata.
 321  *
 322  * @return array
 323  */
 324 function civicrm_api3_custom_field_setvalue($params) {
 325   require_once 'api/v3/Generic/Setvalue.php';
 326   $result = civicrm_api3_generic_setValue(["entity" => 'CustomField', 'params' => $params]);
 327   if (empty($result['is_error'])) {
 328     CRM_Utils_System::flushCache();
 329   }
 330   return $result;
 331 }