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 groups.
31 * OptionGroups are containers for option values.
33 * @package CiviCRM_APIv3
39 * @param array $params
43 function civicrm_api3_option_group_get($params) {
44 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
48 * Create/update option group.
50 * @param array $params
51 * Array per getfields metadata.
55 function civicrm_api3_option_group_create($params) {
56 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
60 * Adjust Metadata for Create action.
62 * The metadata is used for setting defaults, documentation & validation.
64 * @param array $params
65 * Array of parameters determined by getfields.
67 function _civicrm_api3_option_group_create_spec(&$params) {
68 $params['name']['api.unique'] = 1;
69 $params['is_active']['api.default'] = TRUE;
73 * Delete an existing Option Group.
75 * This method is used to delete any existing OptionGroup given its id.
77 * @param array $params
83 function civicrm_api3_option_group_delete($params) {
84 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);