CRM-16173 - Add Cxn.register API. Add extern/cxn.php endpoint.

[civicrm-core.git] / api / v3 / GroupNesting.php

diff --git a/api/v3/GroupNesting.php b/api/v3/GroupNesting.php
index 9d0e21f3fdc3ebc18f9b04f54ed7bdf56f473dbc..2bae63e46f46801a22d1de930813bd00ead0d37b 100644 (file)
--- a/api/v3/GroupNesting.php
+++ b/api/v3/GroupNesting.php
@@ -1,10 +1,9 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -27,53 +26,53 @@
  */
 
 /**
- * File for the CiviCRM APIv3 group nesting functions
- *
- * @package CiviCRM_APIv3
- * @subpackage API_Group
+ * This api exposes CiviCRM GroupNesting.
  *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: GroupNesting.php 21624 2009-08-07 22:02:55Z wmorgan $
+ * This defines parent/child relationships between nested groups.
  *
+ * @package CiviCRM_APIv3
  */
 
 /**
  * Provides group nesting record(s) given parent and/or child id.
  *
- * @param array $params  an array containing at least child_group_id or parent_group_id
- * {@getfields GroupNesting_get}
+ * @param array $params
+ *   An array containing at least child_group_id or parent_group_id.
  *
- * @return  array  list of group nesting records
+ * @return array
+ *   list of group nesting records
  */
 function civicrm_api3_group_nesting_get($params) {
-
   return _civicrm_api3_basic_get('CRM_Contact_DAO_GroupNesting', $params);
 }
 
 /**
  * Creates group nesting record for given parent and child id.
+ *
  * Parent and child groups need to exist.
  *
- * @param array $params parameters array - allowed array keys include:
+ * @param array $params
+ *   Parameters array - allowed array keys include:.
  *
- * @return array TBD
- * {@getfields GroupNesting_create
+ * @return array
+ *   TBD
  * @todo Work out the return value.
  */
 function civicrm_api3_group_nesting_create($params) {
-
   CRM_Contact_BAO_GroupNesting::add($params['parent_group_id'], $params['child_group_id']);
 
   // FIXME: CRM_Contact_BAO_GroupNesting requires some work
   $result = array('is_error' => 0);
-  return civicrm_api3_create_success($result, $params);
+  return civicrm_api3_create_success($result, $params, 'GroupNesting');
 }
 
 /**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
  *
- * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_group_nesting_create_spec(&$params) {
   $params['child_group_id']['api.required'] = 1;
@@ -83,15 +82,13 @@ function _civicrm_api3_group_nesting_create_spec(&$params) {
 /**
  * Removes specific nesting records.
  *
- * @param array $params parameters array - allowed array keys include:
- * {@getfields GroupNesting_delete}
+ * @param array $params
  *
- * @return array API Success or fail array
+ * @return array
+ *   API Success or fail array
  *
  * @todo Work out the return value.
  */
 function civicrm_api3_group_nesting_delete($params) {
-
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
-