5 +--------------------------------------------------------------------+
6 | CiviCRM version 4.6 |
7 +--------------------------------------------------------------------+
8 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
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 * Particular 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(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
63 $status = CRM_Utils_Array
::value('status', $params, 'Added');
65 $groupId = CRM_Utils_Array
::value('group_id', $params);
66 $values = &CRM_Contact_BAO_GroupContact
::getContactGroup($params['contact_id'], $status, NULL, FALSE, TRUE, FALSE, TRUE, $groupId);
67 return civicrm_api3_create_success($values, $params);
71 * Add contact(s) to group(s)
75 * @param array $params Input parameters
77 * Allowed @params array keys are:<br>
78 * "contact_id" (required) : first contact to add<br>
79 * "group_id" (required): first group to add contact(s) to<br>
80 * "contact_id.1" etc. (optional) : another contact to add<br>
81 * "group_id.1" etc. (optional) : additional group to add contact(s) to<br>
82 * "status" (optional) : one of "Added", "Pending" or "Removed" (default is "Added")
83 * {@example GroupContactCreate.php 0}
85 * @return array Information about operation results
87 * On success, the return array will be structured as follows:
93 * "not_added" => integer,
95 * "total_count" => integer
99 * On failure, the return array will be structured as follows:
102 * 'error_message' = string,
103 * 'error_data' = mixed or undefined
105 * {@getfields GroupContact_create}
107 function civicrm_api3_group_contact_create($params) {
108 // Nonstandard bao - doesn't accept ID as a param, so convert id to group_id + contact_id
109 if (!empty($params['id'])) {
110 $getParams = array('id' => $params['id']);
111 $info = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $getParams);
112 if (!empty($info['values'][$params['id']])) {
113 $params['group_id'] = $info['values'][$params['id']]['group_id'];
114 $params['contact_id'] = $info['values'][$params['id']]['contact_id'];
117 civicrm_api3_verify_mandatory($params, NULL, array('group_id', 'contact_id'));
118 $action = CRM_Utils_Array
::value('status', $params, 'Added');
119 return _civicrm_api3_group_contact_common($params, $action);
124 * @param <type> $params
126 * @return array <type>@deprecated
128 function civicrm_api3_group_contact_delete($params) {
129 $params['status'] = CRM_Utils_Array
::value('status', $params, empty($params['skip_undelete']) ?
'Removed' : 'Deleted');
130 // "Deleted" isn't a real option so skip the api wrapper to avoid pseudoconstant validation
131 return civicrm_api3_group_contact_create($params);
137 function _civicrm_api3_group_contact_delete_spec(&$params) {
138 // set as not required no either/or std yet
139 $params['id']['api.required'] = 0;
144 * @param <type> $params
146 * @return array|int <type>@deprecated
148 function civicrm_api3_group_contact_pending($params) {
149 $params['status'] = 'Pending';
150 return civicrm_api('GroupContact', 'Create', $params);
155 * @param array $params
159 * @todo behaviour is highly non-standard - need to figure out how to make this 'behave'
160 * & at the very least return IDs & details of the groups created / changed
162 function _civicrm_api3_group_contact_common($params, $op = 'Added') {
164 $contactIDs = array();
166 foreach ($params as $n => $v) {
167 if (substr($n, 0, 10) == 'contact_id') {
170 elseif (substr($n, 0, 8) == 'group_id') {
175 if (empty($contactIDs)) {
176 return civicrm_api3_create_error('contact_id is a required field');
179 if (empty($groupIDs)) {
180 return civicrm_api3_create_error('group_id is a required field');
183 $method = CRM_Utils_Array
::value('method', $params, 'API');
184 $status = CRM_Utils_Array
::value('status', $params, $op);
185 $tracking = CRM_Utils_Array
::value('tracking', $params);
187 if ($op == 'Added' ||
$op == 'Pending') {
188 $extraReturnValues= array(
193 foreach ($groupIDs as $groupID) {
194 list($tc, $a, $na) = CRM_Contact_BAO_GroupContact
::addContactsToGroup($contactIDs,
200 $extraReturnValues['total_count'] +
= $tc;
201 $extraReturnValues['added'] +
= $a;
202 $extraReturnValues['not_added'] +
= $na;
206 $extraReturnValues= array(
211 foreach ($groupIDs as $groupID) {
212 list($tc, $r, $nr) = CRM_Contact_BAO_GroupContact
::removeContactsFromGroup($contactIDs, $groupID, $method, $status, $tracking);
213 $extraReturnValues['total_count'] +
= $tc;
214 $extraReturnValues['removed'] +
= $r;
215 $extraReturnValues['not_removed'] +
= $nr;
218 $dao = null;// can't pass this by reference
219 return civicrm_api3_create_success(1,$params,'group_contact','create',$dao,$extraReturnValues);
223 * @deprecated - this should be part of create but need to know we aren't missing something
225 function civicrm_api3_group_contact_update_status($params) {
227 civicrm_api3_verify_mandatory($params, NULL, array('contact_id', 'group_id'));
229 CRM_Contact_BAO_GroupContact
::addContactsToGroup(
230 array($params['contact_id']),
232 CRM_Utils_Array
::value('method', $params, 'API'),
234 CRM_Utils_Array
::value('tracking', $params)
241 * @deprecated api notice
242 * @return array of deprecated actions
244 function _civicrm_api3_group_contact_deprecation() {
246 'delete' => 'GroupContact "delete" action is deprecated in favor of "create".',
247 'pending' => 'GroupContact "pending" action is deprecated in favor of "create".',
248 'update_status' => 'GroupContact "update_status" action is deprecated in favor of "create".',