api/v3/GroupNesting.php

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