3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
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_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 = array(1 => array($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
120 $groupRecent = array(
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 = array(array('group', 'IN', array(1 => $id), 0, 0));
134 list($contacts, $_) = CRM_Contact_BAO_Query
::apiQuery($params, array('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();
152 $groupIds = array($id);
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 = array(array('group', '=', $groupID, 0, 0));
199 $returnProperties = array('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 // form the name only if missing: CRM-627
354 $nameParam = CRM_Utils_Array
::value('name', $params, NULL);
355 if (!$nameParam && empty($params['id'])) {
356 $params['name'] = CRM_Utils_String
::titleToVar($params['title']);
359 if (!empty($params['parents'])) {
360 $params['parents'] = CRM_Utils_Array
::convertCheckboxFormatToArray((array) $params['parents']);
363 // convert params if array type
364 if (isset($params['group_type'])) {
365 $params['group_type'] = CRM_Utils_Array
::convertCheckboxFormatToArray((array) $params['group_type']);
368 $params['group_type'] = NULL;
371 $session = CRM_Core_Session
::singleton();
372 $cid = $session->get('userID');
373 // this action is add
374 if ($cid && empty($params['id'])) {
375 $params['created_id'] = $cid;
377 // this action is update
378 if ($cid && !empty($params['id'])) {
379 $params['modified_id'] = $cid;
383 // Validate parents parameter when creating group.
384 if (!empty($params['parents'])) {
385 $parents = is_array($params['parents']) ?
array_keys($params['parents']) : (array) $params['parents'];
386 foreach ($parents as $parent) {
387 CRM_Utils_Type
::validate($parent, 'Integer');
390 $group = new CRM_Contact_BAO_Group();
391 $group->copyValues($params, TRUE);
393 if (empty($params['id']) &&
396 $group->name
.= "_tmp";
404 if (empty($params['id']) &&
407 $group->name
= substr($group->name
, 0, -4) . "_{$group->id}";
410 $group->buildClause();
413 // add custom field values
414 if (!empty($params['custom'])) {
415 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_group', $group->id
);
418 // make the group, child of domain/site group by default.
419 $domainGroupID = CRM_Core_BAO_Domain
::getGroupId();
420 if (CRM_Utils_Array
::value('no_parent', $params) !== 1) {
421 if (empty($params['parents']) &&
422 $domainGroupID != $group->id
&&
423 Civi
::settings()->get('is_enabled') &&
424 !CRM_Contact_BAO_GroupNesting
::hasParentGroups($group->id
)
426 // if no parent present and the group doesn't already have any parents,
427 // make sure site group goes as parent
428 $params['parents'] = array($domainGroupID);
431 if (!empty($params['parents'])) {
432 foreach ($params['parents'] as $parentId) {
433 if ($parentId && !CRM_Contact_BAO_GroupNesting
::isParentChild($parentId, $group->id
)) {
434 CRM_Contact_BAO_GroupNesting
::add($parentId, $group->id
);
439 // this is always required, since we don't know when a
440 // parent group is removed
441 CRM_Contact_BAO_GroupNestingCache
::update();
443 // update group contact cache for all parent groups
444 $parentIds = CRM_Contact_BAO_GroupNesting
::getParentGroupIds($group->id
);
445 foreach ($parentIds as $parentId) {
446 CRM_Contact_BAO_GroupContactCache
::add($parentId);
450 if (!empty($params['organization_id'])) {
452 $groupOrg['group_id'] = $group->id
;
453 CRM_Contact_BAO_GroupOrganization
::add($groupOrg);
457 CRM_Contact_BAO_GroupContactCache
::add($group->id
);
459 if (!empty($params['id'])) {
460 CRM_Utils_Hook
::post('edit', 'Group', $group->id
, $group);
463 CRM_Utils_Hook
::post('create', 'Group', $group->id
, $group);
466 $recentOther = array();
467 if (CRM_Core_Permission
::check('edit groups')) {
468 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/group', 'reset=1&action=update&id=' . $group->id
);
469 // currently same permission we are using for delete a group
470 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/group', 'reset=1&action=delete&id=' . $group->id
);
473 // add the recently added group (unless hidden: CRM-6432)
474 if (!$group->is_hidden
) {
475 CRM_Utils_Recent
::add($group->title
,
476 CRM_Utils_System
::url('civicrm/group/search', 'reset=1&force=1&context=smog&gid=' . $group->id
),
488 * Given a saved search compute the clause and the tables
489 * and store it for future use
491 public function buildClause() {
492 $params = array(array('group', 'IN', array($this->id
), 0, 0));
494 if (!empty($params)) {
495 $tables = $whereTables = array();
496 $this->where_clause
= CRM_Contact_BAO_Query
::getWhereClause($params, NULL, $tables, $whereTables);
497 if (!empty($tables)) {
498 $this->select_tables
= serialize($tables);
500 if (!empty($whereTables)) {
501 $this->where_tables
= serialize($whereTables);
507 * Defines a new smart group.
509 * @param array $params
510 * Associative array of parameters.
512 * @return CRM_Contact_BAO_Group|NULL
513 * The new group BAO (if created)
515 public static function createSmartGroup(&$params) {
516 if (!empty($params['formValues'])) {
518 unset($ssParams['id']);
519 if (isset($ssParams['saved_search_id'])) {
520 $ssParams['id'] = $ssParams['saved_search_id'];
523 $savedSearch = CRM_Contact_BAO_SavedSearch
::create($params);
525 $params['saved_search_id'] = $savedSearch->id
;
531 return self
::create($params);
535 * Update the is_active flag in the db.
538 * Id of the database record.
539 * @param bool $isActive
540 * Value we want to set the is_active field.
542 * @return CRM_Core_DAO|null
543 * DAO object on success, NULL otherwise
545 public static function setIsActive($id, $isActive) {
546 return CRM_Core_DAO
::setFieldValue('CRM_Contact_DAO_Group', $id, 'is_active', $isActive);
550 * Build the condition to retrieve groups.
552 * @param string $groupType
553 * Type of group(Access/Mailing) OR the key of the group.
554 * @param bool $excludeHidden exclude hidden groups.
558 public static function groupTypeCondition($groupType = NULL, $excludeHidden = TRUE) {
560 if ($groupType == 'Mailing') {
561 $value = CRM_Core_DAO
::VALUE_SEPARATOR
. '2' . CRM_Core_DAO
::VALUE_SEPARATOR
;
563 elseif ($groupType == 'Access') {
564 $value = CRM_Core_DAO
::VALUE_SEPARATOR
. '1' . CRM_Core_DAO
::VALUE_SEPARATOR
;
566 elseif (!empty($groupType)) {
567 // ie we have been given the group key
568 $value = CRM_Core_DAO
::VALUE_SEPARATOR
. $groupType . CRM_Core_DAO
::VALUE_SEPARATOR
;
572 if ($excludeHidden) {
573 $condition = "is_hidden = 0";
578 $condition .= " AND group_type LIKE '%$value%'";
581 $condition = "group_type LIKE '%$value%'";
589 * Get permission relevant clauses.
593 public static function getPermissionClause() {
594 if (!isset(Civi
::$statics[__CLASS__
]['permission_clause'])) {
595 if (CRM_Core_Permission
::check('view all contacts') || CRM_Core_Permission
::check('edit all contacts')) {
599 //get the allowed groups for the current user
600 $groups = CRM_ACL_API
::group(CRM_ACL_API
::VIEW
);
601 if (!empty($groups)) {
602 $groupList = implode(', ', array_values($groups));
603 $clause = "groups.id IN ( $groupList ) ";
609 Civi
::$statics[__CLASS__
]['permission_clause'] = $clause;
611 return Civi
::$statics[__CLASS__
]['permission_clause'];
615 * Flush caches that hold group data.
617 * (Actually probably some overkill at the moment.)
619 protected static function flushCaches() {
620 CRM_Utils_System
::flushCache();
621 $staticCaches = array(
622 'CRM_Core_PseudoConstant' => 'groups',
623 'CRM_ACL_API' => 'group_permission',
624 'CRM_ACL_BAO_ACL' => 'permissioned_groups',
625 'CRM_Contact_BAO_Group' => 'permission_clause',
627 foreach ($staticCaches as $class => $key) {
628 if (isset(Civi
::$statics[$class][$key])) {
629 unset(Civi
::$statics[$class][$key]);
637 public function __toString() {
642 * This function create the hidden smart group when user perform
643 * contact search and want to send mailing to search contacts.
645 * @param array $params
646 * ( reference ) an assoc array of name/value pairs.
649 * ( smartGroupId, ssId ) smart group id and saved search id
651 public static function createHiddenSmartGroup($params) {
652 $ssId = CRM_Utils_Array
::value('saved_search_id', $params);
654 //add mapping record only for search builder saved search
656 if ($params['search_context'] == 'builder') {
657 //save the mapping for search builder
659 //save record in mapping table
660 $mappingParams = array(
661 'mapping_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Core_BAO_Mapping', 'mapping_type_id', 'Search Builder'),
663 $mapping = CRM_Core_BAO_Mapping
::add($mappingParams);
664 $mappingId = $mapping->id
;
667 //get the mapping id from saved search
668 $savedSearch = new CRM_Contact_BAO_SavedSearch();
669 $savedSearch->id
= $ssId;
670 $savedSearch->find(TRUE);
671 $mappingId = $savedSearch->mapping_id
;
674 //save mapping fields
675 CRM_Core_BAO_Mapping
::saveMappingFields($params['form_values'], $mappingId);
678 //create/update saved search record.
679 $savedSearch = new CRM_Contact_BAO_SavedSearch();
680 $savedSearch->id
= $ssId;
681 $savedSearch->form_values
= serialize($params['form_values']);
682 $savedSearch->mapping_id
= $mappingId;
683 $savedSearch->search_custom_id
= CRM_Utils_Array
::value('search_custom_id', $params);
684 $savedSearch->save();
686 $ssId = $savedSearch->id
;
691 $smartGroupId = NULL;
692 if (!empty($params['saved_search_id'])) {
693 $smartGroupId = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group', $ssId, 'id', 'saved_search_id');
696 //create group only when new saved search.
697 $groupParams = array(
698 'title' => "Hidden Smart Group {$ssId}",
699 'is_active' => CRM_Utils_Array
::value('is_active', $params, 1),
700 'is_hidden' => CRM_Utils_Array
::value('is_hidden', $params, 1),
701 'group_type' => CRM_Utils_Array
::value('group_type', $params),
702 'visibility' => CRM_Utils_Array
::value('visibility', $params),
703 'saved_search_id' => $ssId,
706 $smartGroup = self
::create($groupParams);
707 $smartGroupId = $smartGroup->id
;
710 // Update mapping with the name and description of the hidden smart group.
712 $mappingParams = array(
714 'name' => CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group', $smartGroupId, 'name', 'id'),
715 'description' => CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group', $smartGroupId, 'description', 'id'),
716 'mapping_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Core_BAO_Mapping', 'mapping_type_id', 'Search Builder'),
718 CRM_Core_BAO_Mapping
::add($mappingParams);
721 return array($smartGroupId, $ssId);
725 * wrapper for ajax group selector.
727 * @param array $params
728 * Associated array for params record id.
731 * associated array of group list
734 * @todo there seems little reason for the small number of functions that call this to pass in
735 * params that then need to be translated in this function since they are coding them when calling
737 static public function getGroupListSelector(&$params) {
739 $params['offset'] = ($params['page'] - 1) * $params['rp'];
740 $params['rowCount'] = $params['rp'];
741 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
744 $groups = CRM_Contact_BAO_Group
::getGroupList($params);
746 //skip total if we are making call to show only children
747 if (empty($params['parent_id'])) {
749 $params['total'] = CRM_Contact_BAO_Group
::getGroupCount($params);
751 // get all the groups
752 $allGroups = CRM_Core_PseudoConstant
::allGroup();
755 // format params and add links
756 $groupList = array();
757 foreach ($groups as $id => $value) {
759 $group['group_id'] = $value['id'];
760 $group['count'] = $value['count'];
761 $group['title'] = $value['title'];
763 // append parent names if in search mode
764 if (empty($params['parent_id']) && !empty($value['parents'])) {
765 $group['parent_id'] = $value['parents'];
766 $groupIds = explode(',', $value['parents']);
768 foreach ($groupIds as $gId) {
769 $title[] = $allGroups[$gId];
771 $group['title'] .= '<div class="crm-row-parent-name"><em>' . ts('Child of') . '</em>: ' . implode(', ', $title) . '</div>';
772 $value['class'] = array_diff($value['class'], array('crm-row-parent'));
774 $group['DT_RowId'] = 'row_' . $value['id'];
775 if (empty($params['parentsOnly'])) {
776 foreach ($value['class'] as $id => $class) {
777 if ($class == 'crm-group-parent') {
778 unset($value['class'][$id]);
782 $group['DT_RowClass'] = 'crm-entity ' . implode(' ', $value['class']);
783 $group['DT_RowAttr'] = array();
784 $group['DT_RowAttr']['data-id'] = $value['id'];
785 $group['DT_RowAttr']['data-entity'] = 'group';
787 $group['description'] = CRM_Utils_Array
::value('description', $value);
789 if (!empty($value['group_type'])) {
790 $group['group_type'] = $value['group_type'];
793 $group['group_type'] = '';
796 $group['visibility'] = $value['visibility'];
797 $group['links'] = $value['action'];
798 $group['org_info'] = CRM_Utils_Array
::value('org_info', $value);
799 $group['created_by'] = CRM_Utils_Array
::value('created_by', $value);
801 $group['is_parent'] = $value['is_parent'];
803 array_push($groupList, $group);
807 $groupsDT['data'] = $groupList;
808 $groupsDT['recordsTotal'] = !empty($params['total']) ?
$params['total'] : NULL;
809 $groupsDT['recordsFiltered'] = !empty($params['total']) ?
$params['total'] : NULL;
815 * This function to get list of groups.
817 * @param array $params
818 * Associated array for params.
822 public static function getGroupList(&$params) {
823 $whereClause = self
::whereClause($params, FALSE);
826 if (!empty($params['rowCount']) &&
827 $params['rowCount'] > 0
829 $limit = " LIMIT {$params['offset']}, {$params['rowCount']} ";
832 $orderBy = ' ORDER BY groups.title asc';
833 if (!empty($params['sort'])) {
834 $orderBy = ' ORDER BY ' . CRM_Utils_Type
::escape($params['sort'], 'String');
836 // CRM-16905 - Sort by count cannot be done with sql
837 if (strpos($params['sort'], 'count') === 0) {
838 $orderBy = $limit = '';
842 $select = $from = $where = "";
844 if (CRM_Core_Permission
::check('administer Multiple Organizations') &&
845 CRM_Core_Permission
::isMultisiteEnabled()
847 $select = ", contact.display_name as org_name, contact.id as org_id";
848 $from = " LEFT JOIN civicrm_group_organization gOrg
849 ON gOrg.group_id = groups.id
850 LEFT JOIN civicrm_contact contact
851 ON contact.id = gOrg.organization_id ";
853 //get the Organization ID
854 $orgID = CRM_Utils_Request
::retrieve('oid', 'Positive');
856 $where = " AND gOrg.organization_id = {$orgID}";
863 SELECT groups.*, createdBy.sort_name as created_by {$select}
864 FROM civicrm_group groups
865 LEFT JOIN civicrm_contact createdBy
866 ON createdBy.id = groups.created_id
868 WHERE $whereClause {$where}
872 $object = CRM_Core_DAO
::executeQuery($query, $params, TRUE, 'CRM_Contact_DAO_Group');
874 //FIXME CRM-4418, now we are handling delete separately
875 //if we introduce 'delete for group' make sure to handle here.
876 $groupPermissions = array(CRM_Core_Permission
::VIEW
);
877 if (CRM_Core_Permission
::check('edit groups')) {
878 $groupPermissions[] = CRM_Core_Permission
::EDIT
;
879 $groupPermissions[] = CRM_Core_Permission
::DELETE
;
883 $reservedPermission = CRM_Core_Permission
::check('administer reserved groups');
885 $links = self
::actionLinks();
887 $allTypes = CRM_Core_OptionGroup
::values('group_type');
890 $visibility = CRM_Core_SelectValues
::ufVisibility();
892 while ($object->fetch()) {
894 $values[$object->id
] = array(
898 CRM_Core_DAO
::storeValues($object, $values[$object->id
]);
900 if ($object->saved_search_id
) {
901 $values[$object->id
]['title'] .= ' (' . ts('Smart Group') . ')';
902 // check if custom search, if so fix view link
903 $customSearchID = CRM_Core_DAO
::getFieldValue(
904 'CRM_Contact_DAO_SavedSearch',
905 $object->saved_search_id
,
909 if ($customSearchID) {
910 $newLinks[CRM_Core_Action
::VIEW
]['url'] = 'civicrm/contact/search/custom';
911 $newLinks[CRM_Core_Action
::VIEW
]['qs'] = "reset=1&force=1&ssID={$object->saved_search_id}";
915 $action = array_sum(array_keys($newLinks));
918 if (array_key_exists('is_reserved', $object)) {
919 //if group is reserved and I don't have reserved permission, suppress delete/edit
920 if ($object->is_reserved
&& !$reservedPermission) {
921 $action -= CRM_Core_Action
::DELETE
;
922 $action -= CRM_Core_Action
::UPDATE
;
923 $action -= CRM_Core_Action
::DISABLE
;
927 if (array_key_exists('is_active', $object)) {
928 if ($object->is_active
) {
929 $action -= CRM_Core_Action
::ENABLE
;
932 $values[$object->id
]['class'][] = 'disabled';
933 $action -= CRM_Core_Action
::VIEW
;
934 $action -= CRM_Core_Action
::DISABLE
;
938 $action = $action & CRM_Core_Action
::mask($groupPermissions);
940 $values[$object->id
]['visibility'] = $visibility[$values[$object->id
]['visibility']];
942 if (isset($values[$object->id
]['group_type'])) {
943 $groupTypes = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
944 substr($values[$object->id
]['group_type'], 1, -1)
947 foreach ($groupTypes as $type) {
948 $types[] = CRM_Utils_Array
::value($type, $allTypes);
950 $values[$object->id
]['group_type'] = implode(', ', $types);
952 $values[$object->id
]['action'] = CRM_Core_Action
::formLink($newLinks,
956 'ssid' => $object->saved_search_id
,
960 'group.selector.row',
965 // If group has children, add class for link to view children
966 $values[$object->id
]['is_parent'] = FALSE;
967 if (array_key_exists('children', $values[$object->id
])) {
968 $values[$object->id
]['class'][] = "crm-group-parent";
969 $values[$object->id
]['is_parent'] = TRUE;
972 // If group is a child, add child class
973 if (array_key_exists('parents', $values[$object->id
])) {
974 $values[$object->id
]['class'][] = "crm-group-child";
978 if ($object->org_id
) {
979 $contactUrl = CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$object->org_id}");
980 $values[$object->id
]['org_info'] = "<a href='{$contactUrl}'>{$object->org_name}</a>";
983 $values[$object->id
]['org_info'] = ''; // Empty cell
987 $values[$object->id
]['org_info'] = NULL; // Collapsed column if all cells are NULL
989 if ($object->created_id
) {
990 $contactUrl = CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$object->created_id}");
991 $values[$object->id
]['created_by'] = "<a href='{$contactUrl}'>{$object->created_by}</a>";
994 // By default, we try to get a count of the contacts in each group
995 // to display to the user on the Manage Group page. However, if
996 // that will result in the cache being regenerated, then dipslay
997 // "unknown" instead to avoid a long wait for the user.
998 if (CRM_Contact_BAO_GroupContactCache
::shouldGroupBeRefreshed($object->id
)) {
999 $values[$object->id
]['count'] = ts('unknown');
1002 $values[$object->id
]['count'] = civicrm_api3('Contact', 'getcount', array('group' => $object->id
));
1006 // CRM-16905 - Sort by count cannot be done with sql
1007 if (!empty($params['sort']) && strpos($params['sort'], 'count') === 0) {
1008 usort($values, function($a, $b) {
1009 return $a['count'] - $b['count'];
1011 if (strpos($params['sort'], 'desc')) {
1012 $values = array_reverse($values, TRUE);
1014 return array_slice($values, $params['offset'], $params['rowCount']);
1021 * This function to get hierarchical list of groups (parent followed by children)
1023 * @param array $groupIDs
1024 * Array of group ids.
1026 * @param NULL $parents
1027 * @param string $spacer
1028 * @param bool $titleOnly
1032 public static function getGroupsHierarchy(
1035 $spacer = '<span class="child-indent"></span>',
1038 if (empty($groupIDs)) {
1042 $groupIdString = '(' . implode(',', array_keys($groupIDs)) . ')';
1043 // <span class="child-icon"></span>
1044 // need to return id, title (w/ spacer), description, visibility
1046 // We need to build a list of tags ordered by hierarchy and sorted by
1047 // name. The hierarchy will be communicated by an accumulation of
1048 // separators in front of the name to give it a visual offset.
1049 // Instead of recursively making mysql queries, we'll make one big
1050 // query and build the hierarchy with the algorithm below.
1052 $args = array(1 => array($groupIdString, 'String'));
1054 SELECT id, title, description, visibility, parents
1056 WHERE id IN $groupIdString
1059 // group can have > 1 parent so parents may be comma separated list (eg. '1,2,5').
1060 $parentArray = explode(',', $parents);
1061 $parent = self
::filterActiveGroups($parentArray);
1062 $args[2] = array($parent, 'Integer');
1063 $query .= " AND SUBSTRING_INDEX(parents, ',', 1) = %2";
1065 $query .= " ORDER BY title";
1066 $dao = CRM_Core_DAO
::executeQuery($query, $args);
1068 // Sort the groups into the correct storage by the parent
1069 // $roots represent the current leaf nodes that need to be checked for
1070 // children. $rows represent the unplaced nodes
1071 // $tree contains the child nodes based on their parent_id.
1074 while ($dao->fetch()) {
1075 if ($dao->parents
) {
1076 $parentArray = explode(',', $dao->parents
);
1077 $parent = self
::filterActiveGroups($parentArray);
1078 $tree[$parent][] = array(
1080 'title' => $dao->title
,
1081 'visibility' => $dao->visibility
,
1082 'description' => $dao->description
,
1088 'title' => $dao->title
,
1089 'visibility' => $dao->visibility
,
1090 'description' => $dao->description
,
1096 $hierarchy = array();
1097 for ($i = 0; $i < count($roots); $i++
) {
1098 self
::buildGroupHierarchy($hierarchy, $roots[$i], $tree, $titleOnly, $spacer, 0);
1104 * Build a list with groups on alphabetical order and child groups after the parent group.
1106 * This is a recursive function filling the $hierarchy parameter.
1115 private static function buildGroupHierarchy(&$hierarchy, $group, $tree, $titleOnly, $spacer, $level) {
1116 $spaces = str_repeat($spacer, $level);
1119 $hierarchy[$group['id']] = $spaces . $group['title'];
1122 $hierarchy[$group['id']] = array(
1123 'title' => $spaces . $group['title'],
1124 'description' => $group['description'],
1125 'visibility' => $group['visibility'],
1129 // For performance reasons we use a for loop rather than a foreach.
1130 // Metrics for performance in an installation with 2867 groups a foreach
1131 // caused the function getGroupsHierarchy with a foreach execution takes
1132 // around 2.2 seoonds (2,200 ms).
1133 // Changing to a for loop execustion takes around 0.02 seconds (20 ms).
1134 if (isset($tree[$group['id']]) && is_array($tree[$group['id']])) {
1135 for ($i = 0; $i < count($tree[$group['id']]); $i++
) {
1136 self
::buildGroupHierarchy($hierarchy, $tree[$group['id']][$i], $tree, $titleOnly, $spacer, $level +
1);
1142 * @param array $params
1144 * @return NULL|string
1146 public static function getGroupCount(&$params) {
1147 $whereClause = self
::whereClause($params, FALSE);
1148 $query = "SELECT COUNT(*) FROM civicrm_group groups";
1150 if (!empty($params['created_by'])) {
1152 INNER JOIN civicrm_contact createdBy
1153 ON createdBy.id = groups.created_id";
1156 WHERE {$whereClause}";
1157 return CRM_Core_DAO
::singleValueQuery($query, $params);
1161 * Generate permissioned where clause for group search.
1162 * @param array $params
1163 * @param bool $sortBy
1164 * @param bool $excludeHidden
1168 public static function whereClause(&$params, $sortBy = TRUE, $excludeHidden = TRUE) {
1170 $title = CRM_Utils_Array
::value('title', $params);
1172 $clauses[] = "groups.title LIKE %1";
1173 if (strpos($title, '%') !== FALSE) {
1174 $params[1] = array($title, 'String', FALSE);
1177 $params[1] = array($title, 'String', TRUE);
1181 $groupType = CRM_Utils_Array
::value('group_type', $params);
1183 $types = explode(',', $groupType);
1184 if (!empty($types)) {
1185 $clauses[] = 'groups.group_type LIKE %2';
1186 $typeString = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $types) . CRM_Core_DAO
::VALUE_SEPARATOR
;
1187 $params[2] = array($typeString, 'String', TRUE);
1191 $visibility = CRM_Utils_Array
::value('visibility', $params);
1193 $clauses[] = 'groups.visibility = %3';
1194 $params[3] = array($visibility, 'String');
1197 $groupStatus = CRM_Utils_Array
::value('status', $params);
1199 switch ($groupStatus) {
1201 $clauses[] = 'groups.is_active = 1';
1202 $params[4] = array($groupStatus, 'Integer');
1206 $clauses[] = 'groups.is_active = 0';
1207 $params[4] = array($groupStatus, 'Integer');
1211 $clauses[] = '(groups.is_active = 0 OR groups.is_active = 1 )';
1216 $parentsOnly = CRM_Utils_Array
::value('parentsOnly', $params);
1218 $clauses[] = 'groups.parents IS NULL';
1221 // only show child groups of a specific parent group
1222 $parent_id = CRM_Utils_Array
::value('parent_id', $params);
1224 $clauses[] = 'groups.id IN (SELECT child_group_id FROM civicrm_group_nesting WHERE parent_group_id = %5)';
1225 $params[5] = array($parent_id, 'Integer');
1228 if ($createdBy = CRM_Utils_Array
::value('created_by', $params)) {
1229 $clauses[] = "createdBy.sort_name LIKE %6";
1230 if (strpos($createdBy, '%') !== FALSE) {
1231 $params[6] = array($createdBy, 'String', FALSE);
1234 $params[6] = array($createdBy, 'String', TRUE);
1238 if (empty($clauses)) {
1239 $clauses[] = 'groups.is_active = 1';
1242 if ($excludeHidden) {
1243 $clauses[] = 'groups.is_hidden = 0';
1246 $clauses[] = self
::getPermissionClause();
1248 return implode(' AND ', $clauses);
1252 * Define action links.
1255 * array of action links
1257 public static function actionLinks() {
1259 CRM_Core_Action
::VIEW
=> array(
1260 'name' => ts('Contacts'),
1261 'url' => 'civicrm/group/search',
1262 'qs' => 'reset=1&force=1&context=smog&gid=%%id%%',
1263 'title' => ts('Group Contacts'),
1265 CRM_Core_Action
::UPDATE
=> array(
1266 'name' => ts('Settings'),
1267 'url' => 'civicrm/group',
1268 'qs' => 'reset=1&action=update&id=%%id%%',
1269 'title' => ts('Edit Group'),
1271 CRM_Core_Action
::DISABLE
=> array(
1272 'name' => ts('Disable'),
1273 'ref' => 'crm-enable-disable',
1274 'title' => ts('Disable Group'),
1276 CRM_Core_Action
::ENABLE
=> array(
1277 'name' => ts('Enable'),
1278 'ref' => 'crm-enable-disable',
1279 'title' => ts('Enable Group'),
1281 CRM_Core_Action
::DELETE
=> array(
1282 'name' => ts('Delete'),
1283 'url' => 'civicrm/group',
1284 'qs' => 'reset=1&action=delete&id=%%id%%',
1285 'title' => ts('Delete Group'),
1293 * @param $whereClause
1294 * @param array $whereParams
1298 public function pagerAtoZ($whereClause, $whereParams) {
1300 SELECT DISTINCT UPPER(LEFT(groups.title, 1)) as sort_name
1301 FROM civicrm_group groups
1303 ORDER BY LEFT(groups.title, 1)
1305 $dao = CRM_Core_DAO
::executeQuery($query, $whereParams);
1307 return CRM_Utils_PagerAToZ
::getAToZBar($dao, $this->_sortByCharacter
, TRUE);
1311 * Assign Test Value.
1313 * @param string $fieldName
1314 * @param array $fieldDef
1315 * @param int $counter
1317 protected function assignTestValue($fieldName, &$fieldDef, $counter) {
1318 if ($fieldName == 'children' ||
$fieldName == 'parents') {
1319 $this->{$fieldName} = "NULL";
1322 parent
::assignTestValues($fieldName, $fieldDef, $counter);
1327 * Get child group ids
1329 * @param array $regularGroupIDs
1334 public static function getChildGroupIds($regularGroupIDs) {
1335 $childGroupIDs = array();
1337 foreach ($regularGroupIDs as $regularGroupID) {
1338 // temporary store the child group ID(s) of regular group identified by $id,
1339 // later merge with main child group array
1340 $tempChildGroupIDs = array();
1341 // check that the regular group has any child group, if not then continue
1342 if ($childrenFound = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group', $regularGroupID, 'children')) {
1343 $tempChildGroupIDs[] = $childrenFound;
1348 // as civicrm_group.children stores multiple group IDs in comma imploded string format,
1349 // so we need to convert it into array of child group IDs first
1350 $tempChildGroupIDs = explode(',', implode(',', $tempChildGroupIDs));
1351 $childGroupIDs = array_merge($childGroupIDs, $tempChildGroupIDs);
1352 // recursively fetch the child group IDs
1353 while (count($tempChildGroupIDs)) {
1354 $tempChildGroupIDs = self
::getChildGroupIds($tempChildGroupIDs);
1355 if (count($tempChildGroupIDs)) {
1356 $childGroupIDs = array_merge($childGroupIDs, $tempChildGroupIDs);
1361 return $childGroupIDs;
1365 * Check parent groups and filter out the disabled ones.
1367 * @param array $parentArray
1368 * Array of group Ids.
1372 public static function filterActiveGroups($parentArray) {
1373 if (count($parentArray) > 1) {
1374 $result = civicrm_api3('Group', 'get', array(
1375 'id' => array('IN' => $parentArray),
1376 'is_active' => TRUE,
1379 $activeParentGroupIDs = CRM_Utils_Array
::collect('id', $result['values']);
1380 foreach ($parentArray as $key => $groupID) {
1381 if (!array_key_exists($groupID, $activeParentGroupIDs)) {
1382 unset($parentArray[$key]);
1387 return reset($parentArray);