Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
bc77d7c0 | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
6a488035 | 5 | | | |
bc77d7c0 TO |
6 | | This work is published under the GNU AGPLv3 license with some | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
6a488035 | 9 | +--------------------------------------------------------------------+ |
d25dd0ee | 10 | */ |
6a488035 TO |
11 | |
12 | /** | |
13 | * | |
14 | * @package CRM | |
ca5cec67 | 15 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
6a488035 TO |
16 | */ |
17 | class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { | |
18 | ||
19 | /** | |
fe482240 | 20 | * Class constructor. |
6a488035 | 21 | */ |
00be9182 | 22 | public function __construct() { |
6a488035 TO |
23 | parent::__construct(); |
24 | } | |
25 | ||
26 | /** | |
fe482240 | 27 | * Takes an associative array and creates a groupContact object. |
6a488035 TO |
28 | * |
29 | * the function extract all the params it needs to initialize the create a | |
30 | * group object. the params array could contain additional unused name/value | |
31 | * pairs | |
32 | * | |
77c5b619 TO |
33 | * @param array $params |
34 | * (reference ) an assoc array of name/value pairs. | |
6a488035 | 35 | * |
16b10e64 | 36 | * @return CRM_Contact_BAO_Group |
6a488035 | 37 | */ |
35cb4b48 CW |
38 | public static function add($params) { |
39 | $hook = empty($params['id']) ? 'create' : 'edit'; | |
40 | CRM_Utils_Hook::pre($hook, 'GroupContact', CRM_Utils_Array::value('id', $params), $params); | |
6a488035 | 41 | |
35cb4b48 | 42 | if (!self::dataExists($params)) { |
6a488035 TO |
43 | return NULL; |
44 | } | |
45 | ||
46 | $groupContact = new CRM_Contact_BAO_GroupContact(); | |
47 | $groupContact->copyValues($params); | |
6a488035 | 48 | $groupContact->save(); |
35cb4b48 CW |
49 | |
50 | // Lookup existing info for the sake of subscription history | |
51 | if (!empty($params['id'])) { | |
52 | $groupContact->find(TRUE); | |
53 | $params = $groupContact->toArray(); | |
54 | } | |
55 | CRM_Contact_BAO_SubscriptionHistory::create($params); | |
56 | ||
57 | CRM_Utils_Hook::post($hook, 'GroupContact', $groupContact->id, $groupContact); | |
58 | ||
6a488035 TO |
59 | return $groupContact; |
60 | } | |
61 | ||
62 | /** | |
fe482240 | 63 | * Check if there is data to create the object. |
6a488035 | 64 | * |
77c5b619 TO |
65 | * @param array $params |
66 | * (reference ) an assoc array of name/value pairs. | |
6a488035 | 67 | * |
608e6658 | 68 | * @return bool |
6a488035 | 69 | */ |
00be9182 | 70 | public static function dataExists(&$params) { |
35cb4b48 | 71 | return (!empty($params['id']) || (!empty($params['group_id']) && !empty($params['contact_id']))); |
6a488035 TO |
72 | } |
73 | ||
74 | /** | |
75 | * Given the list of params in the params array, fetch the object | |
76 | * and store the values in the values array | |
77 | * | |
77c5b619 TO |
78 | * @param array $params |
79 | * Input parameters to find object. | |
80 | * @param array $values | |
81 | * Output values of the object. | |
6c8f6e67 | 82 | * |
a6c01b45 CW |
83 | * @return array |
84 | * (reference) the values that could be potentially assigned to smarty | |
6a488035 | 85 | */ |
00be9182 | 86 | public static function getValues(&$params, &$values) { |
6a488035 TO |
87 | if (empty($params)) { |
88 | return NULL; | |
89 | } | |
b2be28e3 | 90 | $values['group']['data'] = CRM_Contact_BAO_GroupContact::getContactGroup($params['contact_id'], |
6a488035 TO |
91 | 'Added', |
92 | 3 | |
93 | ); | |
94 | ||
95 | // get the total count of groups | |
96 | $values['group']['totalCount'] = CRM_Contact_BAO_GroupContact::getContactGroup($params['contact_id'], | |
97 | 'Added', | |
98 | NULL, | |
99 | TRUE | |
100 | ); | |
101 | ||
102 | return NULL; | |
103 | } | |
104 | ||
105 | /** | |
106 | * Given an array of contact ids, add all the contacts to the group | |
107 | * | |
77c5b619 TO |
108 | * @param array $contactIds |
109 | * The array of contact ids to be added. | |
110 | * @param int $groupId | |
111 | * The id of the group. | |
c49a2977 CW |
112 | * @param string $method |
113 | * @param string $status | |
114 | * @param int $tracking | |
6a488035 | 115 | * |
a6c01b45 CW |
116 | * @return array |
117 | * (total, added, notAdded) count of contacts added to group | |
6a488035 | 118 | */ |
608e6658 | 119 | public static function addContactsToGroup( |
c49a2977 | 120 | $contactIds, |
6a488035 | 121 | $groupId, |
242bd179 TO |
122 | $method = 'Admin', |
123 | $status = 'Added', | |
6a488035 TO |
124 | $tracking = NULL |
125 | ) { | |
66fc0405 | 126 | if (empty($contactIds) || empty($groupId)) { |
be2fb01f | 127 | return []; |
66fc0405 | 128 | } |
6a488035 | 129 | |
6a488035 TO |
130 | CRM_Utils_Hook::pre('create', 'GroupContact', $groupId, $contactIds); |
131 | ||
74e03c66 | 132 | $result = self::bulkAddContactsToGroup($contactIds, $groupId, $method, $status, $tracking); |
133 | CRM_Contact_BAO_GroupContactCache::invalidateGroupContactCache($groupId); | |
0626851e | 134 | CRM_Contact_BAO_Contact_Utils::clearContactCaches(); |
6a488035 TO |
135 | |
136 | CRM_Utils_Hook::post('create', 'GroupContact', $groupId, $contactIds); | |
137 | ||
74e03c66 | 138 | return [count($contactIds), $result['count_added'], $result['count_not_added']]; |
6a488035 TO |
139 | } |
140 | ||
141 | /** | |
142 | * Given an array of contact ids, remove all the contacts from the group | |
143 | * | |
77c5b619 TO |
144 | * @param array $contactIds |
145 | * (reference ) the array of contact ids to be removed. | |
146 | * @param int $groupId | |
147 | * The id of the group. | |
fd31fa4c EM |
148 | * |
149 | * @param string $method | |
150 | * @param string $status | |
e97c66ff | 151 | * @param string $tracking |
6a488035 | 152 | * |
a6c01b45 CW |
153 | * @return array |
154 | * (total, removed, notRemoved) count of contacts removed to group | |
6a488035 | 155 | */ |
608e6658 | 156 | public static function removeContactsFromGroup( |
6a488035 TO |
157 | &$contactIds, |
158 | $groupId, | |
242bd179 TO |
159 | $method = 'Admin', |
160 | $status = 'Removed', | |
6a488035 TO |
161 | $tracking = NULL |
162 | ) { | |
163 | if (!is_array($contactIds)) { | |
be2fb01f | 164 | return [0, 0, 0]; |
6a488035 | 165 | } |
6a488035 TO |
166 | if ($status == 'Removed' || $status == 'Deleted') { |
167 | $op = 'delete'; | |
168 | } | |
169 | else { | |
170 | $op = 'edit'; | |
171 | } | |
172 | ||
173 | CRM_Utils_Hook::pre($op, 'GroupContact', $groupId, $contactIds); | |
174 | ||
175 | $date = date('YmdHis'); | |
176 | $numContactsRemoved = 0; | |
177 | $numContactsNotRemoved = 0; | |
178 | ||
179 | $group = new CRM_Contact_DAO_Group(); | |
180 | $group->id = $groupId; | |
181 | $group->find(TRUE); | |
182 | ||
183 | foreach ($contactIds as $contactId) { | |
184 | if ($status == 'Deleted') { | |
dadeae7d SL |
185 | $query = "DELETE FROM civicrm_group_contact WHERE contact_id = %1 AND group_id = %2"; |
186 | $dao = CRM_Core_DAO::executeQuery($query, [ | |
187 | 1 => [$contactId, 'Positive'], | |
188 | 2 => [$groupId, 'Positive'], | |
189 | ]); | |
be2fb01f | 190 | $historyParams = [ |
6a488035 TO |
191 | 'group_id' => $groupId, |
192 | 'contact_id' => $contactId, | |
193 | 'status' => $status, | |
194 | 'method' => $method, | |
195 | 'date' => $date, | |
196 | 'tracking' => $tracking, | |
be2fb01f | 197 | ]; |
6a488035 | 198 | CRM_Contact_BAO_SubscriptionHistory::create($historyParams); |
dadeae7d SL |
199 | // Removing a row from civicrm_group_contact for a smart group may mean a contact |
200 | // Is now back in a group based on criteria so we will invalidate the cache if it is there | |
201 | // So that accurate group cache is created next time it is needed. | |
202 | CRM_Contact_BAO_GroupContactCache::invalidateGroupContactCache($groupId); | |
6a488035 TO |
203 | } |
204 | else { | |
205 | $groupContact = new CRM_Contact_DAO_GroupContact(); | |
206 | $groupContact->group_id = $groupId; | |
207 | $groupContact->contact_id = $contactId; | |
208 | // check if the selected contact id already a member, or if this is | |
209 | // an opt-out of a smart group. | |
210 | // if not a member remove to groupContact else keep the count of contacts that are not removed | |
211 | if ($groupContact->find(TRUE) || $group->saved_search_id) { | |
212 | // remove the contact from the group | |
213 | $numContactsRemoved++; | |
214 | } | |
215 | else { | |
216 | $numContactsNotRemoved++; | |
217 | } | |
218 | ||
219 | //now we grant the negative membership to contact if not member. CRM-3711 | |
be2fb01f | 220 | $historyParams = [ |
6a488035 TO |
221 | 'group_id' => $groupId, |
222 | 'contact_id' => $contactId, | |
223 | 'status' => $status, | |
224 | 'method' => $method, | |
225 | 'date' => $date, | |
226 | 'tracking' => $tracking, | |
be2fb01f | 227 | ]; |
6a488035 TO |
228 | CRM_Contact_BAO_SubscriptionHistory::create($historyParams); |
229 | $groupContact->status = $status; | |
230 | $groupContact->save(); | |
c82bcfd1 | 231 | // Remove any rows from the group contact cache so it disappears straight away from smart groups. |
232 | CRM_Contact_BAO_GroupContactCache::removeContact($contactId, $groupId); | |
6a488035 TO |
233 | } |
234 | } | |
235 | ||
0626851e | 236 | CRM_Contact_BAO_Contact_Utils::clearContactCaches(); |
6a488035 TO |
237 | |
238 | CRM_Utils_Hook::post($op, 'GroupContact', $groupId, $contactIds); | |
239 | ||
be2fb01f | 240 | return [count($contactIds), $numContactsRemoved, $numContactsNotRemoved]; |
6a488035 TO |
241 | } |
242 | ||
243 | /** | |
fe482240 | 244 | * Get list of all the groups and groups for a contact. |
6a488035 | 245 | * |
77c5b619 TO |
246 | * @param int $contactId |
247 | * Contact id. | |
6a488035 | 248 | * |
da6b46f4 EM |
249 | * @param bool $visibility |
250 | * | |
6a488035 | 251 | * |
a6c01b45 CW |
252 | * @return array |
253 | * this array has key-> group id and value group title | |
6a488035 | 254 | */ |
00be9182 | 255 | public static function getGroupList($contactId = 0, $visibility = FALSE) { |
bad98dd5 | 256 | $select = 'SELECT civicrm_group.id, civicrm_group.title '; |
242bd179 TO |
257 | $from = ' FROM civicrm_group '; |
258 | $where = " WHERE civicrm_group.is_active = 1 "; | |
6a488035 TO |
259 | if ($contactId) { |
260 | $from .= ' , civicrm_group_contact '; | |
261 | $where .= " AND civicrm_group.id = civicrm_group_contact.group_id | |
262 | AND civicrm_group_contact.contact_id = " . CRM_Utils_Type::escape($contactId, 'Integer'); | |
263 | } | |
264 | ||
265 | if ($visibility) { | |
266 | $where .= " AND civicrm_group.visibility != 'User and User Admin Only'"; | |
267 | } | |
3636b520 | 268 | $groupBy = " GROUP BY civicrm_group.id"; |
6a488035 TO |
269 | |
270 | $orderby = " ORDER BY civicrm_group.name"; | |
bad98dd5 | 271 | $sql = $select . $from . $where . $groupBy . $orderby; |
6a488035 | 272 | |
75511053 | 273 | $group = CRM_Core_DAO::executeQuery($sql); |
6a488035 | 274 | |
be2fb01f | 275 | $values = []; |
6a488035 TO |
276 | while ($group->fetch()) { |
277 | $values[$group->id] = $group->title; | |
278 | } | |
279 | ||
280 | return $values; | |
281 | } | |
282 | ||
283 | /** | |
fe482240 | 284 | * Get the list of groups for contact based on status of group membership. |
6a488035 | 285 | * |
77c5b619 TO |
286 | * @param int $contactId |
287 | * Contact id. | |
288 | * @param string $status | |
289 | * State of membership. | |
290 | * @param int $numGroupContact | |
291 | * Number of groups for a contact that should be shown. | |
292 | * @param bool $count | |
293 | * True if we are interested only in the count. | |
294 | * @param bool $ignorePermission | |
295 | * True if we should ignore permissions for the current user. | |
6a488035 TO |
296 | * useful in profile where permissions are limited for the user. If left |
297 | * at false only groups viewable by the current user are returned | |
77c5b619 TO |
298 | * @param bool $onlyPublicGroups |
299 | * True if we want to hide system groups. | |
fd31fa4c EM |
300 | * |
301 | * @param bool $excludeHidden | |
6a488035 | 302 | * |
ea3ddccf | 303 | * @param int $groupId |
304 | * | |
f08cb0da | 305 | * @param bool $includeSmartGroups |
306 | * Include or Exclude Smart Group(s) | |
307 | * | |
69078420 | 308 | * @return array|int |
ea3ddccf | 309 | * the relevant data object values for the contact or the total count when $count is TRUE |
6a488035 | 310 | */ |
3875e6b6 | 311 | public static function getContactGroup( |
6a488035 | 312 | $contactId, |
242bd179 TO |
313 | $status = NULL, |
314 | $numGroupContact = NULL, | |
315 | $count = FALSE, | |
6a488035 TO |
316 | $ignorePermission = FALSE, |
317 | $onlyPublicGroups = FALSE, | |
242bd179 | 318 | $excludeHidden = TRUE, |
b120248c | 319 | $groupId = NULL, |
965403bf | 320 | $includeSmartGroups = FALSE |
6a488035 TO |
321 | ) { |
322 | if ($count) { | |
323 | $select = 'SELECT count(DISTINCT civicrm_group_contact.id)'; | |
324 | } | |
325 | else { | |
326 | $select = 'SELECT | |
327 | civicrm_group_contact.id as civicrm_group_contact_id, | |
328 | civicrm_group.title as group_title, | |
329 | civicrm_group.visibility as visibility, | |
330 | civicrm_group_contact.status as status, | |
331 | civicrm_group.id as group_id, | |
332 | civicrm_group.is_hidden as is_hidden, | |
333 | civicrm_subscription_history.date as date, | |
334 | civicrm_subscription_history.method as method'; | |
335 | } | |
336 | ||
b120248c | 337 | $where = " WHERE contact_a.id = %1 AND civicrm_group.is_active = 1"; |
965403bf AJ |
338 | if (!$includeSmartGroups) { |
339 | $where .= " AND saved_search_id IS NULL"; | |
340 | } | |
6a488035 TO |
341 | if ($excludeHidden) { |
342 | $where .= " AND civicrm_group.is_hidden = 0 "; | |
343 | } | |
be2fb01f | 344 | $params = [1 => [$contactId, 'Integer']]; |
6a488035 TO |
345 | if (!empty($status)) { |
346 | $where .= ' AND civicrm_group_contact.status = %2'; | |
be2fb01f | 347 | $params[2] = [$status, 'String']; |
6a488035 | 348 | } |
49fb4e06 RK |
349 | if (!empty($groupId)) { |
350 | $where .= " AND civicrm_group.id = %3 "; | |
be2fb01f | 351 | $params[3] = [$groupId, 'Integer']; |
49fb4e06 | 352 | } |
be2fb01f | 353 | $tables = [ |
6a488035 TO |
354 | 'civicrm_group_contact' => 1, |
355 | 'civicrm_group' => 1, | |
356 | 'civicrm_subscription_history' => 1, | |
be2fb01f CW |
357 | ]; |
358 | $whereTables = []; | |
6a488035 TO |
359 | if ($ignorePermission) { |
360 | $permission = ' ( 1 ) '; | |
361 | } | |
362 | else { | |
363 | $permission = CRM_Core_Permission::getPermissionedStaticGroupClause(CRM_Core_Permission::VIEW, $tables, $whereTables); | |
364 | } | |
365 | ||
366 | $from = CRM_Contact_BAO_Query::fromClause($tables); | |
367 | ||
368 | $where .= " AND $permission "; | |
369 | ||
370 | if ($onlyPublicGroups) { | |
371 | $where .= " AND civicrm_group.visibility != 'User and User Admin Only' "; | |
372 | } | |
373 | ||
374 | $order = $limit = ''; | |
375 | if (!$count) { | |
376 | $order = ' ORDER BY civicrm_group.title, civicrm_subscription_history.date ASC'; | |
377 | ||
378 | if ($numGroupContact) { | |
379 | $limit = " LIMIT 0, $numGroupContact"; | |
380 | } | |
381 | } | |
382 | ||
383 | $sql = $select . $from . $where . $order . $limit; | |
384 | ||
385 | if ($count) { | |
386 | $result = CRM_Core_DAO::singleValueQuery($sql, $params); | |
387 | return $result; | |
388 | } | |
389 | else { | |
390 | $dao = CRM_Core_DAO::executeQuery($sql, $params); | |
be2fb01f | 391 | $values = []; |
6a488035 TO |
392 | while ($dao->fetch()) { |
393 | $id = $dao->civicrm_group_contact_id; | |
394 | $values[$id]['id'] = $id; | |
395 | $values[$id]['group_id'] = $dao->group_id; | |
396 | $values[$id]['title'] = $dao->group_title; | |
397 | $values[$id]['visibility'] = $dao->visibility; | |
398 | $values[$id]['is_hidden'] = $dao->is_hidden; | |
399 | switch ($dao->status) { | |
400 | case 'Added': | |
401 | $prefix = 'in_'; | |
402 | break; | |
403 | ||
404 | case 'Removed': | |
405 | $prefix = 'out_'; | |
406 | break; | |
407 | ||
408 | default: | |
409 | $prefix = 'pending_'; | |
410 | } | |
411 | $values[$id][$prefix . 'date'] = $dao->date; | |
412 | $values[$id][$prefix . 'method'] = $dao->method; | |
413 | if ($status == 'Removed') { | |
414 | $query = "SELECT `date` as `date_added` FROM civicrm_subscription_history WHERE id = (SELECT max(id) FROM civicrm_subscription_history WHERE contact_id = %1 AND status = \"Added\" AND group_id = $dao->group_id )"; | |
415 | $dateDAO = CRM_Core_DAO::executeQuery($query, $params); | |
416 | if ($dateDAO->fetch()) { | |
417 | $values[$id]['date_added'] = $dateDAO->date_added; | |
418 | } | |
419 | } | |
420 | } | |
421 | return $values; | |
422 | } | |
423 | } | |
424 | ||
425 | /** | |
fe482240 | 426 | * Returns membership details of a contact for a group. |
6a488035 | 427 | * |
77c5b619 TO |
428 | * @param int $contactId |
429 | * Id of the contact. | |
430 | * @param int $groupID | |
3b992cb6 | 431 | * Id of a particular group. |
77c5b619 TO |
432 | * @param string $method |
433 | * If we want the subscription history details for a specific method. | |
6a488035 | 434 | * |
a6c01b45 CW |
435 | * @return object |
436 | * of group contact | |
6a488035 | 437 | */ |
00be9182 | 438 | public static function getMembershipDetail($contactId, $groupID, $method = 'Email') { |
e60f24eb | 439 | $leftJoin = $where = $orderBy = NULL; |
6a488035 TO |
440 | |
441 | if ($method) { | |
071c6f10 BS |
442 | //CRM-13341 add group_id clause |
443 | $leftJoin = " | |
444 | LEFT JOIN civicrm_subscription_history | |
445 | ON ( civicrm_group_contact.contact_id = civicrm_subscription_history.contact_id | |
446 | AND civicrm_subscription_history.group_id = {$groupID} )"; | |
6a488035 TO |
447 | $where = "AND civicrm_subscription_history.method ='Email'"; |
448 | $orderBy = "ORDER BY civicrm_subscription_history.id DESC"; | |
449 | } | |
450 | $query = " | |
451 | SELECT * | |
452 | FROM civicrm_group_contact | |
453 | $leftJoin | |
454 | WHERE civicrm_group_contact.contact_id = %1 | |
455 | AND civicrm_group_contact.group_id = %2 | |
456 | $where | |
457 | $orderBy | |
458 | "; | |
459 | ||
be2fb01f CW |
460 | $params = [ |
461 | 1 => [$contactId, 'Integer'], | |
462 | 2 => [$groupID, 'Integer'], | |
463 | ]; | |
6a488035 TO |
464 | $dao = CRM_Core_DAO::executeQuery($query, $params); |
465 | $dao->fetch(); | |
466 | return $dao; | |
467 | } | |
468 | ||
6a488035 | 469 | /** |
fe482240 | 470 | * Method to get Group Id. |
6a488035 | 471 | * |
77c5b619 | 472 | * @param int $groupContactID |
3b992cb6 | 473 | * Id of a particular group. |
6a488035 TO |
474 | * |
475 | * | |
476 | * @return groupID | |
6a488035 | 477 | */ |
00be9182 | 478 | public static function getGroupId($groupContactID) { |
6a488035 TO |
479 | $dao = new CRM_Contact_DAO_GroupContact(); |
480 | $dao->id = $groupContactID; | |
481 | $dao->find(TRUE); | |
482 | return $dao->group_id; | |
483 | } | |
484 | ||
485 | /** | |
f329c0ca | 486 | * Creates / removes contacts from the groups |
6a488035 | 487 | * |
5298e0b7 CW |
488 | * FIXME: Nonstandard create function; only called from CRM_Contact_BAO_Contact::createProfileContact |
489 | * | |
77c5b619 | 490 | * @param array $params |
f329c0ca | 491 | * Name/value pairs. |
492 | * @param int $contactId | |
77c5b619 | 493 | * Contact id. |
2a6da8d7 | 494 | * |
f329c0ca | 495 | * @param bool $ignorePermission |
496 | * if ignorePermission is true we are coming in via profile mean $method = 'Web' | |
497 | * | |
2a6da8d7 | 498 | * @param string $method |
6a488035 | 499 | */ |
f329c0ca | 500 | public static function create($params, $contactId, $ignorePermission = FALSE, $method = 'Admin') { |
5298e0b7 CW |
501 | $contactIds = [$contactId]; |
502 | $contactGroup = []; | |
6a488035 | 503 | |
6a488035 | 504 | if ($contactId) { |
f078bc70 | 505 | $contactGroupList = CRM_Contact_BAO_GroupContact::getContactGroup($contactId, 'Added', |
6a488035 TO |
506 | NULL, FALSE, $ignorePermission |
507 | ); | |
508 | if (is_array($contactGroupList)) { | |
509 | foreach ($contactGroupList as $key) { | |
510 | $groupId = $key['group_id']; | |
511 | $contactGroup[$groupId] = $groupId; | |
512 | } | |
513 | } | |
514 | } | |
515 | ||
516 | // get the list of all the groups | |
f329c0ca | 517 | $allGroup = CRM_Contact_BAO_GroupContact::getGroupList(0, $ignorePermission); |
6a488035 TO |
518 | |
519 | // this fix is done to prevent warning generated by array_key_exits incase of empty array is given as input | |
520 | if (!is_array($params)) { | |
be2fb01f | 521 | $params = []; |
6a488035 TO |
522 | } |
523 | ||
6a488035 TO |
524 | // check which values has to be add/remove contact from group |
525 | foreach ($allGroup as $key => $varValue) { | |
a7488080 | 526 | if (!empty($params[$key]) && !array_key_exists($key, $contactGroup)) { |
6a488035 TO |
527 | // add contact to group |
528 | CRM_Contact_BAO_GroupContact::addContactsToGroup($contactIds, $key, $method); | |
529 | } | |
a7488080 | 530 | elseif (empty($params[$key]) && array_key_exists($key, $contactGroup)) { |
6a488035 TO |
531 | // remove contact from group |
532 | CRM_Contact_BAO_GroupContact::removeContactsFromGroup($contactIds, $key, $method); | |
533 | } | |
534 | } | |
535 | } | |
536 | ||
86538308 | 537 | /** |
100fef9d CW |
538 | * @param int $contactID |
539 | * @param int $groupID | |
86538308 EM |
540 | * |
541 | * @return bool | |
542 | */ | |
00be9182 | 543 | public static function isContactInGroup($contactID, $groupID) { |
6a488035 TO |
544 | if (!CRM_Utils_Rule::positiveInteger($contactID) || |
545 | !CRM_Utils_Rule::positiveInteger($groupID) | |
546 | ) { | |
547 | return FALSE; | |
548 | } | |
549 | ||
be2fb01f CW |
550 | $params = [ |
551 | ['group', 'IN', [$groupID], 0, 0], | |
552 | ['contact_id', '=', $contactID, 0, 0], | |
553 | ]; | |
676a6ff4 | 554 | [$contacts] = CRM_Contact_BAO_Query::apiQuery($params, ['contact_id']); |
6a488035 TO |
555 | |
556 | if (!empty($contacts)) { | |
557 | return TRUE; | |
558 | } | |
559 | return FALSE; | |
560 | } | |
561 | ||
562 | /** | |
fe482240 | 563 | * Function merges the groups from otherContactID to mainContactID. |
6a488035 TO |
564 | * along with subscription history |
565 | * | |
77c5b619 TO |
566 | * @param int $mainContactId |
567 | * Contact id of main contact record. | |
568 | * @param int $otherContactId | |
569 | * Contact id of record which is going to merge. | |
6a488035 TO |
570 | * |
571 | * @see CRM_Dedupe_Merger::cpTables() | |
572 | * | |
573 | * TODO: use the 3rd $sqls param to append sql statements rather than executing them here | |
6a488035 | 574 | */ |
00be9182 | 575 | public static function mergeGroupContact($mainContactId, $otherContactId) { |
be2fb01f CW |
576 | $params = [ |
577 | 1 => [$mainContactId, 'Integer'], | |
578 | 2 => [$otherContactId, 'Integer'], | |
579 | ]; | |
6a488035 TO |
580 | |
581 | // find all groups that are in otherContactID but not in mainContactID, copy them over | |
582 | $sql = " | |
583 | SELECT cOther.group_id | |
584 | FROM civicrm_group_contact cOther | |
585 | LEFT JOIN civicrm_group_contact cMain ON cOther.group_id = cMain.group_id AND cMain.contact_id = %1 | |
586 | WHERE cOther.contact_id = %2 | |
587 | AND cMain.contact_id IS NULL | |
588 | "; | |
589 | $dao = CRM_Core_DAO::executeQuery($sql, $params); | |
590 | ||
be2fb01f | 591 | $otherGroupIDs = []; |
6a488035 TO |
592 | while ($dao->fetch()) { |
593 | $otherGroupIDs[] = $dao->group_id; | |
594 | } | |
595 | ||
596 | if (!empty($otherGroupIDs)) { | |
597 | $otherGroupIDString = implode(',', $otherGroupIDs); | |
598 | ||
599 | $sql = " | |
600 | UPDATE civicrm_group_contact | |
601 | SET contact_id = %1 | |
602 | WHERE contact_id = %2 | |
603 | AND group_id IN ( $otherGroupIDString ) | |
604 | "; | |
605 | CRM_Core_DAO::executeQuery($sql, $params); | |
606 | ||
607 | $sql = " | |
608 | UPDATE civicrm_subscription_history | |
609 | SET contact_id = %1 | |
610 | WHERE contact_id = %2 | |
611 | AND group_id IN ( $otherGroupIDString ) | |
612 | "; | |
613 | CRM_Core_DAO::executeQuery($sql, $params); | |
614 | } | |
615 | ||
616 | $sql = " | |
617 | SELECT cOther.group_id as group_id, | |
618 | cOther.status as group_status | |
619 | FROM civicrm_group_contact cMain | |
620 | INNER JOIN civicrm_group_contact cOther ON cMain.group_id = cOther.group_id | |
621 | WHERE cMain.contact_id = %1 | |
622 | AND cOther.contact_id = %2 | |
623 | "; | |
624 | $dao = CRM_Core_DAO::executeQuery($sql, $params); | |
625 | ||
be2fb01f | 626 | $groupIDs = []; |
6a488035 TO |
627 | while ($dao->fetch()) { |
628 | // only copy it over if it has added status and migrate the history | |
629 | if ($dao->group_status == 'Added') { | |
630 | $groupIDs[] = $dao->group_id; | |
631 | } | |
632 | } | |
633 | ||
634 | if (!empty($groupIDs)) { | |
635 | $groupIDString = implode(',', $groupIDs); | |
636 | ||
637 | $sql = " | |
638 | UPDATE civicrm_group_contact | |
639 | SET status = 'Added' | |
640 | WHERE contact_id = %1 | |
641 | AND group_id IN ( $groupIDString ) | |
642 | "; | |
643 | CRM_Core_DAO::executeQuery($sql, $params); | |
644 | ||
645 | $sql = " | |
646 | UPDATE civicrm_subscription_history | |
647 | SET contact_id = %1 | |
648 | WHERE contact_id = %2 | |
649 | AND group_id IN ( $groupIDString ) | |
650 | "; | |
651 | CRM_Core_DAO::executeQuery($sql, $params); | |
652 | } | |
653 | ||
654 | // delete all the other group contacts | |
655 | $sql = " | |
656 | DELETE | |
657 | FROM civicrm_group_contact | |
658 | WHERE contact_id = %2 | |
659 | "; | |
660 | CRM_Core_DAO::executeQuery($sql, $params); | |
661 | ||
662 | $sql = " | |
663 | DELETE | |
664 | FROM civicrm_subscription_history | |
665 | WHERE contact_id = %2 | |
666 | "; | |
667 | CRM_Core_DAO::executeQuery($sql, $params); | |
668 | } | |
669 | ||
670 | /** | |
671 | * Given an array of contact ids, add all the contacts to the group | |
672 | * | |
77c5b619 TO |
673 | * @param array $contactIDs |
674 | * The array of contact ids to be added. | |
675 | * @param int $groupID | |
676 | * The id of the group. | |
2a6da8d7 EM |
677 | * @param string $method |
678 | * @param string $status | |
e97c66ff | 679 | * @param string $tracking |
6a488035 | 680 | * |
a6c01b45 CW |
681 | * @return array |
682 | * (total, added, notAdded) count of contacts added to group | |
6a488035 | 683 | */ |
608e6658 | 684 | public static function bulkAddContactsToGroup( |
6a488035 TO |
685 | $contactIDs, |
686 | $groupID, | |
242bd179 TO |
687 | $method = 'Admin', |
688 | $status = 'Added', | |
6a488035 TO |
689 | $tracking = NULL |
690 | ) { | |
691 | ||
692 | $numContactsAdded = 0; | |
693 | $numContactsNotAdded = 0; | |
694 | ||
695 | $contactGroupSQL = " | |
696 | REPLACE INTO civicrm_group_contact ( group_id, contact_id, status ) | |
697 | VALUES | |
698 | "; | |
699 | $subscriptioHistorySQL = " | |
700 | INSERT INTO civicrm_subscription_history( group_id, contact_id, date, method, status, tracking ) | |
701 | VALUES | |
702 | "; | |
703 | ||
704 | $date = date('YmdHis'); | |
705 | ||
706 | // to avoid long strings, lets do BULK_INSERT_HIGH_COUNT values at a time | |
707 | while (!empty($contactIDs)) { | |
708 | $input = array_splice($contactIDs, 0, CRM_Core_DAO::BULK_INSERT_HIGH_COUNT); | |
709 | $contactStr = implode(',', $input); | |
710 | ||
711 | // lets check their current status | |
712 | $sql = " | |
713 | SELECT GROUP_CONCAT(contact_id) as contactStr | |
714 | FROM civicrm_group_contact | |
715 | WHERE group_id = %1 | |
716 | AND status = %2 | |
717 | AND contact_id IN ( $contactStr ) | |
718 | "; | |
be2fb01f CW |
719 | $params = [ |
720 | 1 => [$groupID, 'Integer'], | |
721 | 2 => [$status, 'String'], | |
722 | ]; | |
6a488035 | 723 | |
be2fb01f | 724 | $presentIDs = []; |
6a488035 TO |
725 | $dao = CRM_Core_DAO::executeQuery($sql, $params); |
726 | if ($dao->fetch()) { | |
727 | $presentIDs = explode(',', $dao->contactStr); | |
728 | $presentIDs = array_flip($presentIDs); | |
729 | } | |
730 | ||
be2fb01f | 731 | $gcValues = $shValues = []; |
6a488035 TO |
732 | foreach ($input as $cid) { |
733 | if (isset($presentIDs[$cid])) { | |
734 | $numContactsNotAdded++; | |
735 | continue; | |
736 | } | |
737 | ||
738 | $gcValues[] = "( $groupID, $cid, '$status' )"; | |
739 | $shValues[] = "( $groupID, $cid, '$date', '$method', '$status', '$tracking' )"; | |
740 | $numContactsAdded++; | |
741 | } | |
742 | ||
743 | if (!empty($gcValues)) { | |
744 | $cgSQL = $contactGroupSQL . implode(",\n", $gcValues); | |
745 | CRM_Core_DAO::executeQuery($cgSQL); | |
746 | ||
747 | $shSQL = $subscriptioHistorySQL . implode(",\n", $shValues); | |
748 | CRM_Core_DAO::executeQuery($shSQL); | |
749 | } | |
750 | } | |
751 | ||
74e03c66 | 752 | return ['count_added' => $numContactsAdded, 'count_not_added' => $numContactsNotAdded]; |
6a488035 | 753 | } |
76773c5a CW |
754 | |
755 | /** | |
756 | * Get options for a given field. | |
757 | * @see CRM_Core_DAO::buildOptions | |
758 | * | |
77c5b619 TO |
759 | * @param string $fieldName |
760 | * @param string $context | |
608e6658 | 761 | * @see CRM_Core_DAO::buildOptionsContext |
77c5b619 | 762 | * @param array $props |
16b10e64 | 763 | * whatever is known about this dao object. |
76773c5a | 764 | * |
608e6658 | 765 | * @return array|bool |
76773c5a | 766 | */ |
be2fb01f | 767 | public static function buildOptions($fieldName, $context = NULL, $props = []) { |
39868387 | 768 | $options = CRM_Core_PseudoConstant::get(__CLASS__, $fieldName, [], $context); |
76773c5a | 769 | |
76352fbc | 770 | // Sort group list by hierarchy |
771 | // TODO: This will only work when api.entity is "group_contact". What about others? | |
772 | if (($fieldName == 'group' || $fieldName == 'group_id') && ($context == 'search' || $context == 'create')) { | |
773 | $options = CRM_Contact_BAO_Group::getGroupsHierarchy($options, NULL, '- ', TRUE); | |
76773c5a CW |
774 | } |
775 | ||
776 | return $options; | |
777 | } | |
96025800 | 778 | |
6a488035 | 779 | } |