CRM-12466
authorDonald A. Lobo <lobo@civicrm.org>
Mon, 26 Aug 2013 17:15:46 +0000 (10:15 -0700)
committerDonald A. Lobo <lobo@civicrm.org>
Mon, 26 Aug 2013 17:15:46 +0000 (10:15 -0700)
----------------------------------------
* CRM-12466: Group listings don't load
  http://issues.civicrm.org/jira/browse/CRM-12466

CRM/Contact/BAO/GroupContactCache.php

index f36dd5f0f1665ab6b47980daefa7e2f3a47c4dd7..90b2cdd62ff403c2cd77cc0f6b5833f5b6df0d7e 100644 (file)
@@ -249,6 +249,21 @@ WHERE  id IN ( $groupIDs )
     CRM_Core_DAO::executeQuery($sql);
   }
 
+  /**
+   * Removes all the cache entries pertaining to a specific group
+   * If no groupID is passed in, removes cache entries for all groups
+   * Has an optimization to bypass repeated invocations of this function.
+   * Note that this function is an advisory, i.e. the removal respects the
+   * cache date, i.e. the removal is not done if the group was recently
+   * loaded into the cache.
+   *
+   * @param $groupID  int the groupID to delete cache entries, NULL for all groups
+   * @param $onceOnly boolean run the function exactly once for all groups.
+   *
+   * @public
+   * @return void
+   * @static
+   */
   static function remove($groupID = NULL, $onceOnly = TRUE) {
     static $invoked = FALSE;