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_Group
extends CRM_Contact_DAO_Group
{
38 public function __construct() {
39 parent
::__construct();
43 * Retrieve DB object based on input parameters.
45 * It also stores all the retrieved values in the default array.
47 * @param array $params
48 * (reference ) an assoc array of name/value pairs.
49 * @param array $defaults
50 * (reference ) an assoc array to hold the flattened values.
52 * @return CRM_Contact_BAO_Group
54 public static function retrieve(&$params, &$defaults) {
55 $group = new CRM_Contact_DAO_Group();
56 $group->copyValues($params);
57 if ($group->find(TRUE)) {
58 CRM_Core_DAO
::storeValues($group, $defaults);
64 * Delete the group and all the object that connect to this group.
66 * Incredibly destructive.
68 * @param int $id Group id.
70 public static function discard($id) {
71 CRM_Utils_Hook
::pre('delete', 'Group', $id, CRM_Core_DAO
::$_nullArray);
73 $transaction = new CRM_Core_Transaction();
75 // added for CRM-1631 and CRM-1794
76 // delete all subscribed mails with the selected group id
77 $subscribe = new CRM_Mailing_Event_DAO_Subscribe();
78 $subscribe->group_id
= $id;
81 // delete all Subscription records with the selected group id
82 $subHistory = new CRM_Contact_DAO_SubscriptionHistory();
83 $subHistory->group_id
= $id;
84 $subHistory->delete();
86 // delete all crm_group_contact records with the selected group id
87 $groupContact = new CRM_Contact_DAO_GroupContact();
88 $groupContact->group_id
= $id;
89 $groupContact->delete();
91 // make all the 'add_to_group_id' field of 'civicrm_uf_group table', pointing to this group, as null
92 $params = [1 => [$id, 'Integer']];
93 $query = "UPDATE civicrm_uf_group SET `add_to_group_id`= NULL WHERE `add_to_group_id` = %1";
94 CRM_Core_DAO
::executeQuery($query, $params);
96 $query = "UPDATE civicrm_uf_group SET `limit_listings_group_id`= NULL WHERE `limit_listings_group_id` = %1";
97 CRM_Core_DAO
::executeQuery($query, $params);
99 // make sure u delete all the entries from civicrm_mailing_group and civicrm_campaign_group
101 $query = "DELETE FROM civicrm_mailing_group where entity_table = 'civicrm_group' AND entity_id = %1";
102 CRM_Core_DAO
::executeQuery($query, $params);
104 $query = "DELETE FROM civicrm_campaign_group where entity_table = 'civicrm_group' AND entity_id = %1";
105 CRM_Core_DAO
::executeQuery($query, $params);
107 $query = "DELETE FROM civicrm_acl_entity_role where entity_table = 'civicrm_group' AND entity_id = %1";
108 CRM_Core_DAO
::executeQuery($query, $params);
110 // delete from group table
111 $group = new CRM_Contact_DAO_Group();
115 $transaction->commit();
117 CRM_Utils_Hook
::post('delete', 'Group', $id, $group);
119 // delete the recently created Group
124 CRM_Utils_Recent
::del($groupRecent);
128 * Returns an array of the contacts in the given group.
132 public static function getGroupContacts($id) {
133 $params = [['group', 'IN', [1 => $id], 0, 0]];
134 list($contacts, $_) = CRM_Contact_BAO_Query
::apiQuery($params, ['contact_id']);
139 * Get the count of a members in a group with the specific status.
143 * @param string $status
144 * status of members in group
145 * @param bool $countChildGroups
148 * count of members in the group with above status
150 public static function memberCount($id, $status = 'Added', $countChildGroups = FALSE) {
151 $groupContact = new CRM_Contact_DAO_GroupContact();
153 if ($countChildGroups) {
154 $groupIds = CRM_Contact_BAO_GroupNesting
::getDescendentGroupIds($groupIds);
158 $contacts = self
::getGroupContacts($id);
160 foreach ($groupIds as $groupId) {
162 $groupContacts = self
::getGroupContacts($groupId);
163 foreach ($groupContacts as $gcontact) {
164 if ($groupId != $id) {
165 // Loop through main group's contacts
166 // and subtract from the count for each contact which
167 // matches one in the present group, if it is not the
169 foreach ($contacts as $contact) {
170 if ($contact['contact_id'] == $gcontact['contact_id']) {
176 $groupContact->group_id
= $groupId;
177 if (isset($status)) {
178 $groupContact->status
= $status;
180 $groupContact->_query
['condition'] = 'WHERE contact_id NOT IN (SELECT id FROM civicrm_contact WHERE is_deleted = 1)';
181 $count +
= $groupContact->count();
187 * Get the list of member for a group id.
189 * @param int $groupID
190 * @param bool $useCache
192 * Number to limit to (or 0 for unlimited).
195 * this array contains the list of members for this group id
197 public static function getMember($groupID, $useCache = TRUE, $limit = 0) {
198 $params = [['group', '=', $groupID, 0, 0]];
199 $returnProperties = ['contact_id'];
200 list($contacts) = CRM_Contact_BAO_Query
::apiQuery($params, $returnProperties, NULL, NULL, 0, $limit, $useCache);
203 foreach ($contacts as $contact) {
204 $aMembers[$contact['contact_id']] = 1;
211 * Returns array of group object(s) matching a set of one or Group properties.
213 * @param array $params
214 * Limits the set of groups returned.
215 * @param array $returnProperties
216 * Which properties should be included in the returned group objects.
217 * (member_count should be last element.)
218 * @param string $sort
220 * @param int $rowCount
223 * Array of group objects.
226 * @todo other BAO functions that use returnProperties (e.g. Query Objects) receive the array flipped & filled with 1s and
227 * add in essential fields (e.g. id). This should follow a regular pattern like the others
229 public static function getGroups(
231 $returnProperties = NULL,
236 $dao = new CRM_Contact_DAO_Group();
237 if (!isset($params['is_active'])) {
241 foreach ($params as $k => $v) {
242 if ($k == 'name' ||
$k == 'title') {
243 $dao->whereAdd($k . ' LIKE "' . CRM_Core_DAO
::escapeString($v) . '"');
245 elseif ($k == 'group_type') {
246 foreach ((array) $v as $type) {
247 $dao->whereAdd($k . " LIKE '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. (int) $type . CRM_Core_DAO
::VALUE_SEPARATOR
. "%'");
250 elseif (is_array($v)) {
251 foreach ($v as &$num) {
254 $dao->whereAdd($k . ' IN (' . implode(',', $v) . ')');
262 if ($offset ||
$rowCount) {
263 $offset = ($offset > 0) ?
$offset : 0;
264 $rowCount = ($rowCount > 0) ?
$rowCount : 25;
265 $dao->limit($offset, $rowCount);
269 $dao->orderBy($sort);
272 // return only specific fields if returnproperties are sent
273 if (!empty($returnProperties)) {
275 $dao->selectAdd(implode(',', $returnProperties));
279 $flag = $returnProperties && in_array('member_count', $returnProperties) ?
1 : 0;
282 while ($dao->fetch()) {
283 $group = new CRM_Contact_DAO_Group();
285 $dao->member_count
= CRM_Contact_BAO_Group
::memberCount($dao->id
);
287 $groups[] = clone($dao);
293 * Make sure that the user has permission to access this group.
296 * The id of the object.
297 * @param bool $excludeHidden
298 * Should hidden groups be excluded.
299 * Logically this is the wrong place to filter hidden groups out as that is
300 * not a permission issue. However, as other functions may rely on that defaulting to
301 * FALSE for now & only the api call is calling with true.
304 * The permission that the user has (or NULL)
306 public static function checkPermission($id, $excludeHidden = FALSE) {
307 $allGroups = CRM_Core_PseudoConstant
::allGroup(NULL, $excludeHidden);
310 if (CRM_Core_Permission
::check('edit all contacts') ||
311 CRM_ACL_API
::groupPermission(CRM_ACL_API
::EDIT
, $id, NULL,
312 'civicrm_saved_search', $allGroups
315 $permissions[] = CRM_Core_Permission
::EDIT
;
318 if (CRM_Core_Permission
::check('view all contacts') ||
319 CRM_ACL_API
::groupPermission(CRM_ACL_API
::VIEW
, $id, NULL,
320 'civicrm_saved_search', $allGroups
323 $permissions[] = CRM_Core_Permission
::VIEW
;
326 if (!empty($permissions) && CRM_Core_Permission
::check('delete contacts')) {
327 // Note: using !empty() in if condition, restricts the scope of delete
328 // permission to groups/contacts that are editable/viewable.
329 // We can remove this !empty condition once we have ACL support for delete functionality.
330 $permissions[] = CRM_Core_Permission
::DELETE
;
337 * Create a new group.
339 * @param array $params
341 * @return CRM_Contact_BAO_Group|NULL
342 * The new group BAO (if created)
344 public static function create(&$params) {
346 if (!empty($params['id'])) {
347 CRM_Utils_Hook
::pre('edit', 'Group', $params['id'], $params);
350 CRM_Utils_Hook
::pre('create', 'Group', NULL, $params);
353 // dev/core#287 Disable child groups if all parents are disabled.
354 if (!empty($params['id'])) {
355 $allChildGroupIds = self
::getChildGroupIds($params['id']);
356 foreach ($allChildGroupIds as $childKey => $childValue) {
357 $parentIds = CRM_Contact_BAO_GroupNesting
::getParentGroupIds($childValue);
358 $activeParentsCount = civicrm_api3('Group', 'getcount', [
359 'id' => ['IN' => $parentIds],
362 if (count($parentIds) >= 1 && $activeParentsCount <= 1) {
363 $setDisable = self
::setIsActive($childValue, CRM_Utils_Array
::value('is_active', $params, 1));
367 // form the name only if missing: CRM-627
368 $nameParam = CRM_Utils_Array
::value('name', $params, NULL);
369 if (!$nameParam && empty($params['id'])) {
370 $params['name'] = CRM_Utils_String
::titleToVar($params['title']);
373 if (!empty($params['parents'])) {
374 $params['parents'] = CRM_Utils_Array
::convertCheckboxFormatToArray((array) $params['parents']);
377 // convert params if array type
378 if (isset($params['group_type'])) {
379 $params['group_type'] = CRM_Utils_Array
::convertCheckboxFormatToArray((array) $params['group_type']);
382 $params['group_type'] = NULL;
385 $session = CRM_Core_Session
::singleton();
386 $cid = $session->get('userID');
387 // this action is add
388 if ($cid && empty($params['id'])) {
389 $params['created_id'] = $cid;
391 // this action is update
392 if ($cid && !empty($params['id'])) {
393 $params['modified_id'] = $cid;
397 // Validate parents parameter when creating group.
398 if (!empty($params['parents'])) {
399 $parents = is_array($params['parents']) ?
array_keys($params['parents']) : (array) $params['parents'];
400 foreach ($parents as $parent) {
401 CRM_Utils_Type
::validate($parent, 'Integer');
404 $group = new CRM_Contact_BAO_Group();
405 $group->copyValues($params, TRUE);
407 if (empty($params['id']) &&
410 $group->name
.= "_tmp";
418 if (empty($params['id']) &&
421 $group->name
= substr($group->name
, 0, -4) . "_{$group->id}";
424 $group->buildClause();
427 // add custom field values
428 if (!empty($params['custom'])) {
429 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_group', $group->id
);
432 // make the group, child of domain/site group by default.
433 $domainGroupID = CRM_Core_BAO_Domain
::getGroupId();
434 if (CRM_Utils_Array
::value('no_parent', $params) !== 1) {
435 if (empty($params['parents']) &&
436 $domainGroupID != $group->id
&&
437 Civi
::settings()->get('is_enabled') &&
438 !CRM_Contact_BAO_GroupNesting
::hasParentGroups($group->id
)
440 // if no parent present and the group doesn't already have any parents,
441 // make sure site group goes as parent
442 $params['parents'] = [$domainGroupID];
445 if (!empty($params['parents'])) {
446 foreach ($params['parents'] as $parentId) {
447 if ($parentId && !CRM_Contact_BAO_GroupNesting
::isParentChild($parentId, $group->id
)) {
448 CRM_Contact_BAO_GroupNesting
::add($parentId, $group->id
);
453 // this is always required, since we don't know when a
454 // parent group is removed
455 CRM_Contact_BAO_GroupNestingCache
::update();
457 // update group contact cache for all parent groups
458 $parentIds = CRM_Contact_BAO_GroupNesting
::getParentGroupIds($group->id
);
459 foreach ($parentIds as $parentId) {
460 CRM_Contact_BAO_GroupContactCache
::add($parentId);
464 if (!empty($params['organization_id'])) {
465 // dev/core#382 Keeping the id here can cause db errors as it tries to update the wrong record in the Organization table
467 'group_id' => $group->id
,
468 'organization_id' => $params['organization_id'],
470 CRM_Contact_BAO_GroupOrganization
::add($groupOrg);
474 CRM_Contact_BAO_GroupContactCache
::add($group->id
);
476 if (!empty($params['id'])) {
477 CRM_Utils_Hook
::post('edit', 'Group', $group->id
, $group);
480 CRM_Utils_Hook
::post('create', 'Group', $group->id
, $group);
484 if (CRM_Core_Permission
::check('edit groups')) {
485 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/group', 'reset=1&action=update&id=' . $group->id
);
486 // currently same permission we are using for delete a group
487 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/group', 'reset=1&action=delete&id=' . $group->id
);
490 // add the recently added group (unless hidden: CRM-6432)
491 if (!$group->is_hidden
) {
492 CRM_Utils_Recent
::add($group->title
,
493 CRM_Utils_System
::url('civicrm/group/search', 'reset=1&force=1&context=smog&gid=' . $group->id
),
505 * Given a saved search compute the clause and the tables
506 * and store it for future use
508 public function buildClause() {
509 $params = [['group', 'IN', [$this->id
], 0, 0]];
511 if (!empty($params)) {
512 $tables = $whereTables = [];
513 $this->where_clause
= CRM_Contact_BAO_Query
::getWhereClause($params, NULL, $tables, $whereTables);
514 if (!empty($tables)) {
515 $this->select_tables
= serialize($tables);
517 if (!empty($whereTables)) {
518 $this->where_tables
= serialize($whereTables);
524 * Defines a new smart group.
526 * @param array $params
527 * Associative array of parameters.
529 * @return CRM_Contact_BAO_Group|NULL
530 * The new group BAO (if created)
532 public static function createSmartGroup(&$params) {
533 if (!empty($params['formValues'])) {
535 unset($ssParams['id']);
536 if (isset($ssParams['saved_search_id'])) {
537 $ssParams['id'] = $ssParams['saved_search_id'];
540 $savedSearch = CRM_Contact_BAO_SavedSearch
::create($params);
542 $params['saved_search_id'] = $savedSearch->id
;
548 return self
::create($params);
552 * Update the is_active flag in the db.
555 * Id of the database record.
556 * @param bool $isActive
557 * Value we want to set the is_active field.
560 * true if we found and updated the object, else false
562 public static function setIsActive($id, $isActive) {
563 return CRM_Core_DAO
::setFieldValue('CRM_Contact_DAO_Group', $id, 'is_active', $isActive);
567 * Build the condition to retrieve groups.
569 * @param string $groupType
570 * Type of group(Access/Mailing) OR the key of the group.
571 * @param bool $excludeHidden exclude hidden groups.
575 public static function groupTypeCondition($groupType = NULL, $excludeHidden = TRUE) {
577 if ($groupType == 'Mailing') {
578 $value = CRM_Core_DAO
::VALUE_SEPARATOR
. '2' . CRM_Core_DAO
::VALUE_SEPARATOR
;
580 elseif ($groupType == 'Access') {
581 $value = CRM_Core_DAO
::VALUE_SEPARATOR
. '1' . CRM_Core_DAO
::VALUE_SEPARATOR
;
583 elseif (!empty($groupType)) {
584 // ie we have been given the group key
585 $value = CRM_Core_DAO
::VALUE_SEPARATOR
. $groupType . CRM_Core_DAO
::VALUE_SEPARATOR
;
589 if ($excludeHidden) {
590 $condition = "is_hidden = 0";
595 $condition .= " AND group_type LIKE '%$value%'";
598 $condition = "group_type LIKE '%$value%'";
606 * Get permission relevant clauses.
610 public static function getPermissionClause() {
611 if (!isset(Civi
::$statics[__CLASS__
]['permission_clause'])) {
612 if (CRM_Core_Permission
::check('view all contacts') || CRM_Core_Permission
::check('edit all contacts')) {
616 //get the allowed groups for the current user
617 $groups = CRM_ACL_API
::group(CRM_ACL_API
::VIEW
);
618 if (!empty($groups)) {
619 $groupList = implode(', ', array_values($groups));
620 $clause = "groups.id IN ( $groupList ) ";
626 Civi
::$statics[__CLASS__
]['permission_clause'] = $clause;
628 return Civi
::$statics[__CLASS__
]['permission_clause'];
632 * Flush caches that hold group data.
634 * (Actually probably some overkill at the moment.)
636 protected static function flushCaches() {
637 CRM_Utils_System
::flushCache();
639 'CRM_Core_PseudoConstant' => 'groups',
640 'CRM_ACL_API' => 'group_permission',
641 'CRM_ACL_BAO_ACL' => 'permissioned_groups',
642 'CRM_Contact_BAO_Group' => 'permission_clause',
644 foreach ($staticCaches as $class => $key) {
645 if (isset(Civi
::$statics[$class][$key])) {
646 unset(Civi
::$statics[$class][$key]);
654 public function __toString() {
659 * This function create the hidden smart group when user perform
660 * contact search and want to send mailing to search contacts.
662 * @param array $params
663 * ( reference ) an assoc array of name/value pairs.
666 * ( smartGroupId, ssId ) smart group id and saved search id
668 public static function createHiddenSmartGroup($params) {
669 $ssId = CRM_Utils_Array
::value('saved_search_id', $params);
671 //add mapping record only for search builder saved search
673 if ($params['search_context'] == 'builder') {
674 //save the mapping for search builder
676 //save record in mapping table
678 'mapping_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Core_BAO_Mapping', 'mapping_type_id', 'Search Builder'),
680 $mapping = CRM_Core_BAO_Mapping
::add($mappingParams);
681 $mappingId = $mapping->id
;
684 //get the mapping id from saved search
685 $savedSearch = new CRM_Contact_BAO_SavedSearch();
686 $savedSearch->id
= $ssId;
687 $savedSearch->find(TRUE);
688 $mappingId = $savedSearch->mapping_id
;
691 //save mapping fields
692 CRM_Core_BAO_Mapping
::saveMappingFields($params['form_values'], $mappingId);
695 //create/update saved search record.
696 $savedSearch = new CRM_Contact_BAO_SavedSearch();
697 $savedSearch->id
= $ssId;
698 $savedSearch->form_values
= serialize(CRM_Contact_BAO_Query
::convertFormValues($params['form_values']));
699 $savedSearch->mapping_id
= $mappingId;
700 $savedSearch->search_custom_id
= CRM_Utils_Array
::value('search_custom_id', $params);
701 $savedSearch->save();
703 $ssId = $savedSearch->id
;
708 $smartGroupId = NULL;
709 if (!empty($params['saved_search_id'])) {
710 $smartGroupId = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group', $ssId, 'id', 'saved_search_id');
713 //create group only when new saved search.
715 'title' => "Hidden Smart Group {$ssId}",
716 'is_active' => CRM_Utils_Array
::value('is_active', $params, 1),
717 'is_hidden' => CRM_Utils_Array
::value('is_hidden', $params, 1),
718 'group_type' => CRM_Utils_Array
::value('group_type', $params),
719 'visibility' => CRM_Utils_Array
::value('visibility', $params),
720 'saved_search_id' => $ssId,
723 $smartGroup = self
::create($groupParams);
724 $smartGroupId = $smartGroup->id
;
727 // Update mapping with the name and description of the hidden smart group.
731 'name' => CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group', $smartGroupId, 'name', 'id'),
732 'description' => CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group', $smartGroupId, 'description', 'id'),
733 'mapping_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Core_BAO_Mapping', 'mapping_type_id', 'Search Builder'),
735 CRM_Core_BAO_Mapping
::add($mappingParams);
738 return [$smartGroupId, $ssId];
742 * wrapper for ajax group selector.
744 * @param array $params
745 * Associated array for params record id.
748 * associated array of group list
751 * @todo there seems little reason for the small number of functions that call this to pass in
752 * params that then need to be translated in this function since they are coding them when calling
754 public static function getGroupListSelector(&$params) {
756 $params['offset'] = ($params['page'] - 1) * $params['rp'];
757 $params['rowCount'] = $params['rp'];
758 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
761 $groups = CRM_Contact_BAO_Group
::getGroupList($params);
763 //skip total if we are making call to show only children
764 if (empty($params['parent_id'])) {
766 $params['total'] = CRM_Contact_BAO_Group
::getGroupCount($params);
768 // get all the groups
769 $allGroups = CRM_Core_PseudoConstant
::allGroup();
772 // format params and add links
774 foreach ($groups as $id => $value) {
776 $group['group_id'] = $value['id'];
777 $group['count'] = $value['count'];
778 $group['title'] = $value['title'];
780 // append parent names if in search mode
781 if (empty($params['parent_id']) && !empty($value['parents'])) {
782 $group['parent_id'] = $value['parents'];
783 $groupIds = explode(',', $value['parents']);
785 foreach ($groupIds as $gId) {
786 $title[] = $allGroups[$gId];
788 $group['title'] .= '<div class="crm-row-parent-name"><em>' . ts('Child of') . '</em>: ' . implode(', ', $title) . '</div>';
789 $value['class'] = array_diff($value['class'], ['crm-row-parent']);
791 $group['DT_RowId'] = 'row_' . $value['id'];
792 if (empty($params['parentsOnly'])) {
793 foreach ($value['class'] as $id => $class) {
794 if ($class == 'crm-group-parent') {
795 unset($value['class'][$id]);
799 $group['DT_RowClass'] = 'crm-entity ' . implode(' ', $value['class']);
800 $group['DT_RowAttr'] = [];
801 $group['DT_RowAttr']['data-id'] = $value['id'];
802 $group['DT_RowAttr']['data-entity'] = 'group';
804 $group['description'] = CRM_Utils_Array
::value('description', $value);
806 if (!empty($value['group_type'])) {
807 $group['group_type'] = $value['group_type'];
810 $group['group_type'] = '';
813 $group['visibility'] = $value['visibility'];
814 $group['links'] = $value['action'];
815 $group['org_info'] = CRM_Utils_Array
::value('org_info', $value);
816 $group['created_by'] = CRM_Utils_Array
::value('created_by', $value);
818 $group['is_parent'] = $value['is_parent'];
820 array_push($groupList, $group);
824 $groupsDT['data'] = $groupList;
825 $groupsDT['recordsTotal'] = !empty($params['total']) ?
$params['total'] : NULL;
826 $groupsDT['recordsFiltered'] = !empty($params['total']) ?
$params['total'] : NULL;
832 * This function to get list of groups.
834 * @param array $params
835 * Associated array for params.
839 public static function getGroupList(&$params) {
840 $whereClause = self
::whereClause($params, FALSE);
843 if (!empty($params['rowCount']) &&
844 $params['rowCount'] > 0
846 $limit = " LIMIT {$params['offset']}, {$params['rowCount']} ";
849 $orderBy = ' ORDER BY groups.title asc';
850 if (!empty($params['sort'])) {
851 $orderBy = ' ORDER BY ' . CRM_Utils_Type
::escape($params['sort'], 'String');
853 // CRM-16905 - Sort by count cannot be done with sql
854 if (strpos($params['sort'], 'count') === 0) {
855 $orderBy = $limit = '';
859 $select = $from = $where = "";
861 if (CRM_Core_Permission
::check('administer Multiple Organizations') &&
862 CRM_Core_Permission
::isMultisiteEnabled()
864 $select = ", contact.display_name as org_name, contact.id as org_id";
865 $from = " LEFT JOIN civicrm_group_organization gOrg
866 ON gOrg.group_id = groups.id
867 LEFT JOIN civicrm_contact contact
868 ON contact.id = gOrg.organization_id ";
870 //get the Organization ID
871 $orgID = CRM_Utils_Request
::retrieve('oid', 'Positive');
873 $where = " AND gOrg.organization_id = {$orgID}";
880 SELECT groups.*, createdBy.sort_name as created_by {$select}
881 FROM civicrm_group groups
882 LEFT JOIN civicrm_contact createdBy
883 ON createdBy.id = groups.created_id
885 WHERE $whereClause {$where}
889 $object = CRM_Core_DAO
::executeQuery($query, $params, TRUE, 'CRM_Contact_DAO_Group');
891 //FIXME CRM-4418, now we are handling delete separately
892 //if we introduce 'delete for group' make sure to handle here.
893 $groupPermissions = [CRM_Core_Permission
::VIEW
];
894 if (CRM_Core_Permission
::check('edit groups')) {
895 $groupPermissions[] = CRM_Core_Permission
::EDIT
;
896 $groupPermissions[] = CRM_Core_Permission
::DELETE
;
900 $reservedPermission = CRM_Core_Permission
::check('administer reserved groups');
902 $links = self
::actionLinks($params);
904 $allTypes = CRM_Core_OptionGroup
::values('group_type');
907 $visibility = CRM_Core_SelectValues
::ufVisibility();
909 while ($object->fetch()) {
911 $values[$object->id
] = [
915 CRM_Core_DAO
::storeValues($object, $values[$object->id
]);
917 if ($object->saved_search_id
) {
918 $values[$object->id
]['title'] .= ' (' . ts('Smart Group') . ')';
919 // check if custom search, if so fix view link
920 $customSearchID = CRM_Core_DAO
::getFieldValue(
921 'CRM_Contact_DAO_SavedSearch',
922 $object->saved_search_id
,
926 if ($customSearchID) {
927 $newLinks[CRM_Core_Action
::VIEW
]['url'] = 'civicrm/contact/search/custom';
928 $newLinks[CRM_Core_Action
::VIEW
]['qs'] = "reset=1&force=1&ssID={$object->saved_search_id}";
932 $action = array_sum(array_keys($newLinks));
935 if (array_key_exists('is_reserved', $object)) {
936 //if group is reserved and I don't have reserved permission, suppress delete/edit
937 if ($object->is_reserved
&& !$reservedPermission) {
938 $action -= CRM_Core_Action
::DELETE
;
939 $action -= CRM_Core_Action
::UPDATE
;
940 $action -= CRM_Core_Action
::DISABLE
;
944 if (array_key_exists('is_active', $object)) {
945 if ($object->is_active
) {
946 $action -= CRM_Core_Action
::ENABLE
;
949 $values[$object->id
]['class'][] = 'disabled';
950 $action -= CRM_Core_Action
::VIEW
;
951 $action -= CRM_Core_Action
::DISABLE
;
955 $action = $action & CRM_Core_Action
::mask($groupPermissions);
957 $values[$object->id
]['visibility'] = $visibility[$values[$object->id
]['visibility']];
959 if (isset($values[$object->id
]['group_type'])) {
960 $groupTypes = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
961 substr($values[$object->id
]['group_type'], 1, -1)
964 foreach ($groupTypes as $type) {
965 $types[] = CRM_Utils_Array
::value($type, $allTypes);
967 $values[$object->id
]['group_type'] = implode(', ', $types);
970 $values[$object->id
]['action'] = CRM_Core_Action
::formLink($newLinks,
974 'ssid' => $object->saved_search_id
,
978 'group.selector.row',
984 // If group has children, add class for link to view children
985 $values[$object->id
]['is_parent'] = FALSE;
986 if (array_key_exists('children', $values[$object->id
])) {
987 $values[$object->id
]['class'][] = "crm-group-parent";
988 $values[$object->id
]['is_parent'] = TRUE;
991 // If group is a child, add child class
992 if (array_key_exists('parents', $values[$object->id
])) {
993 $values[$object->id
]['class'][] = "crm-group-child";
997 if ($object->org_id
) {
998 $contactUrl = CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$object->org_id}");
999 $values[$object->id
]['org_info'] = "<a href='{$contactUrl}'>{$object->org_name}</a>";
1003 $values[$object->id
]['org_info'] = '';
1007 // Collapsed column if all cells are NULL
1008 $values[$object->id
]['org_info'] = NULL;
1010 if ($object->created_id
) {
1011 $contactUrl = CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$object->created_id}");
1012 $values[$object->id
]['created_by'] = "<a href='{$contactUrl}'>{$object->created_by}</a>";
1015 // By default, we try to get a count of the contacts in each group
1016 // to display to the user on the Manage Group page. However, if
1017 // that will result in the cache being regenerated, then dipslay
1018 // "unknown" instead to avoid a long wait for the user.
1019 if (CRM_Contact_BAO_GroupContactCache
::shouldGroupBeRefreshed($object->id
)) {
1020 $values[$object->id
]['count'] = ts('unknown');
1023 $values[$object->id
]['count'] = civicrm_api3('Contact', 'getcount', ['group' => $object->id
]);
1027 // CRM-16905 - Sort by count cannot be done with sql
1028 if (!empty($params['sort']) && strpos($params['sort'], 'count') === 0) {
1029 usort($values, function($a, $b) {
1030 return $a['count'] - $b['count'];
1032 if (strpos($params['sort'], 'desc')) {
1033 $values = array_reverse($values, TRUE);
1035 return array_slice($values, $params['offset'], $params['rowCount']);
1042 * This function to get hierarchical list of groups (parent followed by children)
1044 * @param array $groupIDs
1045 * Array of group ids.
1047 * @param string $parents
1048 * @param string $spacer
1049 * @param bool $titleOnly
1053 public static function getGroupsHierarchy(
1056 $spacer = '<span class="child-indent"></span>',
1059 if (empty($groupIDs)) {
1063 $groupIdString = '(' . implode(',', array_keys($groupIDs)) . ')';
1064 // <span class="child-icon"></span>
1065 // need to return id, title (w/ spacer), description, visibility
1067 // We need to build a list of tags ordered by hierarchy and sorted by
1068 // name. The hierarchy will be communicated by an accumulation of
1069 // separators in front of the name to give it a visual offset.
1070 // Instead of recursively making mysql queries, we'll make one big
1071 // query and build the hierarchy with the algorithm below.
1073 $args = [1 => [$groupIdString, 'String']];
1075 SELECT id, title, description, visibility, parents
1077 WHERE id IN $groupIdString
1080 // group can have > 1 parent so parents may be comma separated list (eg. '1,2,5').
1081 $parentArray = explode(',', $parents);
1082 $parent = self
::filterActiveGroups($parentArray);
1083 $args[2] = [$parent, 'Integer'];
1084 $query .= " AND SUBSTRING_INDEX(parents, ',', 1) = %2";
1086 $query .= " ORDER BY title";
1087 $dao = CRM_Core_DAO
::executeQuery($query, $args);
1089 // Sort the groups into the correct storage by the parent
1090 // $roots represent the current leaf nodes that need to be checked for
1091 // children. $rows represent the unplaced nodes
1092 // $tree contains the child nodes based on their parent_id.
1095 while ($dao->fetch()) {
1096 if ($dao->parents
) {
1097 $parentArray = explode(',', $dao->parents
);
1098 $parent = self
::filterActiveGroups($parentArray);
1099 $tree[$parent][] = [
1101 'title' => $dao->title
,
1102 'visibility' => $dao->visibility
,
1103 'description' => $dao->description
,
1109 'title' => $dao->title
,
1110 'visibility' => $dao->visibility
,
1111 'description' => $dao->description
,
1117 for ($i = 0; $i < count($roots); $i++
) {
1118 self
::buildGroupHierarchy($hierarchy, $roots[$i], $tree, $titleOnly, $spacer, 0);
1124 * Build a list with groups on alphabetical order and child groups after the parent group.
1126 * This is a recursive function filling the $hierarchy parameter.
1135 private static function buildGroupHierarchy(&$hierarchy, $group, $tree, $titleOnly, $spacer, $level) {
1136 $spaces = str_repeat($spacer, $level);
1139 $hierarchy[$group['id']] = $spaces . $group['title'];
1142 $hierarchy[$group['id']] = [
1143 'title' => $spaces . $group['title'],
1144 'description' => $group['description'],
1145 'visibility' => $group['visibility'],
1149 // For performance reasons we use a for loop rather than a foreach.
1150 // Metrics for performance in an installation with 2867 groups a foreach
1151 // caused the function getGroupsHierarchy with a foreach execution takes
1152 // around 2.2 seoonds (2,200 ms).
1153 // Changing to a for loop execustion takes around 0.02 seconds (20 ms).
1154 if (isset($tree[$group['id']]) && is_array($tree[$group['id']])) {
1155 for ($i = 0; $i < count($tree[$group['id']]); $i++
) {
1156 self
::buildGroupHierarchy($hierarchy, $tree[$group['id']][$i], $tree, $titleOnly, $spacer, $level +
1);
1162 * @param array $params
1164 * @return NULL|string
1166 public static function getGroupCount(&$params) {
1167 $whereClause = self
::whereClause($params, FALSE);
1168 $query = "SELECT COUNT(*) FROM civicrm_group groups";
1170 if (!empty($params['created_by'])) {
1172 INNER JOIN civicrm_contact createdBy
1173 ON createdBy.id = groups.created_id";
1176 WHERE {$whereClause}";
1177 return CRM_Core_DAO
::singleValueQuery($query, $params);
1181 * Generate permissioned where clause for group search.
1182 * @param array $params
1183 * @param bool $sortBy
1184 * @param bool $excludeHidden
1188 public static function whereClause(&$params, $sortBy = TRUE, $excludeHidden = TRUE) {
1190 $title = CRM_Utils_Array
::value('title', $params);
1192 $clauses[] = "groups.title LIKE %1";
1193 if (strpos($title, '%') !== FALSE) {
1194 $params[1] = [$title, 'String', FALSE];
1197 $params[1] = [$title, 'String', TRUE];
1201 $groupType = CRM_Utils_Array
::value('group_type', $params);
1203 $types = explode(',', $groupType);
1204 if (!empty($types)) {
1205 $clauses[] = 'groups.group_type LIKE %2';
1206 $typeString = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $types) . CRM_Core_DAO
::VALUE_SEPARATOR
;
1207 $params[2] = [$typeString, 'String', TRUE];
1211 $visibility = CRM_Utils_Array
::value('visibility', $params);
1213 $clauses[] = 'groups.visibility = %3';
1214 $params[3] = [$visibility, 'String'];
1217 $groupStatus = CRM_Utils_Array
::value('status', $params);
1219 switch ($groupStatus) {
1221 $clauses[] = 'groups.is_active = 1';
1222 $params[4] = [$groupStatus, 'Integer'];
1226 $clauses[] = 'groups.is_active = 0';
1227 $params[4] = [$groupStatus, 'Integer'];
1231 $clauses[] = '(groups.is_active = 0 OR groups.is_active = 1 )';
1236 $parentsOnly = CRM_Utils_Array
::value('parentsOnly', $params);
1238 $clauses[] = 'groups.parents IS NULL';
1241 // only show child groups of a specific parent group
1242 $parent_id = CRM_Utils_Array
::value('parent_id', $params);
1244 $clauses[] = 'groups.id IN (SELECT child_group_id FROM civicrm_group_nesting WHERE parent_group_id = %5)';
1245 $params[5] = [$parent_id, 'Integer'];
1248 if ($createdBy = CRM_Utils_Array
::value('created_by', $params)) {
1249 $clauses[] = "createdBy.sort_name LIKE %6";
1250 if (strpos($createdBy, '%') !== FALSE) {
1251 $params[6] = [$createdBy, 'String', FALSE];
1254 $params[6] = [$createdBy, 'String', TRUE];
1258 if (empty($clauses)) {
1259 $clauses[] = 'groups.is_active = 1';
1262 if ($excludeHidden) {
1263 $clauses[] = 'groups.is_hidden = 0';
1266 $clauses[] = self
::getPermissionClause();
1268 return implode(' AND ', $clauses);
1272 * Define action links.
1275 * array of action links
1277 public static function actionLinks($params) {
1278 // If component_mode is set we change the "View" link to match the requested component type
1279 if (!isset($params['component_mode'])) {
1280 $params['component_mode'] = CRM_Contact_BAO_Query
::MODE_CONTACTS
;
1282 $modeValue = CRM_Contact_Form_Search
::getModeValue($params['component_mode']);
1284 CRM_Core_Action
::VIEW
=> [
1285 'name' => $modeValue['selectorLabel'],
1286 'url' => 'civicrm/group/search',
1287 'qs' => 'reset=1&force=1&context=smog&gid=%%id%%&component_mode=' . $params['component_mode'],
1288 'title' => ts('Group Contacts'),
1290 CRM_Core_Action
::UPDATE
=> [
1291 'name' => ts('Settings'),
1292 'url' => 'civicrm/group',
1293 'qs' => 'reset=1&action=update&id=%%id%%',
1294 'title' => ts('Edit Group'),
1296 CRM_Core_Action
::DISABLE
=> [
1297 'name' => ts('Disable'),
1298 'ref' => 'crm-enable-disable',
1299 'title' => ts('Disable Group'),
1301 CRM_Core_Action
::ENABLE
=> [
1302 'name' => ts('Enable'),
1303 'ref' => 'crm-enable-disable',
1304 'title' => ts('Enable Group'),
1306 CRM_Core_Action
::DELETE
=> [
1307 'name' => ts('Delete'),
1308 'url' => 'civicrm/group',
1309 'qs' => 'reset=1&action=delete&id=%%id%%',
1310 'title' => ts('Delete Group'),
1318 * @param $whereClause
1319 * @param array $whereParams
1323 public function pagerAtoZ($whereClause, $whereParams) {
1325 SELECT DISTINCT UPPER(LEFT(groups.title, 1)) as sort_name
1326 FROM civicrm_group groups
1328 ORDER BY LEFT(groups.title, 1)
1330 $dao = CRM_Core_DAO
::executeQuery($query, $whereParams);
1332 return CRM_Utils_PagerAToZ
::getAToZBar($dao, $this->_sortByCharacter
, TRUE);
1336 * Assign Test Value.
1338 * @param string $fieldName
1339 * @param array $fieldDef
1340 * @param int $counter
1342 protected function assignTestValue($fieldName, &$fieldDef, $counter) {
1343 if ($fieldName == 'children' ||
$fieldName == 'parents') {
1344 $this->{$fieldName} = "NULL";
1347 parent
::assignTestValues($fieldName, $fieldDef, $counter);
1352 * Get child group ids
1354 * @param array $regularGroupIDs
1359 public static function getChildGroupIds($regularGroupIDs) {
1360 $childGroupIDs = [];
1362 foreach ((array) $regularGroupIDs as $regularGroupID) {
1363 // temporary store the child group ID(s) of regular group identified by $id,
1364 // later merge with main child group array
1365 $tempChildGroupIDs = [];
1366 // check that the regular group has any child group, if not then continue
1367 if ($childrenFound = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group', $regularGroupID, 'children')) {
1368 $tempChildGroupIDs[] = $childrenFound;
1373 // as civicrm_group.children stores multiple group IDs in comma imploded string format,
1374 // so we need to convert it into array of child group IDs first
1375 $tempChildGroupIDs = explode(',', implode(',', $tempChildGroupIDs));
1376 $childGroupIDs = array_merge($childGroupIDs, $tempChildGroupIDs);
1377 // recursively fetch the child group IDs
1378 while (count($tempChildGroupIDs)) {
1379 $tempChildGroupIDs = self
::getChildGroupIds($tempChildGroupIDs);
1380 if (count($tempChildGroupIDs)) {
1381 $childGroupIDs = array_merge($childGroupIDs, $tempChildGroupIDs);
1386 return $childGroupIDs;
1390 * Check parent groups and filter out the disabled ones.
1392 * @param array $parentArray
1393 * Array of group Ids.
1397 public static function filterActiveGroups($parentArray) {
1398 if (count($parentArray) > 1) {
1399 $result = civicrm_api3('Group', 'get', [
1400 'id' => ['IN' => $parentArray],
1401 'is_active' => TRUE,
1404 $activeParentGroupIDs = CRM_Utils_Array
::collect('id', $result['values']);
1405 foreach ($parentArray as $key => $groupID) {
1406 if (!array_key_exists($groupID, $activeParentGroupIDs)) {
1407 unset($parentArray[$key]);
1412 return reset($parentArray);