3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
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 array(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 NULL $tracking
171 * (total, removed, notRemoved) count of contacts removed to group
173 public static function removeContactsFromGroup(
180 if (!is_array($contactIds)) {
181 return array(0, 0, 0);
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);
205 $historyParams = array(
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
231 $historyParams = array(
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();
245 CRM_Contact_BAO_Contact_Utils
::clearContactCaches();
247 CRM_Utils_Hook
::post($op, 'GroupContact', $groupId, $contactIds);
249 return array(count($contactIds), $numContactsRemoved, $numContactsNotRemoved);
253 * Get list of all the groups and groups for a contact.
255 * @param int $contactId
258 * @param bool $visibility
262 * this array has key-> group id and value group title
264 public static function getGroupList($contactId = 0, $visibility = FALSE) {
265 $group = new CRM_Contact_DAO_Group();
267 $select = $from = $where = '';
269 $select = 'SELECT civicrm_group.id, civicrm_group.title ';
270 $from = ' FROM civicrm_group ';
271 $where = " WHERE civicrm_group.is_active = 1 ";
273 $from .= ' , civicrm_group_contact ';
274 $where .= " AND civicrm_group.id = civicrm_group_contact.group_id
275 AND civicrm_group_contact.contact_id = " . CRM_Utils_Type
::escape($contactId, 'Integer');
279 $where .= " AND civicrm_group.visibility != 'User and User Admin Only'";
281 $groupBy = " GROUP BY civicrm_group.id";
283 $orderby = " ORDER BY civicrm_group.name";
284 $sql = $select . $from . $where . $groupBy . $orderby;
289 while ($group->fetch()) {
290 $values[$group->id
] = $group->title
;
297 * Get the list of groups for contact based on status of group membership.
299 * @param int $contactId
301 * @param string $status
302 * State of membership.
303 * @param int $numGroupContact
304 * Number of groups for a contact that should be shown.
306 * True if we are interested only in the count.
307 * @param bool $ignorePermission
308 * True if we should ignore permissions for the current user.
309 * useful in profile where permissions are limited for the user. If left
310 * at false only groups viewable by the current user are returned
311 * @param bool $onlyPublicGroups
312 * True if we want to hide system groups.
314 * @param bool $excludeHidden
316 * @param int $groupId
318 * @param bool $includeSmartGroups
319 * Include or Exclude Smart Group(s)
321 * @return array|int $values
322 * the relevant data object values for the contact or the total count when $count is TRUE
324 public static function getContactGroup(
327 $numGroupContact = NULL,
329 $ignorePermission = FALSE,
330 $onlyPublicGroups = FALSE,
331 $excludeHidden = TRUE,
333 $includeSmartGroups = FALSE
336 $select = 'SELECT count(DISTINCT civicrm_group_contact.id)';
340 civicrm_group_contact.id as civicrm_group_contact_id,
341 civicrm_group.title as group_title,
342 civicrm_group.visibility as visibility,
343 civicrm_group_contact.status as status,
344 civicrm_group.id as group_id,
345 civicrm_group.is_hidden as is_hidden,
346 civicrm_subscription_history.date as date,
347 civicrm_subscription_history.method as method';
350 $where = " WHERE contact_a.id = %1 AND civicrm_group.is_active = 1";
351 if (!$includeSmartGroups) {
352 $where .= " AND saved_search_id IS NULL";
354 if ($excludeHidden) {
355 $where .= " AND civicrm_group.is_hidden = 0 ";
357 $params = array(1 => array($contactId, 'Integer'));
358 if (!empty($status)) {
359 $where .= ' AND civicrm_group_contact.status = %2';
360 $params[2] = array($status, 'String');
362 if (!empty($groupId)) {
363 $where .= " AND civicrm_group.id = %3 ";
364 $params[3] = array($groupId, 'Integer');
367 'civicrm_group_contact' => 1,
368 'civicrm_group' => 1,
369 'civicrm_subscription_history' => 1,
371 $whereTables = array();
372 if ($ignorePermission) {
373 $permission = ' ( 1 ) ';
376 $permission = CRM_Core_Permission
::getPermissionedStaticGroupClause(CRM_Core_Permission
::VIEW
, $tables, $whereTables);
379 $from = CRM_Contact_BAO_Query
::fromClause($tables);
381 $where .= " AND $permission ";
383 if ($onlyPublicGroups) {
384 $where .= " AND civicrm_group.visibility != 'User and User Admin Only' ";
387 $order = $limit = '';
389 $order = ' ORDER BY civicrm_group.title, civicrm_subscription_history.date ASC';
391 if ($numGroupContact) {
392 $limit = " LIMIT 0, $numGroupContact";
396 $sql = $select . $from . $where . $order . $limit;
399 $result = CRM_Core_DAO
::singleValueQuery($sql, $params);
403 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
405 while ($dao->fetch()) {
406 $id = $dao->civicrm_group_contact_id
;
407 $values[$id]['id'] = $id;
408 $values[$id]['group_id'] = $dao->group_id
;
409 $values[$id]['title'] = $dao->group_title
;
410 $values[$id]['visibility'] = $dao->visibility
;
411 $values[$id]['is_hidden'] = $dao->is_hidden
;
412 switch ($dao->status
) {
422 $prefix = 'pending_';
424 $values[$id][$prefix . 'date'] = $dao->date
;
425 $values[$id][$prefix . 'method'] = $dao->method
;
426 if ($status == 'Removed') {
427 $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 )";
428 $dateDAO = CRM_Core_DAO
::executeQuery($query, $params);
429 if ($dateDAO->fetch()) {
430 $values[$id]['date_added'] = $dateDAO->date_added
;
439 * Returns membership details of a contact for a group.
441 * @param int $contactId
443 * @param int $groupID
444 * Id of a particular group.
445 * @param string $method
446 * If we want the subscription history details for a specific method.
451 public static function getMembershipDetail($contactId, $groupID, $method = 'Email') {
452 $leftJoin = $where = $orderBy = NULL;
455 //CRM-13341 add group_id clause
457 LEFT JOIN civicrm_subscription_history
458 ON ( civicrm_group_contact.contact_id = civicrm_subscription_history.contact_id
459 AND civicrm_subscription_history.group_id = {$groupID} )";
460 $where = "AND civicrm_subscription_history.method ='Email'";
461 $orderBy = "ORDER BY civicrm_subscription_history.id DESC";
465 FROM civicrm_group_contact
467 WHERE civicrm_group_contact.contact_id = %1
468 AND civicrm_group_contact.group_id = %2
474 1 => array($contactId, 'Integer'),
475 2 => array($groupID, 'Integer'),
477 $dao = CRM_Core_DAO
::executeQuery($query, $params);
483 * Method to get Group Id.
485 * @param int $groupContactID
486 * Id of a particular group.
491 public static function getGroupId($groupContactID) {
492 $dao = new CRM_Contact_DAO_GroupContact();
493 $dao->id
= $groupContactID;
495 return $dao->group_id
;
499 * Takes an associative array and creates / removes
500 * contacts from the groups
503 * @param array $params
504 * (reference ) an assoc array of name/value pairs.
505 * @param array $contactId
508 * @param bool $visibility
509 * @param string $method
511 public static function create(&$params, $contactId, $visibility = FALSE, $method = 'Admin') {
512 $contactIds = array();
513 $contactIds[] = $contactId;
515 //if $visibility is true we are coming in via profile mean $method = 'Web'
516 $ignorePermission = FALSE;
518 $ignorePermission = TRUE;
522 $contactGroupList = CRM_Contact_BAO_GroupContact
::getContactGroup($contactId, 'Added',
523 NULL, FALSE, $ignorePermission
525 if (is_array($contactGroupList)) {
526 foreach ($contactGroupList as $key) {
527 $groupId = $key['group_id'];
528 $contactGroup[$groupId] = $groupId;
533 // get the list of all the groups
534 $allGroup = CRM_Contact_BAO_GroupContact
::getGroupList(0, $visibility);
536 // this fix is done to prevent warning generated by array_key_exits incase of empty array is given as input
537 if (!is_array($params)) {
541 // this fix is done to prevent warning generated by array_key_exits incase of empty array is given as input
542 if (!isset($contactGroup) ||
!is_array($contactGroup)) {
543 $contactGroup = array();
546 // check which values has to be add/remove contact from group
547 foreach ($allGroup as $key => $varValue) {
548 if (!empty($params[$key]) && !array_key_exists($key, $contactGroup)) {
549 // add contact to group
550 CRM_Contact_BAO_GroupContact
::addContactsToGroup($contactIds, $key, $method);
552 elseif (empty($params[$key]) && array_key_exists($key, $contactGroup)) {
553 // remove contact from group
554 CRM_Contact_BAO_GroupContact
::removeContactsFromGroup($contactIds, $key, $method);
560 * @param int $contactID
561 * @param int $groupID
565 public static function isContactInGroup($contactID, $groupID) {
566 if (!CRM_Utils_Rule
::positiveInteger($contactID) ||
567 !CRM_Utils_Rule
::positiveInteger($groupID)
573 array('group', 'IN', array($groupID), 0, 0),
574 array('contact_id', '=', $contactID, 0, 0),
576 list($contacts, $_) = CRM_Contact_BAO_Query
::apiQuery($params, array('contact_id'));
578 if (!empty($contacts)) {
585 * Function merges the groups from otherContactID to mainContactID.
586 * along with subscription history
588 * @param int $mainContactId
589 * Contact id of main contact record.
590 * @param int $otherContactId
591 * Contact id of record which is going to merge.
593 * @see CRM_Dedupe_Merger::cpTables()
595 * TODO: use the 3rd $sqls param to append sql statements rather than executing them here
597 public static function mergeGroupContact($mainContactId, $otherContactId) {
599 1 => array($mainContactId, 'Integer'),
600 2 => array($otherContactId, 'Integer'),
603 // find all groups that are in otherContactID but not in mainContactID, copy them over
605 SELECT cOther.group_id
606 FROM civicrm_group_contact cOther
607 LEFT JOIN civicrm_group_contact cMain ON cOther.group_id = cMain.group_id AND cMain.contact_id = %1
608 WHERE cOther.contact_id = %2
609 AND cMain.contact_id IS NULL
611 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
613 $otherGroupIDs = array();
614 while ($dao->fetch()) {
615 $otherGroupIDs[] = $dao->group_id
;
618 if (!empty($otherGroupIDs)) {
619 $otherGroupIDString = implode(',', $otherGroupIDs);
622 UPDATE civicrm_group_contact
624 WHERE contact_id = %2
625 AND group_id IN ( $otherGroupIDString )
627 CRM_Core_DAO
::executeQuery($sql, $params);
630 UPDATE civicrm_subscription_history
632 WHERE contact_id = %2
633 AND group_id IN ( $otherGroupIDString )
635 CRM_Core_DAO
::executeQuery($sql, $params);
639 SELECT cOther.group_id as group_id,
640 cOther.status as group_status
641 FROM civicrm_group_contact cMain
642 INNER JOIN civicrm_group_contact cOther ON cMain.group_id = cOther.group_id
643 WHERE cMain.contact_id = %1
644 AND cOther.contact_id = %2
646 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
649 while ($dao->fetch()) {
650 // only copy it over if it has added status and migrate the history
651 if ($dao->group_status
== 'Added') {
652 $groupIDs[] = $dao->group_id
;
656 if (!empty($groupIDs)) {
657 $groupIDString = implode(',', $groupIDs);
660 UPDATE civicrm_group_contact
662 WHERE contact_id = %1
663 AND group_id IN ( $groupIDString )
665 CRM_Core_DAO
::executeQuery($sql, $params);
668 UPDATE civicrm_subscription_history
670 WHERE contact_id = %2
671 AND group_id IN ( $groupIDString )
673 CRM_Core_DAO
::executeQuery($sql, $params);
676 // delete all the other group contacts
679 FROM civicrm_group_contact
680 WHERE contact_id = %2
682 CRM_Core_DAO
::executeQuery($sql, $params);
686 FROM civicrm_subscription_history
687 WHERE contact_id = %2
689 CRM_Core_DAO
::executeQuery($sql, $params);
693 * Given an array of contact ids, add all the contacts to the group
695 * @param array $contactIDs
696 * The array of contact ids to be added.
697 * @param int $groupID
698 * The id of the group.
699 * @param string $method
700 * @param string $status
701 * @param NULL $tracking
704 * (total, added, notAdded) count of contacts added to group
706 public static function bulkAddContactsToGroup(
714 $numContactsAdded = 0;
715 $numContactsNotAdded = 0;
718 REPLACE INTO civicrm_group_contact ( group_id, contact_id, status )
721 $subscriptioHistorySQL = "
722 INSERT INTO civicrm_subscription_history( group_id, contact_id, date, method, status, tracking )
726 $date = date('YmdHis');
728 // to avoid long strings, lets do BULK_INSERT_HIGH_COUNT values at a time
729 while (!empty($contactIDs)) {
730 $input = array_splice($contactIDs, 0, CRM_Core_DAO
::BULK_INSERT_HIGH_COUNT
);
731 $contactStr = implode(',', $input);
733 // lets check their current status
735 SELECT GROUP_CONCAT(contact_id) as contactStr
736 FROM civicrm_group_contact
739 AND contact_id IN ( $contactStr )
742 1 => array($groupID, 'Integer'),
743 2 => array($status, 'String'),
746 $presentIDs = array();
747 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
749 $presentIDs = explode(',', $dao->contactStr
);
750 $presentIDs = array_flip($presentIDs);
753 $gcValues = $shValues = array();
754 foreach ($input as $cid) {
755 if (isset($presentIDs[$cid])) {
756 $numContactsNotAdded++
;
760 $gcValues[] = "( $groupID, $cid, '$status' )";
761 $shValues[] = "( $groupID, $cid, '$date', '$method', '$status', '$tracking' )";
765 if (!empty($gcValues)) {
766 $cgSQL = $contactGroupSQL . implode(",\n", $gcValues);
767 CRM_Core_DAO
::executeQuery($cgSQL);
769 $shSQL = $subscriptioHistorySQL . implode(",\n", $shValues);
770 CRM_Core_DAO
::executeQuery($shSQL);
774 return array($numContactsAdded, $numContactsNotAdded);
778 * Get options for a given field.
779 * @see CRM_Core_DAO::buildOptions
781 * @param string $fieldName
782 * @param string $context
783 * @see CRM_Core_DAO::buildOptionsContext
784 * @param array $props
785 * whatever is known about this dao object.
789 public static function buildOptions($fieldName, $context = NULL, $props = array()) {
792 $options = CRM_Core_PseudoConstant
::get(__CLASS__
, $fieldName, $params, $context);
794 // Sort group list by hierarchy
795 // TODO: This will only work when api.entity is "group_contact". What about others?
796 if (($fieldName == 'group' ||
$fieldName == 'group_id') && ($context == 'search' ||
$context == 'create')) {
797 $options = CRM_Contact_BAO_Group
::getGroupsHierarchy($options, NULL, '- ', TRUE);