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 (reference ) an assoc array of name/value pairs
52 * @param array $defaults (reference ) an assoc array to hold the flattened values
54 * @return CRM_Contact_BAO_Group object
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
73 * @param int $id group id
80 public static function discard($id) {
81 CRM_Utils_Hook
::pre('delete', 'Group', $id, CRM_Core_DAO
::$_nullArray);
83 $transaction = new CRM_Core_Transaction();
85 // added for CRM-1631 and CRM-1794
86 // delete all subscribed mails with the selected group id
87 $subscribe = new CRM_Mailing_Event_DAO_Subscribe();
88 $subscribe->group_id
= $id;
91 // delete all Subscription records with the selected group id
92 $subHistory = new CRM_Contact_DAO_SubscriptionHistory();
93 $subHistory->group_id
= $id;
94 $subHistory->delete();
96 // delete all crm_group_contact records with the selected group id
97 $groupContact = new CRM_Contact_DAO_GroupContact();
98 $groupContact->group_id
= $id;
99 $groupContact->delete();
101 // make all the 'add_to_group_id' field of 'civicrm_uf_group table', pointing to this group, as null
102 $params = array(1 => array($id, 'Integer'));
103 $query = "UPDATE civicrm_uf_group SET `add_to_group_id`= NULL WHERE `add_to_group_id` = %1";
104 CRM_Core_DAO
::executeQuery($query, $params);
106 $query = "UPDATE civicrm_uf_group SET `limit_listings_group_id`= NULL WHERE `limit_listings_group_id` = %1";
107 CRM_Core_DAO
::executeQuery($query, $params);
109 // make sure u delete all the entries from civicrm_mailing_group and civicrm_campaign_group
111 $query = "DELETE FROM civicrm_mailing_group where entity_table = 'civicrm_group' AND entity_id = %1";
112 CRM_Core_DAO
::executeQuery($query, $params);
114 $query = "DELETE FROM civicrm_campaign_group where entity_table = 'civicrm_group' AND entity_id = %1";
115 CRM_Core_DAO
::executeQuery($query, $params);
117 $query = "DELETE FROM civicrm_acl_entity_role where entity_table = 'civicrm_group' AND entity_id = %1";
118 CRM_Core_DAO
::executeQuery($query, $params);
120 if (CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MULTISITE_PREFERENCES_NAME
,
123 // clear any descendant groups cache if exists
124 CRM_Core_BAO_Cache
::deleteGroup('descendant groups for an org');
127 // delete from group table
128 $group = new CRM_Contact_DAO_Group();
132 $transaction->commit();
134 CRM_Utils_Hook
::post('delete', 'Group', $id, $group);
136 // delete the recently created Group
137 $groupRecent = array(
141 CRM_Utils_Recent
::del($groupRecent);
145 * Returns an array of the contacts in the given group.
148 public static function getGroupContacts($id) {
149 $params = array(array('group', 'IN', array($id => 1), 0, 0));
150 list($contacts, $_) = CRM_Contact_BAO_Query
::apiQuery($params, array('contact_id'));
155 * Get the count of a members in a group with the specific status
157 * @param int $id group id
158 * @param enum|string $status status of members in group
160 * @param bool $countChildGroups
162 * @return int count of members in the group with above status
165 public static function memberCount($id, $status = 'Added', $countChildGroups = FALSE) {
166 $groupContact = new CRM_Contact_DAO_GroupContact();
167 $groupIds = array($id);
168 if ($countChildGroups) {
169 $groupIds = CRM_Contact_BAO_GroupNesting
::getDescendentGroupIds($groupIds);
173 $contacts = self
::getGroupContacts($id);
175 foreach ($groupIds as $groupId) {
177 $groupContacts = self
::getGroupContacts($groupId);
178 foreach ($groupContacts as $gcontact) {
179 if ($groupId != $id) {
180 // Loop through main group's contacts
181 // and subtract from the count for each contact which
182 // matches one in the present group, if it is not the
184 foreach ($contacts as $contact) {
185 if ($contact['contact_id'] == $gcontact['contact_id']) {
191 $groupContact->group_id
= $groupId;
192 if (isset($status)) {
193 $groupContact->status
= $status;
195 $groupContact->_query
['condition'] = 'WHERE contact_id NOT IN (SELECT id FROM civicrm_contact WHERE is_deleted = 1)';
196 $count +
= $groupContact->count();
202 * Get the list of member for a group id
204 * @param int $groupID
205 * @param bool $useCache
207 * @return array $aMembers this array contains the list of members for this group id
211 public static function &getMember($groupID, $useCache = TRUE) {
212 $params = array(array('group', 'IN', array($groupID => 1), 0, 0));
213 $returnProperties = array('contact_id');
214 list($contacts, $_) = CRM_Contact_BAO_Query
::apiQuery($params, $returnProperties, NULL, NULL, 0, 0, $useCache);
217 foreach ($contacts as $contact) {
218 $aMembers[$contact['contact_id']] = 1;
225 * Returns array of group object(s) matching a set of one or Group properties.
227 * @param array $params Limits the set of groups returned.
228 * @param array $returnProperties Which properties should be included in the returned group objects.
229 * (member_count should be last element.)
232 * @param null $offset
233 * @param null $rowCount
235 * @return array of group objects.
239 * @todo other BAO functions that use returnProperties (e.g. Query Objects) receive the array flipped & filled with 1s and
240 * add in essential fields (e.g. id). This should follow a regular pattern like the others
242 static function getGroups(
244 $returnProperties = NULL,
249 $dao = new CRM_Contact_DAO_Group();
250 if (!isset($params['is_active'])) {
254 foreach ($params as $k => $v) {
255 if ($k == 'name' ||
$k == 'title') {
256 $dao->whereAdd($k . ' LIKE "' . CRM_Core_DAO
::escapeString($v) . '"');
258 elseif ($k == 'group_type') {
259 foreach ((array) $v as $type) {
260 $dao->whereAdd($k . " LIKE '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. (int) $type . CRM_Core_DAO
::VALUE_SEPARATOR
. "%'");
263 elseif (is_array($v)) {
264 foreach ($v as &$num) {
267 $dao->whereAdd($k . ' IN (' . implode(',', $v) . ')');
275 if ($offset ||
$rowCount) {
276 $offset = ($offset > 0) ?
$offset : 0;
277 $rowCount = ($rowCount > 0) ?
$rowCount : 25;
278 $dao->limit($offset, $rowCount);
282 $dao->orderBy($sort);
285 // return only specific fields if returnproperties are sent
286 if (!empty($returnProperties)) {
288 $dao->selectAdd(implode(',', $returnProperties));
292 $flag = $returnProperties && in_array('member_count', $returnProperties) ?
1 : 0;
295 while ($dao->fetch()) {
296 $group = new CRM_Contact_DAO_Group();
298 $dao->member_count
= CRM_Contact_BAO_Group
::memberCount($dao->id
);
300 $groups[] = clone($dao);
306 * Make sure that the user has permission to access this group
308 * @param int $id the id of the object
310 * @return string the permission that the user has (or null)
314 public static function checkPermission($id) {
315 $allGroups = CRM_Core_PseudoConstant
::allGroup();
318 if (CRM_Core_Permission
::check('edit all contacts') ||
319 CRM_ACL_API
::groupPermission(CRM_ACL_API
::EDIT
, $id, NULL,
320 'civicrm_saved_search', $allGroups
323 $permissions[] = CRM_Core_Permission
::EDIT
;
326 if (CRM_Core_Permission
::check('view all contacts') ||
327 CRM_ACL_API
::groupPermission(CRM_ACL_API
::VIEW
, $id, NULL,
328 'civicrm_saved_search', $allGroups
331 $permissions[] = CRM_Core_Permission
::VIEW
;
334 if (!empty($permissions) && CRM_Core_Permission
::check('delete contacts')) {
335 // Note: using !empty() in if condition, restricts the scope of delete
336 // permission to groups/contacts that are editable/viewable.
337 // We can remove this !empty condition once we have ACL support for delete functionality.
338 $permissions[] = CRM_Core_Permission
::DELETE
;
347 * @param array $params Associative array of parameters
349 * @return object|null The new group BAO (if created)
353 public static function &create(&$params) {
355 if (!empty($params['id'])) {
356 CRM_Utils_Hook
::pre('edit', 'Group', $params['id'], $params);
359 CRM_Utils_Hook
::pre('create', 'Group', NULL, $params);
362 // form the name only if missing: CRM-627
363 $nameParam = CRM_Utils_Array
::value('name', $params, NULL);
364 if (!$nameParam && empty($params['id'])) {
365 $params['name'] = CRM_Utils_String
::titleToVar($params['title']);
368 // convert params if array type
369 if (isset($params['group_type'])) {
370 if (is_array($params['group_type'])) {
371 $params['group_type'] = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
372 array_keys($params['group_type'])
373 ) . CRM_Core_DAO
::VALUE_SEPARATOR
;
377 $params['group_type'] = '';
380 $session = CRM_Core_Session
::singleton( );
381 $cid = $session->get('userID');
382 // this action is add
383 if ($cid && empty($params['id'])) {
384 $params['created_id'] = $cid;
386 // this action is update
387 if ($cid && !empty($params['id'])) {
388 $params['modified_id'] = $cid;
391 $group = new CRM_Contact_BAO_Group();
392 $group->copyValues($params);
393 //@todo very hacky fix for the fact this function wants to receive 'parents' as an array further down but
394 // needs it as a separated string for the DB. Preferred approaches are having the copyParams or save fn
395 // use metadata to translate the array to the appropriate DB type or altering the param in the api layer,
396 // or at least altering the param in same section as 'group_type' rather than repeating here. However, further down
397 // we need the $params one to be in it's original form & we are not sure what test coverage we have on that
398 if(isset($group->parents
) && is_array($group->parents
)) {
399 $group->parents
= CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
400 array_keys($group->parents
)
401 ) . CRM_Core_DAO
::VALUE_SEPARATOR
;
403 if (empty($params['id']) &&
406 $group->name
.= "_tmp";
414 if (empty($params['id']) &&
417 $group->name
= substr($group->name
, 0, -4) . "_{$group->id}";
420 $group->buildClause();
423 // add custom field values
424 if (!empty($params['custom'])) {
425 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_group', $group->id
);
428 // make the group, child of domain/site group by default.
429 $domainGroupID = CRM_Core_BAO_Domain
::getGroupId();
430 if (CRM_Utils_Array
::value('no_parent', $params) !== 1) {
431 if (empty($params['parents']) &&
432 $domainGroupID != $group->id
&&
433 CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MULTISITE_PREFERENCES_NAME
,
436 !CRM_Contact_BAO_GroupNesting
::hasParentGroups($group->id
)
438 // if no parent present and the group doesn't already have any parents,
439 // make sure site group goes as parent
440 $params['parents'] = array($domainGroupID => 1);
442 elseif (array_key_exists('parents', $params) && !is_array($params['parents'])) {
443 $params['parents'] = array($params['parents'] => 1);
446 if (!empty($params['parents'])) {
447 foreach ($params['parents'] as $parentId => $dnc) {
448 if ($parentId && !CRM_Contact_BAO_GroupNesting
::isParentChild($parentId, $group->id
)) {
449 CRM_Contact_BAO_GroupNesting
::add($parentId, $group->id
);
454 // clear any descendant groups cache if exists
455 $finalGroups = CRM_Core_BAO_Cache
::deleteGroup('descendant groups for an org');
457 // this is always required, since we don't know when a
458 // parent group is removed
459 CRM_Contact_BAO_GroupNestingCache
::update();
461 // update group contact cache for all parent groups
462 $parentIds = CRM_Contact_BAO_GroupNesting
::getParentGroupIds($group->id
);
463 foreach ($parentIds as $parentId) {
464 CRM_Contact_BAO_GroupContactCache
::add($parentId);
468 if (!empty($params['organization_id'])) {
471 $groupOrg['group_id'] = $group->id
;
472 CRM_Contact_BAO_GroupOrganization
::add($groupOrg);
475 CRM_Contact_BAO_GroupContactCache
::add($group->id
);
477 if (!empty($params['id'])) {
478 CRM_Utils_Hook
::post('edit', 'Group', $group->id
, $group);
481 CRM_Utils_Hook
::post('create', 'Group', $group->id
, $group);
484 $recentOther = array();
485 if (CRM_Core_Permission
::check('edit groups')) {
486 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/group', 'reset=1&action=update&id=' . $group->id
);
487 // currently same permission we are using for delete a group
488 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/group', 'reset=1&action=delete&id=' . $group->id
);
491 // add the recently added group (unless hidden: CRM-6432)
492 if (!$group->is_hidden
) {
493 CRM_Utils_Recent
::add($group->title
,
494 CRM_Utils_System
::url('civicrm/group/search', 'reset=1&force=1&context=smog&gid=' . $group->id
),
506 * Given a saved search compute the clause and the tables
507 * and store it for future use
509 public function buildClause() {
510 $params = array(array('group', 'IN', array($this->id
=> 1), 0, 0));
512 if (!empty($params)) {
513 $tables = $whereTables = array();
514 $this->where_clause
= CRM_Contact_BAO_Query
::getWhereClause($params, NULL, $tables, $whereTables);
515 if (!empty($tables)) {
516 $this->select_tables
= serialize($tables);
518 if (!empty($whereTables)) {
519 $this->where_tables
= serialize($whereTables);
527 * Defines a new smart group
529 * @param array $params Associative array of parameters
531 * @return object|null The new group BAO (if created)
535 public static function createSmartGroup(&$params) {
536 if (!empty($params['formValues'])) {
538 unset($ssParams['id']);
539 if (isset($ssParams['saved_search_id'])) {
540 $ssParams['id'] = $ssParams['saved_search_id'];
543 $savedSearch = CRM_Contact_BAO_SavedSearch
::create($params);
545 $params['saved_search_id'] = $savedSearch->id
;
551 return self
::create($params);
555 * Update the is_active flag in the db
557 * @param int $id id of the database record
558 * @param boolean $isActive value we want to set the is_active field
560 * @return Object DAO object on sucess, 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 type of group(Access/Mailing) OR the key of the group
571 * @param bool|\boolen $excludeHidden exclude hidden groups.
573 * @return string $condition
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 ( reference ) an assoc array of name/value pairs
645 * @return array ( 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 * This function is a wrapper for ajax group selector
713 * @param array $params associated array for params record id.
715 * @return array $groupList associated array of group list
718 * @todo there seems little reason for the small number of functions that call this to pass in
719 * params that then need to be translated in this function since they are coding them when calling
722 static public function getGroupListSelector(&$params) {
724 $params['offset'] = ($params['page'] - 1) * $params['rp'];
725 $params['rowCount'] = $params['rp'];
726 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
729 $groups = CRM_Contact_BAO_Group
::getGroupList($params);
731 //skip total if we are making call to show only children
732 if (empty($params['parent_id'])) {
734 $params['total'] = CRM_Contact_BAO_Group
::getGroupCount($params);
736 // get all the groups
737 $allGroups = CRM_Core_PseudoConstant
::allGroup();
740 // format params and add links
741 $groupList = array();
742 if (!empty($groups)) {
743 foreach ($groups as $id => $value) {
744 $groupList[$id]['group_id'] = $value['id'];
745 $groupList[$id]['count'] = $value['count'];
746 $groupList[$id]['group_name'] = $value['title'];
748 // append parent names if in search mode
749 if (empty($params['parent_id']) && !empty($value['parents'])) {
750 $groupIds = explode(',', $value['parents']);
752 foreach($groupIds as $gId) {
753 $title[] = $allGroups[$gId];
755 $groupList[$id]['group_name'] .= '<div class="crm-row-parent-name"><em>'.ts('Child of').'</em>: ' . implode(', ', $title) . '</div>';
756 $value['class'] = array_diff($value['class'], array('crm-row-parent'));
758 $value['class'][] = 'crm-entity';
759 $groupList[$id]['class'] = $value['id'] . ',' . implode(' ', $value['class']);
761 $groupList[$id]['group_description'] = CRM_Utils_Array
::value('description', $value);
762 if (!empty($value['group_type'])) {
763 $groupList[$id]['group_type'] = $value['group_type'];
766 $groupList[$id]['group_type'] = '';
768 $groupList[$id]['visibility'] = $value['visibility'];
769 $groupList[$id]['links'] = $value['action'];
770 $groupList[$id]['org_info'] = CRM_Utils_Array
::value('org_info', $value);
771 $groupList[$id]['created_by'] = CRM_Utils_Array
::value('created_by', $value);
773 $groupList[$id]['is_parent'] = $value['is_parent'];
780 * This function to get list of groups
782 * @param array $params associated array for params
787 public static function getGroupList(&$params) {
788 $config = CRM_Core_Config
::singleton();
790 $whereClause = self
::whereClause($params, FALSE);
792 //$this->pagerAToZ( $whereClause, $params );
794 if (!empty($params['rowCount']) &&
795 $params['rowCount'] > 0
797 $limit = " LIMIT {$params['offset']}, {$params['rowCount']} ";
800 $orderBy = ' ORDER BY groups.title asc';
801 if (!empty($params['sort'])) {
802 $orderBy = ' ORDER BY ' . CRM_Utils_Type
::escape($params['sort'], 'String');
805 $select = $from = $where = "";
807 if (CRM_Core_Permission
::check('administer Multiple Organizations') &&
808 CRM_Core_Permission
::isMultisiteEnabled()
810 $select = ", contact.display_name as org_name, contact.id as org_id";
811 $from = " LEFT JOIN civicrm_group_organization gOrg
812 ON gOrg.group_id = groups.id
813 LEFT JOIN civicrm_contact contact
814 ON contact.id = gOrg.organization_id ";
816 //get the Organization ID
817 $orgID = CRM_Utils_Request
::retrieve('oid', 'Positive', CRM_Core_DAO
::$_nullObject);
819 $where = " AND gOrg.organization_id = {$orgID}";
826 SELECT groups.*, createdBy.sort_name as created_by {$select}
827 FROM civicrm_group groups
828 LEFT JOIN civicrm_contact createdBy
829 ON createdBy.id = groups.created_id
831 WHERE $whereClause {$where}
836 $object = CRM_Core_DAO
::executeQuery($query, $params, TRUE, 'CRM_Contact_DAO_Group');
838 //FIXME CRM-4418, now we are handling delete separately
839 //if we introduce 'delete for group' make sure to handle here.
840 $groupPermissions = array(CRM_Core_Permission
::VIEW
);
841 if (CRM_Core_Permission
::check('edit groups')) {
842 $groupPermissions[] = CRM_Core_Permission
::EDIT
;
843 $groupPermissions[] = CRM_Core_Permission
::DELETE
;
847 $reservedPermission = CRM_Core_Permission
::check('administer reserved groups');
849 $links = self
::actionLinks();
851 $allTypes = CRM_Core_OptionGroup
::values('group_type');
852 $values = $groupsToCount = array();
854 $visibility = CRM_Core_SelectValues
::ufVisibility();
856 while ($object->fetch()) {
857 $permission = CRM_Contact_BAO_Group
::checkPermission($object->id
, $object->title
);
858 //@todo CRM-12209 introduced an ACL check in the whereClause function
859 // it may be that this checking is now obsolete - or that what remains
860 // should be removed to the whereClause (which is also accessed by getCount)
864 $values[$object->id
] = array(
868 CRM_Core_DAO
::storeValues($object, $values[$object->id
]);
869 if ($object->saved_search_id
) {
870 $values[$object->id
]['title'] .= ' (' . ts('Smart Group') . ')';
871 // check if custom search, if so fix view link
872 $customSearchID = CRM_Core_DAO
::getFieldValue(
873 'CRM_Contact_DAO_SavedSearch',
874 $object->saved_search_id
,
878 if ($customSearchID) {
879 $newLinks[CRM_Core_Action
::VIEW
]['url'] = 'civicrm/contact/search/custom';
880 $newLinks[CRM_Core_Action
::VIEW
]['qs'] = "reset=1&force=1&ssID={$object->saved_search_id}";
884 $action = array_sum(array_keys($newLinks));
887 if (array_key_exists('is_reserved', $object)) {
888 //if group is reserved and I don't have reserved permission, suppress delete/edit
889 if ($object->is_reserved
&& !$reservedPermission) {
890 $action -= CRM_Core_Action
::DELETE
;
891 $action -= CRM_Core_Action
::UPDATE
;
892 $action -= CRM_Core_Action
::DISABLE
;
896 if (array_key_exists('is_active', $object)) {
897 if ($object->is_active
) {
898 $action -= CRM_Core_Action
::ENABLE
;
901 $values[$object->id
]['class'][] = 'disabled';
902 $action -= CRM_Core_Action
::VIEW
;
903 $action -= CRM_Core_Action
::DISABLE
;
907 $action = $action & CRM_Core_Action
::mask($groupPermissions);
909 $values[$object->id
]['visibility'] = $visibility[$values[$object->id
]['visibility']];
911 $groupsToCount[$object->saved_search_id ?
'civicrm_group_contact_cache' : 'civicrm_group_contact'][] = $object->id
;
913 if (isset($values[$object->id
]['group_type'])) {
914 $groupTypes = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
915 substr($values[$object->id
]['group_type'], 1, -1)
918 foreach ($groupTypes as $type) {
919 $types[] = CRM_Utils_Array
::value($type, $allTypes);
921 $values[$object->id
]['group_type'] = implode(', ', $types);
923 $values[$object->id
]['action'] = CRM_Core_Action
::formLink($newLinks,
927 'ssid' => $object->saved_search_id
,
931 'group.selector.row',
936 // If group has children, add class for link to view children
937 $values[$object->id
]['is_parent'] = false;
938 if (array_key_exists('children', $values[$object->id
])) {
939 $values[$object->id
]['class'][] = "crm-group-parent";
940 $values[$object->id
]['is_parent'] = true;
943 // If group is a child, add child class
944 if (array_key_exists('parents', $values[$object->id
])) {
945 $values[$object->id
]['class'][] = "crm-group-child";
949 if ($object->org_id
) {
950 $contactUrl = CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$object->org_id}");
951 $values[$object->id
]['org_info'] = "<a href='{$contactUrl}'>{$object->org_name}</a>";
954 $values[$object->id
]['org_info'] = ''; // Empty cell
958 $values[$object->id
]['org_info'] = NULL; // Collapsed column if all cells are NULL
960 if ($object->created_id
) {
961 $contactUrl = CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$object->created_id}");
962 $values[$object->id
]['created_by'] = "<a href='{$contactUrl}'>{$object->created_by}</a>";
968 foreach ($groupsToCount as $table => $groups) {
969 $where = "group_id IN (" . implode(',', $groups) . ")";
970 if ($table == 'civicrm_group_contact') {
971 $where .= " AND status = 'Added'";
973 $dao = CRM_Core_DAO
::executeQuery("SELECT group_id, COUNT(id) as `count` FROM $table WHERE $where GROUP BY group_id");
974 while($dao->fetch()) {
975 $values[$dao->group_id
]['count'] = $dao->count
;
983 * This function to get hierarchical list of groups (parent followed by children)
985 * @param array $groupIDs array of group ids
987 * @param null $parents
988 * @param string $spacer
989 * @param bool $titleOnly
994 static function getGroupsHierarchy(
997 $spacer = '<span class="child-indent"></span>',
1000 if (empty($groupIDs)) {
1004 $groupIdString = '(' . implode(',', array_keys($groupIDs)) . ')';
1005 // <span class="child-icon"></span>
1006 // need to return id, title (w/ spacer), description, visibility
1008 // We need to build a list of tags ordered by hierarchy and sorted by
1009 // name. The heirarchy will be communicated by an accumulation of
1010 // separators in front of the name to give it a visual offset.
1011 // Instead of recursively making mysql queries, we'll make one big
1012 // query and build the heirarchy with the algorithm below.
1014 $args = array(1 => array($groupIdString, 'String'));
1016 SELECT id, title, description, visibility, parents
1018 WHERE id IN $groupIdString
1021 // group can have > 1 parent so parents may be comma separated list (eg. '1,2,5'). We just grab and match on 1st parent.
1022 $parentArray = explode(',', $parents);
1023 $parent = $parentArray[0];
1024 $args[2] = array($parent, 'Integer');
1025 $query .= " AND SUBSTRING_INDEX(parents, ',', 1) = %2";
1027 $query .= " ORDER BY title";
1028 $dao = CRM_Core_DAO
::executeQuery($query, $args);
1030 // Sort the groups into the correct storage by the parent
1031 // $roots represent the current leaf nodes that need to be checked for
1032 // children. $rows represent the unplaced nodes
1033 $roots = $rows = $allGroups = array();
1034 while ($dao->fetch()) {
1035 $allGroups[$dao->id
] = array(
1036 'title' => $dao->title
,
1037 'visibility' => $dao->visibility
,
1038 'description' => $dao->description
1041 if ($dao->parents
== $parents) {
1045 'title' => $dao->title
1049 // group can have > 1 parent so $dao->parents may be comma separated list (eg. '1,2,5'). Grab and match on 1st parent.
1050 $parentArray = explode(',', $dao->parents
);
1051 $parent = $parentArray[0];
1055 'title' => $dao->title
,
1056 'parents' => $parent
1061 // While we have nodes left to build, shift the first (alphabetically)
1062 // node of the list, place it in our groups list and loop through the
1063 // list of unplaced nodes to find its children. We make a copy to
1064 // iterate through because we must modify the unplaced nodes list
1066 while (count($roots)) {
1067 $new_roots = array();
1068 $current_rows = $rows;
1069 $root = array_shift($roots);
1070 $groups[$root['id']] = array($root['prefix'], $root['title']);
1072 // As you find the children, append them to the end of the new set
1073 // of roots (maintain alphabetical ordering). Also remove the node
1074 // from the set of unplaced nodes.
1075 if (is_array($current_rows)) {
1076 foreach ($current_rows as $key => $row) {
1077 if ($row['parents'] == $root['id']) {
1078 $new_roots[] = array(
1080 'prefix' => $groups[$root['id']][0] . $spacer,
1081 'title' => $row['title']
1088 //As a group, insert the new roots into the beginning of the roots
1089 //list. This maintains the hierarchical ordering of the tags.
1090 $roots = array_merge($new_roots, $roots);
1093 // below is the redundant looping to ensure child groups are populated in the case where user does not have
1094 // access to parent groups ( esp. using ACL permissions and logged in user can assess only child groups )
1095 foreach ($rows as $value) {
1096 $groups[$value['id']] = array($value['prefix'], $value['title']);
1098 // Prefix titles with the calcuated spacing to give the visual
1099 // appearance of ordering when transformed into HTML in the form layer. Add description and visibility.
1100 $groupsReturn = array();
1101 foreach ($groups as $key => $value) {
1103 $groupsReturn[$key] = $value[0] . $value[1];
1106 $groupsReturn[$key] = array(
1107 'title' => $value[0] . $value[1],
1108 'description' => $allGroups[$key]['description'],
1109 'visibility' => $allGroups[$key]['visibility'],
1114 return $groupsReturn;
1118 * @param array $params
1120 * @return null|string
1122 public static function getGroupCount(&$params) {
1123 $whereClause = self
::whereClause($params, FALSE);
1124 $query = "SELECT COUNT(*) FROM civicrm_group groups";
1126 if (!empty($params['created_by'])) {
1128 INNER JOIN civicrm_contact createdBy
1129 ON createdBy.id = groups.created_id";
1132 WHERE {$whereClause}";
1133 return CRM_Core_DAO
::singleValueQuery($query, $params);
1137 * Generate permissioned where clause for group search
1138 * @param array $params
1139 * @param bool $sortBy
1140 * @param bool $excludeHidden
1144 public static function whereClause(&$params, $sortBy = TRUE, $excludeHidden = TRUE) {
1146 $title = CRM_Utils_Array
::value('title', $params);
1148 $clauses[] = "groups.title LIKE %1";
1149 if (strpos($title, '%') !== FALSE) {
1150 $params[1] = array($title, 'String', FALSE);
1153 $params[1] = array($title, 'String', TRUE);
1157 $groupType = CRM_Utils_Array
::value('group_type', $params);
1159 $types = explode(',', $groupType);
1160 if (!empty($types)) {
1161 $clauses[] = 'groups.group_type LIKE %2';
1162 $typeString = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $types) . CRM_Core_DAO
::VALUE_SEPARATOR
;
1163 $params[2] = array($typeString, 'String', TRUE);
1167 $visibility = CRM_Utils_Array
::value('visibility', $params);
1169 $clauses[] = 'groups.visibility = %3';
1170 $params[3] = array($visibility, 'String');
1173 $groupStatus = CRM_Utils_Array
::value('status', $params);
1175 switch ($groupStatus) {
1177 $clauses[] = 'groups.is_active = 1';
1178 $params[4] = array($groupStatus, 'Integer');
1182 $clauses[] = 'groups.is_active = 0';
1183 $params[4] = array($groupStatus, 'Integer');
1187 $clauses[] = '(groups.is_active = 0 OR groups.is_active = 1 )';
1192 $parentsOnly = CRM_Utils_Array
::value('parentsOnly', $params);
1194 $clauses[] = 'groups.parents IS NULL';
1197 // only show child groups of a specific parent group
1198 $parent_id = CRM_Utils_Array
::value('parent_id', $params);
1200 $clauses[] = 'groups.id IN (SELECT child_group_id FROM civicrm_group_nesting WHERE parent_group_id = %5)';
1201 $params[5] = array($parent_id, 'Integer');
1204 if ($createdBy = CRM_Utils_Array
::value('created_by', $params)) {
1205 $clauses[] = "createdBy.sort_name LIKE %6";
1206 if (strpos($createdBy, '%') !== FALSE) {
1207 $params[6] = array($createdBy, 'String', FALSE);
1210 $params[6] = array($createdBy, 'String', TRUE);
1214 if (empty($clauses)) {
1215 $clauses[] = 'groups.is_active = 1';
1218 if ($excludeHidden) {
1219 $clauses[] = 'groups.is_hidden = 0';
1222 $clauses[] = self
::getPermissionClause();
1225 return implode(' AND ', $clauses);
1229 * Define action links
1231 * @return array $links array of action links
1234 public static function actionLinks() {
1236 CRM_Core_Action
::VIEW
=> array(
1237 'name' => ts('Contacts'),
1238 'url' => 'civicrm/group/search',
1239 'qs' => 'reset=1&force=1&context=smog&gid=%%id%%',
1240 'title' => ts('Group Contacts'),
1242 CRM_Core_Action
::UPDATE
=> array(
1243 'name' => ts('Settings'),
1244 'url' => 'civicrm/group',
1245 'qs' => 'reset=1&action=update&id=%%id%%',
1246 'title' => ts('Edit Group'),
1248 CRM_Core_Action
::DISABLE
=> array(
1249 'name' => ts('Disable'),
1250 'ref' => 'crm-enable-disable',
1251 'title' => ts('Disable Group'),
1253 CRM_Core_Action
::ENABLE
=> array(
1254 'name' => ts('Enable'),
1255 'ref' => 'crm-enable-disable',
1256 'title' => ts('Enable Group'),
1258 CRM_Core_Action
::DELETE
=> array(
1259 'name' => ts('Delete'),
1260 'url' => 'civicrm/group',
1261 'qs' => 'reset=1&action=delete&id=%%id%%',
1262 'title' => ts('Delete Group'),
1270 * @param $whereClause
1271 * @param array $whereParams
1275 public function pagerAtoZ($whereClause, $whereParams) {
1277 SELECT DISTINCT UPPER(LEFT(groups.title, 1)) as sort_name
1278 FROM civicrm_group groups
1280 ORDER BY LEFT(groups.title, 1)
1282 $dao = CRM_Core_DAO
::executeQuery($query, $whereParams);
1284 return CRM_Utils_PagerAToZ
::getAToZBar($dao, $this->_sortByCharacter
, TRUE);