From d238d1bde4854218e04f333df95e8b24c72a0967 Mon Sep 17 00:00:00 2001
From: Ere Maijala <ere.maijala@helsinki.fi>
Date: Mon, 14 Oct 2024 16:13:18 +0300
Subject: [PATCH] Refactor.

---
 module/VuFind/src/VuFind/ILS/Connection.php | 58 ++++++++++++---------
 1 file changed, 34 insertions(+), 24 deletions(-)

diff --git a/module/VuFind/src/VuFind/ILS/Connection.php b/module/VuFind/src/VuFind/ILS/Connection.php
index 88f9a9568c7..e517cda46a8 100644
--- a/module/VuFind/src/VuFind/ILS/Connection.php
+++ b/module/VuFind/src/VuFind/ILS/Connection.php
@@ -1293,24 +1293,18 @@ public function callIlsWithFailover($methodName, $params)
     /**
      * Get data for an ILS method from shared or session cache
      *
-     * @param string $methodName The name of the called method.
-     * @param array  $params     Array of passed parameters.
+     * @param array $cacheSettings Cache settings
      *
      * @return ?array
      */
-    protected function getCachedData($methodName, $params)
+    protected function getCachedData(array $cacheSettings): ?array
     {
-        $cacheLifeTime = $this->cacheLifeTime[$methodName] ?? null;
-        $cacheStorage = $this->cacheStorage[$methodName] ?? null;
-        if (!$cacheLifeTime || !$cacheStorage) {
-            return null;
-        }
-        $cacheKey = $methodName . md5(serialize($params));
-        if ('shared' === $cacheStorage) {
+        $cacheKey = $cacheSettings['key'];
+        if ('shared' === $cacheSettings['storage']) {
             return $this->getSharedCachedData($cacheKey);
         }
         if ($this->sessionCache && ($entry = $this->sessionCache[$cacheKey] ?? null)) {
-            if (time() - $entry['ts'] <= $cacheLifeTime) {
+            if (time() - $entry['ts'] <= $cacheSettings['lifeTime']) {
                 return $entry['payload'];
             }
             unset($this->sessionCache[$cacheKey]);
@@ -1321,21 +1315,15 @@ protected function getCachedData($methodName, $params)
     /**
      * Put data for an ILS method to shared or session cache.
      *
-     * @param string $methodName The name of the called method.
-     * @param array  $params     Array of passed parameters.
-     * @param mixed  $data       Data to cache
+     * @param array $cacheSettings Cache settings
+     * @param array $data          Data to cache
      *
      * @return void
      */
-    protected function putCachedData($methodName, $params, $data): void
+    protected function putCachedData(array $cacheSettings, array $data): void
     {
-        $cacheLifeTime = $this->cacheLifeTime[$methodName] ?? null;
-        $cacheStorage = $this->cacheStorage[$methodName] ?? null;
-        if (!$cacheLifeTime || !$cacheStorage) {
-            return;
-        }
-        $cacheKey = $methodName . md5(serialize($params));
-        if ('shared' === $cacheStorage) {
+        $cacheKey = $cacheSettings['key'];
+        if ('shared' === $cacheSettings['storage']) {
             $this->putSharedCachedData($cacheKey, $data);
             return;
         }
@@ -1347,6 +1335,25 @@ protected function putCachedData($methodName, $params, $data): void
         }
     }
 
+    /**
+     * Get cache settings for a method
+     *
+     * @param string $methodName The name of the called method.
+     * @param array  $params     Array of passed parameters.
+     *
+     * @return ?array
+     */
+    protected function getCacheSettings($methodName, $params): ?array
+    {
+        $lifeTime = $this->cacheLifeTime[$methodName] ?? null;
+        $storage = $this->cacheStorage[$methodName] ?? null;
+        if (!$lifeTime || !$storage) {
+            return null;
+        }
+        $key = $methodName . md5(serialize($params));
+        return compact('lifeTime', 'storage', 'key');
+    }
+
     /**
      * Default method -- pass along calls to the driver if available; return
      * false otherwise. This allows custom functions to be implemented in
@@ -1363,13 +1370,16 @@ protected function putCachedData($methodName, $params, $data): void
      */
     public function __call($methodName, $params)
     {
+        $cacheSettings = $this->getCacheSettings($methodName, $params);
         // Note: The actual data is cached in an array so that we can differentiate
         // between a missing cache entry and null as a valid value.
-        if ($cached = $this->getCachedData($methodName, $params)) {
+        if ($cacheSettings && ($cached = $this->getCachedData($cacheSettings))) {
             return $cached['data'];
         }
         $data = $this->callIlsWithFailover($methodName, $params);
-        $this->putCachedData($methodName, $params, compact('data'));
+        if ($cacheSettings) {
+            $this->putCachedData($cacheSettings, compact('data'));
+        }
         return $data;
     }
 }