Removed covariance marker from container types, removed redundant doc…

…block overrides causing type clashes

Note: we assume laminas/laminas-stdlib#78 will be merged first.

src/AbstractContainer.php

@@ -27,8 +27,8 @@
  * Additionally, expiries may be absolute TTLs or measured in "hops", which
  * are based on how many times the key or container were accessed.
  *
- * @template-covariant TKey of string
- * @template-covariant TValue
+ * @template TKey of string
+ * @template TValue
  * @template-extends ArrayObject<TKey, TValue>
  */
 abstract class AbstractContainer extends ArrayObject
@@ -462,14 +462,7 @@ public function offsetUnset($key)
         unset($storage[$name][$key]);
     }
 
-    /**
-     * Exchange the current array with another array or object.
-     *
-     * @see ArrayObject::exchangeArray()
-     *
-     * @param  array|object $input
-     * @return array        Returns the old array
-     */
+    /** @inheritDoc */
     public function exchangeArray($input)
     {
         // handle arrayobject, iterators and the like:
@@ -605,11 +598,7 @@ public function setExpirationHops($hops, $vars = null)
         return $this;
     }
 
-    /**
-     * Creates a copy of the specific container name
-     *
-     * @return array
-     */
+    /** @inheritDoc */
     public function getArrayCopy()
     {
         $storage   = $this->verifyNamespace();

src/Container.php

@@ -10,8 +10,8 @@
  * Additionally, expiries may be absolute TTLs or measured in "hops", which
  * are based on how many times the key or container were accessed.
  *
- * @template-covariant TKey of string
- * @template-covariant TValue
+ * @template TKey of string
+ * @template TValue
  * @template-extends AbstractContainer<TKey, TValue>
  */
 class Container extends AbstractContainer

src/Storage/AbstractSessionArrayStorage.php

@@ -28,8 +28,8 @@
  *
  * @see ReturnTypeWillChange
  *
- * @template-covariant TKey of string
- * @template-covariant TValue
+ * @template TKey of array-key
+ * @template TValue
  * @template-implements IteratorAggregate<TKey, TValue>
  * @template-implements StorageInterface<TKey, TValue>
  */
@@ -198,11 +198,7 @@ public function unserialize($session)
         return unserialize($session);
     }
 
-    /**
-     * Get Iterator
-     *
-     * @return ArrayIterator
-     */
+    /** @inheritDoc */
     #[ReturnTypeWillChange]
     public function getIterator()
     {
@@ -252,7 +248,7 @@ public function isImmutable()
      * Lock this storage instance, or a key within it
      *
      * @param  null|int|string $key
-     * @return ArrayStorage
+     * @return $this
      */
     public function lock($key = null)
     {
@@ -309,7 +305,7 @@ public function isLocked($key = null)
      * Unlock an object or key marked as locked
      *
      * @param  null|int|string $key
-     * @return ArrayStorage
+     * @return $this
      */
     public function unlock($key = null)
     {
@@ -353,7 +349,7 @@ public function unlock($key = null)
      * @param  string                     $key
      * @param  mixed                      $value
      * @param  bool                       $overwriteArray Whether to overwrite or merge array values; by default, merges
-     * @return ArrayStorage
+     * @return $this
      * @throws Exception\RuntimeException
      */
     public function setMetadata($key, $value, $overwriteArray = false)
@@ -417,7 +413,7 @@ public function getMetadata($key = null)
      * Clear the storage object or a subkey of the object
      *
      * @param  null|int|string            $key
-     * @return ArrayStorage
+     * @return $this
      * @throws Exception\RuntimeException
      */
     public function clear($key = null)
@@ -452,7 +448,7 @@ public function getRequestAccessTime()
      * Set the request access time
      *
      * @param  float        $time
-     * @return ArrayStorage
+     * @return $this
      */
     protected function setRequestAccessTime($time)
     {
@@ -465,7 +461,7 @@ protected function setRequestAccessTime($time)
      * Cast the object to an array
      *
      * @param  bool $metaData Whether to include metadata
-     * @return array
+     * @return array<TKey, TValue>
      */
     public function toArray($metaData = false)
     {

src/Storage/ArrayStorage.php

@@ -23,8 +23,8 @@
  *
  * @see ReturnTypeWillChange
  *
- * @template-covariant TKey of string
- * @template-covariant TValue
+ * @template TKey of array-key
+ * @template TValue
  * @template-extends ArrayObject<TKey, TValue>
  * @template-implements StorageInterface<TKey, TValue>
  */

src/Storage/SessionArrayStorage.php

@@ -5,8 +5,8 @@
 /**
  * Session storage in $_SESSION'
  *
- * @template-covariant TKey of array-key
- * @template-covariant TValue
+ * @template TKey of array-key
+ * @template TValue
  * @template-extends AbstractSessionArrayStorage<TKey, TValue>
  */
 class SessionArrayStorage extends AbstractSessionArrayStorage

src/Storage/SessionStorage.php

@@ -13,8 +13,8 @@
  * Replaces the $_SESSION superglobal with an ArrayObject that allows for
  * property access, metadata storage, locking, and immutability.
  *
- * @template-covariant TKey
- * @template-covariant TValue
+ * @template TKey of array-key
+ * @template TValue
  * @template-extends ArrayStorage<TKey, TValue>
  */
 class SessionStorage extends ArrayStorage

src/Storage/StorageInterface.php

@@ -13,8 +13,8 @@
  * Defines the minimum requirements for handling userland, in-script session
  * storage (e.g., the $_SESSION superglobal array).
  *
- * @template-covariant TKey of array-key
- * @template-covariant TValue
+ * @template TKey of array-key
+ * @template TValue
  * @template-extends Traversable<TKey, TValue>
  * @template-extends ArrayAccess<TKey, TValue>
  */

src/Validator/AbstractValidatorChainEM3.php

@@ -42,8 +42,8 @@ public function __construct(StorageInterface $storage)
      * @param int $priority
      * @return CallbackHandler
      */
-    public function attach($eventName, callable $callback, $priority = 1)
+    public function attach($eventName, callable $listener, $priority = 1)
     {
-        return $this->attachValidator($eventName, $callback, $priority);
+        return $this->attachValidator($eventName, $listener, $priority);
     }
 }

src/ValidatorChain.php

@@ -30,9 +30,9 @@ public function __construct(protected StorageInterface $storage)
      * @param int      $priority
      * @return callable
      */
-    public function attach($eventName, callable $callback, $priority = 1)
+    public function attach($eventName, callable $listener, $priority = 1)
     {
-        return $this->attachValidator($eventName, $callback, $priority);
+        return $this->attachValidator($eventName, $listener, $priority);
     }
 
     /**

test/TestAsset/Php81CompatibleStorageInterface.php

@@ -7,8 +7,8 @@
 use Laminas\Session\Storage\StorageInterface;
 
 /**
- * @template-covariant TKey of array-key
- * @template-covariant TValue
+ * @template TKey of array-key
+ * @template TValue
  * @template-extends StorageInterface<TKey, TValue>
  */
 interface Php81CompatibleStorageInterface extends StorageInterface

test/TestAsset/TestContainer.php

@@ -7,8 +7,8 @@
 use Laminas\Session\AbstractContainer;
 
 /**
- * @template-covariant TKey of string
- * @template-covariant TValue
+ * @template TKey of string
+ * @template TValue
  * @template-extends AbstractContainer<TKey, TValue>
  */
 class TestContainer extends AbstractContainer