| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.4 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2013 | |
| 7 | +--------------------------------------------------------------------+ |
| 8 | | This file is a part of CiviCRM. | |
| 9 | | | |
| 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. | |
| 13 | | | |
| 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. | |
| 18 | | | |
| 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 | +--------------------------------------------------------------------+ |
| 26 | */ |
| 27 | |
| 28 | /** |
| 29 | * |
| 30 | * @package CRM |
| 31 | * @copyright CiviCRM LLC (c) 2004-2013 |
| 32 | * $Id$ |
| 33 | * |
| 34 | */ |
| 35 | class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { |
| 36 | |
| 37 | /** |
| 38 | * class constructor |
| 39 | */ |
| 40 | function __construct() { |
| 41 | parent::__construct(); |
| 42 | } |
| 43 | |
| 44 | /** |
| 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 |
| 50 | * |
| 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 |
| 53 | * |
| 54 | * @return object CRM_Contact_BAO_Group object |
| 55 | * @access public |
| 56 | * @static |
| 57 | */ |
| 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); |
| 63 | return $group; |
| 64 | } |
| 65 | |
| 66 | return NULL; |
| 67 | } |
| 68 | |
| 69 | /** |
| 70 | * Function to delete the group and all the object that connect to |
| 71 | * this group. Incredibly destructive |
| 72 | * |
| 73 | * @param int $id group id |
| 74 | * |
| 75 | * @return null |
| 76 | * @access public |
| 77 | * @static |
| 78 | * |
| 79 | */ |
| 80 | static function discard($id) { |
| 81 | CRM_Utils_Hook::pre('delete', 'Group', $id, CRM_Core_DAO::$_nullArray); |
| 82 | |
| 83 | $transaction = new CRM_Core_Transaction(); |
| 84 | |
| 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; |
| 89 | $subscribe->delete(); |
| 90 | |
| 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(); |
| 95 | |
| 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(); |
| 100 | |
| 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); |
| 105 | |
| 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); |
| 108 | |
| 109 | // make sure u delete all the entries from civicrm_mailing_group and civicrm_campaign_group |
| 110 | // CRM-6186 |
| 111 | $query = "DELETE FROM civicrm_mailing_group where entity_table = 'civicrm_group' AND entity_id = %1"; |
| 112 | CRM_Core_DAO::executeQuery($query, $params); |
| 113 | |
| 114 | $query = "DELETE FROM civicrm_campaign_group where entity_table = 'civicrm_group' AND entity_id = %1"; |
| 115 | CRM_Core_DAO::executeQuery($query, $params); |
| 116 | |
| 117 | $query = "DELETE FROM civicrm_acl_entity_role where entity_table = 'civicrm_group' AND entity_id = %1"; |
| 118 | CRM_Core_DAO::executeQuery($query, $params); |
| 119 | |
| 120 | if (CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MULTISITE_PREFERENCES_NAME, |
| 121 | 'is_enabled' |
| 122 | )) { |
| 123 | // clear any descendant groups cache if exists |
| 124 | $finalGroups = CRM_Core_BAO_Cache::deleteGroup('descendant groups for an org'); |
| 125 | } |
| 126 | |
| 127 | // delete from group table |
| 128 | $group = new CRM_Contact_DAO_Group(); |
| 129 | $group->id = $id; |
| 130 | $group->delete(); |
| 131 | |
| 132 | $transaction->commit(); |
| 133 | |
| 134 | CRM_Utils_Hook::post('delete', 'Group', $id, $group); |
| 135 | |
| 136 | // delete the recently created Group |
| 137 | $groupRecent = array( |
| 138 | 'id' => $id, |
| 139 | 'type' => 'Group', |
| 140 | ); |
| 141 | CRM_Utils_Recent::del($groupRecent); |
| 142 | } |
| 143 | |
| 144 | /** |
| 145 | * Returns an array of the contacts in the given group. |
| 146 | * |
| 147 | */ |
| 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')); |
| 151 | return $contacts; |
| 152 | } |
| 153 | |
| 154 | /** |
| 155 | * Get the count of a members in a group with the specific status |
| 156 | * |
| 157 | * @param int $id group id |
| 158 | * @param enum $status status of members in group |
| 159 | * |
| 160 | * @return int count of members in the group with above status |
| 161 | * @access public |
| 162 | */ |
| 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); |
| 168 | } |
| 169 | $count = 0; |
| 170 | |
| 171 | $contacts = self::getGroupContacts($id); |
| 172 | |
| 173 | foreach ($groupIds as $groupId) { |
| 174 | |
| 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 |
| 181 | // main group |
| 182 | foreach ($contacts as $contact) { |
| 183 | if ($contact['contact_id'] == $gcontact['contact_id']) { |
| 184 | $count--; |
| 185 | } |
| 186 | } |
| 187 | } |
| 188 | } |
| 189 | $groupContact->group_id = $groupId; |
| 190 | if (isset($status)) { |
| 191 | $groupContact->status = $status; |
| 192 | } |
| 193 | $groupContact->_query['condition'] = 'WHERE contact_id NOT IN (SELECT id FROM civicrm_contact WHERE is_deleted = 1)'; |
| 194 | $count += $groupContact->count(); |
| 195 | } |
| 196 | return $count; |
| 197 | } |
| 198 | |
| 199 | /** |
| 200 | * Get the list of member for a group id |
| 201 | * |
| 202 | * @param int $lngGroupId this is group id |
| 203 | * |
| 204 | * @return array $aMembers this arrray contains the list of members for this group id |
| 205 | * @access public |
| 206 | * @static |
| 207 | */ |
| 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); |
| 212 | |
| 213 | $aMembers = array(); |
| 214 | foreach ($contacts as $contact) { |
| 215 | $aMembers[$contact['contact_id']] = 1; |
| 216 | } |
| 217 | |
| 218 | return $aMembers; |
| 219 | } |
| 220 | |
| 221 | /** |
| 222 | * Returns array of group object(s) matching a set of one or Group properties. |
| 223 | * |
| 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.) |
| 228 | * |
| 229 | * @return An array of group objects. |
| 230 | * |
| 231 | * @access public |
| 232 | * |
| 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 |
| 235 | */ |
| 236 | static function getGroups( |
| 237 | $params = NULL, |
| 238 | $returnProperties = NULL, |
| 239 | $sort = NULL, |
| 240 | $offset = NULL, |
| 241 | $rowCount = NULL |
| 242 | ) { |
| 243 | $dao = new CRM_Contact_DAO_Group(); |
| 244 | if (!isset($params['is_active'])) { |
| 245 | $dao->is_active = 1; |
| 246 | } |
| 247 | if ($params) { |
| 248 | foreach ($params as $k => $v) { |
| 249 | if ($k == 'name' || $k == 'title') { |
| 250 | $dao->whereAdd($k . ' LIKE "' . CRM_Core_DAO::escapeString($v) . '"'); |
| 251 | } |
| 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 . "%'"); |
| 255 | } |
| 256 | } |
| 257 | elseif (is_array($v)) { |
| 258 | foreach ($v as &$num) { |
| 259 | $num = (int) $num; |
| 260 | } |
| 261 | $dao->whereAdd($k . ' IN (' . implode(',', $v) . ')'); |
| 262 | } |
| 263 | else { |
| 264 | $dao->$k = $v; |
| 265 | } |
| 266 | } |
| 267 | } |
| 268 | |
| 269 | if ($offset || $rowCount) { |
| 270 | $offset = ($offset > 0) ? $offset : 0; |
| 271 | $rowCount = ($rowCount > 0) ? $rowCount : 25; |
| 272 | $dao->limit($offset, $rowCount); |
| 273 | } |
| 274 | |
| 275 | if ($sort) { |
| 276 | $dao->orderBy($sort); |
| 277 | } |
| 278 | |
| 279 | // return only specific fields if returnproperties are sent |
| 280 | if (!empty($returnProperties)) { |
| 281 | $dao->selectAdd(); |
| 282 | $dao->selectAdd(implode(',', $returnProperties)); |
| 283 | } |
| 284 | $dao->find(); |
| 285 | |
| 286 | $flag = $returnProperties && in_array('member_count', $returnProperties) ? 1 : 0; |
| 287 | |
| 288 | $groups = array(); |
| 289 | while ($dao->fetch()) { |
| 290 | $group = new CRM_Contact_DAO_Group(); |
| 291 | if ($flag) { |
| 292 | $dao->member_count = CRM_Contact_BAO_Group::memberCount($dao->id); |
| 293 | } |
| 294 | $groups[] = clone($dao); |
| 295 | } |
| 296 | return $groups; |
| 297 | } |
| 298 | |
| 299 | /** |
| 300 | * make sure that the user has permission to access this group |
| 301 | * |
| 302 | * @param int $id the id of the object |
| 303 | * |
| 304 | * @return string the permission that the user has (or null) |
| 305 | * @access public |
| 306 | * @static |
| 307 | */ |
| 308 | static function checkPermission($id) { |
| 309 | $allGroups = CRM_Core_PseudoConstant::allGroup(); |
| 310 | |
| 311 | $permissions = NULL; |
| 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 |
| 315 | ) |
| 316 | ) { |
| 317 | $permissions[] = CRM_Core_Permission::EDIT; |
| 318 | } |
| 319 | |
| 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 |
| 323 | ) |
| 324 | ) { |
| 325 | $permissions[] = CRM_Core_Permission::VIEW; |
| 326 | } |
| 327 | |
| 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; |
| 333 | } |
| 334 | |
| 335 | return $permissions; |
| 336 | } |
| 337 | |
| 338 | /** |
| 339 | * Create a new group |
| 340 | * |
| 341 | * @param array $params Associative array of parameters |
| 342 | * |
| 343 | * @return object|null The new group BAO (if created) |
| 344 | * @access public |
| 345 | * @static |
| 346 | */ |
| 347 | public static function &create(&$params) { |
| 348 | |
| 349 | if (CRM_Utils_Array::value('id', $params)) { |
| 350 | CRM_Utils_Hook::pre('edit', 'Group', $params['id'], $params); |
| 351 | } |
| 352 | else { |
| 353 | CRM_Utils_Hook::pre('create', 'Group', NULL, $params); |
| 354 | } |
| 355 | |
| 356 | // form the name only if missing: CRM-627 |
| 357 | if (!CRM_Utils_Array::value('name', $params) && |
| 358 | !CRM_Utils_Array::value('id', $params) |
| 359 | ) { |
| 360 | $params['name'] = CRM_Utils_String::titleToVar($params['title']); |
| 361 | } |
| 362 | |
| 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; |
| 369 | } |
| 370 | } |
| 371 | else { |
| 372 | $params['group_type'] = ''; |
| 373 | } |
| 374 | |
| 375 | $session = CRM_Core_Session::singleton( ); |
| 376 | if ($cid = $session->get('userID')) { |
| 377 | $params['created_id'] = $cid; |
| 378 | } |
| 379 | |
| 380 | $group = new CRM_Contact_BAO_Group(); |
| 381 | $group->copyValues($params); |
| 382 | //@todo very hacky fix for the fact this function wants to receive 'parents' as an array further down but |
| 383 | // needs it as a separated string for the DB. Preferred approaches are having the copyParams or save fn |
| 384 | // use metadata to translate the array to the appropriate DB type or altering the param in the api layer, |
| 385 | // or at least altering the param in same section as 'group_type' rather than repeating here. However, further down |
| 386 | // we need the $params one to be in it's original form & we are not sure what test coverage we have on that |
| 387 | if(isset($group->parents) && is_array($group->parents)) { |
| 388 | $group->parents = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR, |
| 389 | array_keys($group->parents) |
| 390 | ) . CRM_Core_DAO::VALUE_SEPARATOR; |
| 391 | } |
| 392 | if (!CRM_Utils_Array::value('id', $params)) { |
| 393 | $group->name .= "_tmp"; |
| 394 | } |
| 395 | $group->save(); |
| 396 | |
| 397 | if (!$group->id) { |
| 398 | return NULL; |
| 399 | } |
| 400 | |
| 401 | if (!CRM_Utils_Array::value('id', $params)) { |
| 402 | $group->name = substr($group->name, 0, -4) . "_{$group->id}"; |
| 403 | } |
| 404 | |
| 405 | $group->buildClause(); |
| 406 | $group->save(); |
| 407 | |
| 408 | // add custom field values |
| 409 | if (CRM_Utils_Array::value('custom', $params)) { |
| 410 | CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_group', $group->id); |
| 411 | } |
| 412 | |
| 413 | // make the group, child of domain/site group by default. |
| 414 | $domainGroupID = CRM_Core_BAO_Domain::getGroupId(); |
| 415 | if (CRM_Utils_Array::value('no_parent', $params) !== 1) { |
| 416 | if (empty($params['parents']) && |
| 417 | $domainGroupID != $group->id && |
| 418 | CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MULTISITE_PREFERENCES_NAME, |
| 419 | 'is_enabled' |
| 420 | ) && |
| 421 | !CRM_Contact_BAO_GroupNesting::hasParentGroups($group->id) |
| 422 | ) { |
| 423 | // if no parent present and the group doesn't already have any parents, |
| 424 | // make sure site group goes as parent |
| 425 | $params['parents'] = array($domainGroupID => 1); |
| 426 | } |
| 427 | elseif (array_key_exists('parents', $params) && !is_array($params['parents'])) { |
| 428 | $params['parents'] = array($params['parents'] => 1); |
| 429 | } |
| 430 | |
| 431 | if (!empty($params['parents'])) { |
| 432 | foreach ($params['parents'] as $parentId => $dnc) { |
| 433 | if ($parentId && !CRM_Contact_BAO_GroupNesting::isParentChild($parentId, $group->id)) { |
| 434 | CRM_Contact_BAO_GroupNesting::add($parentId, $group->id); |
| 435 | } |
| 436 | } |
| 437 | } |
| 438 | |
| 439 | // clear any descendant groups cache if exists |
| 440 | $finalGroups = CRM_Core_BAO_Cache::deleteGroup('descendant groups for an org'); |
| 441 | |
| 442 | // this is always required, since we don't know when a |
| 443 | // parent group is removed |
| 444 | CRM_Contact_BAO_GroupNestingCache::update(); |
| 445 | |
| 446 | // update group contact cache for all parent groups |
| 447 | $parentIds = CRM_Contact_BAO_GroupNesting::getParentGroupIds($group->id); |
| 448 | foreach ($parentIds as $parentId) { |
| 449 | CRM_Contact_BAO_GroupContactCache::add($parentId); |
| 450 | } |
| 451 | } |
| 452 | |
| 453 | if (CRM_Utils_Array::value('organization_id', $params)) { |
| 454 | $groupOrg = array(); |
| 455 | $groupOrg = $params; |
| 456 | $groupOrg['group_id'] = $group->id; |
| 457 | CRM_Contact_BAO_GroupOrganization::add($groupOrg); |
| 458 | } |
| 459 | |
| 460 | CRM_Contact_BAO_GroupContactCache::add($group->id); |
| 461 | |
| 462 | if (CRM_Utils_Array::value('id', $params)) { |
| 463 | CRM_Utils_Hook::post('edit', 'Group', $group->id, $group); |
| 464 | } |
| 465 | else { |
| 466 | CRM_Utils_Hook::post('create', 'Group', $group->id, $group); |
| 467 | } |
| 468 | |
| 469 | $recentOther = array(); |
| 470 | if (CRM_Core_Permission::check('edit groups')) { |
| 471 | $recentOther['editUrl'] = CRM_Utils_System::url('civicrm/group', 'reset=1&action=update&id=' . $group->id); |
| 472 | // currently same permission we are using for delete a group |
| 473 | $recentOther['deleteUrl'] = CRM_Utils_System::url('civicrm/group', 'reset=1&action=delete&id=' . $group->id); |
| 474 | } |
| 475 | |
| 476 | // add the recently added group (unless hidden: CRM-6432) |
| 477 | if (!$group->is_hidden) { |
| 478 | CRM_Utils_Recent::add($group->title, |
| 479 | CRM_Utils_System::url('civicrm/group/search', 'reset=1&force=1&context=smog&gid=' . $group->id), |
| 480 | $group->id, |
| 481 | 'Group', |
| 482 | NULL, |
| 483 | NULL, |
| 484 | $recentOther |
| 485 | ); |
| 486 | } |
| 487 | return $group; |
| 488 | } |
| 489 | |
| 490 | /** |
| 491 | * given a saved search compute the clause and the tables |
| 492 | * and store it for future use |
| 493 | */ |
| 494 | function buildClause() { |
| 495 | $params = array(array('group', 'IN', array($this->id => 1), 0, 0)); |
| 496 | |
| 497 | if (!empty($params)) { |
| 498 | $tables = $whereTables = array(); |
| 499 | $this->where_clause = CRM_Contact_BAO_Query::getWhereClause($params, NULL, $tables, $whereTables); |
| 500 | if (!empty($tables)) { |
| 501 | $this->select_tables = serialize($tables); |
| 502 | } |
| 503 | if (!empty($whereTables)) { |
| 504 | $this->where_tables = serialize($whereTables); |
| 505 | } |
| 506 | } |
| 507 | |
| 508 | return; |
| 509 | } |
| 510 | |
| 511 | /** |
| 512 | * Defines a new smart group |
| 513 | * |
| 514 | * @param array $params Associative array of parameters |
| 515 | * |
| 516 | * @return object|null The new group BAO (if created) |
| 517 | * @access public |
| 518 | * @static |
| 519 | */ |
| 520 | public static function createSmartGroup(&$params) { |
| 521 | if (CRM_Utils_Array::value('formValues', $params)) { |
| 522 | $ssParams = $params; |
| 523 | unset($ssParams['id']); |
| 524 | if (isset($ssParams['saved_search_id'])) { |
| 525 | $ssParams['id'] = $ssParams['saved_search_id']; |
| 526 | } |
| 527 | |
| 528 | $savedSearch = CRM_Contact_BAO_SavedSearch::create($params); |
| 529 | |
| 530 | $params['saved_search_id'] = $savedSearch->id; |
| 531 | } |
| 532 | else { |
| 533 | return NULL; |
| 534 | } |
| 535 | |
| 536 | return self::create($params); |
| 537 | } |
| 538 | |
| 539 | /** |
| 540 | * update the is_active flag in the db |
| 541 | * |
| 542 | * @param int $id id of the database record |
| 543 | * @param boolean $isActive value we want to set the is_active field |
| 544 | * |
| 545 | * @return Object DAO object on sucess, null otherwise |
| 546 | * @static |
| 547 | */ |
| 548 | static function setIsActive($id, $isActive) { |
| 549 | return CRM_Core_DAO::setFieldValue('CRM_Contact_DAO_Group', $id, 'is_active', $isActive); |
| 550 | } |
| 551 | |
| 552 | /** |
| 553 | * build the condition to retrieve groups. |
| 554 | * |
| 555 | * @param string $groupType type of group(Access/Mailing) OR the key of the group |
| 556 | * @param boolen $excludeHidden exclude hidden groups. |
| 557 | * |
| 558 | * @return string $condition |
| 559 | * @static |
| 560 | */ |
| 561 | static function groupTypeCondition($groupType = NULL, $excludeHidden = TRUE) { |
| 562 | $value = NULL; |
| 563 | if ($groupType == 'Mailing') { |
| 564 | $value = CRM_Core_DAO::VALUE_SEPARATOR . '2' . CRM_Core_DAO::VALUE_SEPARATOR; |
| 565 | } |
| 566 | elseif ($groupType == 'Access') { |
| 567 | $value = CRM_Core_DAO::VALUE_SEPARATOR . '1' . CRM_Core_DAO::VALUE_SEPARATOR; |
| 568 | } |
| 569 | elseif (!empty($groupType)){ |
| 570 | // ie we have been given the group key |
| 571 | $value = CRM_Core_DAO::VALUE_SEPARATOR . $groupType . CRM_Core_DAO::VALUE_SEPARATOR; |
| 572 | } |
| 573 | |
| 574 | $condition = NULL; |
| 575 | if ($excludeHidden) { |
| 576 | $condition = "is_hidden = 0"; |
| 577 | } |
| 578 | |
| 579 | if ($value) { |
| 580 | if ($condition) { |
| 581 | $condition .= " AND group_type LIKE '%$value%'"; |
| 582 | } |
| 583 | else { |
| 584 | $condition = "group_type LIKE '%$value%'"; |
| 585 | } |
| 586 | } |
| 587 | |
| 588 | return $condition; |
| 589 | } |
| 590 | |
| 591 | public function __toString() { |
| 592 | return $this->title; |
| 593 | } |
| 594 | |
| 595 | /** |
| 596 | * This function create the hidden smart group when user perform |
| 597 | * contact seach and want to send mailing to search contacts. |
| 598 | * |
| 599 | * @param array $params ( reference ) an assoc array of name/value pairs |
| 600 | * |
| 601 | * @return array ( smartGroupId, ssId ) smart group id and saved search id |
| 602 | * @access public |
| 603 | * @static |
| 604 | */ |
| 605 | static function createHiddenSmartGroup($params) { |
| 606 | $ssId = CRM_Utils_Array::value('saved_search_id', $params); |
| 607 | |
| 608 | //add mapping record only for search builder saved search |
| 609 | $mappingId = NULL; |
| 610 | if ($params['search_context'] == 'builder') { |
| 611 | //save the mapping for search builder |
| 612 | if (!$ssId) { |
| 613 | //save record in mapping table |
| 614 | $temp = array(); |
| 615 | $mappingParams = array('mapping_type' => 'Search Builder'); |
| 616 | $mapping = CRM_Core_BAO_Mapping::add($mappingParams, $temp); |
| 617 | $mappingId = $mapping->id; |
| 618 | } |
| 619 | else { |
| 620 | //get the mapping id from saved search |
| 621 | $savedSearch = new CRM_Contact_BAO_SavedSearch(); |
| 622 | $savedSearch->id = $ssId; |
| 623 | $savedSearch->find(TRUE); |
| 624 | $mappingId = $savedSearch->mapping_id; |
| 625 | } |
| 626 | |
| 627 | //save mapping fields |
| 628 | CRM_Core_BAO_Mapping::saveMappingFields($params['form_values'], $mappingId); |
| 629 | } |
| 630 | |
| 631 | //create/update saved search record. |
| 632 | $savedSearch = new CRM_Contact_BAO_SavedSearch(); |
| 633 | $savedSearch->id = $ssId; |
| 634 | $savedSearch->form_values = serialize($params['form_values']); |
| 635 | $savedSearch->mapping_id = $mappingId; |
| 636 | $savedSearch->search_custom_id = CRM_Utils_Array::value('search_custom_id', $params); |
| 637 | $savedSearch->save(); |
| 638 | |
| 639 | $ssId = $savedSearch->id; |
| 640 | if (!$ssId) { |
| 641 | return NULL; |
| 642 | } |
| 643 | |
| 644 | $smartGroupId = NULL; |
| 645 | if (CRM_Utils_Array::value('saved_search_id', $params)) { |
| 646 | $smartGroupId = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group', $ssId, 'id', 'saved_search_id'); |
| 647 | } |
| 648 | else { |
| 649 | //create group only when new saved search. |
| 650 | $groupParams = array( |
| 651 | 'title' => "Hidden Smart Group {$ssId}", |
| 652 | 'is_active' => CRM_Utils_Array::value('is_active', $params, 1), |
| 653 | 'is_hidden' => CRM_Utils_Array::value('is_hidden', $params, 1), |
| 654 | 'group_type' => CRM_Utils_Array::value('group_type', $params), |
| 655 | 'visibility' => CRM_Utils_Array::value('visibility', $params), |
| 656 | 'saved_search_id' => $ssId, |
| 657 | ); |
| 658 | |
| 659 | $smartGroup = self::create($groupParams); |
| 660 | $smartGroupId = $smartGroup->id; |
| 661 | } |
| 662 | |
| 663 | return array($smartGroupId, $ssId); |
| 664 | } |
| 665 | |
| 666 | /** |
| 667 | * This function is a wrapper for ajax group selector |
| 668 | * |
| 669 | * @param array $params associated array for params record id. |
| 670 | * |
| 671 | * @return array $groupList associated array of group list |
| 672 | * @access public |
| 673 | */ |
| 674 | public function getGroupListSelector(&$params) { |
| 675 | // format the params |
| 676 | $params['offset'] = ($params['page'] - 1) * $params['rp']; |
| 677 | $params['rowCount'] = $params['rp']; |
| 678 | $params['sort'] = CRM_Utils_Array::value('sortBy', $params); |
| 679 | |
| 680 | // get groups |
| 681 | $groups = CRM_Contact_BAO_Group::getGroupList($params); |
| 682 | |
| 683 | //skip total if we are making call to show only children |
| 684 | if ( !CRM_Utils_Array::value('parent_id', $params) ) { |
| 685 | // add total |
| 686 | $params['total'] = CRM_Contact_BAO_Group::getGroupCount($params); |
| 687 | |
| 688 | // get all the groups |
| 689 | $allGroups = CRM_Core_PseudoConstant::allGroup(); |
| 690 | } |
| 691 | |
| 692 | // format params and add links |
| 693 | $groupList = array(); |
| 694 | if (!empty($groups)) { |
| 695 | foreach ($groups as $id => $value) { |
| 696 | $groupList[$id]['group_id'] = $value['id']; |
| 697 | $groupList[$id]['group_name'] = $value['title']; |
| 698 | $groupList[$id]['class'] = $value['class']; |
| 699 | |
| 700 | // append parent names if in search mode |
| 701 | if ( !CRM_Utils_Array::value('parent_id', $params) && |
| 702 | CRM_Utils_Array::value( 'parents', $value ) ) { |
| 703 | $groupIds = explode(',', $value['parents']); |
| 704 | $title = array(); |
| 705 | foreach($groupIds as $gId) { |
| 706 | $title[] = $allGroups[$gId]; |
| 707 | } |
| 708 | $groupList[$id]['group_name'] .= '<div class="crm-row-parent-name"><em>'.ts('Child of').'</em>: ' . implode(', ', $title) . '</div>'; |
| 709 | $groupList[$id]['class'] = ''; |
| 710 | } |
| 711 | |
| 712 | $groupList[$id]['group_description'] = CRM_Utils_Array::value('description', $value); |
| 713 | if ( CRM_Utils_Array::value('group_type', $value) ) { |
| 714 | $groupList[$id]['group_type'] = $value['group_type']; |
| 715 | } |
| 716 | else { |
| 717 | $groupList[$id]['group_type'] = ''; |
| 718 | } |
| 719 | $groupList[$id]['visibility'] = $value['visibility']; |
| 720 | $groupList[$id]['links'] = $value['action']; |
| 721 | $groupList[$id]['org_info'] = CRM_Utils_Array::value('org_info', $value); |
| 722 | $groupList[$id]['created_by'] = CRM_Utils_Array::value('created_by', $value); |
| 723 | |
| 724 | $groupList[$id]['is_parent'] = $value['is_parent']; |
| 725 | } |
| 726 | return $groupList; |
| 727 | } |
| 728 | } |
| 729 | |
| 730 | /** |
| 731 | * This function to get list of groups |
| 732 | * |
| 733 | * @param array $params associated array for params |
| 734 | * @access public |
| 735 | */ |
| 736 | static function getGroupList(&$params) { |
| 737 | $config = CRM_Core_Config::singleton(); |
| 738 | |
| 739 | $whereClause = self::whereClause($params, FALSE); |
| 740 | |
| 741 | //$this->pagerAToZ( $whereClause, $params ); |
| 742 | |
| 743 | if (!empty($params['rowCount']) && |
| 744 | $params['rowCount'] > 0 |
| 745 | ) { |
| 746 | $limit = " LIMIT {$params['offset']}, {$params['rowCount']} "; |
| 747 | } |
| 748 | |
| 749 | $orderBy = ' ORDER BY groups.title asc'; |
| 750 | if (!empty($params['sort'])) { |
| 751 | $orderBy = ' ORDER BY ' . CRM_Utils_Type::escape($params['sort'], 'String'); |
| 752 | } |
| 753 | |
| 754 | $select = $from = $where = ""; |
| 755 | $groupOrg = FALSE; |
| 756 | if (CRM_Core_Permission::check('administer Multiple Organizations') && |
| 757 | CRM_Core_Permission::isMultisiteEnabled() |
| 758 | ) { |
| 759 | $select = ", contact.display_name as org_name, contact.id as org_id"; |
| 760 | $from = " LEFT JOIN civicrm_group_organization gOrg |
| 761 | ON gOrg.group_id = groups.id |
| 762 | LEFT JOIN civicrm_contact contact |
| 763 | ON contact.id = gOrg.organization_id "; |
| 764 | |
| 765 | //get the Organization ID |
| 766 | $orgID = CRM_Utils_Request::retrieve('oid', 'Positive', CRM_Core_DAO::$_nullObject); |
| 767 | if ($orgID) { |
| 768 | $where = " AND gOrg.organization_id = {$orgID}"; |
| 769 | } |
| 770 | |
| 771 | $groupOrg = TRUE; |
| 772 | } |
| 773 | |
| 774 | $query = " |
| 775 | SELECT groups.*, createdBy.sort_name as created_by {$select} |
| 776 | FROM civicrm_group groups |
| 777 | LEFT JOIN civicrm_contact createdBy |
| 778 | ON createdBy.id = groups.created_id |
| 779 | {$from} |
| 780 | WHERE $whereClause {$where} |
| 781 | {$orderBy} |
| 782 | {$limit}"; |
| 783 | |
| 784 | $object = CRM_Core_DAO::executeQuery($query, $params, TRUE, 'CRM_Contact_DAO_Group'); |
| 785 | |
| 786 | //FIXME CRM-4418, now we are handling delete separately |
| 787 | //if we introduce 'delete for group' make sure to handle here. |
| 788 | $groupPermissions = array(CRM_Core_Permission::VIEW); |
| 789 | if (CRM_Core_Permission::check('edit groups')) { |
| 790 | $groupPermissions[] = CRM_Core_Permission::EDIT; |
| 791 | $groupPermissions[] = CRM_Core_Permission::DELETE; |
| 792 | } |
| 793 | |
| 794 | // CRM-9936 |
| 795 | $reservedPermission = CRM_Core_Permission::check('administer reserved groups'); |
| 796 | |
| 797 | $links = self::actionLinks(); |
| 798 | |
| 799 | $allTypes = CRM_Core_OptionGroup::values('group_type'); |
| 800 | $values = array(); |
| 801 | |
| 802 | while ($object->fetch()) { |
| 803 | $permission = CRM_Contact_BAO_Group::checkPermission($object->id, $object->title); |
| 804 | //@todo CRM-12209 introduced an ACL check in the whereClause function |
| 805 | // it may be that this checking is now obsolete - or that what remains |
| 806 | // should be removed to the whereClause (which is also accessed by getCount) |
| 807 | |
| 808 | if ($permission) { |
| 809 | $newLinks = $links; |
| 810 | $values[$object->id] = array(); |
| 811 | CRM_Core_DAO::storeValues($object, $values[$object->id]); |
| 812 | if ($object->saved_search_id) { |
| 813 | $values[$object->id]['title'] .= ' (' . ts('Smart Group') . ')'; |
| 814 | // check if custom search, if so fix view link |
| 815 | $customSearchID = CRM_Core_DAO::getFieldValue( |
| 816 | 'CRM_Contact_DAO_SavedSearch', |
| 817 | $object->saved_search_id, |
| 818 | 'search_custom_id' |
| 819 | ); |
| 820 | |
| 821 | if ($customSearchID) { |
| 822 | $newLinks[CRM_Core_Action::VIEW]['url'] = 'civicrm/contact/search/custom'; |
| 823 | $newLinks[CRM_Core_Action::VIEW]['qs'] = "reset=1&force=1&ssID={$object->saved_search_id}"; |
| 824 | } |
| 825 | } |
| 826 | |
| 827 | $action = array_sum(array_keys($newLinks)); |
| 828 | |
| 829 | // CRM-9936 |
| 830 | if (array_key_exists('is_reserved', $object)) { |
| 831 | //if group is reserved and I don't have reserved permission, suppress delete/edit |
| 832 | if ($object->is_reserved && !$reservedPermission) { |
| 833 | $action -= CRM_Core_Action::DELETE; |
| 834 | $action -= CRM_Core_Action::UPDATE; |
| 835 | $action -= CRM_Core_Action::DISABLE; |
| 836 | } |
| 837 | } |
| 838 | |
| 839 | $values[$object->id]['class'] = ''; |
| 840 | if (array_key_exists('is_active', $object)) { |
| 841 | if ($object->is_active) { |
| 842 | $action -= CRM_Core_Action::ENABLE; |
| 843 | } |
| 844 | else { |
| 845 | $values[$object->id]['class'] = 'disabled'; |
| 846 | $action -= CRM_Core_Action::VIEW; |
| 847 | $action -= CRM_Core_Action::DISABLE; |
| 848 | } |
| 849 | } |
| 850 | |
| 851 | $action = $action & CRM_Core_Action::mask($groupPermissions); |
| 852 | |
| 853 | $values[$object->id]['visibility'] = CRM_Contact_DAO_Group::tsEnum('visibility', |
| 854 | $values[$object->id]['visibility'] |
| 855 | ); |
| 856 | if (isset($values[$object->id]['group_type'])) { |
| 857 | $groupTypes = explode(CRM_Core_DAO::VALUE_SEPARATOR, |
| 858 | substr($values[$object->id]['group_type'], 1, -1) |
| 859 | ); |
| 860 | $types = array(); |
| 861 | foreach ($groupTypes as $type) { |
| 862 | $types[] = CRM_Utils_Array::value($type, $allTypes); |
| 863 | } |
| 864 | $values[$object->id]['group_type'] = implode(', ', $types); |
| 865 | } |
| 866 | $values[$object->id]['action'] = CRM_Core_Action::formLink($newLinks, |
| 867 | $action, |
| 868 | array( |
| 869 | 'id' => $object->id, |
| 870 | 'ssid' => $object->saved_search_id, |
| 871 | ) |
| 872 | ); |
| 873 | |
| 874 | // If group has children, add class for link to view children |
| 875 | $values[$object->id]['is_parent'] = false; |
| 876 | if (array_key_exists('children', $values[$object->id])) { |
| 877 | $values[$object->id]['class'] = "crm-group-parent"; |
| 878 | $values[$object->id]['is_parent'] = true; |
| 879 | } |
| 880 | |
| 881 | // If group is a child, add child class |
| 882 | if (array_key_exists('parents', $values[$object->id])) { |
| 883 | $values[$object->id]['class'] = "crm-group-child"; |
| 884 | } |
| 885 | |
| 886 | if (array_key_exists('children', $values[$object->id]) |
| 887 | && array_key_exists('parents', $values[$object->id])) { |
| 888 | $values[$object->id]['class'] = "crm-group-child crm-group-parent"; |
| 889 | } |
| 890 | |
| 891 | if ($groupOrg) { |
| 892 | if ($object->org_id) { |
| 893 | $contactUrl = CRM_Utils_System::url('civicrm/contact/view', "reset=1&cid={$object->org_id}"); |
| 894 | $values[$object->id]['org_info'] = "<a href='{$contactUrl}'>{$object->org_name}</a>"; |
| 895 | } |
| 896 | else { |
| 897 | $values[$object->id]['org_info'] = ''; // Empty cell |
| 898 | } |
| 899 | } |
| 900 | else { |
| 901 | $values[$object->id]['org_info'] = NULL; // Collapsed column if all cells are NULL |
| 902 | } |
| 903 | if ($object->created_id) { |
| 904 | $contactUrl = CRM_Utils_System::url('civicrm/contact/view', "reset=1&cid={$object->created_id}"); |
| 905 | $values[$object->id]['created_by'] = "<a href='{$contactUrl}'>{$object->created_by}</a>"; |
| 906 | } |
| 907 | } |
| 908 | } |
| 909 | |
| 910 | return $values; |
| 911 | } |
| 912 | |
| 913 | /** |
| 914 | * This function to get hierarchical list of groups (parent followed by children) |
| 915 | * |
| 916 | * @param array $groupIDs array of group ids |
| 917 | * |
| 918 | * @access public |
| 919 | */ |
| 920 | static function getGroupsHierarchy ( |
| 921 | $groupIDs, |
| 922 | $parents = NULL, |
| 923 | $spacer = '<span class="child-indent"></span>', |
| 924 | $titleOnly = FALSE |
| 925 | ) { |
| 926 | if (empty($groupIDs)) { |
| 927 | return array(); |
| 928 | } |
| 929 | |
| 930 | $groupIdString = '(' . implode(',', array_keys($groupIDs)) . ')'; |
| 931 | // <span class="child-icon"></span> |
| 932 | // need to return id, title (w/ spacer), description, visibility |
| 933 | |
| 934 | // We need to build a list of tags ordered by hierarchy and sorted by |
| 935 | // name. The heirarchy will be communicated by an accumulation of |
| 936 | // separators in front of the name to give it a visual offset. |
| 937 | // Instead of recursively making mysql queries, we'll make one big |
| 938 | // query and build the heirarchy with the algorithm below. |
| 939 | $groups = array(); |
| 940 | $args = array(1 => array($groupIdString, 'String')); |
| 941 | $query = " |
| 942 | SELECT id, title, description, visibility, parents |
| 943 | FROM civicrm_group |
| 944 | WHERE id IN $groupIdString |
| 945 | "; |
| 946 | if ($parents) { |
| 947 | // group can have > 1 parent so parents may be comma separated list (eg. '1,2,5'). We just grab and match on 1st parent. |
| 948 | $parentArray = explode(',', $parents); |
| 949 | $parent = $parentArray[0]; |
| 950 | $args[2] = array($parent, 'Integer'); |
| 951 | $query .= " AND SUBSTRING_INDEX(parents, ',', 1) = %2"; |
| 952 | } |
| 953 | $query .= " ORDER BY title"; |
| 954 | $dao = CRM_Core_DAO::executeQuery($query, $args); |
| 955 | |
| 956 | // Sort the groups into the correct storage by the parent |
| 957 | // $roots represent the current leaf nodes that need to be checked for |
| 958 | // children. $rows represent the unplaced nodes |
| 959 | $roots = $rows = $allGroups = array(); |
| 960 | while ($dao->fetch()) { |
| 961 | $allGroups[$dao->id] = array('title' => $dao->title, |
| 962 | 'visibility' => $dao->visibility, |
| 963 | 'description' => $dao->description); |
| 964 | |
| 965 | if ($dao->parents == $parents) { |
| 966 | $roots[] = array('id' => $dao->id, |
| 967 | 'prefix' => '', |
| 968 | 'title' => $dao->title); |
| 969 | } |
| 970 | else { |
| 971 | // group can have > 1 parent so $dao->parents may be comma separated list (eg. '1,2,5'). Grab and match on 1st parent. |
| 972 | $parentArray = explode(',', $dao->parents); |
| 973 | $parent = $parentArray[0]; |
| 974 | $rows[] = array('id' => $dao->id, |
| 975 | 'prefix' => '', |
| 976 | 'title' => $dao->title, |
| 977 | 'parents' => $parent); |
| 978 | } |
| 979 | } |
| 980 | $dao->free(); |
| 981 | // While we have nodes left to build, shift the first (alphabetically) |
| 982 | // node of the list, place it in our groups list and loop through the |
| 983 | // list of unplaced nodes to find its children. We make a copy to |
| 984 | // iterate through because we must modify the unplaced nodes list |
| 985 | // during the loop. |
| 986 | while (count($roots)) { |
| 987 | $new_roots = array(); |
| 988 | $current_rows = $rows; |
| 989 | $root = array_shift($roots); |
| 990 | $groups[$root['id']] = array($root['prefix'], $root['title']); |
| 991 | |
| 992 | // As you find the children, append them to the end of the new set |
| 993 | // of roots (maintain alphabetical ordering). Also remove the node |
| 994 | // from the set of unplaced nodes. |
| 995 | if (is_array($current_rows)) { |
| 996 | foreach ($current_rows as $key => $row) { |
| 997 | if ($row['parents'] == $root['id']) { |
| 998 | $new_roots[] = array('id' => $row['id'], 'prefix' => $groups[$root['id']][0] . $spacer, 'title' => $row['title']); |
| 999 | unset($rows[$key]); |
| 1000 | } |
| 1001 | } |
| 1002 | } |
| 1003 | |
| 1004 | //As a group, insert the new roots into the beginning of the roots |
| 1005 | //list. This maintains the hierarchical ordering of the tags. |
| 1006 | $roots = array_merge($new_roots, $roots); |
| 1007 | } |
| 1008 | |
| 1009 | // Prefix titles with the calcuated spacing to give the visual |
| 1010 | // appearance of ordering when transformed into HTML in the form layer. Add description and visibility. |
| 1011 | $groupsReturn = array(); |
| 1012 | foreach ($groups as $key=>$value) { |
| 1013 | if ($titleOnly) { |
| 1014 | $groupsReturn[$key] = $value[0] . $value[1]; |
| 1015 | } else { |
| 1016 | $groupsReturn[$key] = array( |
| 1017 | 'title' => $value[0] . $value[1], |
| 1018 | 'description' => $allGroups[$key]['description'], |
| 1019 | 'visibility' => $allGroups[$key]['visibility'], |
| 1020 | ); |
| 1021 | } |
| 1022 | } |
| 1023 | |
| 1024 | return $groupsReturn; |
| 1025 | } |
| 1026 | |
| 1027 | static function getGroupCount(&$params) { |
| 1028 | $whereClause = self::whereClause($params, FALSE); |
| 1029 | $query = "SELECT COUNT(*) FROM civicrm_group groups"; |
| 1030 | |
| 1031 | if (CRM_Utils_Array::value('created_by', $params)) { |
| 1032 | $query .= " |
| 1033 | INNER JOIN civicrm_contact createdBy |
| 1034 | ON createdBy.id = groups.created_id"; |
| 1035 | } |
| 1036 | $query .= " |
| 1037 | WHERE {$whereClause}"; |
| 1038 | return CRM_Core_DAO::singleValueQuery($query, $params); |
| 1039 | } |
| 1040 | |
| 1041 | function whereClause(&$params, $sortBy = TRUE, $excludeHidden = TRUE) { |
| 1042 | $values = array(); |
| 1043 | $clauses = array(); |
| 1044 | |
| 1045 | $title = CRM_Utils_Array::value('title', $params); |
| 1046 | if ($title) { |
| 1047 | $clauses[] = "groups.title LIKE %1"; |
| 1048 | if (strpos($title, '%') !== FALSE) { |
| 1049 | $params[1] = array($title, 'String', FALSE); |
| 1050 | } |
| 1051 | else { |
| 1052 | $params[1] = array($title, 'String', TRUE); |
| 1053 | } |
| 1054 | } |
| 1055 | |
| 1056 | $groupType = CRM_Utils_Array::value('group_type', $params); |
| 1057 | if ($groupType) { |
| 1058 | $types = explode(',', $groupType); |
| 1059 | if (!empty($types)) { |
| 1060 | $clauses[] = 'groups.group_type LIKE %2'; |
| 1061 | $typeString = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR, $types) . CRM_Core_DAO::VALUE_SEPARATOR; |
| 1062 | $params[2] = array($typeString, 'String', TRUE); |
| 1063 | } |
| 1064 | } |
| 1065 | |
| 1066 | $visibility = CRM_Utils_Array::value('visibility', $params); |
| 1067 | if ($visibility) { |
| 1068 | $clauses[] = 'groups.visibility = %3'; |
| 1069 | $params[3] = array($visibility, 'String'); |
| 1070 | } |
| 1071 | |
| 1072 | $groupStatus = CRM_Utils_Array::value('status', $params); |
| 1073 | if ($groupStatus) { |
| 1074 | switch ($groupStatus) { |
| 1075 | case 1: |
| 1076 | $clauses[] = 'groups.is_active = 1'; |
| 1077 | $params[4] = array($groupStatus, 'Integer'); |
| 1078 | break; |
| 1079 | |
| 1080 | case 2: |
| 1081 | $clauses[] = 'groups.is_active = 0'; |
| 1082 | $params[4] = array($groupStatus, 'Integer'); |
| 1083 | break; |
| 1084 | |
| 1085 | case 3: |
| 1086 | $clauses[] = '(groups.is_active = 0 OR groups.is_active = 1 )'; |
| 1087 | break; |
| 1088 | } |
| 1089 | } |
| 1090 | |
| 1091 | $parentsOnly = CRM_Utils_Array::value('parentsOnly', $params); |
| 1092 | if ($parentsOnly) { |
| 1093 | $clauses[] = 'groups.parents IS NULL'; |
| 1094 | } |
| 1095 | |
| 1096 | // only show child groups of a specific parent group |
| 1097 | $parent_id = CRM_Utils_Array::value('parent_id', $params); |
| 1098 | if ($parent_id) { |
| 1099 | $clauses[] = 'groups.id IN (SELECT child_group_id FROM civicrm_group_nesting WHERE parent_group_id = %5)'; |
| 1100 | $params[5] = array($parent_id, 'Integer'); |
| 1101 | } |
| 1102 | |
| 1103 | if ($createdBy = CRM_Utils_Array::value('created_by', $params)) { |
| 1104 | $clauses[] = "createdBy.sort_name LIKE %6"; |
| 1105 | if (strpos($createdBy, '%') !== FALSE) { |
| 1106 | $params[6] = array($createdBy, 'String', FALSE); |
| 1107 | } |
| 1108 | else { |
| 1109 | $params[6] = array($createdBy, 'String', TRUE); |
| 1110 | } |
| 1111 | } |
| 1112 | |
| 1113 | /* |
| 1114 | if ( $sortBy && |
| 1115 | $this->_sortByCharacter !== null ) { |
| 1116 | $clauses[] = |
| 1117 | "groups.title LIKE '" . |
| 1118 | strtolower(CRM_Core_DAO::escapeWildCardString($this->_sortByCharacter)) . |
| 1119 | "%'"; |
| 1120 | } |
| 1121 | |
| 1122 | // dont do a the below assignement when doing a |
| 1123 | // AtoZ pager clause |
| 1124 | if ( $sortBy ) { |
| 1125 | if ( count( $clauses ) > 1 ) { |
| 1126 | $this->assign( 'isSearch', 1 ); |
| 1127 | } else { |
| 1128 | $this->assign( 'isSearch', 0 ); |
| 1129 | } |
| 1130 | } |
| 1131 | */ |
| 1132 | |
| 1133 | |
| 1134 | if (empty($clauses)) { |
| 1135 | $clauses[] = 'groups.is_active = 1'; |
| 1136 | } |
| 1137 | |
| 1138 | if ($excludeHidden) { |
| 1139 | $clauses[] = 'groups.is_hidden = 0'; |
| 1140 | } |
| 1141 | //CRM-12209 |
| 1142 | if (!CRM_Core_Permission::check('view all contacts')) { |
| 1143 | //get the allowed groups for the current user |
| 1144 | $groups = CRM_ACL_API::group(CRM_ACL_API::VIEW); |
| 1145 | if (!empty( $groups)) { |
| 1146 | $groupList = implode( ', ', array_values( $groups ) ); |
| 1147 | $clauses[] = "groups.id IN ( $groupList ) "; |
| 1148 | } |
| 1149 | } |
| 1150 | |
| 1151 | return implode(' AND ', $clauses); |
| 1152 | } |
| 1153 | |
| 1154 | /** |
| 1155 | * Function to define action links |
| 1156 | * |
| 1157 | * @return array $links array of action links |
| 1158 | * @access public |
| 1159 | */ |
| 1160 | static function actionLinks() { |
| 1161 | $links = array( |
| 1162 | CRM_Core_Action::VIEW => array( |
| 1163 | 'name' => ts('Contacts'), |
| 1164 | 'url' => 'civicrm/group/search', |
| 1165 | 'qs' => 'reset=1&force=1&context=smog&gid=%%id%%', |
| 1166 | 'title' => ts('Group Contacts'), |
| 1167 | ), |
| 1168 | CRM_Core_Action::UPDATE => array( |
| 1169 | 'name' => ts('Settings'), |
| 1170 | 'url' => 'civicrm/group', |
| 1171 | 'qs' => 'reset=1&action=update&id=%%id%%', |
| 1172 | 'title' => ts('Edit Group'), |
| 1173 | ), |
| 1174 | CRM_Core_Action::DISABLE => array( |
| 1175 | 'name' => ts('Disable'), |
| 1176 | 'extra' => 'onclick = "enableDisable( %%id%%,\'' . 'CRM_Contact_BAO_Group' . '\',\'' . 'enable-disable' . '\' );"', |
| 1177 | 'ref' => 'disable-action', |
| 1178 | 'title' => ts('Disable Group'), |
| 1179 | ), |
| 1180 | CRM_Core_Action::ENABLE => array( |
| 1181 | 'name' => ts('Enable'), |
| 1182 | 'extra' => 'onclick = "enableDisable( %%id%%,\'' . 'CRM_Contact_BAO_Group' . '\',\'' . 'disable-enable' . '\' );"', |
| 1183 | 'ref' => 'enable-action', |
| 1184 | 'title' => ts('Enable Group'), |
| 1185 | ), |
| 1186 | CRM_Core_Action::DELETE => array( |
| 1187 | 'name' => ts('Delete'), |
| 1188 | 'url' => 'civicrm/group', |
| 1189 | 'qs' => 'reset=1&action=delete&id=%%id%%', |
| 1190 | 'title' => ts('Delete Group'), |
| 1191 | ), |
| 1192 | ); |
| 1193 | |
| 1194 | return $links; |
| 1195 | } |
| 1196 | |
| 1197 | function pagerAtoZ($whereClause, $whereParams) { |
| 1198 | $query = " |
| 1199 | SELECT DISTINCT UPPER(LEFT(groups.title, 1)) as sort_name |
| 1200 | FROM civicrm_group groups |
| 1201 | WHERE $whereClause |
| 1202 | ORDER BY LEFT(groups.title, 1) |
| 1203 | "; |
| 1204 | $dao = CRM_Core_DAO::executeQuery($query, $whereParams); |
| 1205 | |
| 1206 | return CRM_Utils_PagerAToZ::getAToZBar($dao, $this->_sortByCharacter, TRUE); |
| 1207 | } |
| 1208 | } |
| 1209 | |