X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FGroup.php;h=22f7e38eb07fd2b6cab675a0d414b8f72cace98b;hb=6049c0d89e4b18c81cea8108acc71ba6bdc3ba85;hp=786f15b2d58cb29202dbc2958ca01996e46b2569;hpb=da7a33feb6f28d09a8b2de93cb702b43ed484851;p=civicrm-core.git diff --git a/api/v3/Group.php b/api/v3/Group.php index 786f15b2d5..22f7e38eb0 100644 --- a/api/v3/Group.php +++ b/api/v3/Group.php @@ -2,7 +2,7 @@ /* +--------------------------------------------------------------------+ - | CiviCRM version 4.5 | + | CiviCRM version 4.6 | +--------------------------------------------------------------------+ | Copyright CiviCRM LLC (c) 2004-2014 | +--------------------------------------------------------------------+ @@ -39,15 +39,15 @@ * create/update group * * This API is used to create new group or update any of the existing - * In case of updating existing group, id of that particular grop must + * In case of updating existing group, id of that particular group must * be in $params array. Either id or name is required field in the * $params array * - * @param array $params (referance) Associative array of property + * @param array $params + * Associative array of property. * name/value pairs to insert in new 'group' * - * @return array returns id of the group created if success, - * error message otherwise + * @return array API result array *@example GroupCreate.php *{@getfields group_create} * @access public @@ -60,7 +60,8 @@ function civicrm_api3_group_create($params) { * Adjust Metadata for Create action * * The metadata is used for setting defaults, documentation & validation - * @param array $params array or parameters determined by getfields + * @param array $params + * Array or parameters determined by getfields. */ function _civicrm_api3_group_create_spec(&$params) { $params['is_active']['api.default'] = 1; @@ -70,7 +71,8 @@ function _civicrm_api3_group_create_spec(&$params) { /** * Returns array of groups matching a set of one or more group properties * - * @param array $params (referance) Array of one or more valid + * @param array $params + * Array of one or more valid. * property_name=>value pairs. If $params is set * as null, all groups will be returned * @@ -81,7 +83,7 @@ function _civicrm_api3_group_create_spec(&$params) { */ function civicrm_api3_group_get($params) { $options = _civicrm_api3_get_options_from_params($params, TRUE, 'group', 'get'); - if(empty($options['return']) || !in_array('member_count', $options['return'])) { + if (empty($options['return']) || !in_array('member_count', $options['return'])) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Group'); } @@ -98,7 +100,8 @@ function civicrm_api3_group_get($params) { * This method is used to delete any existing group. id of the group * to be deleted is required field in $params array * - * @param array $params array containing id of the group + * @param array $params + * Array containing id of the group. * to be deleted * * @return array API result array