Add generic annotations to EventInterface

.gitattributes

@@ -14,3 +14,4 @@
 /phpbench.json export-ignore
 /phpunit.xml.dist export-ignore
 /test/ export-ignore
+/psalm/ export-ignore

composer.json

@@ -23,7 +23,8 @@
             "php": "8.0.99"
         },
         "allow-plugins": {
-            "dealerdirect/phpcodesniffer-composer-installer": true
+            "dealerdirect/phpcodesniffer-composer-installer": true,
+            "composer/package-versions-deprecated": true
         }
     },
     "extra": {
@@ -52,7 +53,8 @@
     "autoload-dev": {
         "psr-4": {
             "LaminasTest\\EventManager\\": "test/",
-            "LaminasBench\\EventManager\\": "benchmarks/"
+            "LaminasBench\\EventManager\\": "benchmarks/",
+            "LaminasPsalm\\EventManager\\": "psalm/"
         }
     },
     "scripts": {

phpcs.xml

@@ -14,6 +14,7 @@
 
     <!-- Paths to check -->
     <file>benchmarks</file>
+    <file>psalm</file>
     <file>src</file>
     <file>test</file>
 

psalm.xml

@@ -9,6 +9,7 @@
     <projectFiles>
         <directory name="src"/>
         <directory name="test"/>
+        <directory name="psalm"/>
         <ignoreFiles>
             <directory name="vendor"/>
         </ignoreFiles>

psalm/CheckObject.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace LaminasPsalm\EventManager;
+
+class CheckObject
+{
+}

psalm/EventChecks.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace LaminasPsalm\EventManager;
+
+use Laminas\EventManager\Event;
+use Laminas\EventManager\EventInterface;
+
+class EventChecks
+{
+    /**
+     * @return array{
+     *     Event,
+     *     EventInterface,
+     *     Event<null, array<empty, empty>>,
+     *     EventInterface<null, array<empty, empty>>,
+     * }
+     */
+    public function checkEmptyCtorInference(): array
+    {
+        $event = new Event();
+        return [
+            $event,
+            $event,
+            $event,
+            $event,
+        ];
+    }
+
+    /**
+     * @return array{
+     *     Event<'target-string', array{foo: 'bar', baz: true}>,
+     *     'target-string',
+     *     array{foo: 'bar', baz: true},
+     * }
+     */
+    public function checkCtorInference(): array
+    {
+        $event = new Event(null, 'target-string', [
+            'foo' => 'bar',
+            'baz' => true,
+        ]);
+        return [
+            $event,
+            $event->getTarget(),
+            $event->getParams(),
+        ];
+    }
+}

psalm/EventInterfaceChecks.php

@@ -0,0 +1,96 @@
+<?php
+
+declare(strict_types=1);
+
+namespace LaminasPsalm\EventManager;
+
+use Laminas\EventManager\EventInterface;
+
+class EventInterfaceChecks
+{
+    /**
+     * @param EventInterface<CheckObject, array{foo: int, bar: CheckObject}> $e
+     * @return array{
+     *     CheckObject,
+     *     array{foo: int, bar: CheckObject},
+     *     int,
+     *     CheckObject
+     * }
+     */
+    public function checkTargetAndParamsMatchTemplate(EventInterface $e): array
+    {
+        return [
+            $e->getTarget(),
+            $e->getParams(),
+            $e->getParams()['foo'],
+            $e->getParams()['bar'],
+        ];
+    }
+
+    /**
+     * @param EventInterface<null, array<empty, empty>> $e
+     * @return array{
+     *     EventInterface<CheckObject, array<empty, empty>>,
+     * }
+     */
+    public function checkSetTargetChangesTemplate(EventInterface $e): array
+    {
+        $e->setTarget(new CheckObject());
+        return [
+            $e,
+        ];
+    }
+
+    /**
+     * @param EventInterface<null, array{foo: int}> $e
+     * @return array{
+     *     EventInterface<null, array{foo: CheckObject, bar: 'baz'}>,
+     * }
+     */
+    public function checkSetParamsChangesTemplate(EventInterface $e): array
+    {
+        $e->setParams([
+            'foo' => new CheckObject(),
+            'bar' => 'baz',
+        ]);
+        return [
+            $e,
+        ];
+    }
+
+    /**
+     * Individual params obtained via `getParam()` can't be inferred because their keys/values can't be selected from
+     * the template type.
+     *
+     * @param EventInterface<null, array{foo: int, bar: CheckObject}> $e
+     * @return array{
+     *     mixed,
+     *     mixed
+     * }
+     */
+    public function checkIndividualParamsNotInferred(EventInterface $e): array
+    {
+        return [
+            $e->getParam('foo'),
+            $e->getParam('bar'),
+        ];
+    }
+
+    /**
+     * Changing the template and statically checking individual values is not possible with Psalm because
+     * key-of and value-of do not work on objects.
+     *
+     * @param EventInterface<null, array{foo: int}> $e
+     * @return array{
+     *     EventInterface<null, array{foo: int}>,
+     * }
+     */
+    public function checkIndividualParamDoesNotChangeTemplate(EventInterface $e): array
+    {
+        $e->setParam('foo', 'notAnInt');
+        $e->setParam('bar', 'keyDidNotExist');
+        return [
+            $e,
+        ];
+    }
+}