3 +--------------------------------------------------------------------+
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 GroupNesting.
31 * This defines parent/child relationships between nested groups.
33 * @package CiviCRM_APIv3
37 * Provides group nesting record(s) given parent and/or child id.
39 * @param array $params
40 * An array containing at least child_group_id or parent_group_id.
43 * list of group nesting records
45 function civicrm_api3_group_nesting_get($params) {
46 return _civicrm_api3_basic_get('CRM_Contact_DAO_GroupNesting', $params);
50 * Creates group nesting record for given parent and child id.
52 * Parent and child groups need to exist.
54 * @param array $params
55 * Parameters array - allowed array keys include:.
60 function civicrm_api3_group_nesting_create($params) {
61 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'GroupNesting');
65 * Adjust Metadata for Create action.
67 * The metadata is used for setting defaults, documentation & validation.
69 * @param array $params
70 * Array of parameters determined by getfields.
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;
78 * Removes specific nesting records.
80 * @param array $params
83 * API Success or fail array
85 * @todo Work out the return value.
87 function civicrm_api3_group_nesting_delete($params) {
88 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);