108 lines
3.9 KiB
PHP
108 lines
3.9 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 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
|
|
*/
|
|
|
|
/**
|
|
* Create/update group.
|
|
*
|
|
* @param array $params
|
|
* name/value pairs to insert in new 'Group'
|
|
*
|
|
* @return array
|
|
* API result array
|
|
*/
|
|
function civicrm_api3_group_create($params) {
|
|
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Group');
|
|
}
|
|
|
|
/**
|
|
* 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_create_spec(&$params) {
|
|
$params['is_active']['api.default'] = 1;
|
|
$params['title']['api.required'] = 1;
|
|
}
|
|
|
|
/**
|
|
* Returns array of groups matching a set of one or more Group properties.
|
|
*
|
|
* @param array $params
|
|
* Array of properties. If empty, all records will be returned.
|
|
*
|
|
* @return array
|
|
* Array of matching groups
|
|
*/
|
|
function civicrm_api3_group_get($params) {
|
|
$options = _civicrm_api3_get_options_from_params($params, TRUE, 'Group', 'get');
|
|
|
|
if ($options['is_count']) {
|
|
$params['options']['is_count'] = 0;
|
|
$params['return'] = 'id';
|
|
}
|
|
|
|
$groups = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, FALSE, 'Group');
|
|
foreach ($groups as $id => $group) {
|
|
if (!empty($params['check_permissions']) && !CRM_Contact_BAO_Group::checkPermission($group['id'])) {
|
|
unset($groups[$id]);
|
|
}
|
|
if (!empty($options['return']) && in_array('member_count', $options['return'])) {
|
|
$groups[$id]['member_count'] = CRM_Contact_BAO_Group::memberCount($id);
|
|
}
|
|
}
|
|
return civicrm_api3_create_success($groups, $params, 'Group', 'get');
|
|
}
|
|
|
|
/**
|
|
* Delete an existing Group.
|
|
*
|
|
* @param array $params
|
|
* [id]
|
|
* @return array API result array
|
|
* @throws API_Exception
|
|
*/
|
|
function civicrm_api3_group_delete($params) {
|
|
$group = civicrm_api3_group_get(array('id' => $params['id']));
|
|
if ($group['count'] == 0) {
|
|
throw new API_Exception('Could not delete group ' . $params['id']);
|
|
}
|
|
CRM_Contact_BAO_Group::discard($params['id']);
|
|
return civicrm_api3_create_success(TRUE);
|
|
}
|