CRM-16642 - Rename `refreshCache` to `flushCache`

The old name is misleading about the outcome -- it does not end up producing
a 'fresh' cache.  It produces an empty cache.

diff --git a/CRM/Activity/BAO/Activity.php b/CRM/Activity/BAO/Activity.php
index d4027444e5ecb35f7afd6faec2b721862a134a0e..b5dbd4a44081ee1f53b2a564f6ed71cbafd2e793 100644 (file)
--- a/CRM/Activity/BAO/Activity.php
+++ b/CRM/Activity/BAO/Activity.php
@@ -584,7 +584,7 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity {
       }
     }
 
-    CRM_Contact_BAO_GroupContactCache::opportunisticCacheRefresh();
+    CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
 
     if (!empty($params['id'])) {
       CRM_Utils_Hook::post('edit', 'Activity', $activity->id, $activity);

diff --git a/CRM/Contact/BAO/Contact.php b/CRM/Contact/BAO/Contact.php
index 0e9dc2b34b3a7a7dc3db1d03b3d86e0f34d8cd57..aa10293b5719736bda778082089c5e03e349b3ee 100644 (file)
--- a/CRM/Contact/BAO/Contact.php
+++ b/CRM/Contact/BAO/Contact.php
@@ -935,7 +935,7 @@ WHERE     civicrm_contact.id = " . CRM_Utils_Type::escape($id, 'Integer');
       CRM_Core_DAO::executeQuery('DELETE FROM civicrm_acl_contact_cache WHERE contact_id = %1', array(1 => array($contactID, 'Integer')));
     }
     else {
-      CRM_Contact_BAO_GroupContactCache::opportunisticCacheRefresh();
+      CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
     }
   }
 
@@ -1932,7 +1932,7 @@ ORDER BY civicrm_email.is_primary DESC";
       CRM_Contact_BAO_GroupContact::addContactsToGroup($contactIds, $addToGroupID);
     }
 
-    CRM_Contact_BAO_GroupContactCache::opportunisticCacheRefresh();
+    CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
 
     if ($editHook) {
       CRM_Utils_Hook::post('edit', 'Profile', $contactID, $params);

diff --git a/CRM/Contact/BAO/Contact/Utils.php b/CRM/Contact/BAO/Contact/Utils.php
index 5eaf2fa867827d66b43a8ad0d5de91276b867614..84e0c605374bd650525522efa56632106f7edede 100644 (file)
--- a/CRM/Contact/BAO/Contact/Utils.php
+++ b/CRM/Contact/BAO/Contact/Utils.php
@@ -910,7 +910,7 @@ Group By  componentId";
       CRM_Core_BAO_PrevNextCache::deleteItem();
     }
 
-    CRM_Contact_BAO_GroupContactCache::opportunisticCacheRefresh();
+    CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
   }
 
   /**

diff --git a/CRM/Contact/BAO/GroupContact.php b/CRM/Contact/BAO/GroupContact.php
index 654b4513809ef19669d6c98ee90dbf4738a6aec0..78722e001bd9eae1afc15d874f23dc158716aa64 100644 (file)
--- a/CRM/Contact/BAO/GroupContact.php
+++ b/CRM/Contact/BAO/GroupContact.php
@@ -148,7 +148,7 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact {
 
     // reset the group contact cache for all group(s)
     // if this group is being used as a smart group
-    CRM_Contact_BAO_GroupContactCache::opportunisticCacheRefresh();
+    CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
 
     CRM_Utils_Hook::post('create', 'GroupContact', $groupId, $contactIds);
 
@@ -252,7 +252,7 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact {
     // if this group is being used as a smart group
     // @todo consider what to do here - it feels like we should either
     // 1) just invalidate the specific group's cache(& perhaps any parents) & let cron do it's thing or
-    // possibly clear this specific groups cache, or just call opportunisticCacheRefresh() - which would have the
+    // possibly clear this specific groups cache, or just call opportunisticCacheFlush() - which would have the
     // same effect as the remove call. The reservation about that is that it is no more aggressive for the group that
     // we know is altered than for all the others, or perhaps, more the point with it's parents & groups that use it in
     // their criteria.

diff --git a/CRM/Contact/BAO/GroupContactCache.php b/CRM/Contact/BAO/GroupContactCache.php
index febcee0e9781d751af242bbaff06f15ebe047b17..4b0ca89b864a2a04c8e273b87b85f8bf6a9c7d05 100644 (file)
--- a/CRM/Contact/BAO/GroupContactCache.php
+++ b/CRM/Contact/BAO/GroupContactCache.php
@@ -416,7 +416,7 @@ WHERE  id = %1
    * This function should be called via the opportunistic or deterministic cache refresh function to make the intent
    * clear.
    */
