5 +--------------------------------------------------------------------+
6 | CiviCRM version 4.3 |
7 +--------------------------------------------------------------------+
8 | Copyright CiviCRM LLC (c) 2004-2013 |
9 +--------------------------------------------------------------------+
10 | This file is a part of CiviCRM. |
12 | CiviCRM is free software; you can copy, modify, and distribute it |
13 | under the terms of the GNU Affero General Public License |
14 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
16 | CiviCRM is distributed in the hope that it will be useful, but |
17 | WITHOUT ANY WARRANTY; without even the implied warranty of |
18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
19 | See the GNU Affero General Public License for more details. |
21 | You should have received a copy of the GNU Affero General Public |
22 | License and the CiviCRM Licensing Exception along |
23 | with this program; if not, contact CiviCRM LLC |
24 | at info[AT]civicrm[DOT]org. If you have questions about the |
25 | GNU Affero General Public License or the licensing of CiviCRM, |
26 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
27 +--------------------------------------------------------------------+
31 * File for the CiviCRM APIv3 group contact functions
33 * @package CiviCRM_APIv3
34 * @subpackage API_Group
36 * @copyright CiviCRM LLC (c) 2004-2013
37 * @version $Id: GroupContact.php 30171 2010-10-14 09:11:27Z mover $
43 * This API will give list of the groups for particular contact
44 * Particualr status can be sent in params array
45 * If no status mentioned in params, by default 'added' will be used
46 * to fetch the records
48 * @param array $params name value pair of contact information
49 * {@getfields GroupContact_get}
51 * @return array list of groups, given contact subsribed to
53 function civicrm_api3_group_contact_get($params) {
55 if (empty($params['contact_id'])) {
56 if (empty($params['status'])) {
58 $params['status'] = 'Added';
60 //ie. id passed in so we have to return something
61 return _civicrm_api3_basic_get('CRM_Contact_BAO_GroupContact', $params);
63 $status = CRM_Utils_Array
::value('status', $params, 'Added');
65 $values = &CRM_Contact_BAO_GroupContact
::getContactGroup($params['contact_id'], $status, NULL, FALSE, TRUE);
66 return civicrm_api3_create_success($values, $params);
70 * Add contact(s) to group(s)
74 * @param array $params Input parameters
76 * Allowed @params array keys are:<br>
77 * "contact_id" (required) : first contact to add<br>
78 * "group_id" (required): first group to add contact(s) to<br>
79 * "contact_id.1" etc. (optional) : another contact to add<br>
80 * "group_id.1" etc. (optional) : additional group to add contact(s) to<br>
81 * "status" (optional) : one of "Added", "Pending" or "Removed" (default is "Added")
82 * {@example GroupContactCreate.php 0}
84 * @return array Information about operation results
86 * On success, the return array will be structured as follows:
92 * "not_added" => integer,
94 * "total_count" => integer
98 * On failure, the return array will be structured as follows:
101 * 'error_message' = string,
102 * 'error_data' = mixed or undefined
104 * {@getfields GroupContact_create}
106 function civicrm_api3_group_contact_create($params) {
108 $action = CRM_Utils_Array
::value('status', $params, 'Added');
109 return _civicrm_api3_group_contact_common($params, $action);
113 * Adjust Metadata for Create action
115 * The metadata is used for setting defaults, documentation & validation
116 * @param array $params array or parameters determined by getfields
118 function _civicrm_api3_group_contact_create_spec(&$params) {
119 $params['group_id']['api.required'] = 1;
120 $params['contact_id']['api.required'] = 1;
125 * @param <type> $params
130 function civicrm_api3_group_contact_delete($params) {
131 $params['status'] = 'Removed';
132 return civicrm_api('GroupContact', 'Create', $params);
138 function _civicrm_api3_group_contact_delete_spec(&$params) {
139 // set as not required no either/or std yet
140 $params['id']['api.required'] = 0;
145 * @param <type> $params
150 function civicrm_api3_group_contact_pending($params) {
151 $params['status'] = 'Pending';
152 return civicrm_api('GroupContact', 'Create', $params);
157 * @param array $params
161 * @todo behaviour is highly non-standard - need to figure out how to make this 'behave'
162 * & at the very least return IDs & details of the groups created / changed
164 function _civicrm_api3_group_contact_common($params, $op = 'Added') {
166 $contactIDs = array();
168 foreach ($params as $n => $v) {
169 if (substr($n, 0, 10) == 'contact_id') {
172 elseif (substr($n, 0, 8) == 'group_id') {
177 if (empty($contactIDs)) {
178 return civicrm_api3_create_error('contact_id is a required field');
181 if (empty($groupIDs)) {
182 return civicrm_api3_create_error('group_id is a required field');
185 $method = CRM_Utils_Array
::value('method', $params, 'API');
186 $status = CRM_Utils_Array
::value('status', $params, $op);
187 $tracking = CRM_Utils_Array
::value('tracking', $params);
190 if ($op == 'Added' ||
$op == 'Pending') {
191 $extraReturnValues= array(
196 foreach ($groupIDs as $groupID) {
197 list($tc, $a, $na) = CRM_Contact_BAO_GroupContact
::addContactsToGroup($contactIDs,
203 $extraReturnValues['total_count'] +
= $tc;
204 $extraReturnValues['added'] +
= $a;
205 $extraReturnValues['not_added'] +
= $na;
209 $extraReturnValues= array(
214 foreach ($groupIDs as $groupID) {
215 list($tc, $r, $nr) = CRM_Contact_BAO_GroupContact
::removeContactsFromGroup($contactIDs, $groupID, $method, $status, $tracking);
216 $extraReturnValues['total_count'] +
= $tc;
217 $extraReturnValues['removed'] +
= $r;
218 $extraReturnValues['not_removed'] +
= $nr;
221 $dao = null;// can't pass this by reference
222 return civicrm_api3_create_success(1,$params,'group_contact','create',$dao,$extraReturnValues);
226 * @deprecated - this should be part of create but need to know we aren't missing something
228 function civicrm_api3_group_contact_update_status($params) {
230 civicrm_api3_verify_mandatory($params, NULL, array('contact_id', 'group_id'));
232 $method = CRM_Utils_Array
::value('method', $params, 'API');
233 $tracking = CRM_Utils_Array
::value('tracking', $params);
235 CRM_Contact_BAO_GroupContact
::updateGroupMembershipStatus($params['contact_id'], $params['group_id'], $method, $tracking);