Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | |
3 | /* | |
4 | +--------------------------------------------------------------------+ | |
731a0992 | 5 | | CiviCRM version 4.5 | |
6a488035 | 6 | +--------------------------------------------------------------------+ |
731a0992 | 7 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
8 | +--------------------------------------------------------------------+ |
9 | | This file is a part of CiviCRM. | | |
10 | | | | |
11 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
12 | | under the terms of the GNU Affero General Public License | | |
13 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
14 | | | | |
15 | | CiviCRM is distributed in the hope that it will be useful, but | | |
16 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
17 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
18 | | See the GNU Affero General Public License for more details. | | |
19 | | | | |
20 | | You should have received a copy of the GNU Affero General Public | | |
21 | | License and the CiviCRM Licensing Exception along | | |
22 | | with this program; if not, contact CiviCRM LLC | | |
23 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
24 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
25 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
26 | +--------------------------------------------------------------------+ | |
27 | */ | |
28 | ||
29 | /** | |
30 | * File for the CiviCRM APIv3 group contact functions | |
31 | * | |
32 | * @package CiviCRM_APIv3 | |
33 | * @subpackage API_Group | |
34 | * | |
731a0992 | 35 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
36 | * @version $Id: GroupContact.php 21624 2009-06-04 22:02:55Z mover $ |
37 | * | |
38 | */ | |
39 | ||
40 | ||
6a488035 TO |
41 | /** |
42 | * This API will give list of the groups for particular contact | |
43 | * Particualr status can be sent in params array | |
44 | * If no status mentioned in params, by default 'added' will be used | |
45 | * to fetch the records | |
46 | * | |
47 | * @param array $params name value pair of contact information | |
48 | * {@getfields GroupOrganization_get} | |
49 | * @example GroupOrganizationGet.php | |
50 | * | |
51 | * @return array list of groups, given contact subsribed to | |
52 | */ | |
53 | function civicrm_api3_group_organization_get($params) { | |
54 | return _civicrm_api3_basic_get('CRM_Contact_DAO_GroupOrganization', $params); | |
55 | } | |
56 | ||
57 | /** | |
58 | * @example GroupOrganizationCreate.php | |
59 | * {@getfields GroupOrganization_create} | |
60 | * | |
61 | * @param $params array | |
62 | * | |
63 | * @return array | |
64 | * | |
65 | */ | |
66 | function civicrm_api3_group_organization_create($params) { | |
67 | ||
68 | $groupOrgBAO = CRM_Contact_BAO_GroupOrganization::add($params); | |
69 | ||
70 | if (is_null($groupOrgBAO)) { | |
71 | return civicrm_api3_create_error("group organization not created"); | |
72 | } | |
73 | ||
74 | _civicrm_api3_object_to_array($groupOrgBAO, $values); | |
75 | return civicrm_api3_create_success($values, $params, 'group_organization', 'get', $groupOrgBAO); | |
76 | } | |
77 | ||
11e09c59 | 78 | /** |
6a488035 | 79 | * Adjust Metadata for Create action |
1c88e578 | 80 | * |
6a488035 TO |
81 | * The metadata is used for setting defaults, documentation & validation |
82 | * @param array $params array or parameters determined by getfields | |
83 | */ | |
84 | function _civicrm_api3_group_organization_create_spec(&$params) { | |
85 | $params['organization_id']['api.required'] = 1; | |
86 | $params['group_id']['api.required'] = 1; | |
87 | } | |
88 | ||
89 | /** | |
90 | * Deletes an existing Group Organization | |
91 | * | |
92 | * This API is used for deleting a Group Organization | |
93 | * | |
94 | * @param array $params with 'id' = ID of the Group Organization to be deleted | |
95 | * | |
96 | * @return array API Result | |
97 | * {@getfields GroupOrganization_delete} | |
98 | * @example GroupOrganizationDelete.php | |
99 | * @access public | |
100 | */ | |
101 | function civicrm_api3_group_organization_delete($params) { | |
102 | ||
103 | $result = CRM_Contact_BAO_GroupOrganization::deleteGroupOrganization($params['id']); | |
104 | return $result ? civicrm_api3_create_success('Deleted Group Organization successfully') : civicrm_api3_create_error('Could not delete Group Organization'); | |
105 | } | |
106 |