3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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 * File for the CiviCRM APIv3 group nesting functions
31 * @package CiviCRM_APIv3
32 * @subpackage API_Group
34 * @copyright CiviCRM LLC (c) 2004-2014
35 * @version $Id: GroupNesting.php 21624 2009-08-07 22:02:55Z wmorgan $
40 * Provides group nesting record(s) given parent and/or child id.
42 * @param array $params
43 * An array containing at least child_group_id or parent_group_id.
44 * {@getfields GroupNesting_get}
47 * list of group nesting records
49 function civicrm_api3_group_nesting_get($params) {
51 return _civicrm_api3_basic_get('CRM_Contact_DAO_GroupNesting', $params);
55 * Creates group nesting record for given parent and child id.
56 * Parent and child groups need to exist.
58 * @param array $params
59 * Parameters array - allowed array keys include:.
63 * {@getfields GroupNesting_create
64 * @todo Work out the return value.
66 function civicrm_api3_group_nesting_create($params) {
68 CRM_Contact_BAO_GroupNesting
::add($params['parent_group_id'], $params['child_group_id']);
70 // FIXME: CRM_Contact_BAO_GroupNesting requires some work
71 $result = array('is_error' => 0);
72 return civicrm_api3_create_success($result, $params);
76 * Adjust Metadata for Create action
78 * The metadata is used for setting defaults, documentation & validation
79 * @param array $params
80 * Array or parameters determined by getfields.
82 function _civicrm_api3_group_nesting_create_spec(&$params) {
83 $params['child_group_id']['api.required'] = 1;
84 $params['parent_group_id']['api.required'] = 1;
88 * Removes specific nesting records.
90 * @param array $params
91 * Parameters array - allowed array keys include:.
92 * {@getfields GroupNesting_delete}
95 * API Success or fail array
97 * @todo Work out the return value.
99 function civicrm_api3_group_nesting_delete($params) {
101 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);