Merge pull request #319 from boesing/bugfix/add-missing-template-type…

…-storageinterface Add missing template param for `StorageInterface`
laminas · Jun 21, 2024 · 03b73c8 · 03b73c8
2 parents 512dc92 + 2cd2b28
commit 03b73c8
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 3 deletions.
diff --git a/src/Storage/Adapter/AbstractAdapter.php b/src/Storage/Adapter/AbstractAdapter.php
@@ -31,6 +31,7 @@
 
 /**
  * @template TOptions of AdapterOptions
+ * @template-implements StorageInterface<TOptions>
  */
 abstract class AbstractAdapter implements StorageInterface, PluginAwareInterface
 {

diff --git a/src/Storage/StorageInterface.php b/src/Storage/StorageInterface.php
@@ -3,18 +3,23 @@
 namespace Laminas\Cache\Storage;
 
 use Laminas\Cache\Exception\ExceptionInterface;
+use Laminas\Cache\Storage\Adapter\AdapterOptions;
 
 /**
- * NOTE: when providing integrish cache keys in iterables, internal array conversion might convert these to int, even
+ * NOTE: when providing integerish cache keys in iterables, internal array conversion might convert these to int, even
  *       tho they were non-empty-string beforehand. See https://3v4l.org/GsiBl for more details.
  *
  * @psalm-type CacheKeyInIterableType = non-empty-string|int
+ * @template TOptions of AdapterOptions
  */
 interface StorageInterface
 {
-    public function setOptions(iterable|Adapter\AdapterOptions $options): self;
+    public function setOptions(iterable|AdapterOptions $options): self;
 
-    public function getOptions(): Adapter\AdapterOptions;
+    /**
+     * @return TOptions
+     */
+    public function getOptions(): AdapterOptions;
 
     /* reading */
     /**

diff --git a/test/Psr/CacheItemPool/TestAsset/FlushableStorageAdapterInterface.php b/test/Psr/CacheItemPool/TestAsset/FlushableStorageAdapterInterface.php
@@ -4,9 +4,14 @@
 
 namespace LaminasTest\Cache\Psr\CacheItemPool\TestAsset;
 
+use Laminas\Cache\Storage\Adapter\AdapterOptions;
 use Laminas\Cache\Storage\FlushableInterface;
 use Laminas\Cache\Storage\StorageInterface;
 
+/**
+ * @template TOptions of AdapterOptions
+ * @template-extends StorageInterface<TOptions>
+ */
 interface FlushableStorageAdapterInterface extends StorageInterface, FlushableInterface
 {
 }
diff --git a/test/Psr/TestAsset/FlushableNamespaceStorageInterface.php b/test/Psr/TestAsset/FlushableNamespaceStorageInterface.php
@@ -4,8 +4,13 @@
 
 namespace LaminasTest\Cache\Psr\TestAsset;
 
+use Laminas\Cache\Storage\Adapter\AdapterOptions;
 use Laminas\Cache\Storage\ClearByNamespaceInterface;
 
+/**
+ * @template TOptions of AdapterOptions
+ * @template-extends FlushableStorageInterface<TOptions>
+ */
 interface FlushableNamespaceStorageInterface extends FlushableStorageInterface, ClearByNamespaceInterface
 {
 }
diff --git a/test/Psr/TestAsset/FlushableStorageInterface.php b/test/Psr/TestAsset/FlushableStorageInterface.php
@@ -4,10 +4,15 @@
 
 namespace LaminasTest\Cache\Psr\TestAsset;
 
+use Laminas\Cache\Storage\Adapter\AdapterOptions;
 use Laminas\Cache\Storage\FlushableInterface;
 use Laminas\Cache\Storage\PluginAwareInterface;
 use Laminas\Cache\Storage\StorageInterface;
 
+/**
+ * @template TOptions of AdapterOptions
+ * @template-extends StorageInterface<TOptions>
+ */
 interface FlushableStorageInterface extends StorageInterface, FlushableInterface, PluginAwareInterface
 {
 }
diff --git a/test/Storage/Adapter/TestAsset/AdapterWithStorageAndEventsCapableInterface.php b/test/Storage/Adapter/TestAsset/AdapterWithStorageAndEventsCapableInterface.php
@@ -4,10 +4,15 @@
 
 namespace LaminasTest\Cache\Storage\Adapter\TestAsset;
 
+use Laminas\Cache\Storage\Adapter\AdapterOptions;
 use Laminas\Cache\Storage\Plugin\PluginInterface;
 use Laminas\Cache\Storage\StorageInterface;
 use Laminas\EventManager\EventsCapableInterface;
 
+/**
+ * @template TOptions of AdapterOptions
+ * @template-extends StorageInterface<TOptions>
+ */
 interface AdapterWithStorageAndEventsCapableInterface extends StorageInterface, EventsCapableInterface
 {
     public function hasPlugin(PluginInterface $plugin): bool;