4 * Retrieve one or more option values.
9 * Details of found Option Values
11 function civicrm_api3_option_value_get($params) {
13 if (empty($params['option_group_id']) && !empty($params['option_group_name'])) {
14 $opt = array('version' => 3, 'name' => $params['option_group_name']);
15 $optionGroup = civicrm_api('OptionGroup', 'Get', $opt);
16 if (empty($optionGroup['id'])) {
17 return civicrm_api3_create_error("option group name does not correlate to a single option group");
19 $params['option_group_id'] = $optionGroup['id'];
22 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
28 * @param array $params
30 * @throws API_Exception
32 * Array of newly created option_value property values.
34 function civicrm_api3_option_value_create($params) {
35 $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
36 if (!empty($params['id']) && !array_key_exists('option_group_id', $params)) {
37 $groupId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue',
38 $params['id'], 'option_group_id', 'id'
42 $groupId = $params['option_group_id'];
45 civicrm_api('option_value', 'getfields', array('version' => 3, 'cache_clear' => 1, 'option_group_id' => $groupId));
50 * Adjust Metadata for Create action.
52 * The metadata is used for setting defaults, documentation & validation.
54 * @param array $params
55 * Array or parameters determined by getfields.
57 function _civicrm_api3_option_value_create_spec(&$params) {
58 $params['is_active']['api.default'] = 1;
59 //continue to support component
60 $params['component_id']['api.aliases'] = array('component');
61 $params['name']['api.aliases'] = array('label');
62 $params['option_group_id']['api.required'] = TRUE;
66 * Deletes an existing option value.
68 * @param array $params
73 function civicrm_api3_option_value_delete($params) {
74 // We will get the option group id before deleting so we can flush pseudoconstants.
75 $optionGroupID = civicrm_api('option_value', 'getvalue', array('version' => 3, 'id' => $params['id'], 'return' => 'option_group_id'));
76 if (CRM_Core_BAO_OptionValue
::del((int) $params['id'])) {
77 civicrm_api('option_value', 'getfields', array('version' => 3, 'cache_clear' => 1, 'option_group_id' => $optionGroupID));
78 return civicrm_api3_create_success();
81 civicrm_api3_create_error('Could not delete OptionValue ' . $params['id']);