4 * Retrieve one or more OptionValues
8 * @internal param $array $ params input parameters
10 * {@example OptionValueGet.php 0}
11 * @example OptionValueGet.php
13 * @return array details of found Option Values
14 * {@getfields OptionValue_get}
17 function civicrm_api3_option_value_get($params) {
19 if (empty($params['option_group_id']) && !empty($params['option_group_name'])) {
20 $opt = array('version' => 3, 'name' => $params['option_group_name']);
21 $optionGroup = civicrm_api('OptionGroup', 'Get', $opt);
22 if (empty($optionGroup['id'])) {
23 return civicrm_api3_create_error("option group name does not correlate to a single option group");
25 $params['option_group_id'] = $optionGroup['id'];
28 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
32 * Add a OptionValue. OptionValues are used to classify CRM entities (including Contacts, Groups and Actions).
34 * Allowed @params array keys are:
36 * {@example OptionValueCreate.php}
40 * @throws API_Exception
41 * @return array of newly created option_value property values.
42 * {@getfields OptionValue_create}
45 function civicrm_api3_option_value_create($params) {
46 $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
47 if (!empty($params['id']) && !array_key_exists('option_group_id', $params)) {
48 $groupId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue',
49 $params['id'], 'option_group_id', 'id'
53 $groupId = $params['option_group_id'];
56 civicrm_api('option_value', 'getfields', array('version' => 3, 'cache_clear' => 1, 'option_group_id' => $groupId));
61 * Adjust Metadata for Create action
63 * The metadata is used for setting defaults, documentation & validation
64 * @param array $params array or parameters determined by getfields
66 function _civicrm_api3_option_value_create_spec(&$params) {
67 $params['is_active']['api.default'] = 1;
68 //continue to support component
69 $params['component_id']['api.aliases'] = array('component');
70 $params['name']['api.aliases'] = array('label');
71 $params['option_group_id']['api.required'] = TRUE;
75 * Deletes an existing OptionValue
77 * @param array $params
79 * {@example OptionValueDelete.php 0}
81 * @return array Api result
82 * {@getfields OptionValue_create}
85 function civicrm_api3_option_value_delete($params) {
86 // we will get the option group id before deleting so we can flush pseudoconstants
87 $optionGroupID = civicrm_api('option_value', 'getvalue', array('version' => 3, 'id' => $params['id'], 'return' => 'option_group_id'));
88 if(CRM_Core_BAO_OptionValue
::del((int) $params['id'])){
89 civicrm_api('option_value', 'getfields', array('version' => 3, 'cache_clear' => 1, 'option_group_id' => $optionGroupID));
90 return civicrm_api3_create_success();
93 civicrm_api3_create_error('Could not delete OptionValue ' . $params['id']);