Merge pull request #2971 from eileenmcnaughton/Cleanups

[civicrm-core.git] / api / v3 / OptionValue.php

diff --git a/api/v3/OptionValue.php b/api/v3/OptionValue.php
index 30b7e26be114d16705fdd807f1a359ed73c5ed5c..6f83e2b564537dce44f8ec7ed9e3df9d059bdaa2 100644 (file)
--- a/api/v3/OptionValue.php
+++ b/api/v3/OptionValue.php
@@ -1,10 +1,11 @@
 <?php
-// $Id$
 
 /**
  * Retrieve one or more OptionValues
  *
- * @param  array  $ params input parameters
+ * @param $params
+ *
+ * @internal param $array $ params input parameters
  *
  * {@example OptionValueGet.php 0}
  * @example OptionValueGet.php
@@ -34,53 +35,26 @@ function civicrm_api3_option_value_get($params) {
  *
  * {@example OptionValueCreate.php}
  *
+ * @param $params
+ *
+ * @throws API_Exception
  * @return array of newly created option_value property values.
  * {@getfields OptionValue_create}
  * @access public
  */
 function civicrm_api3_option_value_create($params) {
-
-  // CRM-10921: do not fill-in defaults if this is an update
-  if (!CRM_Utils_Array::value('id', $params)) {
-    if (!CRM_Utils_Array::value('label', $params) && CRM_Utils_Array::value('name', $params)) {
-      // 'label' defaults to 'name'
-      $params['label'] = $params['name'];
-    }
-    if (!CRM_Utils_Array::value('value', $params) && CRM_Utils_Array::value('option_group_id', $params)) {
-      // 'value' defaults to next weight in option_group
-      $params['value'] = (int) CRM_Utils_Weight::getDefaultWeight('CRM_Core_DAO_OptionValue',
-        array('option_group_id' => $params['option_group_id'])
-      );
-    }
-    if (!CRM_Utils_Array::value('weight', $params) && CRM_Utils_Array::value('value', $params)) {
-      // 'weight' defaults to 'value'
-      $params['weight'] = $params['value'];
-    } elseif (CRM_Utils_Array::value('weight', $params) && $params['weight'] == 'next' && CRM_Utils_Array::value('option_group_id', $params)) {
-      // weight is numeric, so it's safe-ish to treat symbol 'next' as magical value
-      $params['weight'] = (int) CRM_Utils_Weight::getDefaultWeight('CRM_Core_DAO_OptionValue',
-        array('option_group_id' => $params['option_group_id'])
-      );
-    }
+  $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
+  if (!empty($params['id']) && !array_key_exists('option_group_id', $params)) {
+    $groupId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue',
+      $params['id'], 'option_group_id', 'id'
+    );
   }
-
-  if (isset($params['component'])) {// allow a component to be reset to ''
-    // convert 'component' to 'component_id'
-    if (empty($params['component'])) {
-      $params['component_id'] = '';
-    } else {
-      $params['component_id'] = array_search($params['component'], CRM_Core_PseudoConstant::component());
-    }
-    unset($params['component']);
+  else {
+    $groupId = $params['option_group_id'];
   }
 
-  if (CRM_Utils_Array::value('id', $params)) {
-    $ids = array('optionValue' => $params['id']);
-  }
-  $optionValueBAO = CRM_Core_BAO_OptionValue::add($params, $ids);
-  civicrm_api('option_value', 'getfields', array('version' => 3, 'cache_clear' => 1, 'option_group_id' => $params['option_group_id']));
-  $values = array();
-  _civicrm_api3_object_to_array($optionValueBAO, $values[$optionValueBAO->id]);
-  return civicrm_api3_create_success($values, $params);
+  civicrm_api('option_value', 'getfields', array('version' => 3, 'cache_clear' => 1, 'option_group_id' => $groupId));
+  return $result;
 }
 
 /**
@@ -91,10 +65,10 @@ function civicrm_api3_option_value_create($params) {
  */
 function _civicrm_api3_option_value_create_spec(&$params) {
   $params['is_active']['api.default'] = 1;
-  $params['component']['type'] = CRM_Utils_Type::T_STRING;
-  $params['component']['options'] = array_values(CRM_Core_PseudoConstant::component());
+  //continue to support component
+  $params['component_id']['api.aliases'] = array('component');
   $params['name']['api.aliases'] = array('label');
-  // $params['component_id']['pseudoconstant'] = 'component';
+  $params['option_group_id']['api.required'] = TRUE;
 }
 
 /**