3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
33 class CRM_Contact_BAO_GroupContact
extends CRM_Contact_DAO_GroupContact
{
38 public function __construct() {
39 parent
::__construct();
43 * Takes an associative array and creates a groupContact object.
45 * the function extract all the params it needs to initialize the create a
46 * group object. the params array could contain additional unused name/value
49 * @param array $params
50 * (reference ) an assoc array of name/value pairs.
52 * @return CRM_Contact_BAO_Group
54 public static function add($params) {
55 $hook = empty($params['id']) ?
'create' : 'edit';
56 CRM_Utils_Hook
::pre($hook, 'GroupContact', CRM_Utils_Array
::value('id', $params), $params);
58 if (!self
::dataExists($params)) {
62 $groupContact = new CRM_Contact_BAO_GroupContact();
63 $groupContact->copyValues($params);
64 $groupContact->save();
66 // Lookup existing info for the sake of subscription history
67 if (!empty($params['id'])) {
68 $groupContact->find(TRUE);
69 $params = $groupContact->toArray();
71 CRM_Contact_BAO_SubscriptionHistory
::create($params);
73 CRM_Utils_Hook
::post($hook, 'GroupContact', $groupContact->id
, $groupContact);
79 * Check if there is data to create the object.
81 * @param array $params
82 * (reference ) an assoc array of name/value pairs.
86 public static function dataExists(&$params) {
87 return (!empty($params['id']) ||
(!empty($params['group_id']) && !empty($params['contact_id'])));
91 * Given the list of params in the params array, fetch the object
92 * and store the values in the values array
94 * @param array $params
95 * Input parameters to find object.
96 * @param array $values
97 * Output values of the object.
100 * (reference) the values that could be potentially assigned to smarty
102 public static function getValues(&$params, &$values) {
103 if (empty($params)) {
106 $values['group']['data'] = CRM_Contact_BAO_GroupContact
::getContactGroup($params['contact_id'],
111 // get the total count of groups
112 $values['group']['totalCount'] = CRM_Contact_BAO_GroupContact
::getContactGroup($params['contact_id'],
122 * Given an array of contact ids, add all the contacts to the group
124 * @param array $contactIds
125 * The array of contact ids to be added.
126 * @param int $groupId
127 * The id of the group.
128 * @param string $method
129 * @param string $status
130 * @param int $tracking
133 * (total, added, notAdded) count of contacts added to group
135 public static function addContactsToGroup(
142 if (empty($contactIds) ||
empty($groupId)) {
146 CRM_Utils_Hook
::pre('create', 'GroupContact', $groupId, $contactIds);
148 list($numContactsAdded, $numContactsNotAdded)
149 = self
::bulkAddContactsToGroup($contactIds, $groupId, $method, $status, $tracking);
151 CRM_Contact_BAO_Contact_Utils
::clearContactCaches();
153 CRM_Utils_Hook
::post('create', 'GroupContact', $groupId, $contactIds);
155 return [count($contactIds), $numContactsAdded, $numContactsNotAdded];
159 * Given an array of contact ids, remove all the contacts from the group
161 * @param array $contactIds
162 * (reference ) the array of contact ids to be removed.
163 * @param int $groupId
164 * The id of the group.
166 * @param string $method
167 * @param string $status
168 * @param string $tracking
171 * (total, removed, notRemoved) count of contacts removed to group
173 public static function removeContactsFromGroup(
180 if (!is_array($contactIds)) {
184 if ($status == 'Removed' ||
$status == 'Deleted') {
191 CRM_Utils_Hook
::pre($op, 'GroupContact', $groupId, $contactIds);
193 $date = date('YmdHis');
194 $numContactsRemoved = 0;
195 $numContactsNotRemoved = 0;
197 $group = new CRM_Contact_DAO_Group();
198 $group->id
= $groupId;
201 foreach ($contactIds as $contactId) {
202 if ($status == 'Deleted') {
203 $query = "DELETE FROM civicrm_group_contact WHERE contact_id=$contactId AND group_id=$groupId";
204 $dao = CRM_Core_DAO
::executeQuery($query);
206 'group_id' => $groupId,
207 'contact_id' => $contactId,
211 'tracking' => $tracking,
213 CRM_Contact_BAO_SubscriptionHistory
::create($historyParams);
216 $groupContact = new CRM_Contact_DAO_GroupContact();
217 $groupContact->group_id
= $groupId;
218 $groupContact->contact_id
= $contactId;
219 // check if the selected contact id already a member, or if this is
220 // an opt-out of a smart group.
221 // if not a member remove to groupContact else keep the count of contacts that are not removed
222 if ($groupContact->find(TRUE) ||
$group->saved_search_id
) {
223 // remove the contact from the group
224 $numContactsRemoved++
;
227 $numContactsNotRemoved++
;
230 //now we grant the negative membership to contact if not member. CRM-3711
232 'group_id' => $groupId,
233 'contact_id' => $contactId,
237 'tracking' => $tracking,
239 CRM_Contact_BAO_SubscriptionHistory
::create($historyParams);
240 $groupContact->status
= $status;
241 $groupContact->save();
242 // Remove any rows from the group contact cache so it disappears straight away from smart groups.
243 CRM_Contact_BAO_GroupContactCache
::removeContact($contactId, $groupId);
247 CRM_Contact_BAO_Contact_Utils
::clearContactCaches();
249 CRM_Utils_Hook
::post($op, 'GroupContact', $groupId, $contactIds);
251 return [count($contactIds), $numContactsRemoved, $numContactsNotRemoved];
255 * Get list of all the groups and groups for a contact.
257 * @param int $contactId
260 * @param bool $visibility
264 * this array has key-> group id and value group title
266 public static function getGroupList($contactId = 0, $visibility = FALSE) {
267 $group = new CRM_Contact_DAO_Group();
269 $select = $from = $where = '';
271 $select = 'SELECT civicrm_group.id, civicrm_group.title ';
272 $from = ' FROM civicrm_group ';
273 $where = " WHERE civicrm_group.is_active = 1 ";
275 $from .= ' , civicrm_group_contact ';
276 $where .= " AND civicrm_group.id = civicrm_group_contact.group_id
277 AND civicrm_group_contact.contact_id = " . CRM_Utils_Type
::escape($contactId, 'Integer');
281 $where .= " AND civicrm_group.visibility != 'User and User Admin Only'";
283 $groupBy = " GROUP BY civicrm_group.id";
285 $orderby = " ORDER BY civicrm_group.name";
286 $sql = $select . $from . $where . $groupBy . $orderby;
291 while ($group->fetch()) {
292 $values[$group->id
] = $group->title
;
299 * Get the list of groups for contact based on status of group membership.
301 * @param int $contactId
303 * @param string $status
304 * State of membership.
305 * @param int $numGroupContact
306 * Number of groups for a contact that should be shown.
308 * True if we are interested only in the count.
309 * @param bool $ignorePermission
310 * True if we should ignore permissions for the current user.
311 * useful in profile where permissions are limited for the user. If left
312 * at false only groups viewable by the current user are returned
313 * @param bool $onlyPublicGroups
314 * True if we want to hide system groups.
316 * @param bool $excludeHidden
318 * @param int $groupId
320 * @param bool $includeSmartGroups
321 * Include or Exclude Smart Group(s)
324 * the relevant data object values for the contact or the total count when $count is TRUE
326 public static function getContactGroup(
329 $numGroupContact = NULL,
331 $ignorePermission = FALSE,
332 $onlyPublicGroups = FALSE,
333 $excludeHidden = TRUE,
335 $includeSmartGroups = FALSE
338 $select = 'SELECT count(DISTINCT civicrm_group_contact.id)';
342 civicrm_group_contact.id as civicrm_group_contact_id,
343 civicrm_group.title as group_title,
344 civicrm_group.visibility as visibility,
345 civicrm_group_contact.status as status,
346 civicrm_group.id as group_id,
347 civicrm_group.is_hidden as is_hidden,
348 civicrm_subscription_history.date as date,
349 civicrm_subscription_history.method as method';
352 $where = " WHERE contact_a.id = %1 AND civicrm_group.is_active = 1";
353 if (!$includeSmartGroups) {
354 $where .= " AND saved_search_id IS NULL";
356 if ($excludeHidden) {
357 $where .= " AND civicrm_group.is_hidden = 0 ";
359 $params = [1 => [$contactId, 'Integer']];
360 if (!empty($status)) {
361 $where .= ' AND civicrm_group_contact.status = %2';
362 $params[2] = [$status, 'String'];
364 if (!empty($groupId)) {
365 $where .= " AND civicrm_group.id = %3 ";
366 $params[3] = [$groupId, 'Integer'];
369 'civicrm_group_contact' => 1,
370 'civicrm_group' => 1,
371 'civicrm_subscription_history' => 1,
374 if ($ignorePermission) {
375 $permission = ' ( 1 ) ';
378 $permission = CRM_Core_Permission
::getPermissionedStaticGroupClause(CRM_Core_Permission
::VIEW
, $tables, $whereTables);
381 $from = CRM_Contact_BAO_Query
::fromClause($tables);
383 $where .= " AND $permission ";
385 if ($onlyPublicGroups) {
386 $where .= " AND civicrm_group.visibility != 'User and User Admin Only' ";
389 $order = $limit = '';
391 $order = ' ORDER BY civicrm_group.title, civicrm_subscription_history.date ASC';
393 if ($numGroupContact) {
394 $limit = " LIMIT 0, $numGroupContact";
398 $sql = $select . $from . $where . $order . $limit;
401 $result = CRM_Core_DAO
::singleValueQuery($sql, $params);
405 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
407 while ($dao->fetch()) {
408 $id = $dao->civicrm_group_contact_id
;
409 $values[$id]['id'] = $id;
410 $values[$id]['group_id'] = $dao->group_id
;
411 $values[$id]['title'] = $dao->group_title
;
412 $values[$id]['visibility'] = $dao->visibility
;
413 $values[$id]['is_hidden'] = $dao->is_hidden
;
414 switch ($dao->status
) {
424 $prefix = 'pending_';
426 $values[$id][$prefix . 'date'] = $dao->date
;
427 $values[$id][$prefix . 'method'] = $dao->method
;
428 if ($status == 'Removed') {
429 $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 )";
430 $dateDAO = CRM_Core_DAO
::executeQuery($query, $params);
431 if ($dateDAO->fetch()) {
432 $values[$id]['date_added'] = $dateDAO->date_added
;
441 * Returns membership details of a contact for a group.
443 * @param int $contactId
445 * @param int $groupID
446 * Id of a particular group.
447 * @param string $method
448 * If we want the subscription history details for a specific method.
453 public static function getMembershipDetail($contactId, $groupID, $method = 'Email') {
454 $leftJoin = $where = $orderBy = NULL;
457 //CRM-13341 add group_id clause
459 LEFT JOIN civicrm_subscription_history
460 ON ( civicrm_group_contact.contact_id = civicrm_subscription_history.contact_id
461 AND civicrm_subscription_history.group_id = {$groupID} )";
462 $where = "AND civicrm_subscription_history.method ='Email'";
463 $orderBy = "ORDER BY civicrm_subscription_history.id DESC";
467 FROM civicrm_group_contact
469 WHERE civicrm_group_contact.contact_id = %1
470 AND civicrm_group_contact.group_id = %2
476 1 => [$contactId, 'Integer'],
477 2 => [$groupID, 'Integer'],
479 $dao = CRM_Core_DAO
::executeQuery($query, $params);
485 * Method to get Group Id.
487 * @param int $groupContactID
488 * Id of a particular group.
493 public static function getGroupId($groupContactID) {
494 $dao = new CRM_Contact_DAO_GroupContact();
495 $dao->id
= $groupContactID;
497 return $dao->group_id
;
501 * Takes an associative array and creates / removes
502 * contacts from the groups
505 * @param array $params
506 * (reference ) an assoc array of name/value pairs.
507 * @param array $contactId
510 * @param bool $visibility
511 * @param string $method
513 public static function create(&$params, $contactId, $visibility = FALSE, $method = 'Admin') {
515 $contactIds[] = $contactId;
517 //if $visibility is true we are coming in via profile mean $method = 'Web'
518 $ignorePermission = FALSE;
520 $ignorePermission = TRUE;
524 $contactGroupList = CRM_Contact_BAO_GroupContact
::getContactGroup($contactId, 'Added',
525 NULL, FALSE, $ignorePermission
527 if (is_array($contactGroupList)) {
528 foreach ($contactGroupList as $key) {
529 $groupId = $key['group_id'];
530 $contactGroup[$groupId] = $groupId;
535 // get the list of all the groups
536 $allGroup = CRM_Contact_BAO_GroupContact
::getGroupList(0, $visibility);
538 // this fix is done to prevent warning generated by array_key_exits incase of empty array is given as input
539 if (!is_array($params)) {
543 // this fix is done to prevent warning generated by array_key_exits incase of empty array is given as input
544 if (!isset($contactGroup) ||
!is_array($contactGroup)) {
548 // check which values has to be add/remove contact from group
549 foreach ($allGroup as $key => $varValue) {
550 if (!empty($params[$key]) && !array_key_exists($key, $contactGroup)) {
551 // add contact to group
552 CRM_Contact_BAO_GroupContact
::addContactsToGroup($contactIds, $key, $method);
554 elseif (empty($params[$key]) && array_key_exists($key, $contactGroup)) {
555 // remove contact from group
556 CRM_Contact_BAO_GroupContact
::removeContactsFromGroup($contactIds, $key, $method);
562 * @param int $contactID
563 * @param int $groupID
567 public static function isContactInGroup($contactID, $groupID) {
568 if (!CRM_Utils_Rule
::positiveInteger($contactID) ||
569 !CRM_Utils_Rule
::positiveInteger($groupID)
575 ['group', 'IN', [$groupID], 0, 0],
576 ['contact_id', '=', $contactID, 0, 0],
578 list($contacts, $_) = CRM_Contact_BAO_Query
::apiQuery($params, ['contact_id']);
580 if (!empty($contacts)) {
587 * Function merges the groups from otherContactID to mainContactID.
588 * along with subscription history
590 * @param int $mainContactId
591 * Contact id of main contact record.
592 * @param int $otherContactId
593 * Contact id of record which is going to merge.
595 * @see CRM_Dedupe_Merger::cpTables()
597 * TODO: use the 3rd $sqls param to append sql statements rather than executing them here
599 public static function mergeGroupContact($mainContactId, $otherContactId) {
601 1 => [$mainContactId, 'Integer'],
602 2 => [$otherContactId, 'Integer'],
605 // find all groups that are in otherContactID but not in mainContactID, copy them over
607 SELECT cOther.group_id
608 FROM civicrm_group_contact cOther
609 LEFT JOIN civicrm_group_contact cMain ON cOther.group_id = cMain.group_id AND cMain.contact_id = %1
610 WHERE cOther.contact_id = %2
611 AND cMain.contact_id IS NULL
613 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
616 while ($dao->fetch()) {
617 $otherGroupIDs[] = $dao->group_id
;
620 if (!empty($otherGroupIDs)) {
621 $otherGroupIDString = implode(',', $otherGroupIDs);
624 UPDATE civicrm_group_contact
626 WHERE contact_id = %2
627 AND group_id IN ( $otherGroupIDString )
629 CRM_Core_DAO
::executeQuery($sql, $params);
632 UPDATE civicrm_subscription_history
634 WHERE contact_id = %2
635 AND group_id IN ( $otherGroupIDString )
637 CRM_Core_DAO
::executeQuery($sql, $params);
641 SELECT cOther.group_id as group_id,
642 cOther.status as group_status
643 FROM civicrm_group_contact cMain
644 INNER JOIN civicrm_group_contact cOther ON cMain.group_id = cOther.group_id
645 WHERE cMain.contact_id = %1
646 AND cOther.contact_id = %2
648 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
651 while ($dao->fetch()) {
652 // only copy it over if it has added status and migrate the history
653 if ($dao->group_status
== 'Added') {
654 $groupIDs[] = $dao->group_id
;
658 if (!empty($groupIDs)) {
659 $groupIDString = implode(',', $groupIDs);
662 UPDATE civicrm_group_contact
664 WHERE contact_id = %1
665 AND group_id IN ( $groupIDString )
667 CRM_Core_DAO
::executeQuery($sql, $params);
670 UPDATE civicrm_subscription_history
672 WHERE contact_id = %2
673 AND group_id IN ( $groupIDString )
675 CRM_Core_DAO
::executeQuery($sql, $params);
678 // delete all the other group contacts
681 FROM civicrm_group_contact
682 WHERE contact_id = %2
684 CRM_Core_DAO
::executeQuery($sql, $params);
688 FROM civicrm_subscription_history
689 WHERE contact_id = %2
691 CRM_Core_DAO
::executeQuery($sql, $params);
695 * Given an array of contact ids, add all the contacts to the group
697 * @param array $contactIDs
698 * The array of contact ids to be added.
699 * @param int $groupID
700 * The id of the group.
701 * @param string $method
702 * @param string $status
703 * @param string $tracking
706 * (total, added, notAdded) count of contacts added to group
708 public static function bulkAddContactsToGroup(
716 $numContactsAdded = 0;
717 $numContactsNotAdded = 0;
720 REPLACE INTO civicrm_group_contact ( group_id, contact_id, status )
723 $subscriptioHistorySQL = "
724 INSERT INTO civicrm_subscription_history( group_id, contact_id, date, method, status, tracking )
728 $date = date('YmdHis');
730 // to avoid long strings, lets do BULK_INSERT_HIGH_COUNT values at a time
731 while (!empty($contactIDs)) {
732 $input = array_splice($contactIDs, 0, CRM_Core_DAO
::BULK_INSERT_HIGH_COUNT
);
733 $contactStr = implode(',', $input);
735 // lets check their current status
737 SELECT GROUP_CONCAT(contact_id) as contactStr
738 FROM civicrm_group_contact
741 AND contact_id IN ( $contactStr )
744 1 => [$groupID, 'Integer'],
745 2 => [$status, 'String'],
749 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
751 $presentIDs = explode(',', $dao->contactStr
);
752 $presentIDs = array_flip($presentIDs);
755 $gcValues = $shValues = [];
756 foreach ($input as $cid) {
757 if (isset($presentIDs[$cid])) {
758 $numContactsNotAdded++
;
762 $gcValues[] = "( $groupID, $cid, '$status' )";
763 $shValues[] = "( $groupID, $cid, '$date', '$method', '$status', '$tracking' )";
767 if (!empty($gcValues)) {
768 $cgSQL = $contactGroupSQL . implode(",\n", $gcValues);
769 CRM_Core_DAO
::executeQuery($cgSQL);
771 $shSQL = $subscriptioHistorySQL . implode(",\n", $shValues);
772 CRM_Core_DAO
::executeQuery($shSQL);
776 return [$numContactsAdded, $numContactsNotAdded];
780 * Get options for a given field.
781 * @see CRM_Core_DAO::buildOptions
783 * @param string $fieldName
784 * @param string $context
785 * @see CRM_Core_DAO::buildOptionsContext
786 * @param array $props
787 * whatever is known about this dao object.
791 public static function buildOptions($fieldName, $context = NULL, $props = []) {
793 $options = CRM_Core_PseudoConstant
::get(__CLASS__
, $fieldName, $props, $context);
795 // Sort group list by hierarchy
796 // TODO: This will only work when api.entity is "group_contact". What about others?
797 if (($fieldName == 'group' ||
$fieldName == 'group_id') && ($context == 'search' ||
$context == 'create')) {
798 $options = CRM_Contact_BAO_Group
::getGroupsHierarchy($options, NULL, '- ', TRUE);