-  protected static function refreshCaches() {
+  protected static function flushCaches() {
     try {
       $lock = self::getLockForRefresh();
     }
@@ -492,9 +492,9 @@ WHERE  id = %1
    * Sites that do not run the smart group clearing cron job should refresh the caches under an opportunistic mode, akin
    * to a poor man's cron. The user session will be forced to wait on this so it is less desirable.
    */
-  public static function opportunisticCacheRefresh() {
+  public static function opportunisticCacheFlush() {
     if (Civi::settings()->get('smart_group_cache_refresh_mode') == 'opportunistic') {
-      self::refreshCaches();
+      self::flushCaches();
     }
   }
 
@@ -503,7 +503,7 @@ WHERE  id = %1
    *
    * This function is appropriate to be called by system jobs & non-user sessions.
    */
-  public static function deterministicCacheRefresh() {
+  public static function deterministicCacheFlush() {
     if (self::smartGroupCacheTimeout() == 0) {
       CRM_Core_DAO::executeQuery("TRUNCATE civicrm_group_contact_cache");
       CRM_Core_DAO::executeQuery("
@@ -511,7 +511,7 @@ WHERE  id = %1
         SET cache_date = null, refresh_date = null");
     }
     else {
-      self::refreshCaches();
+      self::flushCaches();
     }
   }
 

diff --git a/CRM/Contact/Form/CustomData.php b/CRM/Contact/Form/CustomData.php
index 187d5fdbb6aa9f10fe7bb4553478db9eff8ab5db..bbb3c4e09014990acbac9282eca978d22048c521 100644 (file)
--- a/CRM/Contact/Form/CustomData.php
+++ b/CRM/Contact/Form/CustomData.php
@@ -309,7 +309,7 @@ class CRM_Contact_Form_CustomData extends CRM_Core_Form {
       $this->ajaxResponse += CRM_Contact_Form_Inline::renderFooter($this->_tableID);
     }
 
-    CRM_Contact_BAO_GroupContactCache::opportunisticCacheRefresh();
+    CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
   }
 
 }

diff --git a/CRM/Contact/Form/Inline/CustomData.php b/CRM/Contact/Form/Inline/CustomData.php
index a21e5e14971e6a1ff80d6e12af5eafb1d6cded57..0c7d4630270c34751679d4b9f5a87c996025c361 100644 (file)
--- a/CRM/Contact/Form/Inline/CustomData.php
+++ b/CRM/Contact/Form/Inline/CustomData.php
@@ -97,7 +97,7 @@ class CRM_Contact_Form_Inline_CustomData extends CRM_Contact_Form_Inline {
 
     $this->log();
 
-    CRM_Contact_BAO_GroupContactCache::opportunisticCacheRefresh();
+    CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
 
     $this->response();
   }

diff --git a/CRM/Contact/Page/AJAX.php b/CRM/Contact/Page/AJAX.php
index 00aa2051ee87203f658abd2418d83bf88439ee08..d39afc5da3b456c330493491b9c66dd999339c77 100644 (file)
--- a/CRM/Contact/Page/AJAX.php
+++ b/CRM/Contact/Page/AJAX.php
@@ -294,7 +294,7 @@ class CRM_Contact_Page_AJAX {
       echo CRM_Contact_BAO_Contact::getCountComponent('custom_' . $customGroupID, $contactId);
     }
 
-    CRM_Contact_BAO_GroupContactCache::opportunisticCacheRefresh();
+    CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
     CRM_Utils_System::civiExit();
   }
 

diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php
index 94a3388526e1761b67923cea09ad36b1c35faaf0..0508a7116d4871201ca0a2154d0a55221f497eac 100644 (file)
--- a/CRM/Contribute/BAO/Contribution.php
+++ b/CRM/Contribute/BAO/Contribution.php
@@ -212,7 +212,7 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution {
       );
     }
 
-    CRM_Contact_BAO_GroupContactCache::opportunisticCacheRefresh();
+    CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
 
     if ($contributionID) {
       CRM_Utils_Hook::post('edit', 'Contribution', $contribution->id, $contribution);

diff --git a/CRM/Core/BAO/EntityTag.php b/CRM/Core/BAO/EntityTag.php
index f3bed639a791adf4b4a10daa56ecef4db0b1921f..eec0888a27cae2bb0078166c2fbd41de0cdd78f3 100644 (file)
--- a/CRM/Core/BAO/EntityTag.php
+++ b/CRM/Core/BAO/EntityTag.php
@@ -168,7 +168,7 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag {
     $object = array($entityIdsAdded, $entityTable);
     CRM_Utils_Hook::post('create', 'EntityTag', $tagId, $object);
 
-    CRM_Contact_BAO_GroupContactCache::opportunisticCacheRefresh();
+    CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
 
     return array(count($entityIds), $numEntitiesAdded, $numEntitiesNotAdded);
   }
@@ -242,7 +242,7 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag {
     $object = array($entityIdsRemoved, $entityTable);
     CRM_Utils_Hook::post('delete', 'EntityTag', $tagId, $object);
 
-    CRM_Contact_BAO_GroupContactCache::opportunisticCacheRefresh();
+    CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
 
     return array(count($entityIds), $numEntitiesRemoved, $numEntitiesNotRemoved);
   }

diff --git a/CRM/Event/BAO/Participant.php b/CRM/Event/BAO/Participant.php
index d0b2b0f5d793036da906f0615df056a81e907319..622e96f82a4144ec8e778790b6c9c41f3e8ba28f 100644 (file)
--- a/CRM/Event/BAO/Participant.php
+++ b/CRM/Event/BAO/Participant.php
@@ -138,7 +138,7 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant {
 
     $session = CRM_Core_Session::singleton();
 
-    CRM_Contact_BAO_GroupContactCache::opportunisticCacheRefresh();
+    CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
 
     if (!empty($params['id'])) {
       CRM_Utils_Hook::post('edit', 'Participant', $participantBAO->id, $participantBAO);

diff --git a/CRM/Member/BAO/Membership.php b/CRM/Member/BAO/Membership.php
index 0e4333d5c7d1203e17a3f74b918890016e6614c9..fabd1cc20701663806efc52a6b85dc44543c16ba 100644 (file)
--- a/CRM/Member/BAO/Membership.php
+++ b/CRM/Member/BAO/Membership.php
@@ -137,7 +137,7 @@ class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership {
     CRM_Member_BAO_MembershipLog::add($membershipLog, CRM_Core_DAO::$_nullArray);
 
     // reset the group contact cache since smart groups might be affected due to this
-    CRM_Contact_BAO_GroupContactCache::opportunisticCacheRefresh();
+    CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
 
     if ($id) {
       if ($membership->status_id != $oldStatus) {

diff --git a/api/v3/Job.php b/api/v3/Job.php
index cfd2ff2396c4cce2e4cf88880b2a6544ac258ef0..da4eb0476300efc5e09595fffe864a5191788116 100644 (file)
--- a/api/v3/Job.php
+++ b/api/v3/Job.php
@@ -657,7 +657,7 @@ function civicrm_api3_job_group_rebuild($params) {
  * @throws \API_Exception
  */
 function civicrm_api3_job_group_cache_flush($params) {
-  CRM_Contact_BAO_GroupContactCache::deterministicCacheRefresh();
+  CRM_Contact_BAO_GroupContactCache::deterministicCacheFlush();
   return civicrm_api3_create_success();
 }
 

diff --git a/tests/phpunit/CRM/Contact/BAO/GroupContactCacheTest.php b/tests/phpunit/CRM/Contact/BAO/GroupContactCacheTest.php
index bd00ca58a7b3cd48f4fb5563615a394775929999..98aec5af51618ae19744ef07f4792922d27d25be 100644 (file)
--- a/tests/phpunit/CRM/Contact/BAO/GroupContactCacheTest.php
+++ b/tests/phpunit/CRM/Contact/BAO/GroupContactCacheTest.php
@@ -169,7 +169,7 @@ class CRM_Contact_BAO_GroupContactCacheTest extends CiviUnitTestCase {
       array($deceased[0]->id, $deceased[1]->id, $deceased[2]->id),
       $group->id
     );
-    CRM_Contact_BAO_GroupContactCache::opportunisticCacheRefresh();
+    CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
 
     $this->assertCacheNotRefreshed($deceased, $group);
   }
@@ -184,7 +184,7 @@ class CRM_Contact_BAO_GroupContactCacheTest extends CiviUnitTestCase {
     $group->find(TRUE);
     Civi::$statics['CRM_Contact_BAO_GroupContactCache']['is_refresh_init'] = FALSE;
     sleep(1);
-    CRM_Contact_BAO_GroupContactCache::opportunisticCacheRefresh();
+    CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
 
     $this->assertCacheRefreshed($group);
   }
@@ -197,7 +197,7 @@ class CRM_Contact_BAO_GroupContactCacheTest extends CiviUnitTestCase {
     $this->callAPISuccess('Setting', 'create', array('smart_group_cache_refresh_mode' => 'deterministic'));
     $this->callAPISuccess('Contact', 'create', array('id' => $deceased[0]->id, 'is_deceased' => 0));
     $this->makeCacheStale($group);
-    CRM_Contact_BAO_GroupContactCache::opportunisticCacheRefresh();
+    CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
     $this->assertCacheNotRefreshed($deceased, $group);
     $this->callAPISuccess('Setting', 'create', array('smart_group_cache_refresh_mode' => 'opportunistic'));
   }
@@ -210,7 +210,7 @@ class CRM_Contact_BAO_GroupContactCacheTest extends CiviUnitTestCase {
     $this->callAPISuccess('Setting', 'create', array('smart_group_cache_refresh_mode' => 'deterministic'));
     $this->callAPISuccess('Contact', 'create', array('id' => $deceased[0]->id, 'is_deceased' => 0));
     $this->makeCacheStale($group);
-    CRM_Contact_BAO_GroupContactCache::deterministicCacheRefresh();
+    CRM_Contact_BAO_GroupContactCache::deterministicCacheFlush();
     $this->assertCacheRefreshed($group);
     $this->callAPISuccess('Setting', 'create', array('smart_group_cache_refresh_mode' => 'opportunistic'));
   }
@@ -222,7 +222,7 @@ class CRM_Contact_BAO_GroupContactCacheTest extends CiviUnitTestCase {
     list($group, $living, $deceased) = $this->setupSmartGroup();
     $this->callAPISuccess('Setting', 'create', array('smart_group_cache_refresh_mode' => 'deterministic'));
     $this->callAPISuccess('Contact', 'create', array('id' => $deceased[0]->id, 'is_deceased' => 0));
-    CRM_Contact_BAO_GroupContactCache::deterministicCacheRefresh();
+    CRM_Contact_BAO_GroupContactCache::deterministicCacheFlush();
     $this->assertCacheNotRefreshed($deceased, $group);
     $this->callAPISuccess('Setting', 'create', array('smart_group_cache_refresh_mode' => 'opportunistic'));
   }
@@ -237,7 +237,7 @@ class CRM_Contact_BAO_GroupContactCacheTest extends CiviUnitTestCase {
     $this->callAPISuccess('Setting', 'create', array('smart_group_cache_refresh_mode' => 'opportunistic'));
     $this->callAPISuccess('Contact', 'create', array('id' => $deceased[0]->id, 'is_deceased' => 0));
     $this->makeCacheStale($group);
-    CRM_Contact_BAO_GroupContactCache::deterministicCacheRefresh();
+    CRM_Contact_BAO_GroupContactCache::deterministicCacheFlush();
     $this->assertCacheRefreshed($group);
   }