3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
35 class CRM_Contact_BAO_Group
extends CRM_Contact_DAO_Group
{
40 public function __construct() {
41 parent
::__construct();
45 * Takes a bunch of params that are needed to match certain criteria and
46 * retrieves the relevant objects. Typically the valid params are only
47 * group_id. We'll tweak this function to be more full featured over a period
48 * of time. This is the inverse function of create. It also stores all the retrieved
49 * values in the default array
51 * @param array $params
52 * (reference ) an assoc array of name/value pairs.
53 * @param array $defaults
54 * (reference ) an assoc array to hold the flattened values.
56 * @return CRM_Contact_BAO_Group
58 public static function retrieve(&$params, &$defaults) {
59 $group = new CRM_Contact_DAO_Group();
60 $group->copyValues($params);
61 if ($group->find(TRUE)) {
62 CRM_Core_DAO
::storeValues($group, $defaults);
70 * Delete the group and all the object that connect to
71 * this group. Incredibly destructive
78 public static function discard($id) {
79 CRM_Utils_Hook
::pre('delete', 'Group', $id, CRM_Core_DAO
::$_nullArray);
81 $transaction = new CRM_Core_Transaction();
83 // added for CRM-1631 and CRM-1794
84 // delete all subscribed mails with the selected group id
85 $subscribe = new CRM_Mailing_Event_DAO_Subscribe();
86 $subscribe->group_id
= $id;
89 // delete all Subscription records with the selected group id
90 $subHistory = new CRM_Contact_DAO_SubscriptionHistory();
91 $subHistory->group_id
= $id;
92 $subHistory->delete();
94 // delete all crm_group_contact records with the selected group id
95 $groupContact = new CRM_Contact_DAO_GroupContact();
96 $groupContact->group_id
= $id;
97 $groupContact->delete();
99 // make all the 'add_to_group_id' field of 'civicrm_uf_group table', pointing to this group, as null
100 $params = array(1 => array($id, 'Integer'));
101 $query = "UPDATE civicrm_uf_group SET `add_to_group_id`= NULL WHERE `add_to_group_id` = %1";
102 CRM_Core_DAO
::executeQuery($query, $params);
104 $query = "UPDATE civicrm_uf_group SET `limit_listings_group_id`= NULL WHERE `limit_listings_group_id` = %1";
105 CRM_Core_DAO
::executeQuery($query, $params);
107 // make sure u delete all the entries from civicrm_mailing_group and civicrm_campaign_group
109 $query = "DELETE FROM civicrm_mailing_group where entity_table = 'civicrm_group' AND entity_id = %1";
110 CRM_Core_DAO
::executeQuery($query, $params);
112 $query = "DELETE FROM civicrm_campaign_group where entity_table = 'civicrm_group' AND entity_id = %1";
113 CRM_Core_DAO
::executeQuery($query, $params);
115 $query = "DELETE FROM civicrm_acl_entity_role where entity_table = 'civicrm_group' AND entity_id = %1";
116 CRM_Core_DAO
::executeQuery($query, $params);
118 if (CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MULTISITE_PREFERENCES_NAME
,
122 // clear any descendant groups cache if exists
123 CRM_Core_BAO_Cache
::deleteGroup('descendant groups for an org');
126 // delete from group table
127 $group = new CRM_Contact_DAO_Group();
131 $transaction->commit();
133 CRM_Utils_Hook
::post('delete', 'Group', $id, $group);
135 // delete the recently created Group
136 $groupRecent = array(
140 CRM_Utils_Recent
::del($groupRecent);
144 * Returns an array of the contacts in the given group.
146 public static function getGroupContacts($id) {
147 $params = array(array('group', 'IN', array($id => 1), 0, 0));
148 list($contacts, $_) = CRM_Contact_BAO_Query
::apiQuery($params, array('contact_id'));
153 * Get the count of a members in a group with the specific status
157 * @param string $status
158 * status of members in group
159 * @param bool $countChildGroups
162 * count of members in the group with above status
164 public static function memberCount($id, $status = 'Added', $countChildGroups = FALSE) {
165 $groupContact = new CRM_Contact_DAO_GroupContact();
166 $groupIds = array($id);
167 if ($countChildGroups) {
168 $groupIds = CRM_Contact_BAO_GroupNesting
::getDescendentGroupIds($groupIds);
172 $contacts = self
::getGroupContacts($id);
174 foreach ($groupIds as $groupId) {
176 $groupContacts = self
::getGroupContacts($groupId);
177 foreach ($groupContacts as $gcontact) {
178 if ($groupId != $id) {
179 // Loop through main group's contacts
180 // and subtract from the count for each contact which
181 // matches one in the present group, if it is not the
183 foreach ($contacts as $contact) {
184 if ($contact['contact_id'] == $gcontact['contact_id']) {
190 $groupContact->group_id
= $groupId;
191 if (isset($status)) {
192 $groupContact->status
= $status;
194 $groupContact->_query
['condition'] = 'WHERE contact_id NOT IN (SELECT id FROM civicrm_contact WHERE is_deleted = 1)';
195 $count +
= $groupContact->count();
201 * Get the list of member for a group id
203 * @param int $groupID
204 * @param bool $useCache
207 * this array contains the list of members for this group id
209 public static function &getMember($groupID, $useCache = TRUE) {
210 $params = array(array('group', 'IN', array($groupID => 1), 0, 0));
211 $returnProperties = array('contact_id');
212 list($contacts, $_) = CRM_Contact_BAO_Query
::apiQuery($params, $returnProperties, NULL, NULL, 0, 0, $useCache);
215 foreach ($contacts as $contact) {
216 $aMembers[$contact['contact_id']] = 1;
223 * Returns array of group object(s) matching a set of one or Group properties.
225 * @param array $params
226 * Limits the set of groups returned.
227 * @param array $returnProperties
228 * Which properties should be included in the returned group objects.
229 * (member_count should be last element.)
230 * @param string $sort
232 * @param int $rowCount
235 * Array of group objects.
238 * @todo other BAO functions that use returnProperties (e.g. Query Objects) receive the array flipped & filled with 1s and
239 * add in essential fields (e.g. id). This should follow a regular pattern like the others
241 static function getGroups(
243 $returnProperties = NULL,
248 $dao = new CRM_Contact_DAO_Group();
249 if (!isset($params['is_active'])) {
253 foreach ($params as $k => $v) {
254 if ($k == 'name' ||
$k == 'title') {
255 $dao->whereAdd($k . ' LIKE "' . CRM_Core_DAO
::escapeString($v) . '"');
257 elseif ($k == 'group_type') {
258 foreach ((array) $v as $type) {
259 $dao->whereAdd($k . " LIKE '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. (int) $type . CRM_Core_DAO
::VALUE_SEPARATOR
. "%'");
262 elseif (is_array($v)) {
263 foreach ($v as &$num) {
266 $dao->whereAdd($k . ' IN (' . implode(',', $v) . ')');
274 if ($offset ||
$rowCount) {
275 $offset = ($offset > 0) ?
$offset : 0;
276 $rowCount = ($rowCount > 0) ?
$rowCount : 25;
277 $dao->limit($offset, $rowCount);
281 $dao->orderBy($sort);
284 // return only specific fields if returnproperties are sent
285 if (!empty($returnProperties)) {
287 $dao->selectAdd(implode(',', $returnProperties));
291 $flag = $returnProperties && in_array('member_count', $returnProperties) ?
1 : 0;
294 while ($dao->fetch()) {
295 $group = new CRM_Contact_DAO_Group();
297 $dao->member_count
= CRM_Contact_BAO_Group
::memberCount($dao->id
);
299 $groups[] = clone($dao);
305 * Make sure that the user has permission to access this group
308 * The id of the object.
311 * the permission that the user has (or NULL)
313 public static function checkPermission($id) {
314 $allGroups = CRM_Core_PseudoConstant
::allGroup();
317 if (CRM_Core_Permission
::check('edit all contacts') ||
318 CRM_ACL_API
::groupPermission(CRM_ACL_API
::EDIT
, $id, NULL,
319 'civicrm_saved_search', $allGroups
322 $permissions[] = CRM_Core_Permission
::EDIT
;
325 if (CRM_Core_Permission
::check('view all contacts') ||
326 CRM_ACL_API
::groupPermission(CRM_ACL_API
::VIEW
, $id, NULL,
327 'civicrm_saved_search', $allGroups
330 $permissions[] = CRM_Core_Permission
::VIEW
;
333 if (!empty($permissions) && CRM_Core_Permission
::check('delete contacts')) {
334 // Note: using !empty() in if condition, restricts the scope of delete
335 // permission to groups/contacts that are editable/viewable.
336 // We can remove this !empty condition once we have ACL support for delete functionality.
337 $permissions[] = CRM_Core_Permission
::DELETE
;
346 * @param array $params
348 * @return CRM_Contact_BAO_Group|NULL
349 * The new group BAO (if created)
351 public static function &create(&$params) {
353 if (!empty($params['id'])) {
354 CRM_Utils_Hook
::pre('edit', 'Group', $params['id'], $params);
357 CRM_Utils_Hook
::pre('create', 'Group', NULL, $params);
360 // form the name only if missing: CRM-627
361 $nameParam = CRM_Utils_Array
::value('name', $params, NULL);
362 if (!$nameParam && empty($params['id'])) {
363 $params['name'] = CRM_Utils_String
::titleToVar($params['title']);
366 // convert params if array type
367 if (isset($params['group_type'])) {
368 if (is_array($params['group_type'])) {
369 $params['group_type'] = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
370 array_keys($params['group_type'])
371 ) . CRM_Core_DAO
::VALUE_SEPARATOR
;
375 $params['group_type'] = '';
378 $session = CRM_Core_Session
::singleton();
379 $cid = $session->get('userID');
380 // this action is add
381 if ($cid && empty($params['id'])) {
382 $params['created_id'] = $cid;
384 // this action is update
385 if ($cid && !empty($params['id'])) {
386 $params['modified_id'] = $cid;
389 $group = new CRM_Contact_BAO_Group();
390 $group->copyValues($params);
391 //@todo very hacky fix for the fact this function wants to receive 'parents' as an array further down but
392 // needs it as a separated string for the DB. Preferred approaches are having the copyParams or save fn
393 // use metadata to translate the array to the appropriate DB type or altering the param in the api layer,
394 // or at least altering the param in same section as 'group_type' rather than repeating here. However, further down
395 // we need the $params one to be in it's original form & we are not sure what test coverage we have on that
396 if (isset($group->parents
) && is_array($group->parents
)) {
397 $group->parents
= CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
398 array_keys($group->parents
)
399 ) . CRM_Core_DAO
::VALUE_SEPARATOR
;
401 if (empty($params['id']) &&
404 $group->name
.= "_tmp";
412 if (empty($params['id']) &&
415 $group->name
= substr($group->name
, 0, -4) . "_{$group->id}";
418 $group->buildClause();
421 // add custom field values
422 if (!empty($params['custom'])) {
423 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_group', $group->id
);
426 // make the group, child of domain/site group by default.
427 $domainGroupID = CRM_Core_BAO_Domain
::getGroupId();
428 if (CRM_Utils_Array
::value('no_parent', $params) !== 1) {
429 if (empty($params['parents']) &&
430 $domainGroupID != $group->id
&&
431 CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MULTISITE_PREFERENCES_NAME
,
434 !CRM_Contact_BAO_GroupNesting
::hasParentGroups($group->id
)
436 // if no parent present and the group doesn't already have any parents,
437 // make sure site group goes as parent
438 $params['parents'] = array($domainGroupID => 1);
440 elseif (array_key_exists('parents', $params) && !is_array($params['parents'])) {
441 $params['parents'] = array($params['parents'] => 1);
444 if (!empty($params['parents'])) {
445 foreach ($params['parents'] as $parentId => $dnc) {
446 if ($parentId && !CRM_Contact_BAO_GroupNesting
::isParentChild($parentId, $group->id
)) {
447 CRM_Contact_BAO_GroupNesting
::add($parentId, $group->id
);
452 // clear any descendant groups cache if exists
453 $finalGroups = CRM_Core_BAO_Cache
::deleteGroup('descendant groups for an org');
455 // this is always required, since we don't know when a
456 // parent group is removed
457 CRM_Contact_BAO_GroupNestingCache
::update();
459 // update group contact cache for all parent groups
460 $parentIds = CRM_Contact_BAO_GroupNesting
::getParentGroupIds($group->id
);
461 foreach ($parentIds as $parentId) {
462 CRM_Contact_BAO_GroupContactCache
::add($parentId);
466 if (!empty($params['organization_id'])) {
469 $groupOrg['group_id'] = $group->id
;
470 CRM_Contact_BAO_GroupOrganization
::add($groupOrg);
473 CRM_Contact_BAO_GroupContactCache
::add($group->id
);
475 if (!empty($params['id'])) {
476 CRM_Utils_Hook
::post('edit', 'Group', $group->id
, $group);
479 CRM_Utils_Hook
::post('create', 'Group', $group->id
, $group);
482 $recentOther = array();
483 if (CRM_Core_Permission
::check('edit groups')) {
484 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/group', 'reset=1&action=update&id=' . $group->id
);
485 // currently same permission we are using for delete a group
486 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/group', 'reset=1&action=delete&id=' . $group->id
);
489 // add the recently added group (unless hidden: CRM-6432)
490 if (!$group->is_hidden
) {
491 CRM_Utils_Recent
::add($group->title
,
492 CRM_Utils_System
::url('civicrm/group/search', 'reset=1&force=1&context=smog&gid=' . $group->id
),
504 * Given a saved search compute the clause and the tables
505 * and store it for future use
507 public function buildClause() {
508 $params = array(array('group', 'IN', array($this->id
=> 1), 0, 0));
510 if (!empty($params)) {
511 $tables = $whereTables = array();
512 $this->where_clause
= CRM_Contact_BAO_Query
::getWhereClause($params, NULL, $tables, $whereTables);
513 if (!empty($tables)) {
514 $this->select_tables
= serialize($tables);
516 if (!empty($whereTables)) {
517 $this->where_tables
= serialize($whereTables);
525 * Defines a new smart group
527 * @param array $params
528 * Associative array of parameters.
530 * @return CRM_Contact_BAO_Group|NULL
531 * The new group BAO (if created)
533 public static function createSmartGroup(&$params) {
534 if (!empty($params['formValues'])) {
536 unset($ssParams['id']);
537 if (isset($ssParams['saved_search_id'])) {
538 $ssParams['id'] = $ssParams['saved_search_id'];
541 $savedSearch = CRM_Contact_BAO_SavedSearch
::create($params);
543 $params['saved_search_id'] = $savedSearch->id
;
549 return self
::create($params);
553 * Update the is_active flag in the db
556 * Id of the database record.
557 * @param bool $isActive
558 * Value we want to set the is_active field.
560 * @return CRM_Core_DAO|null
561 * DAO object on success, NULL otherwise
563 public static function setIsActive($id, $isActive) {
564 return CRM_Core_DAO
::setFieldValue('CRM_Contact_DAO_Group', $id, 'is_active', $isActive);
568 * Build the condition to retrieve groups.
570 * @param string $groupType
571 * Type of group(Access/Mailing) OR the key of the group.
572 * @param bool $excludeHidden exclude hidden groups.
576 public static function groupTypeCondition($groupType = NULL, $excludeHidden = TRUE) {
578 if ($groupType == 'Mailing') {
579 $value = CRM_Core_DAO
::VALUE_SEPARATOR
. '2' . CRM_Core_DAO
::VALUE_SEPARATOR
;
581 elseif ($groupType == 'Access') {
582 $value = CRM_Core_DAO
::VALUE_SEPARATOR
. '1' . CRM_Core_DAO
::VALUE_SEPARATOR
;
584 elseif (!empty($groupType)) {
585 // ie we have been given the group key
586 $value = CRM_Core_DAO
::VALUE_SEPARATOR
. $groupType . CRM_Core_DAO
::VALUE_SEPARATOR
;
590 if ($excludeHidden) {
591 $condition = "is_hidden = 0";
596 $condition .= " AND group_type LIKE '%$value%'";
599 $condition = "group_type LIKE '%$value%'";
607 * Get permission relevant clauses
614 public static function getPermissionClause($force = FALSE) {
616 static $retrieved = FALSE;
617 if ((!$retrieved ||
$force) && !CRM_Core_Permission
::check('view all contacts') && !CRM_Core_Permission
::check('edit all contacts')) {
618 //get the allowed groups for the current user
619 $groups = CRM_ACL_API
::group(CRM_ACL_API
::VIEW
);
620 if (!empty($groups)) {
621 $groupList = implode(', ', array_values($groups));
622 $clause = "groups.id IN ( $groupList ) ";
635 public function __toString() {
640 * This function create the hidden smart group when user perform
641 * contact seach and want to send mailing to search contacts.
643 * @param array $params
644 * ( reference ) an assoc array of name/value pairs.
647 * ( smartGroupId, ssId ) smart group id and saved search id
649 public static function createHiddenSmartGroup($params) {
650 $ssId = CRM_Utils_Array
::value('saved_search_id', $params);
652 //add mapping record only for search builder saved search
654 if ($params['search_context'] == 'builder') {
655 //save the mapping for search builder
657 //save record in mapping table
659 $mappingParams = array('mapping_type' => 'Search Builder');
660 $mapping = CRM_Core_BAO_Mapping
::add($mappingParams, $temp);
661 $mappingId = $mapping->id
;
664 //get the mapping id from saved search
665 $savedSearch = new CRM_Contact_BAO_SavedSearch();
666 $savedSearch->id
= $ssId;
667 $savedSearch->find(TRUE);
668 $mappingId = $savedSearch->mapping_id
;
671 //save mapping fields
672 CRM_Core_BAO_Mapping
::saveMappingFields($params['form_values'], $mappingId);
675 //create/update saved search record.
676 $savedSearch = new CRM_Contact_BAO_SavedSearch();
677 $savedSearch->id
= $ssId;
678 $savedSearch->form_values
= serialize($params['form_values']);
679 $savedSearch->mapping_id
= $mappingId;
680 $savedSearch->search_custom_id
= CRM_Utils_Array
::value('search_custom_id', $params);
681 $savedSearch->save();
683 $ssId = $savedSearch->id
;
688 $smartGroupId = NULL;
689 if (!empty($params['saved_search_id'])) {
690 $smartGroupId = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group', $ssId, 'id', 'saved_search_id');
693 //create group only when new saved search.
694 $groupParams = array(
695 'title' => "Hidden Smart Group {$ssId}",
696 'is_active' => CRM_Utils_Array
::value('is_active', $params, 1),
697 'is_hidden' => CRM_Utils_Array
::value('is_hidden', $params, 1),
698 'group_type' => CRM_Utils_Array
::value('group_type', $params),
699 'visibility' => CRM_Utils_Array
::value('visibility', $params),
700 'saved_search_id' => $ssId,
703 $smartGroup = self
::create($groupParams);
704 $smartGroupId = $smartGroup->id
;
707 return array($smartGroupId, $ssId);
711 * wrapper for ajax group selector
713 * @param array $params
714 * Associated array for params record id.
717 * associated array of group list
720 * @todo there seems little reason for the small number of functions that call this to pass in
721 * params that then need to be translated in this function since they are coding them when calling
723 static public function getGroupListSelector(&$params) {
725 $params['offset'] = ($params['page'] - 1) * $params['rp'];
726 $params['rowCount'] = $params['rp'];
727 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
730 $groups = CRM_Contact_BAO_Group
::getGroupList($params);
732 //skip total if we are making call to show only children
733 if (empty($params['parent_id'])) {
735 $params['total'] = CRM_Contact_BAO_Group
::getGroupCount($params);
737 // get all the groups
738 $allGroups = CRM_Core_PseudoConstant
::allGroup();
741 // format params and add links
742 $groupList = array();
743 if (!empty($groups)) {
744 foreach ($groups as $id => $value) {
745 $groupList[$id]['group_id'] = $value['id'];
746 $groupList[$id]['count'] = $value['count'];
747 $groupList[$id]['group_name'] = $value['title'];
749 // append parent names if in search mode
750 if (empty($params['parent_id']) && !empty($value['parents'])) {
751 $groupIds = explode(',', $value['parents']);
753 foreach ($groupIds as $gId) {
754 $title[] = $allGroups[$gId];
756 $groupList[$id]['group_name'] .= '<div class="crm-row-parent-name"><em>' . ts('Child of') . '</em>: ' . implode(', ', $title) . '</div>';
757 $value['class'] = array_diff($value['class'], array('crm-row-parent'));
759 $value['class'][] = 'crm-entity';
760 $groupList[$id]['class'] = $value['id'] . ',' . implode(' ', $value['class']);
762 $groupList[$id]['group_description'] = CRM_Utils_Array
::value('description', $value);
763 if (!empty($value['group_type'])) {
764 $groupList[$id]['group_type'] = $value['group_type'];
767 $groupList[$id]['group_type'] = '';
769 $groupList[$id]['visibility'] = $value['visibility'];
770 $groupList[$id]['links'] = $value['action'];
771 $groupList[$id]['org_info'] = CRM_Utils_Array
::value('org_info', $value);
772 $groupList[$id]['created_by'] = CRM_Utils_Array
::value('created_by', $value);
774 $groupList[$id]['is_parent'] = $value['is_parent'];
781 * This function to get list of groups
783 * @param array $params
784 * Associated array for params.
788 public static function getGroupList(&$params) {
789 $config = CRM_Core_Config
::singleton();
791 $whereClause = self
::whereClause($params, FALSE);
793 //$this->pagerAToZ( $whereClause, $params );
795 if (!empty($params['rowCount']) &&
796 $params['rowCount'] > 0
798 $limit = " LIMIT {$params['offset']}, {$params['rowCount']} ";
801 $orderBy = ' ORDER BY groups.title asc';
802 if (!empty($params['sort'])) {
803 $orderBy = ' ORDER BY ' . CRM_Utils_Type
::escape($params['sort'], 'String');
806 $select = $from = $where = "";
808 if (CRM_Core_Permission
::check('administer Multiple Organizations') &&
809 CRM_Core_Permission
::isMultisiteEnabled()
811 $select = ", contact.display_name as org_name, contact.id as org_id";
812 $from = " LEFT JOIN civicrm_group_organization gOrg
813 ON gOrg.group_id = groups.id
814 LEFT JOIN civicrm_contact contact
815 ON contact.id = gOrg.organization_id ";
817 //get the Organization ID
818 $orgID = CRM_Utils_Request
::retrieve('oid', 'Positive', CRM_Core_DAO
::$_nullObject);
820 $where = " AND gOrg.organization_id = {$orgID}";
827 SELECT groups.*, createdBy.sort_name as created_by {$select}
828 FROM civicrm_group groups
829 LEFT JOIN civicrm_contact createdBy
830 ON createdBy.id = groups.created_id
832 WHERE $whereClause {$where}
837 $object = CRM_Core_DAO
::executeQuery($query, $params, TRUE, 'CRM_Contact_DAO_Group');
839 //FIXME CRM-4418, now we are handling delete separately
840 //if we introduce 'delete for group' make sure to handle here.
841 $groupPermissions = array(CRM_Core_Permission
::VIEW
);
842 if (CRM_Core_Permission
::check('edit groups')) {
843 $groupPermissions[] = CRM_Core_Permission
::EDIT
;
844 $groupPermissions[] = CRM_Core_Permission
::DELETE
;
848 $reservedPermission = CRM_Core_Permission
::check('administer reserved groups');
850 $links = self
::actionLinks();
852 $allTypes = CRM_Core_OptionGroup
::values('group_type');
853 $values = $groupsToCount = array();
855 $visibility = CRM_Core_SelectValues
::ufVisibility();
857 while ($object->fetch()) {
858 $permission = CRM_Contact_BAO_Group
::checkPermission($object->id
, $object->title
);
859 //@todo CRM-12209 introduced an ACL check in the whereClause function
860 // it may be that this checking is now obsolete - or that what remains
861 // should be removed to the whereClause (which is also accessed by getCount)
865 $values[$object->id
] = array(
869 CRM_Core_DAO
::storeValues($object, $values[$object->id
]);
870 if ($object->saved_search_id
) {
871 $values[$object->id
]['title'] .= ' (' . ts('Smart Group') . ')';
872 // check if custom search, if so fix view link
873 $customSearchID = CRM_Core_DAO
::getFieldValue(
874 'CRM_Contact_DAO_SavedSearch',
875 $object->saved_search_id
,
879 if ($customSearchID) {
880 $newLinks[CRM_Core_Action
::VIEW
]['url'] = 'civicrm/contact/search/custom';
881 $newLinks[CRM_Core_Action
::VIEW
]['qs'] = "reset=1&force=1&ssID={$object->saved_search_id}";
885 $action = array_sum(array_keys($newLinks));
888 if (array_key_exists('is_reserved', $object)) {
889 //if group is reserved and I don't have reserved permission, suppress delete/edit
890 if ($object->is_reserved
&& !$reservedPermission) {
891 $action -= CRM_Core_Action
::DELETE
;
892 $action -= CRM_Core_Action
::UPDATE
;
893 $action -= CRM_Core_Action
::DISABLE
;
897 if (array_key_exists('is_active', $object)) {
898 if ($object->is_active
) {
899 $action -= CRM_Core_Action
::ENABLE
;
902 $values[$object->id
]['class'][] = 'disabled';
903 $action -= CRM_Core_Action
::VIEW
;
904 $action -= CRM_Core_Action
::DISABLE
;
908 $action = $action & CRM_Core_Action
::mask($groupPermissions);
910 $values[$object->id
]['visibility'] = $visibility[$values[$object->id
]['visibility']];
912 $groupsToCount[$object->saved_search_id ?
'civicrm_group_contact_cache' : 'civicrm_group_contact'][] = $object->id
;
914 if (isset($values[$object->id
]['group_type'])) {
915 $groupTypes = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
916 substr($values[$object->id
]['group_type'], 1, -1)
919 foreach ($groupTypes as $type) {
920 $types[] = CRM_Utils_Array
::value($type, $allTypes);
922 $values[$object->id
]['group_type'] = implode(', ', $types);
924 $values[$object->id
]['action'] = CRM_Core_Action
::formLink($newLinks,
928 'ssid' => $object->saved_search_id
,
932 'group.selector.row',
937 // If group has children, add class for link to view children
938 $values[$object->id
]['is_parent'] = FALSE;
939 if (array_key_exists('children', $values[$object->id
])) {
940 $values[$object->id
]['class'][] = "crm-group-parent";
941 $values[$object->id
]['is_parent'] = TRUE;
944 // If group is a child, add child class
945 if (array_key_exists('parents', $values[$object->id
])) {
946 $values[$object->id
]['class'][] = "crm-group-child";
950 if ($object->org_id
) {
951 $contactUrl = CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$object->org_id}");
952 $values[$object->id
]['org_info'] = "<a href='{$contactUrl}'>{$object->org_name}</a>";
955 $values[$object->id
]['org_info'] = ''; // Empty cell
959 $values[$object->id
]['org_info'] = NULL; // Collapsed column if all cells are NULL
961 if ($object->created_id
) {
962 $contactUrl = CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$object->created_id}");
963 $values[$object->id
]['created_by'] = "<a href='{$contactUrl}'>{$object->created_by}</a>";
968 // Get group counts - executes one query for regular groups and another for smart groups
969 foreach ($groupsToCount as $table => $groups) {
970 $where = "g.group_id IN (" . implode(',', $groups) . ")";
971 if ($table == 'civicrm_group_contact') {
972 $where .= " AND g.status = 'Added'";
974 // Exclude deleted contacts
975 $where .= " and c.id = g.contact_id AND c.is_deleted = 0";
976 $dao = CRM_Core_DAO
::executeQuery("SELECT g.group_id, COUNT(g.id) as `count` FROM $table g, civicrm_contact c WHERE $where GROUP BY g.group_id");
977 while ($dao->fetch()) {
978 $values[$dao->group_id
]['count'] = $dao->count
;
986 * This function to get hierarchical list of groups (parent followed by children)
988 * @param array $groupIDs
989 * Array of group ids.
991 * @param NULL $parents
992 * @param string $spacer
993 * @param bool $titleOnly
997 static function getGroupsHierarchy(
1000 $spacer = '<span class="child-indent"></span>',
1003 if (empty($groupIDs)) {
1007 $groupIdString = '(' . implode(',', array_keys($groupIDs)) . ')';
1008 // <span class="child-icon"></span>
1009 // need to return id, title (w/ spacer), description, visibility
1011 // We need to build a list of tags ordered by hierarchy and sorted by
1012 // name. The heirarchy will be communicated by an accumulation of
1013 // separators in front of the name to give it a visual offset.
1014 // Instead of recursively making mysql queries, we'll make one big
1015 // query and build the heirarchy with the algorithm below.
1017 $args = array(1 => array($groupIdString, 'String'));
1019 SELECT id, title, description, visibility, parents
1021 WHERE id IN $groupIdString
1024 // group can have > 1 parent so parents may be comma separated list (eg. '1,2,5'). We just grab and match on 1st parent.
1025 $parentArray = explode(',', $parents);
1026 $parent = $parentArray[0];
1027 $args[2] = array($parent, 'Integer');
1028 $query .= " AND SUBSTRING_INDEX(parents, ',', 1) = %2";
1030 $query .= " ORDER BY title";
1031 $dao = CRM_Core_DAO
::executeQuery($query, $args);
1033 // Sort the groups into the correct storage by the parent
1034 // $roots represent the current leaf nodes that need to be checked for
1035 // children. $rows represent the unplaced nodes
1036 $roots = $rows = $allGroups = array();
1037 while ($dao->fetch()) {
1038 $allGroups[$dao->id
] = array(
1039 'title' => $dao->title
,
1040 'visibility' => $dao->visibility
,
1041 'description' => $dao->description
,
1044 if ($dao->parents
== $parents) {
1048 'title' => $dao->title
,
1052 // group can have > 1 parent so $dao->parents may be comma separated list (eg. '1,2,5'). Grab and match on 1st parent.
1053 $parentArray = explode(',', $dao->parents
);
1054 $parent = $parentArray[0];
1058 'title' => $dao->title
,
1059 'parents' => $parent,
1064 // While we have nodes left to build, shift the first (alphabetically)
1065 // node of the list, place it in our groups list and loop through the
1066 // list of unplaced nodes to find its children. We make a copy to
1067 // iterate through because we must modify the unplaced nodes list
1069 while (count($roots)) {
1070 $new_roots = array();
1071 $current_rows = $rows;
1072 $root = array_shift($roots);
1073 $groups[$root['id']] = array($root['prefix'], $root['title']);
1075 // As you find the children, append them to the end of the new set
1076 // of roots (maintain alphabetical ordering). Also remove the node
1077 // from the set of unplaced nodes.
1078 if (is_array($current_rows)) {
1079 foreach ($current_rows as $key => $row) {
1080 if ($row['parents'] == $root['id']) {
1081 $new_roots[] = array(
1083 'prefix' => $groups[$root['id']][0] . $spacer,
1084 'title' => $row['title'],
1091 //As a group, insert the new roots into the beginning of the roots
1092 //list. This maintains the hierarchical ordering of the tags.
1093 $roots = array_merge($new_roots, $roots);
1096 // below is the redundant looping to ensure child groups are populated in the case where user does not have
1097 // access to parent groups ( esp. using ACL permissions and logged in user can assess only child groups )
1098 foreach ($rows as $value) {
1099 $groups[$value['id']] = array($value['prefix'], $value['title']);
1101 // Prefix titles with the calcuated spacing to give the visual
1102 // appearance of ordering when transformed into HTML in the form layer. Add description and visibility.
1103 $groupsReturn = array();
1104 foreach ($groups as $key => $value) {
1106 $groupsReturn[$key] = $value[0] . $value[1];
1109 $groupsReturn[$key] = array(
1110 'title' => $value[0] . $value[1],
1111 'description' => $allGroups[$key]['description'],
1112 'visibility' => $allGroups[$key]['visibility'],
1117 return $groupsReturn;
1121 * @param array $params
1123 * @return NULL|string
1125 public static function getGroupCount(&$params) {
1126 $whereClause = self
::whereClause($params, FALSE);
1127 $query = "SELECT COUNT(*) FROM civicrm_group groups";
1129 if (!empty($params['created_by'])) {
1131 INNER JOIN civicrm_contact createdBy
1132 ON createdBy.id = groups.created_id";
1135 WHERE {$whereClause}";
1136 return CRM_Core_DAO
::singleValueQuery($query, $params);
1140 * Generate permissioned where clause for group search
1141 * @param array $params
1142 * @param bool $sortBy
1143 * @param bool $excludeHidden
1147 public static function whereClause(&$params, $sortBy = TRUE, $excludeHidden = TRUE) {
1149 $title = CRM_Utils_Array
::value('title', $params);
1151 $clauses[] = "groups.title LIKE %1";
1152 if (strpos($title, '%') !== FALSE) {
1153 $params[1] = array($title, 'String', FALSE);
1156 $params[1] = array($title, 'String', TRUE);
1160 $groupType = CRM_Utils_Array
::value('group_type', $params);
1162 $types = explode(',', $groupType);
1163 if (!empty($types)) {
1164 $clauses[] = 'groups.group_type LIKE %2';
1165 $typeString = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $types) . CRM_Core_DAO
::VALUE_SEPARATOR
;
1166 $params[2] = array($typeString, 'String', TRUE);
1170 $visibility = CRM_Utils_Array
::value('visibility', $params);
1172 $clauses[] = 'groups.visibility = %3';
1173 $params[3] = array($visibility, 'String');
1176 $groupStatus = CRM_Utils_Array
::value('status', $params);
1178 switch ($groupStatus) {
1180 $clauses[] = 'groups.is_active = 1';
1181 $params[4] = array($groupStatus, 'Integer');
1185 $clauses[] = 'groups.is_active = 0';
1186 $params[4] = array($groupStatus, 'Integer');
1190 $clauses[] = '(groups.is_active = 0 OR groups.is_active = 1 )';
1195 $parentsOnly = CRM_Utils_Array
::value('parentsOnly', $params);
1197 $clauses[] = 'groups.parents IS NULL';
1200 // only show child groups of a specific parent group
1201 $parent_id = CRM_Utils_Array
::value('parent_id', $params);
1203 $clauses[] = 'groups.id IN (SELECT child_group_id FROM civicrm_group_nesting WHERE parent_group_id = %5)';
1204 $params[5] = array($parent_id, 'Integer');
1207 if ($createdBy = CRM_Utils_Array
::value('created_by', $params)) {
1208 $clauses[] = "createdBy.sort_name LIKE %6";
1209 if (strpos($createdBy, '%') !== FALSE) {
1210 $params[6] = array($createdBy, 'String', FALSE);
1213 $params[6] = array($createdBy, 'String', TRUE);
1217 if (empty($clauses)) {
1218 $clauses[] = 'groups.is_active = 1';
1221 if ($excludeHidden) {
1222 $clauses[] = 'groups.is_hidden = 0';
1225 $clauses[] = self
::getPermissionClause();
1228 return implode(' AND ', $clauses);
1232 * Define action links
1235 * array of action links
1237 public static function actionLinks() {
1239 CRM_Core_Action
::VIEW
=> array(
1240 'name' => ts('Contacts'),
1241 'url' => 'civicrm/group/search',
1242 'qs' => 'reset=1&force=1&context=smog&gid=%%id%%',
1243 'title' => ts('Group Contacts'),
1245 CRM_Core_Action
::UPDATE
=> array(
1246 'name' => ts('Settings'),
1247 'url' => 'civicrm/group',
1248 'qs' => 'reset=1&action=update&id=%%id%%',
1249 'title' => ts('Edit Group'),
1251 CRM_Core_Action
::DISABLE
=> array(
1252 'name' => ts('Disable'),
1253 'ref' => 'crm-enable-disable',
1254 'title' => ts('Disable Group'),
1256 CRM_Core_Action
::ENABLE
=> array(
1257 'name' => ts('Enable'),
1258 'ref' => 'crm-enable-disable',
1259 'title' => ts('Enable Group'),
1261 CRM_Core_Action
::DELETE
=> array(
1262 'name' => ts('Delete'),
1263 'url' => 'civicrm/group',
1264 'qs' => 'reset=1&action=delete&id=%%id%%',
1265 'title' => ts('Delete Group'),
1273 * @param $whereClause
1274 * @param array $whereParams
1278 public function pagerAtoZ($whereClause, $whereParams) {
1280 SELECT DISTINCT UPPER(LEFT(groups.title, 1)) as sort_name
1281 FROM civicrm_group groups
1283 ORDER BY LEFT(groups.title, 1)
1285 $dao = CRM_Core_DAO
::executeQuery($query, $whereParams);
1287 return CRM_Utils_PagerAToZ
::getAToZBar($dao, $this->_sortByCharacter
, TRUE);