4 * Retrieve one or more OptionValues
6 * @param array $ params input parameters
8 * {@example OptionValueGet.php 0}
9 * @example OptionValueGet.php
11 * @return array details of found Option Values
12 * {@getfields OptionValue_get}
15 function civicrm_api3_option_value_get($params) {
17 if (empty($params['option_group_id']) && !empty($params['option_group_name'])) {
18 $opt = array('version' => 3, 'name' => $params['option_group_name']);
19 $optionGroup = civicrm_api('OptionGroup', 'Get', $opt);
20 if (empty($optionGroup['id'])) {
21 return civicrm_api3_create_error("option group name does not correlate to a single option group");
23 $params['option_group_id'] = $optionGroup['id'];
26 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
30 * Add a OptionValue. OptionValues are used to classify CRM entities (including Contacts, Groups and Actions).
32 * Allowed @params array keys are:
34 * {@example OptionValueCreate.php}
36 * @return array of newly created option_value property values.
37 * {@getfields OptionValue_create}
40 function civicrm_api3_option_value_create($params) {
41 $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
43 // CRM-13814 : evalute option group id
44 // option group id would be passed in case of adding a new option value record
45 if (!empty($params['id']) && !array_key_exists('option_group_id', $params)) {
46 $groupId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue',
47 $params['id'], 'option_group_id', 'id'
51 $groupId = $params['option_group_id'];
54 civicrm_api('option_value', 'getfields', array('version' => 3, 'cache_clear' => 1, 'option_group_id' => $groupId));
59 * Adjust Metadata for Create action
61 * The metadata is used for setting defaults, documentation & validation
62 * @param array $params array or parameters determined by getfields
64 function _civicrm_api3_option_value_create_spec(&$params) {
65 $params['is_active']['api.default'] = 1;
66 //continue to support component
67 $params['component_id']['api.aliases'] = array('component');
68 $params['name']['api.aliases'] = array('label');
69 $params['option_group_id']['api.required'] = TRUE;
73 * Deletes an existing OptionValue
75 * @param array $params
77 * {@example OptionValueDelete.php 0}
79 * @return array Api result
80 * {@getfields OptionValue_create}
83 function civicrm_api3_option_value_delete($params) {
84 // we will get the option group id before deleting so we can flush pseudoconstants
85 $optionGroupID = civicrm_api('option_value', 'getvalue', array('version' => 3, 'id' => $params['id'], 'return' => 'option_group_id'));
86 if(CRM_Core_BAO_OptionValue
::del((int) $params['id'])){
87 civicrm_api('option_value', 'getfields', array('version' => 3, 'cache_clear' => 1, 'option_group_id' => $optionGroupID));
88 return civicrm_api3_create_success();
91 civicrm_api3_create_error('Could not delete OptionValue ' . $params['id']);