projects
/
civicrm-core.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
version fixes
[civicrm-core.git]
/
api
/
v3
/
GroupOrganization.php
diff --git
a/api/v3/GroupOrganization.php
b/api/v3/GroupOrganization.php
index d0b4b420cb535a7a12ca23a6c1e769e6f07d8de5..607ffe1286a00fbfa5dcf3fcf1eb5788d3d0aeb5 100644
(file)
--- a/
api/v3/GroupOrganization.php
+++ b/
api/v3/GroupOrganization.php
@@
-1,10
+1,9
@@
<?php
<?php
-
/*
+--------------------------------------------------------------------+
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.
6
|
+ | CiviCRM version 4.
7
|
+--------------------------------------------------------------------+
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-201
4
|
+ | Copyright CiviCRM LLC (c) 2004-201
5
|
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
@@
-27,44
+26,32
@@
*/
/**
*/
/**
- *
File for the CiviCRM APIv3 group contact functions
+ *
This api exposes the relationships between organizations and CiviCRM groups.
*
* @package CiviCRM_APIv3
*
* @package CiviCRM_APIv3
- * @subpackage API_Group
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: GroupContact.php 21624 2009-06-04 22:02:55Z mover $
- *
*/
/**
*/
/**
- * This API will give list of the groups for particular contact
- * Particualr status can be sent in params array
- * If no status mentioned in params, by default 'added' will be used
- * to fetch the records
+ * Get group organization record/s.
*
* @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
*
* @return array
- * list of groups, given contact subsribed to
+ * list of groups, given contact subs
c
ribed to
*/
function civicrm_api3_group_organization_get($params) {
return _civicrm_api3_basic_get('CRM_Contact_DAO_GroupOrganization', $params);
}
/**
*/
function civicrm_api3_group_organization_get($params) {
return _civicrm_api3_basic_get('CRM_Contact_DAO_GroupOrganization', $params);
}
/**
- * @example GroupOrganizationCreate.php
- * {@getfields GroupOrganization_create}
+ * Create group organization record.
*
* @param array $params
* Array.
*
* @return array
*
* @param array $params
* Array.
*
* @return array
- *
*/
function civicrm_api3_group_organization_create($params) {
*/
function civicrm_api3_group_organization_create($params) {
@@
-75,15
+62,16
@@
function civicrm_api3_group_organization_create($params) {
}
_civicrm_api3_object_to_array($groupOrgBAO, $values);
}
_civicrm_api3_object_to_array($groupOrgBAO, $values);
- return civicrm_api3_create_success($values, $params, '
group_o
rganization', 'get', $groupOrgBAO);
+ return civicrm_api3_create_success($values, $params, '
GroupO
rganization', 'get', $groupOrgBAO);
}
/**
}
/**
- * 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
* @param array $params
- * Array o
r
parameters determined by getfields.
+ * Array o
f
parameters determined by getfields.
*/
function _civicrm_api3_group_organization_create_spec(&$params) {
$params['organization_id']['api.required'] = 1;
*/
function _civicrm_api3_group_organization_create_spec(&$params) {
$params['organization_id']['api.required'] = 1;
@@
-91,7
+79,7
@@
function _civicrm_api3_group_organization_create_spec(&$params) {
}
/**
}
/**
- * Deletes an existing Group Organization
+ * Deletes an existing Group Organization
.
*
* This API is used for deleting a Group Organization
*
*
* This API is used for deleting a Group Organization
*
@@
-100,9
+88,6
@@
function _civicrm_api3_group_organization_create_spec(&$params) {
*
* @return array
* API Result
*
* @return array
* API Result
- * {@getfields GroupOrganization_delete}
- * @example GroupOrganizationDelete.php
- * @access public
*/
function civicrm_api3_group_organization_delete($params) {
*/
function civicrm_api3_group_organization_delete($params) {