api/v3/CustomField.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.4                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2013                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27  */
  28
  29 /**
  30  * File for the CiviCRM APIv3 custom group functions
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_CustomField
  34  *
  35  * @copyright CiviCRM LLC (c) 2004-2013
  36  * @version $Id: CustomField.php 30879 2010-11-22 15:45:55Z shot $
  37  */
  38
  39 /**
  40  * Most API functions take in associative arrays ( name => value pairs
  41  * as parameters. Some of the most commonly used parameters are
  42  * described below
  43  *
  44  * @param array $params           an associative array used in construction
  45  * retrieval of the object
  46  *
  47  */
  48
  49 /**
  50  * Create a 'custom field' within a custom field group.
  51  * We also empty the static var in the getfields
  52  * function after deletion so that the field is available for us (getfields manages date conversion
  53  * among other things
  54  *
  55  * @param $params array  Associative array of property name/value pairs to create new custom field.
  56  *
  57  * @return Newly API success object
  58  *
  59  * @access public
  60  *
  61  * @example CustomFieldCreate.php
  62  * {@getfields CustomField_create}
  63  * {@example CustomFieldCreate.php 0}
  64  *
  65  */
  66 function civicrm_api3_custom_field_create($params) {
  67
  68   // Array created for passing options in params
  69   if (isset($params['option_values']) && is_array($params['option_values'])) {
  70     foreach ($params['option_values'] as $key => $value) {
  71       $params['option_label'][$key] = $value['label'];
  72       $params['option_value'][$key] = $value['value'];
  73       $params['option_status'][$key] = $value['is_active'];
  74       $params['option_weight'][$key] = $value['weight'];
  75     }
  76   }
  77   $values = array();
  78   $customField = CRM_Core_BAO_CustomField::create($params);
  79   _civicrm_api3_object_to_array_unique_fields($customField, $values[$customField->id]);
  80   _civicrm_api3_custom_field_flush_static_caches();
  81   return civicrm_api3_create_success($values, $params, 'custom_field', $customField);
  82 }
  83
  84 /**
  85  * Flush static caches in functions that might have stored available custom fields
  86  */
  87 function _civicrm_api3_custom_field_flush_static_caches(){
  88   civicrm_api('custom_field', 'getfields', array('version' => 3, 'cache_clear' => 1));
  89   CRM_Core_BAO_UFField::getAvailableFieldsFlat(TRUE);
  90 }
  91 /**
  92  * Adjust Metadata for Create action
  93  *
  94  * @param array $params array or parameters determined by getfields
  95  */
  96 function _civicrm_api3_custom_field_create_spec(&$params) {
  97   $params['label']['api.required'] = 1;
  98   $params['custom_group_id']['api.required'] = 1;
  99   $params['is_active']['api.default'] = 1;
 100   $params['option_type'] = array(
 101     'title' => 'This (boolean) field tells the BAO to create an option group for the field if the field type is appropriate',
 102     'api.default' => 1,
 103     'type' => CRM_Utils_Type::T_BOOLEAN,
 104   );
 105   $params['data_type']['api.default'] = 'String';
 106   $params['is_active']['api.default'] = 1;
 107 }
 108
 109 /**
 110  * Use this API to delete an existing custom group field.
 111  *
 112  * @param $params     Array id of the field to be deleted
 113  * @example CustomFieldDelete.php
 114  *
 115  * {@example CustomFieldDelete.php 0}
 116  * {@getfields CustomField_delete}
 117  * @access public
 118  **/
 119 function civicrm_api3_custom_field_delete($params) {
 120
 121   $field = new CRM_Core_BAO_CustomField();
 122   $field->id = $params['id'];
 123   $field->find(TRUE);
 124   $customFieldDelete = CRM_Core_BAO_CustomField::deleteField($field);
 125   civicrm_api('custom_field', 'getfields', array('version' => 3, 'cache_clear' => 1));
 126   return $customFieldDelete ? civicrm_api3_create_error('Error while deleting custom field') : civicrm_api3_create_success();
 127 }
 128
 129 /**
 130  * Use this API to get existing custom fields.
 131  *
 132  * @param array $params Array to search on
 133  *{@getfields CustomField_get}
 134  * @access public
 135  *
 136  **/
 137 function civicrm_api3_custom_field_get($params) {
 138   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 139 }
 140
 141 /*
 142  * Helper function to validate custom field values
 143  *
 144  * @params Array   $params             Custom fields with values
 145  * @params Array   $errors             Reference fields to be check with
 146  * @params Boolean $checkForDisallowed Check for disallowed elements
 147  *                                     in params
 148  * @params Boolean $checkForRequired   Check for non present required elements
 149  *                                     in params
 150  * @return Array  Validation errors
 151  */
 152
 153 /**
 154  * Helper function to validate custom field value
 155  *
 156  * @params String $fieldName    Custom field name (eg: custom_8 )
 157  * @params Mixed  $value        Field value to be validate
 158  * @params Array  $fieldDetails Field Details
 159  * @params Array  $errors       Collect validation  errors
 160  *
 161  * @return Array  Validation errors
 162  * @todo remove this function - not in use but need to review functionality before
 163  * removing as it might be useful in wrapper layer
 164  */
 165 function _civicrm_api3_custom_field_validate_field($fieldName, $value, $fieldDetails, &$errors = array(
 166   )) {
 167     return;
 168     //see comment block
 169   if (!$value) {
 170     return $errors;
 171   }
 172
 173   $dataType = $fieldDetails['data_type'];
 174   $htmlType = $fieldDetails['html_type'];
 175
 176   switch ($dataType) {
 177     case 'Int':
 178       if (!CRM_Utils_Rule::integer($value)) {
 179         $errors[$fieldName] = 'Invalid integer value for ' . $fieldName;
 180       }
 181       break;
 182
 183     case 'Float':
 184       if (!CRM_Utils_Rule::numeric($value)) {
 185         $errors[$fieldName] = 'Invalid numeric value for ' . $fieldName;
 186       }
 187       break;
 188
 189     case 'Money':
 190       if (!CRM_Utils_Rule::money($value)) {
 191         $errors[$fieldName] = 'Invalid numeric value for ' . $fieldName;
 192       }
 193       break;
 194
 195     case 'Link':
 196       if (!CRM_Utils_Rule::url($value)) {
 197         $errors[$fieldName] = 'Invalid link for ' . $fieldName;
 198       }
 199       break;
 200
 201     case 'Boolean':
 202       if ($value != '1' && $value != '0') {
 203         $errors[$fieldName] = 'Invalid boolean (use 1 or 0) value for ' . $fieldName;
 204       }
 205       break;
 206
 207     case 'Country':
 208       if (empty($value)) {
 209         break;
 210       }
 211       if ($htmlType != 'Multi-Select Country' && is_array($value)) {
 212         $errors[$fieldName] = 'Invalid country for ' . $fieldName;
 213         break;
 214       }
 215
 216       if (!is_array($value)) {
 217         $value = array($value);
 218       }
 219
 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;
 223       }
 224       break;
 225
 226     case 'StateProvince':
 227       if (empty($value)) {
 228         break;
 229       }
 230
 231       if ($htmlType != 'Multi-Select State/Province' && is_array($value)) {
 232         $errors[$fieldName] = 'Invalid State/Province for ' . $fieldName;
 233         break;
 234       }
 235
 236       if (!is_array($value)) {
 237         $value = array($value);
 238       }
 239
 240       $query = "
 241 SELECT count(*)
 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;
 246       }
 247       break;
 248
 249     case 'ContactReference':
 250       //FIX ME
 251       break;
 252   }
 253
 254   if (in_array($htmlType, array(
 255     'Select', 'Multi-Select', 'CheckBox', 'Radio', 'AdvMulti-Select')) &&
 256     !isset($errors[$fieldName])
 257   ) {
 258     $options = CRM_Core_OptionGroup::valuesByID($fieldDetails['option_group_id']);
 259     if (!is_array($value)) {
 260       $value = array($value);
 261     }
 262
 263     $invalidOptions = array_diff($value, array_keys($options));
 264     if (!empty($invalidOptions)) {
 265       $errors[$fieldName] = "Invalid option(s) for field '{$fieldName}': " . implode(',', $invalidOptions);
 266     }
 267   }
 268
 269   return $errors;
 270 }
 271