| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.6 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
| 7 | +--------------------------------------------------------------------+ |
| 8 | | This file is a part of CiviCRM. | |
| 9 | | | |
| 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. | |
| 13 | | | |
| 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. | |
| 18 | | | |
| 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 | +--------------------------------------------------------------------+ |
| 26 | */ |
| 27 | |
| 28 | /** |
| 29 | * This api exposes CiviCRM option values. |
| 30 | * |
| 31 | * Values are grouped by "OptionGroup" |
| 32 | * |
| 33 | * @package CiviCRM_APIv3 |
| 34 | */ |
| 35 | |
| 36 | /** |
| 37 | * Retrieve one or more option values. |
| 38 | * |
| 39 | * @param array $params |
| 40 | * |
| 41 | * @return array |
| 42 | * Details of found Option Values |
| 43 | */ |
| 44 | function civicrm_api3_option_value_get($params) { |
| 45 | |
| 46 | if (empty($params['option_group_id']) && !empty($params['option_group_name'])) { |
| 47 | $opt = array('version' => 3, 'name' => $params['option_group_name']); |
| 48 | $optionGroup = civicrm_api('OptionGroup', 'Get', $opt); |
| 49 | if (empty($optionGroup['id'])) { |
| 50 | return civicrm_api3_create_error("option group name does not correlate to a single option group"); |
| 51 | } |
| 52 | $params['option_group_id'] = $optionGroup['id']; |
| 53 | } |
| 54 | |
| 55 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 56 | } |
| 57 | |
| 58 | /** |
| 59 | * Add an OptionValue. |
| 60 | * |
| 61 | * @param array $params |
| 62 | * |
| 63 | * @throws API_Exception |
| 64 | * @return array |
| 65 | */ |
| 66 | function civicrm_api3_option_value_create($params) { |
| 67 | $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 68 | if (!empty($params['id']) && !array_key_exists('option_group_id', $params)) { |
| 69 | $groupId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', |
| 70 | $params['id'], 'option_group_id', 'id' |
| 71 | ); |
| 72 | } |
| 73 | else { |
| 74 | $groupId = $params['option_group_id']; |
| 75 | } |
| 76 | |
| 77 | civicrm_api('option_value', 'getfields', array('version' => 3, 'cache_clear' => 1, 'option_group_id' => $groupId)); |
| 78 | return $result; |
| 79 | } |
| 80 | |
| 81 | /** |
| 82 | * Adjust Metadata for Create action. |
| 83 | * |
| 84 | * The metadata is used for setting defaults, documentation & validation. |
| 85 | * |
| 86 | * @param array $params |
| 87 | * Array of parameters determined by getfields. |
| 88 | */ |
| 89 | function _civicrm_api3_option_value_create_spec(&$params) { |
| 90 | $params['is_active']['api.default'] = 1; |
| 91 | //continue to support component |
| 92 | $params['component_id']['api.aliases'] = array('component'); |
| 93 | $params['name']['api.aliases'] = array('label'); |
| 94 | $params['option_group_id']['api.required'] = TRUE; |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * Deletes an existing option value. |
| 99 | * |
| 100 | * @param array $params |
| 101 | * |
| 102 | * @return array |
| 103 | * Api result |
| 104 | */ |
| 105 | function civicrm_api3_option_value_delete($params) { |
| 106 | // We will get the option group id before deleting so we can flush pseudoconstants. |
| 107 | $optionGroupID = civicrm_api('option_value', 'getvalue', array('version' => 3, 'id' => $params['id'], 'return' => 'option_group_id')); |
| 108 | if (CRM_Core_BAO_OptionValue::del((int) $params['id'])) { |
| 109 | civicrm_api('option_value', 'getfields', array('version' => 3, 'cache_clear' => 1, 'option_group_id' => $optionGroupID)); |
| 110 | return civicrm_api3_create_success(); |
| 111 | } |
| 112 | else { |
| 113 | civicrm_api3_create_error('Could not delete OptionValue ' . $params['id']); |
| 114 | } |
| 115 | } |