4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.3 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2013 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
11 | CiviCRM is free software; you can copy, modify, and distribute it |
12 | under the terms of the GNU Affero General Public License |
13 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
15 | CiviCRM is distributed in the hope that it will be useful, but |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
18 | See the GNU Affero General Public License for more details. |
20 | You should have received a copy of the GNU Affero General Public |
21 | License and the CiviCRM Licensing Exception along |
22 | with this program; if not, contact CiviCRM LLC |
23 | at info[AT]civicrm[DOT]org. If you have questions about the |
24 | GNU Affero General Public License or the licensing of CiviCRM, |
25 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
26 +--------------------------------------------------------------------+
30 * File for the CiviCRM APIv3 group nesting functions
32 * @package CiviCRM_APIv3
33 * @subpackage API_Group
35 * @copyright CiviCRM LLC (c) 2004-2013
36 * @version $Id: GroupNesting.php 21624 2009-08-07 22:02:55Z wmorgan $
41 * Provides group nesting record(s) given parent and/or child id.
43 * @param array $params an array containing at least child_group_id or parent_group_id
44 * {@getfields GroupNesting_get}
46 * @return array list of group nesting records
48 function civicrm_api3_group_nesting_get($params) {
50 return _civicrm_api3_basic_get('CRM_Contact_DAO_GroupNesting', $params);
54 * Creates group nesting record for given parent and child id.
55 * Parent and child groups need to exist.
57 * @param array $params parameters array - allowed array keys include:
60 * {@getfields GroupNesting_create
61 * @todo Work out the return value.
63 function civicrm_api3_group_nesting_create($params) {
65 CRM_Contact_BAO_GroupNesting
::add($params['parent_group_id'], $params['child_group_id']);
67 // FIXME: CRM_Contact_BAO_GroupNesting requires some work
68 $result = array('is_error' => 0);
69 return civicrm_api3_create_success($result, $params);
73 * Adjust Metadata for Create action
75 * The metadata is used for setting defaults, documentation & validation
76 * @param array $params array or parameters determined by getfields
78 function _civicrm_api3_group_nesting_create_spec(&$params) {
79 $params['child_group_id']['api.required'] = 1;
80 $params['parent_group_id']['api.required'] = 1;
84 * Removes specific nesting records.
86 * @param array $params parameters array - allowed array keys include:
87 * {@getfields GroupNesting_delete}
89 * @return array API Success or fail array
91 * @todo Work out the return value.
93 function civicrm_api3_group_nesting_delete($params) {
95 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);