X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FGroupOrganization.php;h=d0b4b420cb535a7a12ca23a6c1e769e6f07d8de5;hb=7d86179d7d8e91160bbb5e6643fa265198a99a2d;hp=9792f106e018688de4219d2552f0e2744f0618f4;hpb=6643a63b47c9607cdc5f14a739cf7c7cfe55d726;p=civicrm-core.git diff --git a/api/v3/GroupOrganization.php b/api/v3/GroupOrganization.php index 9792f106e0..d0b4b420cb 100644 --- a/api/v3/GroupOrganization.php +++ b/api/v3/GroupOrganization.php @@ -2,7 +2,7 @@ /* +--------------------------------------------------------------------+ - | CiviCRM version 4.5 | + | CiviCRM version 4.6 | +--------------------------------------------------------------------+ | Copyright CiviCRM LLC (c) 2004-2014 | +--------------------------------------------------------------------+ @@ -44,11 +44,13 @@ * If no status mentioned in params, by default 'added' will be used * to fetch the records * - * @param array $params name value pair of contact information + * @param array $params + * Name value pair of contact information. * {@getfields GroupOrganization_get} * @example GroupOrganizationGet.php * - * @return array list of groups, given contact subsribed to + * @return array + * list of groups, given contact subsribed to */ function civicrm_api3_group_organization_get($params) { return _civicrm_api3_basic_get('CRM_Contact_DAO_GroupOrganization', $params); @@ -58,7 +60,8 @@ function civicrm_api3_group_organization_get($params) { * @example GroupOrganizationCreate.php * {@getfields GroupOrganization_create} * - * @param $params array + * @param array $params + * Array. * * @return array * @@ -79,7 +82,8 @@ function civicrm_api3_group_organization_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_organization_create_spec(&$params) { $params['organization_id']['api.required'] = 1; @@ -91,9 +95,11 @@ function _civicrm_api3_group_organization_create_spec(&$params) { * * This API is used for deleting a Group Organization * - * @param array $params with 'id' = ID of the Group Organization to be deleted + * @param array $params + * With 'id' = ID of the Group Organization to be deleted. * - * @return array API Result + * @return array + * API Result * {@getfields GroupOrganization_delete} * @example GroupOrganizationDelete.php * @access public @@ -103,4 +109,3 @@ function civicrm_api3_group_organization_delete($params) { $result = CRM_Contact_BAO_GroupOrganization::deleteGroupOrganization($params['id']); return $result ? civicrm_api3_create_success('Deleted Group Organization successfully') : civicrm_api3_create_error('Could not delete Group Organization'); } -