97 lines
3.4 KiB
PHP
97 lines
3.4 KiB
PHP
<?php
|
|
/*
|
|
+--------------------------------------------------------------------+
|
|
| CiviCRM version 4.7 |
|
|
+--------------------------------------------------------------------+
|
|
| Copyright CiviCRM LLC (c) 2004-2017 |
|
|
+--------------------------------------------------------------------+
|
|
| This file is a part of CiviCRM. |
|
|
| |
|
|
| CiviCRM is free software; you can copy, modify, and distribute it |
|
|
| under the terms of the GNU Affero General Public License |
|
|
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
|
|
| |
|
|
| CiviCRM is distributed in the hope that it will be useful, but |
|
|
| WITHOUT ANY WARRANTY; without even the implied warranty of |
|
|
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
|
|
| See the GNU Affero General Public License for more details. |
|
|
| |
|
|
| You should have received a copy of the GNU Affero General Public |
|
|
| License and the CiviCRM Licensing Exception along |
|
|
| with this program; if not, contact CiviCRM LLC |
|
|
| at info[AT]civicrm[DOT]org. If you have questions about the |
|
|
| GNU Affero General Public License or the licensing of CiviCRM, |
|
|
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
|
|
+--------------------------------------------------------------------+
|
|
*/
|
|
|
|
/**
|
|
* This api exposes the relationships between organizations and CiviCRM groups.
|
|
*
|
|
* @package CiviCRM_APIv3
|
|
*/
|
|
|
|
|
|
/**
|
|
* Get group organization record/s.
|
|
*
|
|
* @param array $params
|
|
* Name value pair of contact information.
|
|
*
|
|
* @return array
|
|
* list of groups, given contact subscribed to
|
|
*/
|
|
function civicrm_api3_group_organization_get($params) {
|
|
return _civicrm_api3_basic_get('CRM_Contact_DAO_GroupOrganization', $params);
|
|
}
|
|
|
|
/**
|
|
* Create group organization record.
|
|
*
|
|
* @param array $params
|
|
* Array.
|
|
*
|
|
* @return array
|
|
*/
|
|
function civicrm_api3_group_organization_create($params) {
|
|
|
|
$groupOrgBAO = CRM_Contact_BAO_GroupOrganization::add($params);
|
|
|
|
if (is_null($groupOrgBAO)) {
|
|
return civicrm_api3_create_error("group organization not created");
|
|
}
|
|
|
|
_civicrm_api3_object_to_array($groupOrgBAO, $values);
|
|
return civicrm_api3_create_success($values, $params, 'GroupOrganization', 'get', $groupOrgBAO);
|
|
}
|
|
|
|
/**
|
|
* Adjust Metadata for Create action.
|
|
*
|
|
* The metadata is used for setting defaults, documentation & validation.
|
|
*
|
|
* @param array $params
|
|
* Array of parameters determined by getfields.
|
|
*/
|
|
function _civicrm_api3_group_organization_create_spec(&$params) {
|
|
$params['organization_id']['api.required'] = 1;
|
|
$params['group_id']['api.required'] = 1;
|
|
}
|
|
|
|
/**
|
|
* Deletes an existing Group Organization.
|
|
*
|
|
* This API is used for deleting a Group Organization
|
|
*
|
|
* @param array $params
|
|
* With 'id' = ID of the Group Organization to be deleted.
|
|
*
|
|
* @return array
|
|
* API Result
|
|
*/
|
|
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');
|
|
}
|