3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * This api exposes CiviCRM option values.
31 * Values are grouped by "OptionGroup"
33 * @package CiviCRM_APIv3
37 * Retrieve one or more option values.
39 * @param array $params
44 function civicrm_api3_option_value_get($params) {
45 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
49 * Adjust Metadata for get action.
51 * The metadata is used for setting defaults, documentation & validation.
53 * @param array $params
54 * Array of parameters determined by getfields.
56 function _civicrm_api3_option_value_get_spec(&$params) {
57 $params['option_group_id']['api.aliases'] = array('option_group_name');
63 * @param array $params
65 * @throws API_Exception
69 function civicrm_api3_option_value_create($params) {
70 $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
71 if (!empty($params['id']) && !array_key_exists('option_group_id', $params)) {
72 $groupId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue',
73 $params['id'], 'option_group_id', 'id'
77 $groupId = $params['option_group_id'];
80 civicrm_api('option_value', 'getfields', array('version' => 3, 'cache_clear' => 1, 'option_group_id' => $groupId));
85 * Adjust Metadata for Create action.
87 * The metadata is used for setting defaults, documentation & validation.
89 * @param array $params
90 * Array of parameters determined by getfields.
92 function _civicrm_api3_option_value_create_spec(&$params) {
93 $params['is_active']['api.default'] = 1;
94 //continue to support component
95 $params['component_id']['api.aliases'] = array('component');
96 // $params['name']['api.aliases'] = array('label');
97 $params['option_group_id']['api.required'] = TRUE;
101 * Deletes an existing option value.
103 * @param array $params
104 * @return array API result array
105 * @throws API_Exception
107 function civicrm_api3_option_value_delete($params) {
108 // We will get the option group id before deleting so we can flush pseudoconstants.
109 $optionGroupID = civicrm_api('option_value', 'getvalue', array('version' => 3, 'id' => $params['id'], 'return' => 'option_group_id'));
110 $result = CRM_Core_BAO_OptionValue
::del($params['id']);
112 civicrm_api('option_value', 'getfields', array('version' => 3, 'cache_clear' => 1, 'option_group_id' => $optionGroupID));
113 return civicrm_api3_create_success();
116 throw new API_Exception('Could not delete OptionValue ' . $params['id']);