Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
1f4ea726 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
6a488035 TO |
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 | /** | |
244bbdd8 | 29 | * This api exposes CiviCRM GroupNesting. |
6a488035 | 30 | * |
b081365f | 31 | * This defines parent/child relationships between nested groups. |
6a488035 | 32 | * |
b081365f | 33 | * @package CiviCRM_APIv3 |
6a488035 TO |
34 | */ |
35 | ||
6a488035 TO |
36 | /** |
37 | * Provides group nesting record(s) given parent and/or child id. | |
38 | * | |
cf470720 TO |
39 | * @param array $params |
40 | * An array containing at least child_group_id or parent_group_id. | |
6a488035 | 41 | * |
a6c01b45 | 42 | * @return array |
72b3a70c | 43 | * list of group nesting records |
6a488035 TO |
44 | */ |
45 | function civicrm_api3_group_nesting_get($params) { | |
6a488035 TO |
46 | return _civicrm_api3_basic_get('CRM_Contact_DAO_GroupNesting', $params); |
47 | } | |
48 | ||
49 | /** | |
50 | * Creates group nesting record for given parent and child id. | |
22242c87 | 51 | * |
6a488035 TO |
52 | * Parent and child groups need to exist. |
53 | * | |
cf470720 TO |
54 | * @param array $params |
55 | * Parameters array - allowed array keys include:. | |
6a488035 | 56 | * |
a6c01b45 | 57 | * @return array |
1237d8d7 | 58 | * API success array |
6a488035 TO |
59 | */ |
60 | function civicrm_api3_group_nesting_create($params) { | |
1237d8d7 | 61 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'GroupNesting'); |
6a488035 | 62 | } |
11e09c59 TO |
63 | |
64 | /** | |
0aa0303c EM |
65 | * Adjust Metadata for Create action. |
66 | * | |
67 | * The metadata is used for setting defaults, documentation & validation. | |
1c88e578 | 68 | * |
cf470720 | 69 | * @param array $params |
b081365f | 70 | * Array of parameters determined by getfields. |
6a488035 TO |
71 | */ |
72 | function _civicrm_api3_group_nesting_create_spec(&$params) { | |
73 | $params['child_group_id']['api.required'] = 1; | |
74 | $params['parent_group_id']['api.required'] = 1; | |
75 | } | |
76 | ||
77 | /** | |
78 | * Removes specific nesting records. | |
79 | * | |
cf470720 | 80 | * @param array $params |
6a488035 | 81 | * |
a6c01b45 | 82 | * @return array |
72b3a70c | 83 | * API Success or fail array |
6a488035 TO |
84 | * |
85 | * @todo Work out the return value. | |
86 | */ | |
87 | function civicrm_api3_group_nesting_delete($params) { | |
6a488035 TO |
88 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
89 | } |