3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
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 |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
17 class CRM_Contact_BAO_GroupContact
extends CRM_Contact_DAO_GroupContact
{
22 public function __construct() {
23 parent
::__construct();
27 * Takes an associative array and creates a groupContact object.
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
33 * @param array $params
34 * (reference ) an assoc array of name/value pairs.
36 * @return CRM_Contact_BAO_Group
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);
42 if (!self
::dataExists($params)) {
46 $groupContact = new CRM_Contact_BAO_GroupContact();
47 $groupContact->copyValues($params);
48 $groupContact->save();
50 // Lookup existing info for the sake of subscription history
51 if (!empty($params['id'])) {
52 $groupContact->find(TRUE);
53 $params = $groupContact->toArray();
55 CRM_Contact_BAO_SubscriptionHistory
::create($params);
57 CRM_Utils_Hook
::post($hook, 'GroupContact', $groupContact->id
, $groupContact);
63 * Check if there is data to create the object.
65 * @param array $params
66 * (reference ) an assoc array of name/value pairs.
70 public static function dataExists(&$params) {
71 return (!empty($params['id']) ||
(!empty($params['group_id']) && !empty($params['contact_id'])));
75 * Given the list of params in the params array, fetch the object
76 * and store the values in the values array
78 * @param array $params
79 * Input parameters to find object.
80 * @param array $values
81 * Output values of the object.
84 * (reference) the values that could be potentially assigned to smarty
86 public static function getValues(&$params, &$values) {
90 $values['group']['data'] = CRM_Contact_BAO_GroupContact
::getContactGroup($params['contact_id'],
95 // get the total count of groups
96 $values['group']['totalCount'] = CRM_Contact_BAO_GroupContact
::getContactGroup($params['contact_id'],
106 * Given an array of contact ids, add all the contacts to the group
108 * @param array $contactIds
109 * The array of contact ids to be added.
110 * @param int $groupId
111 * The id of the group.
112 * @param string $method
113 * @param string $status
114 * @param int $tracking
117 * (total, added, notAdded) count of contacts added to group
119 public static function addContactsToGroup(
126 if (empty($contactIds) ||
empty($groupId)) {
130 CRM_Utils_Hook
::pre('create', 'GroupContact', $groupId, $contactIds);
132 $result = self
::bulkAddContactsToGroup($contactIds, $groupId, $method, $status, $tracking);
133 CRM_Contact_BAO_GroupContactCache
::invalidateGroupContactCache($groupId);
134 CRM_Contact_BAO_Contact_Utils
::clearContactCaches();
136 CRM_Utils_Hook
::post('create', 'GroupContact', $groupId, $contactIds);
138 return [count($contactIds), $result['count_added'], $result['count_not_added']];
142 * Given an array of contact ids, remove all the contacts from the group
144 * @param array $contactIds
145 * (reference ) the array of contact ids to be removed.
146 * @param int $groupId
147 * The id of the group.
149 * @param string $method
150 * @param string $status
151 * @param string $tracking
154 * (total, removed, notRemoved) count of contacts removed to group
156 public static function removeContactsFromGroup(
163 if (!is_array($contactIds)) {
166 if ($status == 'Removed' ||
$status == 'Deleted') {
173 CRM_Utils_Hook
::pre($op, 'GroupContact', $groupId, $contactIds);
175 $date = date('YmdHis');
176 $numContactsRemoved = 0;
177 $numContactsNotRemoved = 0;
179 $group = new CRM_Contact_DAO_Group();
180 $group->id
= $groupId;
183 foreach ($contactIds as $contactId) {
184 if ($status == 'Deleted') {
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'],
191 'group_id' => $groupId,
192 'contact_id' => $contactId,
196 'tracking' => $tracking,
198 CRM_Contact_BAO_SubscriptionHistory
::create($historyParams);
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);
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++
;
216 $numContactsNotRemoved++
;
219 //now we grant the negative membership to contact if not member. CRM-3711
221 'group_id' => $groupId,
222 'contact_id' => $contactId,
226 'tracking' => $tracking,
228 CRM_Contact_BAO_SubscriptionHistory
::create($historyParams);
229 $groupContact->status
= $status;
230 $groupContact->save();
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);
236 CRM_Contact_BAO_Contact_Utils
::clearContactCaches();
238 CRM_Utils_Hook
::post($op, 'GroupContact', $groupId, $contactIds);
240 return [count($contactIds), $numContactsRemoved, $numContactsNotRemoved];
244 * Get list of all the groups and groups for a contact.
246 * @param int $contactId
249 * @param bool $visibility
253 * this array has key-> group id and value group title
255 public static function getGroupList($contactId = 0, $visibility = FALSE) {
256 $group = new CRM_Contact_DAO_Group();
258 $select = $from = $where = '';
260 $select = 'SELECT civicrm_group.id, civicrm_group.title ';
261 $from = ' FROM civicrm_group ';
262 $where = " WHERE civicrm_group.is_active = 1 ";
264 $from .= ' , civicrm_group_contact ';
265 $where .= " AND civicrm_group.id = civicrm_group_contact.group_id
266 AND civicrm_group_contact.contact_id = " . CRM_Utils_Type
::escape($contactId, 'Integer');
270 $where .= " AND civicrm_group.visibility != 'User and User Admin Only'";
272 $groupBy = " GROUP BY civicrm_group.id";
274 $orderby = " ORDER BY civicrm_group.name";
275 $sql = $select . $from . $where . $groupBy . $orderby;
280 while ($group->fetch()) {
281 $values[$group->id
] = $group->title
;
288 * Get the list of groups for contact based on status of group membership.
290 * @param int $contactId
292 * @param string $status
293 * State of membership.
294 * @param int $numGroupContact
295 * Number of groups for a contact that should be shown.
297 * True if we are interested only in the count.
298 * @param bool $ignorePermission
299 * True if we should ignore permissions for the current user.
300 * useful in profile where permissions are limited for the user. If left
301 * at false only groups viewable by the current user are returned
302 * @param bool $onlyPublicGroups
303 * True if we want to hide system groups.
305 * @param bool $excludeHidden
307 * @param int $groupId
309 * @param bool $includeSmartGroups
310 * Include or Exclude Smart Group(s)
313 * the relevant data object values for the contact or the total count when $count is TRUE
315 public static function getContactGroup(
318 $numGroupContact = NULL,
320 $ignorePermission = FALSE,
321 $onlyPublicGroups = FALSE,
322 $excludeHidden = TRUE,
324 $includeSmartGroups = FALSE
327 $select = 'SELECT count(DISTINCT civicrm_group_contact.id)';
331 civicrm_group_contact.id as civicrm_group_contact_id,
332 civicrm_group.title as group_title,
333 civicrm_group.visibility as visibility,
334 civicrm_group_contact.status as status,
335 civicrm_group.id as group_id,
336 civicrm_group.is_hidden as is_hidden,
337 civicrm_subscription_history.date as date,
338 civicrm_subscription_history.method as method';
341 $where = " WHERE contact_a.id = %1 AND civicrm_group.is_active = 1";
342 if (!$includeSmartGroups) {
343 $where .= " AND saved_search_id IS NULL";
345 if ($excludeHidden) {
346 $where .= " AND civicrm_group.is_hidden = 0 ";
348 $params = [1 => [$contactId, 'Integer']];
349 if (!empty($status)) {
350 $where .= ' AND civicrm_group_contact.status = %2';
351 $params[2] = [$status, 'String'];
353 if (!empty($groupId)) {
354 $where .= " AND civicrm_group.id = %3 ";
355 $params[3] = [$groupId, 'Integer'];
358 'civicrm_group_contact' => 1,
359 'civicrm_group' => 1,
360 'civicrm_subscription_history' => 1,
363 if ($ignorePermission) {
364 $permission = ' ( 1 ) ';
367 $permission = CRM_Core_Permission
::getPermissionedStaticGroupClause(CRM_Core_Permission
::VIEW
, $tables, $whereTables);
370 $from = CRM_Contact_BAO_Query
::fromClause($tables);
372 $where .= " AND $permission ";
374 if ($onlyPublicGroups) {
375 $where .= " AND civicrm_group.visibility != 'User and User Admin Only' ";
378 $order = $limit = '';
380 $order = ' ORDER BY civicrm_group.title, civicrm_subscription_history.date ASC';
382 if ($numGroupContact) {
383 $limit = " LIMIT 0, $numGroupContact";
387 $sql = $select . $from . $where . $order . $limit;
390 $result = CRM_Core_DAO
::singleValueQuery($sql, $params);
394 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
396 while ($dao->fetch()) {
397 $id = $dao->civicrm_group_contact_id
;
398 $values[$id]['id'] = $id;
399 $values[$id]['group_id'] = $dao->group_id
;
400 $values[$id]['title'] = $dao->group_title
;
401 $values[$id]['visibility'] = $dao->visibility
;
402 $values[$id]['is_hidden'] = $dao->is_hidden
;
403 switch ($dao->status
) {
413 $prefix = 'pending_';
415 $values[$id][$prefix . 'date'] = $dao->date
;
416 $values[$id][$prefix . 'method'] = $dao->method
;
417 if ($status == 'Removed') {
418 $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 )";
419 $dateDAO = CRM_Core_DAO
::executeQuery($query, $params);
420 if ($dateDAO->fetch()) {
421 $values[$id]['date_added'] = $dateDAO->date_added
;
430 * Returns membership details of a contact for a group.
432 * @param int $contactId
434 * @param int $groupID
435 * Id of a particular group.
436 * @param string $method
437 * If we want the subscription history details for a specific method.
442 public static function getMembershipDetail($contactId, $groupID, $method = 'Email') {
443 $leftJoin = $where = $orderBy = NULL;
446 //CRM-13341 add group_id clause
448 LEFT JOIN civicrm_subscription_history
449 ON ( civicrm_group_contact.contact_id = civicrm_subscription_history.contact_id
450 AND civicrm_subscription_history.group_id = {$groupID} )";
451 $where = "AND civicrm_subscription_history.method ='Email'";
452 $orderBy = "ORDER BY civicrm_subscription_history.id DESC";
456 FROM civicrm_group_contact
458 WHERE civicrm_group_contact.contact_id = %1
459 AND civicrm_group_contact.group_id = %2
465 1 => [$contactId, 'Integer'],
466 2 => [$groupID, 'Integer'],
468 $dao = CRM_Core_DAO
::executeQuery($query, $params);
474 * Method to get Group Id.
476 * @param int $groupContactID
477 * Id of a particular group.
482 public static function getGroupId($groupContactID) {
483 $dao = new CRM_Contact_DAO_GroupContact();
484 $dao->id
= $groupContactID;
486 return $dao->group_id
;
490 * Creates / removes contacts from the groups
492 * FIXME: Nonstandard create function; only called from CRM_Contact_BAO_Contact::createProfileContact
494 * @param array $params
496 * @param int $contactId
499 * @param bool $ignorePermission
500 * if ignorePermission is true we are coming in via profile mean $method = 'Web'
502 * @param string $method
504 public static function create($params, $contactId, $ignorePermission = FALSE, $method = 'Admin') {
505 $contactIds = [$contactId];
509 $contactGroupList = CRM_Contact_BAO_GroupContact
::getContactGroup($contactId, 'Added',
510 NULL, FALSE, $ignorePermission
512 if (is_array($contactGroupList)) {
513 foreach ($contactGroupList as $key) {
514 $groupId = $key['group_id'];
515 $contactGroup[$groupId] = $groupId;
520 // get the list of all the groups
521 $allGroup = CRM_Contact_BAO_GroupContact
::getGroupList(0, $ignorePermission);
523 // this fix is done to prevent warning generated by array_key_exits incase of empty array is given as input
524 if (!is_array($params)) {
528 // check which values has to be add/remove contact from group
529 foreach ($allGroup as $key => $varValue) {
530 if (!empty($params[$key]) && !array_key_exists($key, $contactGroup)) {
531 // add contact to group
532 CRM_Contact_BAO_GroupContact
::addContactsToGroup($contactIds, $key, $method);
534 elseif (empty($params[$key]) && array_key_exists($key, $contactGroup)) {
535 // remove contact from group
536 CRM_Contact_BAO_GroupContact
::removeContactsFromGroup($contactIds, $key, $method);
542 * @param int $contactID
543 * @param int $groupID
547 public static function isContactInGroup($contactID, $groupID) {
548 if (!CRM_Utils_Rule
::positiveInteger($contactID) ||
549 !CRM_Utils_Rule
::positiveInteger($groupID)
555 ['group', 'IN', [$groupID], 0, 0],
556 ['contact_id', '=', $contactID, 0, 0],
558 list($contacts, $_) = CRM_Contact_BAO_Query
::apiQuery($params, ['contact_id']);
560 if (!empty($contacts)) {
567 * Function merges the groups from otherContactID to mainContactID.
568 * along with subscription history
570 * @param int $mainContactId
571 * Contact id of main contact record.
572 * @param int $otherContactId
573 * Contact id of record which is going to merge.
575 * @see CRM_Dedupe_Merger::cpTables()
577 * TODO: use the 3rd $sqls param to append sql statements rather than executing them here
579 public static function mergeGroupContact($mainContactId, $otherContactId) {
581 1 => [$mainContactId, 'Integer'],
582 2 => [$otherContactId, 'Integer'],
585 // find all groups that are in otherContactID but not in mainContactID, copy them over
587 SELECT cOther.group_id
588 FROM civicrm_group_contact cOther
589 LEFT JOIN civicrm_group_contact cMain ON cOther.group_id = cMain.group_id AND cMain.contact_id = %1
590 WHERE cOther.contact_id = %2
591 AND cMain.contact_id IS NULL
593 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
596 while ($dao->fetch()) {
597 $otherGroupIDs[] = $dao->group_id
;
600 if (!empty($otherGroupIDs)) {
601 $otherGroupIDString = implode(',', $otherGroupIDs);
604 UPDATE civicrm_group_contact
606 WHERE contact_id = %2
607 AND group_id IN ( $otherGroupIDString )
609 CRM_Core_DAO
::executeQuery($sql, $params);
612 UPDATE civicrm_subscription_history
614 WHERE contact_id = %2
615 AND group_id IN ( $otherGroupIDString )
617 CRM_Core_DAO
::executeQuery($sql, $params);
621 SELECT cOther.group_id as group_id,
622 cOther.status as group_status
623 FROM civicrm_group_contact cMain
624 INNER JOIN civicrm_group_contact cOther ON cMain.group_id = cOther.group_id
625 WHERE cMain.contact_id = %1
626 AND cOther.contact_id = %2
628 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
631 while ($dao->fetch()) {
632 // only copy it over if it has added status and migrate the history
633 if ($dao->group_status
== 'Added') {
634 $groupIDs[] = $dao->group_id
;
638 if (!empty($groupIDs)) {
639 $groupIDString = implode(',', $groupIDs);
642 UPDATE civicrm_group_contact
644 WHERE contact_id = %1
645 AND group_id IN ( $groupIDString )
647 CRM_Core_DAO
::executeQuery($sql, $params);
650 UPDATE civicrm_subscription_history
652 WHERE contact_id = %2
653 AND group_id IN ( $groupIDString )
655 CRM_Core_DAO
::executeQuery($sql, $params);
658 // delete all the other group contacts
661 FROM civicrm_group_contact
662 WHERE contact_id = %2
664 CRM_Core_DAO
::executeQuery($sql, $params);
668 FROM civicrm_subscription_history
669 WHERE contact_id = %2
671 CRM_Core_DAO
::executeQuery($sql, $params);
675 * Given an array of contact ids, add all the contacts to the group
677 * @param array $contactIDs
678 * The array of contact ids to be added.
679 * @param int $groupID
680 * The id of the group.
681 * @param string $method
682 * @param string $status
683 * @param string $tracking
686 * (total, added, notAdded) count of contacts added to group
688 public static function bulkAddContactsToGroup(
696 $numContactsAdded = 0;
697 $numContactsNotAdded = 0;
700 REPLACE INTO civicrm_group_contact ( group_id, contact_id, status )
703 $subscriptioHistorySQL = "
704 INSERT INTO civicrm_subscription_history( group_id, contact_id, date, method, status, tracking )
708 $date = date('YmdHis');
710 // to avoid long strings, lets do BULK_INSERT_HIGH_COUNT values at a time
711 while (!empty($contactIDs)) {
712 $input = array_splice($contactIDs, 0, CRM_Core_DAO
::BULK_INSERT_HIGH_COUNT
);
713 $contactStr = implode(',', $input);
715 // lets check their current status
717 SELECT GROUP_CONCAT(contact_id) as contactStr
718 FROM civicrm_group_contact
721 AND contact_id IN ( $contactStr )
724 1 => [$groupID, 'Integer'],
725 2 => [$status, 'String'],
729 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
731 $presentIDs = explode(',', $dao->contactStr
);
732 $presentIDs = array_flip($presentIDs);
735 $gcValues = $shValues = [];
736 foreach ($input as $cid) {
737 if (isset($presentIDs[$cid])) {
738 $numContactsNotAdded++
;
742 $gcValues[] = "( $groupID, $cid, '$status' )";
743 $shValues[] = "( $groupID, $cid, '$date', '$method', '$status', '$tracking' )";
747 if (!empty($gcValues)) {
748 $cgSQL = $contactGroupSQL . implode(",\n", $gcValues);
749 CRM_Core_DAO
::executeQuery($cgSQL);
751 $shSQL = $subscriptioHistorySQL . implode(",\n", $shValues);
752 CRM_Core_DAO
::executeQuery($shSQL);
756 return ['count_added' => $numContactsAdded, 'count_not_added' => $numContactsNotAdded];
760 * Get options for a given field.
761 * @see CRM_Core_DAO::buildOptions
763 * @param string $fieldName
764 * @param string $context
765 * @see CRM_Core_DAO::buildOptionsContext
766 * @param array $props
767 * whatever is known about this dao object.
771 public static function buildOptions($fieldName, $context = NULL, $props = []) {
772 $options = CRM_Core_PseudoConstant
::get(__CLASS__
, $fieldName, [], $context);
774 // Sort group list by hierarchy
775 // TODO: This will only work when api.entity is "group_contact". What about others?
776 if (($fieldName == 'group' ||
$fieldName == 'group_id') && ($context == 'search' ||
$context == 'create')) {
777 $options = CRM_Contact_BAO_Group
::getGroupsHierarchy($options, NULL, '- ', TRUE);