Merge pull request #316 from boesing/qa/narrow-key-types

Narrow some more string types to `non-empty-string`

Author: boesing

src/Storage/AbstractMetadataCapableAdapter.php

@@ -14,6 +14,7 @@
 use Laminas\Cache\Storage\Adapter\AdapterOptions;
 use Webmozart\Assert\Assert;
 
+use function array_keys;
 use function is_array;
 use function is_object;
 
@@ -74,6 +75,7 @@ public function getMetadata(string $key): ?object
     /**
      * Internal method to get metadata of an item.
      *
+     * @param non-empty-string $normalizedKey
      * @return TMetadata|null Metadata on success, null on failure or in case metadata is not accessible.
      * @throws ExceptionInterface
      */
@@ -103,28 +105,14 @@ public function getMetadatas(array $keys): array
             }
 
             $result = $this->triggerPost(__FUNCTION__, $args, $result);
-            Assert::isMap($result);
-            Assert::allObject($result);
+            $this->assertValidMetadataResult($result);
 
-            /**
-             * NOTE: We do trust the event handling here and assume that it will return a map of instances of Metadata
-             *      and thus does not modify the type.
-             *
-             * @var array<string,TMetadata> $result
-             */
             return $result;
         } catch (Exception $exception) {
             $result = [];
             $result = $this->triggerThrowable(__FUNCTION__, $args, $result, $exception);
-            Assert::isArray($result);
-            Assert::allObject($result);
+            $this->assertValidMetadataResult($result);
 
-            /**
-             * NOTE: We do trust the event handling here and assume that it will return a map of instances of Metadata
-             *      and thus does not modify the type.
-             *
-             * @var array<string,TMetadata> $result
-             */
             return $result;
         }
     }
@@ -150,4 +138,14 @@ protected function internalGetMetadatas(array $normalizedKeys): array
 
         return $result;
     }
+
+    /**
+     * @psalm-assert array<non-empty-string,TMetadata> $result
+     */
+    private function assertValidMetadataResult(mixed $result): void
+    {
+        Assert::isMap($result);
+        $this->assertValidKeys(array_keys($result));
+        Assert::allObject($result);
+    }
 }

src/Storage/Adapter/AbstractAdapter.php

@@ -1273,7 +1273,7 @@ protected function assertValidKeyValuePairs(mixed $keyValuePairs): void
     /**
      * @psalm-assert list<non-empty-string|int> $keys
      */
-    private function assertValidKeys(array $keys): void
+    protected function assertValidKeys(array $keys): void
     {
         foreach ($keys as $key) {
             $this->assertValidKey($key);

src/Storage/ClearByNamespaceInterface.php

@@ -6,6 +6,8 @@ interface ClearByNamespaceInterface
 {
     /**
      * Remove items of given namespace
+     *
+     * @param non-empty-string $namespace
      */
     public function clearByNamespace(string $namespace): bool;
 }

src/Storage/ClearByPrefixInterface.php

@@ -6,6 +6,8 @@ interface ClearByPrefixInterface
 {
     /**
      * Remove items matching given prefix
+     *
+     * @param non-empty-string $prefix
      */
     public function clearByPrefix(string $prefix): bool;
 }

src/Storage/MetadataCapableInterface.php

@@ -14,6 +14,7 @@ interface MetadataCapableInterface
     /**
      * Get metadata of an item.
      *
+     * @param non-empty-string $key
      * @return TMetadata|null Metadata on success, null on failure or in case metadata is not accessible.
      * @throws ExceptionInterface
      */
@@ -23,7 +24,7 @@ public function getMetadata(string $key): ?object;
      * Get multiple metadata
      *
      * @param non-empty-list<non-empty-string> $keys
-     * @return array<string,TMetadata> Associative array of keys and metadata
+     * @return array<non-empty-string|int,TMetadata> Associative array of keys and metadata
      * @throws ExceptionInterface
      */
     public function getMetadatas(array $keys): array;

src/Storage/TaggableInterface.php

@@ -8,13 +8,15 @@ interface TaggableInterface
      * Set tags to an item by given key.
      * An empty array will remove all tags.
      *
+     * @param non-empty-string $key
      * @param string[] $tags
      */
     public function setTags(string $key, array $tags): bool;
 
     /**
      * Get tags of an item by given key
      *
+     * @param non-empty-string $key
      * @return string[]|false
      */
     public function getTags(string $key): false|array;