api/v3/Group.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2020                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * This api exposes CiviCRM Groups.
  30  *
  31  * This api is for creating/deleting groups or fetching a list of existing groups.
  32  * To add/remove contacts to a group, use the GroupContact api instead.
  33  *
  34  * @package CiviCRM_APIv3
  35  */
  36
  37 /**
  38  * Create/update group.
  39  *
  40  * @param array $params
  41  *   name/value pairs to insert in new 'Group'
  42  *
  43  * @return array
  44  *   API result array
  45  */
  46 function civicrm_api3_group_create($params) {
  47   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Group');
  48 }
  49
  50 /**
  51  * Adjust Metadata for Create action.
  52  *
  53  * The metadata is used for setting defaults, documentation & validation.
  54  *
  55  * @param array $params
  56  *   Array of parameters determined by getfields.
  57  */
  58 function _civicrm_api3_group_create_spec(&$params) {
  59   $params['is_active']['api.default'] = 1;
  60   $params['title']['api.required'] = 1;
  61 }
  62
  63 /**
  64  * Returns array of groups matching a set of one or more Group properties.
  65  *
  66  * @param array $params
  67  *   Array of properties. If empty, all records will be returned.
  68  *
  69  * @return array
  70  *   Array of matching groups
  71  */
  72 function civicrm_api3_group_get($params) {
  73   $options = _civicrm_api3_get_options_from_params($params, TRUE, 'Group', 'get');
  74
  75   if ($options['is_count']) {
  76     $params['options']['is_count'] = 0;
  77     $params['return'] = 'id';
  78   }
  79
  80   $groups = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, FALSE, 'Group');
  81   foreach ($groups as $id => $group) {
  82     if (!empty($params['check_permissions']) && !CRM_Contact_BAO_Group::checkPermission($group['id'])) {
  83       unset($groups[$id]);
  84     }
  85     if (!empty($options['return']) && in_array('member_count', $options['return'])) {
  86       $groups[$id]['member_count'] = CRM_Contact_BAO_Group::memberCount($id);
  87     }
  88   }
  89   return civicrm_api3_create_success($groups, $params, 'Group', 'get');
  90 }
  91
  92 /**
  93  * Delete an existing Group.
  94  *
  95  * @param array $params
  96  *   [id]
  97  * @return array API result array
  98  * @throws API_Exception
  99  */
 100 function civicrm_api3_group_delete($params) {
 101   $group = civicrm_api3_group_get(['id' => $params['id']]);
 102   if ($group['count'] == 0) {
 103     throw new API_Exception('Could not delete group ' . $params['id']);
 104   }
 105   CRM_Contact_BAO_Group::discard($params['id']);
 106   return civicrm_api3_create_success(TRUE);
 107 }