Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
81621fee | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
1f4ea726 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
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 | /** | |
c28e1768 | 29 | * This api exposes the relationships between organizations and CiviCRM groups. |
6a488035 TO |
30 | * |
31 | * @package CiviCRM_APIv3 | |
6a488035 TO |
32 | */ |
33 | ||
34 | ||
6a488035 | 35 | /** |
9d32e6f7 | 36 | * Get group organization record/s. |
6a488035 | 37 | * |
cf470720 TO |
38 | * @param array $params |
39 | * Name value pair of contact information. | |
6a488035 | 40 | * |
a6c01b45 | 41 | * @return array |
9d32e6f7 | 42 | * list of groups, given contact subscribed to |
6a488035 TO |
43 | */ |
44 | function civicrm_api3_group_organization_get($params) { | |
45 | return _civicrm_api3_basic_get('CRM_Contact_DAO_GroupOrganization', $params); | |
46 | } | |
47 | ||
48 | /** | |
9d32e6f7 | 49 | * Create group organization record. |
6a488035 | 50 | * |
16b10e64 | 51 | * @param array $params |
cf470720 | 52 | * Array. |
6a488035 TO |
53 | * |
54 | * @return array | |
6a488035 TO |
55 | */ |
56 | function civicrm_api3_group_organization_create($params) { | |
57 | ||
58 | $groupOrgBAO = CRM_Contact_BAO_GroupOrganization::add($params); | |
59 | ||
60 | if (is_null($groupOrgBAO)) { | |
61 | return civicrm_api3_create_error("group organization not created"); | |
62 | } | |
63 | ||
64 | _civicrm_api3_object_to_array($groupOrgBAO, $values); | |
244bbdd8 | 65 | return civicrm_api3_create_success($values, $params, 'GroupOrganization', 'get', $groupOrgBAO); |
6a488035 TO |
66 | } |
67 | ||
11e09c59 | 68 | /** |
0aa0303c EM |
69 | * Adjust Metadata for Create action. |
70 | * | |
71 | * The metadata is used for setting defaults, documentation & validation. | |
1c88e578 | 72 | * |
cf470720 | 73 | * @param array $params |
b081365f | 74 | * Array of parameters determined by getfields. |
6a488035 TO |
75 | */ |
76 | function _civicrm_api3_group_organization_create_spec(&$params) { | |
77 | $params['organization_id']['api.required'] = 1; | |
78 | $params['group_id']['api.required'] = 1; | |
79 | } | |
80 | ||
81 | /** | |
9d32e6f7 | 82 | * Deletes an existing Group Organization. |
6a488035 TO |
83 | * |
84 | * This API is used for deleting a Group Organization | |
85 | * | |
cf470720 TO |
86 | * @param array $params |
87 | * With 'id' = ID of the Group Organization to be deleted. | |
6a488035 | 88 | * |
a6c01b45 | 89 | * @return array |
72b3a70c | 90 | * API Result |
6a488035 TO |
91 | */ |
92 | function civicrm_api3_group_organization_delete($params) { | |
93 | ||
94 | $result = CRM_Contact_BAO_GroupOrganization::deleteGroupOrganization($params['id']); | |
95 | return $result ? civicrm_api3_create_success('Deleted Group Organization successfully') : civicrm_api3_create_error('Could not delete Group Organization'); | |
96 | } |