Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
81621fee | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
6a488035 TO |
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 | /** | |
244bbdd8 | 29 | * This api exposes CiviCRM Groups. |
b081365f CW |
30 | * |
31 | * This api is for creating/deleting groups or fetching a list of existing groups. | |
244bbdd8 | 32 | * To add/remove contacts to a group, use the GroupContact api instead. |
6a488035 TO |
33 | * |
34 | * @package CiviCRM_APIv3 | |
6a488035 TO |
35 | */ |
36 | ||
6a488035 | 37 | /** |
22242c87 | 38 | * Create/update group. |
6a488035 | 39 | * |
cf470720 | 40 | * @param array $params |
244bbdd8 | 41 | * name/value pairs to insert in new 'Group' |
6a488035 | 42 | * |
a6c01b45 | 43 | * @return array |
72b3a70c | 44 | * API result array |
6a488035 TO |
45 | */ |
46 | function civicrm_api3_group_create($params) { | |
e34ab426 | 47 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Group'); |
6a488035 | 48 | } |
11e09c59 TO |
49 | |
50 | /** | |
0aa0303c EM |
51 | * Adjust Metadata for Create action. |
52 | * | |
53 | * The metadata is used for setting defaults, documentation & validation. | |
6a488035 | 54 | * |
cf470720 | 55 | * @param array $params |
b081365f | 56 | * Array of parameters determined by getfields. |
6a488035 TO |
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 | /** | |
244bbdd8 | 64 | * Returns array of groups matching a set of one or more Group properties. |
6a488035 | 65 | * |
cf470720 | 66 | * @param array $params |
b081365f | 67 | * Array of properties. If empty, all records will be returned. |
6a488035 | 68 | * |
a6c01b45 | 69 | * @return array |
72b3a70c | 70 | * Array of matching groups |
6a488035 TO |
71 | */ |
72 | function civicrm_api3_group_get($params) { | |
244bbdd8 | 73 | $options = _civicrm_api3_get_options_from_params($params, TRUE, 'Group', 'get'); |
23f6cae2 | 74 | if ((empty($options['return']) || !in_array('member_count', $options['return'])) && empty($params['check_permissions'])) { |
75 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Group'); | |
76 | } | |
77 | ||
e34ab426 EM |
78 | $groups = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, FALSE, 'Group'); |
79 | foreach ($groups as $id => $group) { | |
23f6cae2 | 80 | if (!empty($params['check_permissions']) && !CRM_Contact_BAO_Group::checkPermission($group['id'])) { |
a0fd420c | 81 | unset($groups[$id]); |
82 | } | |
2f983add | 83 | elseif (!empty($options['return']) && in_array('member_count', $options['return'])) { |
a0fd420c | 84 | $groups[$id]['member_count'] = CRM_Contact_BAO_Group::memberCount($id); |
85 | } | |
e34ab426 | 86 | } |
244bbdd8 | 87 | return civicrm_api3_create_success($groups, $params, 'Group', 'get'); |
6a488035 TO |
88 | } |
89 | ||
90 | /** | |
244bbdd8 | 91 | * Delete an existing Group. |
6a488035 | 92 | * |
cf470720 | 93 | * @param array $params |
c28e1768 | 94 | * [id] |
6a488035 | 95 | * |
a6c01b45 | 96 | * @return array |
72b3a70c | 97 | * API result array |
6a488035 TO |
98 | */ |
99 | function civicrm_api3_group_delete($params) { | |
100 | ||
101 | CRM_Contact_BAO_Group::discard($params['id']); | |
102 | return civicrm_api3_create_success(TRUE); | |
103 | } |