3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
35 class CRM_Contact_BAO_Group
extends CRM_Contact_DAO_Group
{
40 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 object CRM_Contact_BAO_Group object
58 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 * Function to delete the group and all the object that connect to
71 * this group. Incredibly destructive
73 * @param int $id group id
80 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 $finalGroups = 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 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 $status status of members in group
160 * @return int count of members in the group with above status
163 static function memberCount($id, $status = 'Added', $countChildGroups = FALSE) {
164 $groupContact = new CRM_Contact_DAO_GroupContact();
165 $groupIds = array($id);
166 if ($countChildGroups) {
167 $groupIds = CRM_Contact_BAO_GroupNesting
::getDescendentGroupIds($groupIds);
171 $contacts = self
::getGroupContacts($id);
173 foreach ($groupIds as $groupId) {
175 $groupContacts = self
::getGroupContacts($groupId);
176 foreach ($groupContacts as $gcontact) {
177 if ($groupId != $id) {
178 // Loop through main group's contacts
179 // and subtract from the count for each contact which
180 // matches one in the present group, if it is not the
182 foreach ($contacts as $contact) {
183 if ($contact['contact_id'] == $gcontact['contact_id']) {
189 $groupContact->group_id
= $groupId;
190 if (isset($status)) {
191 $groupContact->status
= $status;
193 $groupContact->_query
['condition'] = 'WHERE contact_id NOT IN (SELECT id FROM civicrm_contact WHERE is_deleted = 1)';
194 $count +
= $groupContact->count();
200 * Get the list of member for a group id
202 * @param int $lngGroupId this is group id
204 * @return array $aMembers this arrray contains the list of members for this group id
208 static function &getMember($groupID, $useCache = TRUE) {
209 $params = array(array('group', 'IN', array($groupID => 1), 0, 0));
210 $returnProperties = array('contact_id');
211 list($contacts, $_) = CRM_Contact_BAO_Query
::apiQuery($params, $returnProperties, NULL, NULL, 0, 0, $useCache);
214 foreach ($contacts as $contact) {
215 $aMembers[$contact['contact_id']] = 1;
222 * Returns array of group object(s) matching a set of one or Group properties.
224 * @param array $param Array of one or more valid property_name=>value pairs.
225 * Limits the set of groups returned.
226 * @param array $returnProperties Which properties should be included in the returned group objects.
227 * (member_count should be last element.)
229 * @return An array of group objects.
233 * @todo other BAO functions that use returnProperties (e.g. Query Objects) receive the array flipped & filled with 1s and
234 * add in essential fields (e.g. id). This should follow a regular pattern like the others
236 static function getGroups(
238 $returnProperties = NULL,
243 $dao = new CRM_Contact_DAO_Group();
244 if (!isset($params['is_active'])) {
248 foreach ($params as $k => $v) {
249 if ($k == 'name' ||
$k == 'title') {
250 $dao->whereAdd($k . ' LIKE "' . CRM_Core_DAO
::escapeString($v) . '"');
252 elseif ($k == 'group_type') {
253 foreach ((array) $v as $type) {
254 $dao->whereAdd($k . " LIKE '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. (int) $type . CRM_Core_DAO
::VALUE_SEPARATOR
. "%'");
257 elseif (is_array($v)) {
258 foreach ($v as &$num) {
261 $dao->whereAdd($k . ' IN (' . implode(',', $v) . ')');
269 if ($offset ||
$rowCount) {
270 $offset = ($offset > 0) ?
$offset : 0;
271 $rowCount = ($rowCount > 0) ?
$rowCount : 25;
272 $dao->limit($offset, $rowCount);
276 $dao->orderBy($sort);
279 // return only specific fields if returnproperties are sent
280 if (!empty($returnProperties)) {
282 $dao->selectAdd(implode(',', $returnProperties));
286 $flag = $returnProperties && in_array('member_count', $returnProperties) ?
1 : 0;
289 while ($dao->fetch()) {
290 $group = new CRM_Contact_DAO_Group();
292 $dao->member_count
= CRM_Contact_BAO_Group
::memberCount($dao->id
);
294 $groups[] = clone($dao);
300 * make sure that the user has permission to access this group
302 * @param int $id the id of the object
304 * @return string the permission that the user has (or null)
308 static function checkPermission($id) {
309 $allGroups = CRM_Core_PseudoConstant
::allGroup();
312 if (CRM_Core_Permission
::check('edit all contacts') ||
313 CRM_ACL_API
::groupPermission(CRM_ACL_API
::EDIT
, $id, NULL,
314 'civicrm_saved_search', $allGroups
317 $permissions[] = CRM_Core_Permission
::EDIT
;
320 if (CRM_Core_Permission
::check('view all contacts') ||
321 CRM_ACL_API
::groupPermission(CRM_ACL_API
::VIEW
, $id, NULL,
322 'civicrm_saved_search', $allGroups
325 $permissions[] = CRM_Core_Permission
::VIEW
;
328 if (!empty($permissions) && CRM_Core_Permission
::check('delete contacts')) {
329 // Note: using !empty() in if condition, restricts the scope of delete
330 // permission to groups/contacts that are editable/viewable.
331 // We can remove this !empty condition once we have ACL support for delete functionality.
332 $permissions[] = CRM_Core_Permission
::DELETE
;
341 * @param array $params Associative array of parameters
343 * @return object|null The new group BAO (if created)
347 public static function &create(&$params) {
349 if (CRM_Utils_Array
::value('id', $params)) {
350 CRM_Utils_Hook
::pre('edit', 'Group', $params['id'], $params);
353 CRM_Utils_Hook
::pre('create', 'Group', NULL, $params);
356 // form the name only if missing: CRM-627
357 if (!CRM_Utils_Array
::value('name', $params) &&
358 !CRM_Utils_Array
::value('id', $params)
360 $params['name'] = CRM_Utils_String
::titleToVar($params['title']);
363 // convert params if array type
364 if (isset($params['group_type'])) {
365 if (is_array($params['group_type'])) {
366 $params['group_type'] = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
367 array_keys($params['group_type'])
368 ) . CRM_Core_DAO
::VALUE_SEPARATOR
;
372 $params['group_type'] = '';
375 $session = CRM_Core_Session
::singleton( );
376 $cid = $session->get('userID');
377 // this action is add
378 if ($cid && empty($params['id'])) {
379 $params['created_id'] = $cid;
381 // this action is update
382 if ($cid && !empty($params['id'])) {
383 $params['modified_id'] = $cid;
386 $group = new CRM_Contact_BAO_Group();
387 $group->copyValues($params);
388 //@todo very hacky fix for the fact this function wants to receive 'parents' as an array further down but
389 // needs it as a separated string for the DB. Preferred approaches are having the copyParams or save fn
390 // use metadata to translate the array to the appropriate DB type or altering the param in the api layer,
391 // or at least altering the param in same section as 'group_type' rather than repeating here. However, further down
392 // we need the $params one to be in it's original form & we are not sure what test coverage we have on that
393 if(isset($group->parents
) && is_array($group->parents
)) {
394 $group->parents
= CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
395 array_keys($group->parents
)
396 ) . CRM_Core_DAO
::VALUE_SEPARATOR
;
398 if (!CRM_Utils_Array
::value('id', $params)) {
399 $group->name
.= "_tmp";
407 if (!CRM_Utils_Array
::value('id', $params)) {
408 $group->name
= substr($group->name
, 0, -4) . "_{$group->id}";
411 $group->buildClause();
414 // add custom field values
415 if (CRM_Utils_Array
::value('custom', $params)) {
416 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_group', $group->id
);
419 // make the group, child of domain/site group by default.
420 $domainGroupID = CRM_Core_BAO_Domain
::getGroupId();
421 if (CRM_Utils_Array
::value('no_parent', $params) !== 1) {
422 if (empty($params['parents']) &&
423 $domainGroupID != $group->id
&&
424 CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MULTISITE_PREFERENCES_NAME
,
427 !CRM_Contact_BAO_GroupNesting
::hasParentGroups($group->id
)
429 // if no parent present and the group doesn't already have any parents,
430 // make sure site group goes as parent
431 $params['parents'] = array($domainGroupID => 1);
433 elseif (array_key_exists('parents', $params) && !is_array($params['parents'])) {
434 $params['parents'] = array($params['parents'] => 1);
437 if (!empty($params['parents'])) {
438 foreach ($params['parents'] as $parentId => $dnc) {
439 if ($parentId && !CRM_Contact_BAO_GroupNesting
::isParentChild($parentId, $group->id
)) {
440 CRM_Contact_BAO_GroupNesting
::add($parentId, $group->id
);
445 // clear any descendant groups cache if exists
446 $finalGroups = CRM_Core_BAO_Cache
::deleteGroup('descendant groups for an org');
448 // this is always required, since we don't know when a
449 // parent group is removed
450 CRM_Contact_BAO_GroupNestingCache
::update();
452 // update group contact cache for all parent groups
453 $parentIds = CRM_Contact_BAO_GroupNesting
::getParentGroupIds($group->id
);
454 foreach ($parentIds as $parentId) {
455 CRM_Contact_BAO_GroupContactCache
::add($parentId);
459 if (CRM_Utils_Array
::value('organization_id', $params)) {
462 $groupOrg['group_id'] = $group->id
;
463 CRM_Contact_BAO_GroupOrganization
::add($groupOrg);
466 CRM_Contact_BAO_GroupContactCache
::add($group->id
);
468 if (CRM_Utils_Array
::value('id', $params)) {
469 CRM_Utils_Hook
::post('edit', 'Group', $group->id
, $group);
472 CRM_Utils_Hook
::post('create', 'Group', $group->id
, $group);
475 $recentOther = array();
476 if (CRM_Core_Permission
::check('edit groups')) {
477 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/group', 'reset=1&action=update&id=' . $group->id
);
478 // currently same permission we are using for delete a group
479 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/group', 'reset=1&action=delete&id=' . $group->id
);
482 // add the recently added group (unless hidden: CRM-6432)
483 if (!$group->is_hidden
) {
484 CRM_Utils_Recent
::add($group->title
,
485 CRM_Utils_System
::url('civicrm/group/search', 'reset=1&force=1&context=smog&gid=' . $group->id
),
497 * given a saved search compute the clause and the tables
498 * and store it for future use
500 function buildClause() {
501 $params = array(array('group', 'IN', array($this->id
=> 1), 0, 0));
503 if (!empty($params)) {
504 $tables = $whereTables = array();
505 $this->where_clause
= CRM_Contact_BAO_Query
::getWhereClause($params, NULL, $tables, $whereTables);
506 if (!empty($tables)) {
507 $this->select_tables
= serialize($tables);
509 if (!empty($whereTables)) {
510 $this->where_tables
= serialize($whereTables);
518 * Defines a new smart group
520 * @param array $params Associative array of parameters
522 * @return object|null The new group BAO (if created)
526 public static function createSmartGroup(&$params) {
527 if (CRM_Utils_Array
::value('formValues', $params)) {
529 unset($ssParams['id']);
530 if (isset($ssParams['saved_search_id'])) {
531 $ssParams['id'] = $ssParams['saved_search_id'];
534 $savedSearch = CRM_Contact_BAO_SavedSearch
::create($params);
536 $params['saved_search_id'] = $savedSearch->id
;
542 return self
::create($params);
546 * update the is_active flag in the db
548 * @param int $id id of the database record
549 * @param boolean $isActive value we want to set the is_active field
551 * @return Object DAO object on sucess, null otherwise
554 static function setIsActive($id, $isActive) {
555 return CRM_Core_DAO
::setFieldValue('CRM_Contact_DAO_Group', $id, 'is_active', $isActive);
559 * build the condition to retrieve groups.
561 * @param string $groupType type of group(Access/Mailing) OR the key of the group
562 * @param boolen $excludeHidden exclude hidden groups.
564 * @return string $condition
567 static function groupTypeCondition($groupType = NULL, $excludeHidden = TRUE) {
569 if ($groupType == 'Mailing') {
570 $value = CRM_Core_DAO
::VALUE_SEPARATOR
. '2' . CRM_Core_DAO
::VALUE_SEPARATOR
;
572 elseif ($groupType == 'Access') {
573 $value = CRM_Core_DAO
::VALUE_SEPARATOR
. '1' . CRM_Core_DAO
::VALUE_SEPARATOR
;
575 elseif (!empty($groupType)){
576 // ie we have been given the group key
577 $value = CRM_Core_DAO
::VALUE_SEPARATOR
. $groupType . CRM_Core_DAO
::VALUE_SEPARATOR
;
581 if ($excludeHidden) {
582 $condition = "is_hidden = 0";
587 $condition .= " AND group_type LIKE '%$value%'";
590 $condition = "group_type LIKE '%$value%'";
597 public function __toString() {
602 * This function create the hidden smart group when user perform
603 * contact seach and want to send mailing to search contacts.
605 * @param array $params ( reference ) an assoc array of name/value pairs
607 * @return array ( smartGroupId, ssId ) smart group id and saved search id
611 static function createHiddenSmartGroup($params) {
612 $ssId = CRM_Utils_Array
::value('saved_search_id', $params);
614 //add mapping record only for search builder saved search
616 if ($params['search_context'] == 'builder') {
617 //save the mapping for search builder
619 //save record in mapping table
621 $mappingParams = array('mapping_type' => 'Search Builder');
622 $mapping = CRM_Core_BAO_Mapping
::add($mappingParams, $temp);
623 $mappingId = $mapping->id
;
626 //get the mapping id from saved search
627 $savedSearch = new CRM_Contact_BAO_SavedSearch();
628 $savedSearch->id
= $ssId;
629 $savedSearch->find(TRUE);
630 $mappingId = $savedSearch->mapping_id
;
633 //save mapping fields
634 CRM_Core_BAO_Mapping
::saveMappingFields($params['form_values'], $mappingId);
637 //create/update saved search record.
638 $savedSearch = new CRM_Contact_BAO_SavedSearch();
639 $savedSearch->id
= $ssId;
640 $savedSearch->form_values
= serialize($params['form_values']);
641 $savedSearch->mapping_id
= $mappingId;
642 $savedSearch->search_custom_id
= CRM_Utils_Array
::value('search_custom_id', $params);
643 $savedSearch->save();
645 $ssId = $savedSearch->id
;
650 $smartGroupId = NULL;
651 if (CRM_Utils_Array
::value('saved_search_id', $params)) {
652 $smartGroupId = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group', $ssId, 'id', 'saved_search_id');
655 //create group only when new saved search.
656 $groupParams = array(
657 'title' => "Hidden Smart Group {$ssId}",
658 'is_active' => CRM_Utils_Array
::value('is_active', $params, 1),
659 'is_hidden' => CRM_Utils_Array
::value('is_hidden', $params, 1),
660 'group_type' => CRM_Utils_Array
::value('group_type', $params),
661 'visibility' => CRM_Utils_Array
::value('visibility', $params),
662 'saved_search_id' => $ssId,
665 $smartGroup = self
::create($groupParams);
666 $smartGroupId = $smartGroup->id
;
669 return array($smartGroupId, $ssId);
673 * This function is a wrapper for ajax group selector
675 * @param array $params associated array for params record id.
677 * @return array $groupList associated array of group list
680 public function getGroupListSelector(&$params) {
682 $params['offset'] = ($params['page'] - 1) * $params['rp'];
683 $params['rowCount'] = $params['rp'];
684 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
687 $groups = CRM_Contact_BAO_Group
::getGroupList($params);
689 //skip total if we are making call to show only children
690 if ( !CRM_Utils_Array
::value('parent_id', $params) ) {
692 $params['total'] = CRM_Contact_BAO_Group
::getGroupCount($params);
694 // get all the groups
695 $allGroups = CRM_Core_PseudoConstant
::allGroup();
698 // format params and add links
699 $groupList = array();
700 if (!empty($groups)) {
701 foreach ($groups as $id => $value) {
702 $groupList[$id]['group_id'] = $value['id'];
703 $groupList[$id]['group_name'] = $value['title'];
704 $groupList[$id]['class'] = implode(' ', $value['class']);
706 // append parent names if in search mode
707 if ( !CRM_Utils_Array
::value('parent_id', $params) &&
708 CRM_Utils_Array
::value( 'parents', $value ) ) {
709 $groupIds = explode(',', $value['parents']);
711 foreach($groupIds as $gId) {
712 $title[] = $allGroups[$gId];
714 $groupList[$id]['group_name'] .= '<div class="crm-row-parent-name"><em>'.ts('Child of').'</em>: ' . implode(', ', $title) . '</div>';
715 $groupList[$id]['class'] = in_array('disabled', $value['class']) ?
'disabled' : '';
718 $groupList[$id]['group_description'] = CRM_Utils_Array
::value('description', $value);
719 if ( CRM_Utils_Array
::value('group_type', $value) ) {
720 $groupList[$id]['group_type'] = $value['group_type'];
723 $groupList[$id]['group_type'] = '';
725 $groupList[$id]['visibility'] = $value['visibility'];
726 $groupList[$id]['links'] = $value['action'];
727 $groupList[$id]['org_info'] = CRM_Utils_Array
::value('org_info', $value);
728 $groupList[$id]['created_by'] = CRM_Utils_Array
::value('created_by', $value);
730 $groupList[$id]['is_parent'] = $value['is_parent'];
737 * This function to get list of groups
739 * @param array $params associated array for params
742 static function getGroupList(&$params) {
743 $config = CRM_Core_Config
::singleton();
745 $whereClause = self
::whereClause($params, FALSE);
747 //$this->pagerAToZ( $whereClause, $params );
749 if (!empty($params['rowCount']) &&
750 $params['rowCount'] > 0
752 $limit = " LIMIT {$params['offset']}, {$params['rowCount']} ";
755 $orderBy = ' ORDER BY groups.title asc';
756 if (!empty($params['sort'])) {
757 $orderBy = ' ORDER BY ' . CRM_Utils_Type
::escape($params['sort'], 'String');
760 $select = $from = $where = "";
762 if (CRM_Core_Permission
::check('administer Multiple Organizations') &&
763 CRM_Core_Permission
::isMultisiteEnabled()
765 $select = ", contact.display_name as org_name, contact.id as org_id";
766 $from = " LEFT JOIN civicrm_group_organization gOrg
767 ON gOrg.group_id = groups.id
768 LEFT JOIN civicrm_contact contact
769 ON contact.id = gOrg.organization_id ";
771 //get the Organization ID
772 $orgID = CRM_Utils_Request
::retrieve('oid', 'Positive', CRM_Core_DAO
::$_nullObject);
774 $where = " AND gOrg.organization_id = {$orgID}";
781 SELECT groups.*, createdBy.sort_name as created_by {$select}
782 FROM civicrm_group groups
783 LEFT JOIN civicrm_contact createdBy
784 ON createdBy.id = groups.created_id
786 WHERE $whereClause {$where}
790 $object = CRM_Core_DAO
::executeQuery($query, $params, TRUE, 'CRM_Contact_DAO_Group');
792 //FIXME CRM-4418, now we are handling delete separately
793 //if we introduce 'delete for group' make sure to handle here.
794 $groupPermissions = array(CRM_Core_Permission
::VIEW
);
795 if (CRM_Core_Permission
::check('edit groups')) {
796 $groupPermissions[] = CRM_Core_Permission
::EDIT
;
797 $groupPermissions[] = CRM_Core_Permission
::DELETE
;
801 $reservedPermission = CRM_Core_Permission
::check('administer reserved groups');
803 $links = self
::actionLinks();
805 $allTypes = CRM_Core_OptionGroup
::values('group_type');
808 while ($object->fetch()) {
809 $permission = CRM_Contact_BAO_Group
::checkPermission($object->id
, $object->title
);
810 //@todo CRM-12209 introduced an ACL check in the whereClause function
811 // it may be that this checking is now obsolete - or that what remains
812 // should be removed to the whereClause (which is also accessed by getCount)
816 $values[$object->id
] = array('class' => array());
817 CRM_Core_DAO
::storeValues($object, $values[$object->id
]);
818 if ($object->saved_search_id
) {
819 $values[$object->id
]['title'] .= ' (' . ts('Smart Group') . ')';
820 // check if custom search, if so fix view link
821 $customSearchID = CRM_Core_DAO
::getFieldValue(
822 'CRM_Contact_DAO_SavedSearch',
823 $object->saved_search_id
,
827 if ($customSearchID) {
828 $newLinks[CRM_Core_Action
::VIEW
]['url'] = 'civicrm/contact/search/custom';
829 $newLinks[CRM_Core_Action
::VIEW
]['qs'] = "reset=1&force=1&ssID={$object->saved_search_id}";
833 $action = array_sum(array_keys($newLinks));
836 if (array_key_exists('is_reserved', $object)) {
837 //if group is reserved and I don't have reserved permission, suppress delete/edit
838 if ($object->is_reserved
&& !$reservedPermission) {
839 $action -= CRM_Core_Action
::DELETE
;
840 $action -= CRM_Core_Action
::UPDATE
;
841 $action -= CRM_Core_Action
::DISABLE
;
845 if (array_key_exists('is_active', $object)) {
846 if ($object->is_active
) {
847 $action -= CRM_Core_Action
::ENABLE
;
850 $values[$object->id
]['class'][] = 'disabled';
851 $action -= CRM_Core_Action
::VIEW
;
852 $action -= CRM_Core_Action
::DISABLE
;
856 $action = $action & CRM_Core_Action
::mask($groupPermissions);
858 $values[$object->id
]['visibility'] = CRM_Contact_DAO_Group
::tsEnum('visibility',
859 $values[$object->id
]['visibility']
861 if (isset($values[$object->id
]['group_type'])) {
862 $groupTypes = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
863 substr($values[$object->id
]['group_type'], 1, -1)
866 foreach ($groupTypes as $type) {
867 $types[] = CRM_Utils_Array
::value($type, $allTypes);
869 $values[$object->id
]['group_type'] = implode(', ', $types);
871 $values[$object->id
]['action'] = CRM_Core_Action
::formLink($newLinks,
875 'ssid' => $object->saved_search_id
,
879 'group.selector.row',
884 // If group has children, add class for link to view children
885 $values[$object->id
]['is_parent'] = false;
886 if (array_key_exists('children', $values[$object->id
])) {
887 $values[$object->id
]['class'][] = "crm-group-parent";
888 $values[$object->id
]['is_parent'] = true;
891 // If group is a child, add child class
892 if (array_key_exists('parents', $values[$object->id
])) {
893 $values[$object->id
]['class'][] = "crm-group-child";
897 if ($object->org_id
) {
898 $contactUrl = CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$object->org_id}");
899 $values[$object->id
]['org_info'] = "<a href='{$contactUrl}'>{$object->org_name}</a>";
902 $values[$object->id
]['org_info'] = ''; // Empty cell
906 $values[$object->id
]['org_info'] = NULL; // Collapsed column if all cells are NULL
908 if ($object->created_id
) {
909 $contactUrl = CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$object->created_id}");
910 $values[$object->id
]['created_by'] = "<a href='{$contactUrl}'>{$object->created_by}</a>";
919 * This function to get hierarchical list of groups (parent followed by children)
921 * @param array $groupIDs array of group ids
925 static function getGroupsHierarchy (
928 $spacer = '<span class="child-indent"></span>',
931 if (empty($groupIDs)) {
935 $groupIdString = '(' . implode(',', array_keys($groupIDs)) . ')';
936 // <span class="child-icon"></span>
937 // need to return id, title (w/ spacer), description, visibility
939 // We need to build a list of tags ordered by hierarchy and sorted by
940 // name. The heirarchy will be communicated by an accumulation of
941 // separators in front of the name to give it a visual offset.
942 // Instead of recursively making mysql queries, we'll make one big
943 // query and build the heirarchy with the algorithm below.
945 $args = array(1 => array($groupIdString, 'String'));
947 SELECT id, title, description, visibility, parents
949 WHERE id IN $groupIdString
952 // group can have > 1 parent so parents may be comma separated list (eg. '1,2,5'). We just grab and match on 1st parent.
953 $parentArray = explode(',', $parents);
954 $parent = $parentArray[0];
955 $args[2] = array($parent, 'Integer');
956 $query .= " AND SUBSTRING_INDEX(parents, ',', 1) = %2";
958 $query .= " ORDER BY title";
959 $dao = CRM_Core_DAO
::executeQuery($query, $args);
961 // Sort the groups into the correct storage by the parent
962 // $roots represent the current leaf nodes that need to be checked for
963 // children. $rows represent the unplaced nodes
964 $roots = $rows = $allGroups = array();
965 while ($dao->fetch()) {
966 $allGroups[$dao->id
] = array('title' => $dao->title
,
967 'visibility' => $dao->visibility
,
968 'description' => $dao->description
);
970 if ($dao->parents
== $parents) {
971 $roots[] = array('id' => $dao->id
,
973 'title' => $dao->title
);
976 // group can have > 1 parent so $dao->parents may be comma separated list (eg. '1,2,5'). Grab and match on 1st parent.
977 $parentArray = explode(',', $dao->parents
);
978 $parent = $parentArray[0];
979 $rows[] = array('id' => $dao->id
,
981 'title' => $dao->title
,
982 'parents' => $parent);
986 // While we have nodes left to build, shift the first (alphabetically)
987 // node of the list, place it in our groups list and loop through the
988 // list of unplaced nodes to find its children. We make a copy to
989 // iterate through because we must modify the unplaced nodes list
991 while (count($roots)) {
992 $new_roots = array();
993 $current_rows = $rows;
994 $root = array_shift($roots);
995 $groups[$root['id']] = array($root['prefix'], $root['title']);
997 // As you find the children, append them to the end of the new set
998 // of roots (maintain alphabetical ordering). Also remove the node
999 // from the set of unplaced nodes.
1000 if (is_array($current_rows)) {
1001 foreach ($current_rows as $key => $row) {
1002 if ($row['parents'] == $root['id']) {
1003 $new_roots[] = array('id' => $row['id'], 'prefix' => $groups[$root['id']][0] . $spacer, 'title' => $row['title']);
1009 //As a group, insert the new roots into the beginning of the roots
1010 //list. This maintains the hierarchical ordering of the tags.
1011 $roots = array_merge($new_roots, $roots);
1014 // Prefix titles with the calcuated spacing to give the visual
1015 // appearance of ordering when transformed into HTML in the form layer. Add description and visibility.
1016 $groupsReturn = array();
1017 foreach ($groups as $key=>$value) {
1019 $groupsReturn[$key] = $value[0] . $value[1];
1021 $groupsReturn[$key] = array(
1022 'title' => $value[0] . $value[1],
1023 'description' => $allGroups[$key]['description'],
1024 'visibility' => $allGroups[$key]['visibility'],
1029 return $groupsReturn;
1032 static function getGroupCount(&$params) {
1033 $whereClause = self
::whereClause($params, FALSE);
1034 $query = "SELECT COUNT(*) FROM civicrm_group groups";
1036 if (CRM_Utils_Array
::value('created_by', $params)) {
1038 INNER JOIN civicrm_contact createdBy
1039 ON createdBy.id = groups.created_id";
1042 WHERE {$whereClause}";
1043 return CRM_Core_DAO
::singleValueQuery($query, $params);
1046 function whereClause(&$params, $sortBy = TRUE, $excludeHidden = TRUE) {
1050 $title = CRM_Utils_Array
::value('title', $params);
1052 $clauses[] = "groups.title LIKE %1";
1053 if (strpos($title, '%') !== FALSE) {
1054 $params[1] = array($title, 'String', FALSE);
1057 $params[1] = array($title, 'String', TRUE);
1061 $groupType = CRM_Utils_Array
::value('group_type', $params);
1063 $types = explode(',', $groupType);
1064 if (!empty($types)) {
1065 $clauses[] = 'groups.group_type LIKE %2';
1066 $typeString = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $types) . CRM_Core_DAO
::VALUE_SEPARATOR
;
1067 $params[2] = array($typeString, 'String', TRUE);
1071 $visibility = CRM_Utils_Array
::value('visibility', $params);
1073 $clauses[] = 'groups.visibility = %3';
1074 $params[3] = array($visibility, 'String');
1077 $groupStatus = CRM_Utils_Array
::value('status', $params);
1079 switch ($groupStatus) {
1081 $clauses[] = 'groups.is_active = 1';
1082 $params[4] = array($groupStatus, 'Integer');
1086 $clauses[] = 'groups.is_active = 0';
1087 $params[4] = array($groupStatus, 'Integer');
1091 $clauses[] = '(groups.is_active = 0 OR groups.is_active = 1 )';
1096 $parentsOnly = CRM_Utils_Array
::value('parentsOnly', $params);
1098 $clauses[] = 'groups.parents IS NULL';
1101 // only show child groups of a specific parent group
1102 $parent_id = CRM_Utils_Array
::value('parent_id', $params);
1104 $clauses[] = 'groups.id IN (SELECT child_group_id FROM civicrm_group_nesting WHERE parent_group_id = %5)';
1105 $params[5] = array($parent_id, 'Integer');
1108 if ($createdBy = CRM_Utils_Array
::value('created_by', $params)) {
1109 $clauses[] = "createdBy.sort_name LIKE %6";
1110 if (strpos($createdBy, '%') !== FALSE) {
1111 $params[6] = array($createdBy, 'String', FALSE);
1114 $params[6] = array($createdBy, 'String', TRUE);
1120 $this->_sortByCharacter !== null ) {
1122 "groups.title LIKE '" .
1123 strtolower(CRM_Core_DAO::escapeWildCardString($this->_sortByCharacter)) .
1127 // dont do a the below assignement when doing a
1128 // AtoZ pager clause
1130 if ( count( $clauses ) > 1 ) {
1131 $this->assign( 'isSearch', 1 );
1133 $this->assign( 'isSearch', 0 );
1139 if (empty($clauses)) {
1140 $clauses[] = 'groups.is_active = 1';
1143 if ($excludeHidden) {
1144 $clauses[] = 'groups.is_hidden = 0';
1147 if (!CRM_Core_Permission
::check('view all contacts')) {
1148 //get the allowed groups for the current user
1149 $groups = CRM_ACL_API
::group(CRM_ACL_API
::VIEW
);
1150 if (!empty( $groups)) {
1151 $groupList = implode( ', ', array_values( $groups ) );
1152 $clauses[] = "groups.id IN ( $groupList ) ";
1156 return implode(' AND ', $clauses);
1160 * Function to define action links
1162 * @return array $links array of action links
1165 static function actionLinks() {
1167 CRM_Core_Action
::VIEW
=> array(
1168 'name' => ts('Contacts'),
1169 'url' => 'civicrm/group/search',
1170 'qs' => 'reset=1&force=1&context=smog&gid=%%id%%',
1171 'title' => ts('Group Contacts'),
1173 CRM_Core_Action
::UPDATE
=> array(
1174 'name' => ts('Settings'),
1175 'url' => 'civicrm/group',
1176 'qs' => 'reset=1&action=update&id=%%id%%',
1177 'title' => ts('Edit Group'),
1179 CRM_Core_Action
::DISABLE
=> array(
1180 'name' => ts('Disable'),
1181 'ref' => 'crm-enable-disable',
1182 'title' => ts('Disable Group'),
1184 CRM_Core_Action
::ENABLE
=> array(
1185 'name' => ts('Enable'),
1186 'ref' => 'crm-enable-disable',
1187 'title' => ts('Enable Group'),
1189 CRM_Core_Action
::DELETE
=> array(
1190 'name' => ts('Delete'),
1191 'url' => 'civicrm/group',
1192 'qs' => 'reset=1&action=delete&id=%%id%%',
1193 'title' => ts('Delete Group'),
1200 function pagerAtoZ($whereClause, $whereParams) {
1202 SELECT DISTINCT UPPER(LEFT(groups.title, 1)) as sort_name
1203 FROM civicrm_group groups
1205 ORDER BY LEFT(groups.title, 1)
1207 $dao = CRM_Core_DAO
::executeQuery($query, $whereParams);
1209 return CRM_Utils_PagerAToZ
::getAToZBar($dao, $this->_sortByCharacter
, TRUE);