Merge pull request #6251 from LevityNL/master

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

diff --git a/api/v3/CustomGroup.php b/api/v3/CustomGroup.php
index b90ec9e6271783325853c6d09f535e2e376530ee..97c783af43f82f8cf3b5b9d2433a740c84fd6571 100644 (file)
--- a/api/v3/CustomGroup.php
+++ b/api/v3/CustomGroup.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -26,38 +26,22 @@
  */
 
 /**
- * File for the CiviCRM APIv3 custom group functions
+ * This api exposes CiviCRM custom group.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_CustomGroup
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: CustomGroup.php 30879 2010-11-22 15:45:55Z shot $
  */
 
 /**
- * Most API functions take in associative arrays ( name => value pairs
- * as parameters. Some of the most commonly used parameters are
- * described below
- *
- * @param array $params
- *   An associative array used in construction.
- *   retrieval of the object
- * @todo missing get function
+ * Use this API to create a new group.
  *
- *
- */
-
-/**
- * Use this API to create a new group.  The 'extends' value accepts an array or a comma separated string.
+ * The 'extends' value accepts an array or a comma separated string.
  * e.g array(
-   'Individual','Contact') or 'Individual,Contact'
+ * 'Individual','Contact') or 'Individual,Contact'
  * See the CRM Data Model for custom_group property definitions
  * $params['class_name'] is a required field, class being extended.
  *
  * @param array $params
- *   Array Associative array of property name/value pairs to insert in group.
- * {@getfields CustomGroup_create}
+ *   Array per getfields metadata.
  *
  * @return array
  * @todo $params['extends'] is array format - is that std compatible
@@ -80,10 +64,10 @@ function civicrm_api3_custom_group_create($params) {
 }
 
 /**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
  *
  * @param array $params
- *   Array or parameters determined by getfields.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_custom_group_create_spec(&$params) {
   $params['extends']['api.required'] = 1;
@@ -109,10 +93,10 @@ function civicrm_api3_custom_group_delete($params) {
 }
 
 /**
- * Use this API to get existing custom fields.
+ * API to get existing custom fields.
  *
  * @param array $params
- *   Array to search on.
+ *   Array per getfields metadata.
  *
  * @return array
  */
@@ -121,13 +105,16 @@ function civicrm_api3_custom_group_get($params) {
 }
 
 /**
- * CRM-15191 - Hack to ensure the cache gets cleared after updating a custom group
+ * CRM-15191 - Hack to ensure the cache gets cleared after updating a custom group.
+ *
  * @param array $params
+ *   Array per getfields metadata.
+ *
  * @return array
  */
 function civicrm_api3_custom_group_setvalue($params) {
   require_once 'api/v3/Generic/Setvalue.php';
-  $result = civicrm_api3_generic_setValue(array("entity" => 'custom_group', 'params' => $params));
+  $result = civicrm_api3_generic_setValue(array("entity" => 'CustomGroup', 'params' => $params));
   if (empty($result['is_error'])) {
     CRM_Utils_System::flushCache();
   }