Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
731a0992 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 | /** | |
29 | * File for the CiviCRM APIv3 group contact functions | |
30 | * | |
31 | * @package CiviCRM_APIv3 | |
32 | * @subpackage API_Group | |
33 | * | |
731a0992 | 34 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
35 | * @version $Id: GroupContact.php 21624 2009-06-04 22:02:55Z mover $ |
36 | * | |
37 | */ | |
38 | ||
39 | ||
6a488035 TO |
40 | /** |
41 | * This API will give list of the groups for particular contact | |
42 | * Particualr status can be sent in params array | |
43 | * If no status mentioned in params, by default 'added' will be used | |
44 | * to fetch the records | |
45 | * | |
cf470720 TO |
46 | * @param array $params |
47 | * Name value pair of contact information. | |
6a488035 TO |
48 | * {@getfields GroupOrganization_get} |
49 | * @example GroupOrganizationGet.php | |
50 | * | |
a6c01b45 | 51 | * @return array |
72b3a70c | 52 | * list of groups, given contact subsribed to |
6a488035 TO |
53 | */ |
54 | function civicrm_api3_group_organization_get($params) { | |
55 | return _civicrm_api3_basic_get('CRM_Contact_DAO_GroupOrganization', $params); | |
56 | } | |
57 | ||
58 | /** | |
59 | * @example GroupOrganizationCreate.php | |
60 | * {@getfields GroupOrganization_create} | |
61 | * | |
16b10e64 | 62 | * @param array $params |
cf470720 | 63 | * Array. |
6a488035 TO |
64 | * |
65 | * @return array | |
66 | * | |
67 | */ | |
68 | function civicrm_api3_group_organization_create($params) { | |
69 | ||
70 | $groupOrgBAO = CRM_Contact_BAO_GroupOrganization::add($params); | |
71 | ||
72 | if (is_null($groupOrgBAO)) { | |
73 | return civicrm_api3_create_error("group organization not created"); | |
74 | } | |
75 | ||
76 | _civicrm_api3_object_to_array($groupOrgBAO, $values); | |
77 | return civicrm_api3_create_success($values, $params, 'group_organization', 'get', $groupOrgBAO); | |
78 | } | |
79 | ||
11e09c59 | 80 | /** |
6a488035 | 81 | * Adjust Metadata for Create action |
1c88e578 | 82 | * |
6a488035 | 83 | * The metadata is used for setting defaults, documentation & validation |
cf470720 TO |
84 | * @param array $params |
85 | * Array or parameters determined by getfields. | |
6a488035 TO |
86 | */ |
87 | function _civicrm_api3_group_organization_create_spec(&$params) { | |
88 | $params['organization_id']['api.required'] = 1; | |
89 | $params['group_id']['api.required'] = 1; | |
90 | } | |
91 | ||
92 | /** | |
93 | * Deletes an existing Group Organization | |
94 | * | |
95 | * This API is used for deleting a Group Organization | |
96 | * | |
cf470720 TO |
97 | * @param array $params |
98 | * With 'id' = ID of the Group Organization to be deleted. | |
6a488035 | 99 | * |
a6c01b45 | 100 | * @return array |
72b3a70c | 101 | * API Result |
6a488035 TO |
102 | * {@getfields GroupOrganization_delete} |
103 | * @example GroupOrganizationDelete.php | |
6a488035 TO |
104 | */ |
105 | function civicrm_api3_group_organization_delete($params) { | |
106 | ||
107 | $result = CRM_Contact_BAO_GroupOrganization::deleteGroupOrganization($params['id']); | |
108 | return $result ? civicrm_api3_create_success('Deleted Group Organization successfully') : civicrm_api3_create_error('Could not delete Group Organization'); | |
109 | } |