projects
/
civicrm-core.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Api docblock cleanup.
[civicrm-core.git]
/
api
/
v3
/
Group.php
diff --git
a/api/v3/Group.php
b/api/v3/Group.php
index 0bbc1640419dffb2dc0f76e50c685b57951e67b6..59ab73fcf4f097135fcfe28a8fa65bba5c1200f5 100644
(file)
--- a/
api/v3/Group.php
+++ b/
api/v3/Group.php
@@
-26,20
+26,19
@@
*/
/**
*/
/**
- * File for the CiviCRM APIv3 group functions
+ * This api exposes CiviCRM groups.
+ *
+ * This api is for creating/deleting groups or fetching a list of existing groups.
+ * To add/remove contacts to a group, use the groupContact api instead.
*
* @package CiviCRM_APIv3
*
* @package CiviCRM_APIv3
- * @subpackage API_Group
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: Group.php 30171 2010-10-14 09:11:27Z mover $
*/
/**
* Create/update group.
*
* @param array $params
*/
/**
* Create/update group.
*
* @param array $params
- * Associative array of property.
- * name/value pairs to insert in new 'group'
+ * name/value pairs to insert in new 'group'
*
* @return array
* API result array
*
* @return array
* API result array
@@
-54,7
+53,7
@@
function civicrm_api3_group_create($params) {
* The metadata is used for setting defaults, documentation & validation.
*
* @param array $params
* The metadata is used for setting defaults, documentation & validation.
*
* @param array $params
- * Array o
r
parameters determined by getfields.
+ * Array o
f
parameters determined by getfields.
*/
function _civicrm_api3_group_create_spec(&$params) {
$params['is_active']['api.default'] = 1;
*/
function _civicrm_api3_group_create_spec(&$params) {
$params['is_active']['api.default'] = 1;
@@
-65,9
+64,7
@@
function _civicrm_api3_group_create_spec(&$params) {
* Returns array of groups matching a set of one or more group properties.
*
* @param array $params
* Returns array of groups matching a set of one or more group properties.
*
* @param array $params
- * Array of one or more valid.
- * property_name=>value pairs. If $params is set
- * as null, all groups will be returned
+ * Array of properties. If empty, all records will be returned.
*
* @return array
* Array of matching groups
*
* @return array
* Array of matching groups
@@
-89,8
+86,7
@@
function civicrm_api3_group_get($params) {
* Delete an existing group.
*
* @param array $params
* Delete an existing group.
*
* @param array $params
- * Array containing id of the group.
- * to be deleted
+ * [id]
*
* @return array
* API result array
*
* @return array
* API result array