Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
c28e1768 CW |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
81621fee | 4 | | CiviCRM version 4.7 | |
c28e1768 | 5 | +--------------------------------------------------------------------+ |
1f4ea726 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
c28e1768 CW |
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 groups. | |
244bbdd8 CW |
30 | * |
31 | * OptionGroups are containers for option values. | |
c28e1768 CW |
32 | * |
33 | * @package CiviCRM_APIv3 | |
c28e1768 | 34 | */ |
6a488035 | 35 | |
aa1b1481 | 36 | /** |
61fe4988 EM |
37 | * Get option groups. |
38 | * | |
c490a46a | 39 | * @param array $params |
aa1b1481 EM |
40 | * |
41 | * @return array | |
42 | */ | |
6a488035 | 43 | function civicrm_api3_option_group_get($params) { |
6a488035 TO |
44 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
45 | } | |
46 | ||
47 | /** | |
9d32e6f7 | 48 | * Create/update option group. |
6a488035 | 49 | * |
cf470720 | 50 | * @param array $params |
9d32e6f7 | 51 | * Array per getfields metadata. |
6a488035 | 52 | * |
a6c01b45 | 53 | * @return array |
6a488035 TO |
54 | */ |
55 | function civicrm_api3_option_group_create($params) { | |
4033343a | 56 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
6a488035 TO |
57 | } |
58 | ||
11e09c59 | 59 | /** |
211e2fca EM |
60 | * Adjust Metadata for Create action. |
61 | * | |
62 | * The metadata is used for setting defaults, documentation & validation. | |
1c88e578 | 63 | * |
cf470720 | 64 | * @param array $params |
b081365f | 65 | * Array of parameters determined by getfields. |
6a488035 TO |
66 | */ |
67 | function _civicrm_api3_option_group_create_spec(&$params) { | |
68 | $params['name']['api.unique'] = 1; | |
801bafd7 | 69 | $params['is_active']['api.default'] = TRUE; |
6a488035 | 70 | } |
4033343a | 71 | |
72 | /** | |
211e2fca | 73 | * Delete an existing Option Group. |
4033343a | 74 | * |
244bbdd8 | 75 | * This method is used to delete any existing OptionGroup given its id. |
4033343a | 76 | * |
cf470720 | 77 | * @param array $params |
c28e1768 | 78 | * [id] |
4033343a | 79 | * |
a6c01b45 | 80 | * @return array |
72b3a70c | 81 | * API Result Array |
4033343a | 82 | */ |
83 | function civicrm_api3_option_group_delete($params) { | |
84 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
85 | } |