Fix a range of minor psalm issues

Signed-off-by: George Steel <[email protected]>
laminas · Jan 8, 2024 · 136c24e · 136c24e
1 parent ff7aa3c
commit 136c24e
Show file tree

Hide file tree

Showing 10 changed files with 185 additions and 242 deletions.
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
diff --git a/src/AbstractContainer.php b/src/AbstractContainer.php
@@ -392,16 +392,16 @@ protected function expireByHops(Storage $storage, $name, $key)
     /**
      * Store a value within the container
      *
-     * @param  string $key
+     * @param  string $offset
      * @param  mixed  $value
      * @return void
      */
-    public function offsetSet($key, $value)
+    public function offsetSet($offset, $value)
     {
-        $this->expireKeys($key);
-        $storage              = $this->verifyNamespace();
-        $name                 = $this->getName();
-        $storage[$name][$key] = $value;
+        $this->expireKeys($offset);
+        $storage                 = $this->verifyNamespace();
+        $name                    = $this->getName();
+        $storage[$name][$offset] = $value;
     }
 
     /**

diff --git a/src/SaveHandler/Cache.php b/src/SaveHandler/Cache.php
@@ -45,15 +45,15 @@ public function __construct(CacheStorage $cacheStorage)
     /**
      * Open Session
      *
-     * @param string $savePath
+     * @param string $path
      * @param string $name
      * @return bool
      */
     #[ReturnTypeWillChange]
-    public function open($savePath, $name)
+    public function open($path, $name)
     {
         // @todo figure out if we want to use these
-        $this->sessionSavePath = $savePath;
+        $this->sessionSavePath = $path;
         $this->sessionName     = $name;
 
         return true;

diff --git a/src/SaveHandler/DbTableGateway.php b/src/SaveHandler/DbTableGateway.php
@@ -55,14 +55,14 @@ public function __construct(
     /**
      * Open Session
      *
-     * @param  string $savePath
+     * @param  string $path
      * @param  string $name
      * @return bool
      */
     #[ReturnTypeWillChange]
-    public function open($savePath, $name)
+    public function open($path, $name)
     {
-        $this->sessionSavePath = $savePath;
+        $this->sessionSavePath = $path;
         $this->sessionName     = $name;
         $this->lifetime        = ini_get('session.gc_maxlifetime');
 

diff --git a/src/SaveHandler/MongoDB.php b/src/SaveHandler/MongoDB.php
@@ -71,12 +71,12 @@ public function __construct(protected $mongoClient, MongoDBOptions $options)
     /**
      * Open session
      *
-     * @param string $savePath
+     * @param string $path
      * @param string $name
      * @return bool
      */
     #[ReturnTypeWillChange]
-    public function open($savePath, $name)
+    public function open($path, $name)
     {
         // Note: session save path is not used
         $this->sessionName = $name;

diff --git a/src/Storage/AbstractSessionArrayStorage.php b/src/Storage/AbstractSessionArrayStorage.php
@@ -150,9 +150,9 @@ public function offsetGet(mixed $key)
      * @return void
      */
     #[ReturnTypeWillChange]
-    public function offsetSet(mixed $key, mixed $value)
+    public function offsetSet(mixed $offset, mixed $value)
     {
-        $_SESSION[$key] = $value;
+        $_SESSION[$offset] = $value;
     }
 
     /**
@@ -161,9 +161,9 @@ public function offsetSet(mixed $key, mixed $value)
      * @return void
      */
     #[ReturnTypeWillChange]
-    public function offsetUnset(mixed $key)
+    public function offsetUnset(mixed $offset)
     {
-        unset($_SESSION[$key]);
+        unset($_SESSION[$offset]);
     }
 
     /**

diff --git a/src/Storage/ArrayStorage.php b/src/Storage/ArrayStorage.php
@@ -85,31 +85,26 @@ public function getRequestAccessTime()
      * If the object is marked as isImmutable, or the object or key is marked as
      * locked, raises an exception.
      *
-     * @param  string $key
-     * @param  mixed  $value
+     * @param array-key $offset
+     * @param mixed $value
      * @return void
-     */
-
-    /**
-     * @param  mixed                      $key
-     * @param  mixed                      $value
      * @throws Exception\RuntimeException
      */
     #[ReturnTypeWillChange]
-    public function offsetSet($key, $value)
+    public function offsetSet($offset, $value)
     {
         if ($this->isImmutable()) {
             throw new Exception\RuntimeException(
-                sprintf('Cannot set key "%s" as storage is marked isImmutable', $key)
+                sprintf('Cannot set key "%s" as storage is marked isImmutable', $offset)
             );
         }
-        if ($this->isLocked($key)) {
+        if ($this->isLocked($offset)) {
             throw new Exception\RuntimeException(
-                sprintf('Cannot set key "%s" due to locking', $key)
+                sprintf('Cannot set key "%s" due to locking', $offset)
             );
         }
 
-        parent::offsetSet($key, $value);
+        parent::offsetSet($offset, $value);
     }
 
     /**

diff --git a/test/SessionManagerTest.php b/test/SessionManagerTest.php
@@ -621,6 +621,7 @@ public function testRememberMeShouldSendNewSessionCookieWithUpdatedTimestamp():
 
         self::assertTrue($found, 'No session cookie found: ' . var_export($headers, true));
 
+        self::assertIsString($cookie);
         $ts = $this->getTimestampFromCookie($cookie);
         if (! $ts) {
             self::fail('Cookie did not contain expiry? ' . var_export($headers, true));
@@ -629,7 +630,7 @@ public function testRememberMeShouldSendNewSessionCookieWithUpdatedTimestamp():
         self::assertGreaterThan(
             $_SERVER['REQUEST_TIME'],
             $ts->getTimestamp(),
-            'Session cookie: ' . var_export($headers, 1)
+            'Session cookie: ' . var_export($headers, true)
         );
     }
 
@@ -663,6 +664,7 @@ public function testRememberMeShouldSetTimestampBasedOnConfigurationByDefault():
         }
 
         self::assertTrue($found, 'No session cookie found: ' . var_export($headers, true));
+        self::assertIsString($cookie);
 
         $ts = $this->getTimestampFromCookie($cookie);
         if (! $ts) {

diff --git a/test/TestAsset/TestSaveHandler.php b/test/TestAsset/TestSaveHandler.php
@@ -12,13 +12,10 @@
  */
 class TestSaveHandler implements SaveHandler
 {
-    /**
-     * @param string $savePath
-     * @param string $name
-     */
     #[ReturnTypeWillChange]
-    public function open($savePath, $name): void
+    public function open(string $path, string $name): bool
     {
+        return true;
     }
 
     public function close(): bool

diff --git a/test/TestAsset/TestSaveHandlerWithValidator.php b/test/TestAsset/TestSaveHandlerWithValidator.php
@@ -12,12 +12,7 @@
  */
 class TestSaveHandlerWithValidator implements SaveHandler
 {
-    /**
-     * @param string $savePath
-     * @param string $name
-     * @return string
-     */
-    public function open($savePath, $name): bool
+    public function open(string $path, string $name): bool
     {
         return true;
     }