Issue template - Small tweak

[civicrm-core.git] / CRM / ACL / BAO / Cache.php

diff --git a/CRM/ACL/BAO/Cache.php b/CRM/ACL/BAO/Cache.php
index 2884ce8d68272e6fc910c44151f2337fb1ed9dbc..9e68e38bf0bd3764364717f7adbbf6787d478fd8 100644 (file)
--- a/CRM/ACL/BAO/Cache.php
+++ b/CRM/ACL/BAO/Cache.php
@@ -34,18 +34,19 @@
 /**
  *  Access Control Cache.
  */
-class CRM_ACL_BAO_Cache extends CRM_ACL_DAO_Cache {
+class CRM_ACL_BAO_Cache extends CRM_ACL_DAO_ACLCache {
 
-  static $_cache = NULL;
+  public static $_cache = NULL;
 
   /**
-   * @param int $id
+   * Build an array of ACLs for a specific ACLed user
+   * @param int $id - contact_id of the ACLed user
    *
    * @return mixed
    */
   public static function &build($id) {
     if (!self::$_cache) {
-      self::$_cache = array();
+      self::$_cache = [];
     }
 
     if (array_key_exists($id, self::$_cache)) {
@@ -75,7 +76,7 @@ SELECT acl_id
   FROM civicrm_acl_cache
  WHERE contact_id = %1
 ";
-    $params = array(1 => array($id, 'Integer'));
+    $params = [1 => [$id, 'Integer']];
 
     if ($id == 0) {
       $query .= " OR contact_id IS NULL";
@@ -83,7 +84,7 @@ SELECT acl_id
 
     $dao = CRM_Core_DAO::executeQuery($query, $params);
 
-    $cache = array();
+    $cache = [];
     while ($dao->fetch()) {
       $cache[$dao->acl_id] = 1;
     }
@@ -91,12 +92,14 @@ SELECT acl_id
   }
 
   /**
-   * @param int $id
-   * @param array $cache
+   * Store ACLs for a specific user in the `civicrm_acl_cache` table
+   * @param int $id - contact_id of the ACLed user
+   * @param array $cache - key civicrm_acl.id - values is the details of the ACL.
+   *
    */
   public static function store($id, &$cache) {
     foreach ($cache as $aclID => $data) {
-      $dao = new CRM_ACL_DAO_Cache();
+      $dao = new CRM_ACL_BAO_Cache();
       if ($id) {
         $dao->contact_id = $id;
       }
@@ -109,7 +112,9 @@ SELECT acl_id
   }
 
   /**
-   * @param int $id
+   * Remove entries from civicrm_acl_cache for a specified ACLed user
+   * @param int $id - contact_id of the ACLed user
+   *
    */
   public static function deleteEntry($id) {
     if (self::$_cache &&
@@ -122,12 +127,14 @@ SELECT acl_id
 DELETE FROM civicrm_acl_cache
 WHERE contact_id = %1
 ";
-    $params = array(1 => array($id, 'Integer'));
+    $params = [1 => [$id, 'Integer']];
     CRM_Core_DAO::executeQuery($query, $params);
   }
 
   /**
-   * @param int $id
+   * Update ACL caches `civicrm_acl_cache` and `civicrm_acl_contact_cache for the specified ACLed user
+   * @param int $id - contact_id of ACLed user to update caches for.
+   *
    */
   public static function updateEntry($id) {
     // rebuilds civicrm_acl_cache
@@ -154,7 +161,12 @@ FROM   civicrm_acl_cache
 WHERE  modified_date IS NULL
    OR  (modified_date <= %1)
 ";
-    $params = array(1 => array(CRM_Contact_BAO_GroupContactCache::getCacheInvalidDateTime(), 'String'));
+    $params = [
+      1 => [
+        CRM_Contact_BAO_GroupContactCache::getCacheInvalidDateTime(),
+        'String',
+      ],
+    ];
     CRM_Core_DAO::singleValueQuery($query, $params);
 
     // CRM_Core_DAO::singleValueQuery("TRUNCATE TABLE civicrm_acl_contact_cache"); // No, force-commits transaction
@@ -169,4 +181,13 @@ WHERE  modified_date IS NULL
     }
   }
 
+  /**
+   * Remove Entries from `civicrm_acl_contact_cache` for a specific ACLed user
+   * @param int $userID - contact_id of the ACLed user
+   *
+   */
+  public static function deleteContactCacheEntry($userID) {
+    CRM_Core_DAO::executeQuery("DELETE FROM civicrm_acl_contact_cache WHERE user_id = %1", [1 => [$userID, 'Positive']]);
+  }
+
 }