Merge pull request #78 from Ocramius/fix/correct-psalm-self-out-refer…

…ences Dropping `@psalm-self-out` to avoid incorrect type inference in inheritance
laminas · Dec 3, 2022 · f4f7736 · f4f7736
2 parents 0880e3d + 82a3c33
commit f4f7736
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 70 deletions.
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -29,14 +29,12 @@
     <DocblockTypeContradiction occurrences="1">
       <code>! is_array($data) &amp;&amp; ! is_object($data)</code>
     </DocblockTypeContradiction>
-    <InvalidArgument occurrences="2">
-      <code>$key</code>
-      <code>$value</code>
-    </InvalidArgument>
-    <InvalidPropertyAssignmentValue occurrences="2">
-      <code>$data</code>
+    <InvalidPropertyAssignmentValue occurrences="1">
       <code>$this-&gt;storage</code>
     </InvalidPropertyAssignmentValue>
+    <MixedArgument occurrences="1">
+      <code>$v</code>
+    </MixedArgument>
     <MixedAssignment occurrences="1">
       <code>$v</code>
     </MixedAssignment>
@@ -100,14 +98,12 @@
     <ImplementedReturnTypeMismatch occurrences="1">
       <code>TValue|int|array{data: TValue|false, priority: int}|false</code>
     </ImplementedReturnTypeMismatch>
-    <InvalidPropertyAssignmentValue occurrences="1">
-      <code>$this-&gt;values</code>
-    </InvalidPropertyAssignmentValue>
     <LessSpecificReturnStatement occurrences="3">
       <code>$array</code>
       <code>$value</code>
     </LessSpecificReturnStatement>
-    <MixedArgument occurrences="1">
+    <MixedArgument occurrences="2">
+      <code>$item['data']</code>
       <code>$item['priority']</code>
     </MixedArgument>
     <MixedArrayAccess occurrences="2">
@@ -172,32 +168,13 @@
       <code>setMetadata</code>
     </MissingReturnType>
   </file>
-  <file src="src/Parameters.php">
-    <InvalidArgument occurrences="3">
-      <code>$name</code>
-      <code>$name</code>
-      <code>$value</code>
-    </InvalidArgument>
-    <MixedArgumentTypeCoercion occurrences="1">
-      <code>$this-&gt;toArray()</code>
-    </MixedArgumentTypeCoercion>
-    <MoreSpecificImplementedParamType occurrences="1">
-      <code>$name</code>
-    </MoreSpecificImplementedParamType>
-  </file>
   <file src="src/PriorityList.php">
     <FalsableReturnStatement occurrences="1">
       <code>$node ? $node['data'] : false</code>
     </FalsableReturnStatement>
-    <InvalidArrayOffset occurrences="1">
-      <code>$this-&gt;items[$name]</code>
-    </InvalidArrayOffset>
     <InvalidFalsableReturnType occurrences="1">
       <code>current</code>
     </InvalidFalsableReturnType>
-    <InvalidPropertyAssignmentValue occurrences="1">
-      <code>$this-&gt;items</code>
-    </InvalidPropertyAssignmentValue>
     <InvalidReturnStatement occurrences="1">
       <code>$node ? $node['data'] : false</code>
     </InvalidReturnStatement>
@@ -466,11 +443,6 @@
     </UndefinedPropertyFetch>
   </file>
   <file src="test/PriorityListTest.php">
-    <MixedAssignment occurrences="3">
-      <code>$orders1[$this-&gt;list-&gt;key()]</code>
-      <code>$orders2[$key]</code>
-      <code>$value</code>
-    </MixedAssignment>
     <NullArgument occurrences="5">
       <code>null</code>
       <code>null</code>

diff --git a/src/ArrayObject.php b/src/ArrayObject.php
@@ -108,11 +108,8 @@ public function __isset(mixed $key)
     /**
      * Sets the value at the specified key to value
      *
-     * @template TInputKey of array-key
-     * @template TInputValue
-     * @param TInputKey $key
-     * @param TInputValue $value
-     * @psalm-self-out ArrayObject<TKey|TInputKey, TValue|TInputValue>
+     * @param TKey $key
+     * @param TValue $value
      * @return void
      */
     public function __set(mixed $key, mixed $value)
@@ -173,9 +170,7 @@ public function &__get(mixed $key)
     /**
      * Appends the value
      *
-     * @template TInputValue
-     * @param TInputValue $value
-     * @psalm-self-out ArrayObject<TKey|int, TValue|TInputValue>
+     * @param TValue $value
      * @return void
      */
     public function append(mixed $value)
@@ -207,12 +202,7 @@ public function count()
     /**
      * Exchange the array for another one.
      *
-     * @template       TInputKey of array-key
-     * @template       TInputValue
-     * // phpcs:disable Generic.Files.LineLength.TooLong
-     * @param array<TInputKey, TInputValue>|ArrayObject<TInputKey, TInputValue>|ArrayIterator<TInputKey, TInputValue>|object $data
-     * // phpcs:enable Generic.Files.LineLength.TooLong
-     * @psalm-self-out ArrayObject<TInputKey, TInputValue>
+     * @param array<TKey, TValue>|ArrayObject<TKey, TValue>|ArrayIterator<TKey, TValue>|object $data
      * @return array<TKey, TValue>
      */
     public function exchangeArray($data)

diff --git a/src/FastPriorityQueue.php b/src/FastPriorityQueue.php
@@ -115,10 +115,8 @@ public function __unserialize(array $data): void
     /**
      * Insert an element in the queue with a specified priority
      *
-     * @template       TInputValue
-     * @param TInputValue $value
-     * @param int         $priority
-     * @psalm-self-out FastPriorityQueue<TValue|TInputValue>
+     * @param TValue $value
+     * @param int    $priority
      * @return void
      */
     public function insert(mixed $value, $priority)

diff --git a/src/Parameters.php b/src/Parameters.php
@@ -11,7 +11,7 @@
 use function parse_str;
 
 /**
- * @template TKey
+ * @template TKey of array-key
  * @template TValue
  * @template-extends PhpArrayObject<TKey, TValue>
  * @template-implements ParametersInterface<TKey, TValue>
@@ -37,10 +37,7 @@ public function __construct(?array $values = null)
     /**
      * Populate from native PHP array
      *
-     * @template TInputKey of array-key
-     * @template TInputValue
-     * @param array<TInputKey, TInputValue> $values
-     * @psalm-self-out Parameters<TInputKey, TInputValue>
+     * @param array<TKey, TValue> $values
      * @return void
      */
     public function fromArray(array $values)
@@ -52,7 +49,6 @@ public function fromArray(array $values)
      * Populate from query string
      *
      * @param  string $string
-     * @psalm-self-out Parameters<array-key, mixed>
      * @return void
      */
     public function fromString($string)
@@ -115,11 +111,8 @@ public function get($name, $default = null)
     }
 
     /**
-     * @template       TInputKey of array-key
-     * @template       TInputValue
-     * @param TInputKey   $name
-     * @param TInputValue $value
-     * @psalm-self-out Parameters<TKey|TInputKey, TValue|TInputValue>
+     * @param TKey   $name
+     * @param TValue $value
      * @return $this
      */
     public function set($name, $value)

diff --git a/src/ParametersInterface.php b/src/ParametersInterface.php
@@ -33,7 +33,7 @@ public function __construct(?array $values = null);
      *
      * Allow deserialization from standard array
      *
-     * @param array $values
+     * @param array<TKey, TValue> $values
      * @return mixed
      */
     public function fromArray(array $values);

diff --git a/src/PriorityList.php b/src/PriorityList.php
@@ -69,12 +69,9 @@ class PriorityList implements Iterator, Countable
     /**
      * Insert a new item.
      *
-     * @template       TInputKey of string
-     * @template       TInputValue
-     * @param TInputKey   $name
-     * @param TInputValue $value
-     * @param int         $priority
-     * @psalm-self-out PriorityList<TInputKey|TKey, TInputValue|TValue>
+     * @param TKey   $name
+     * @param TValue $value
+     * @param int    $priority
      * @return void
      */
     public function insert($name, mixed $value, $priority = 0)

diff --git a/test/ArrayObjectTest.php b/test/ArrayObjectTest.php
@@ -48,6 +48,7 @@ public function testConstructorParameters(): void
 
     public function testStdPropList(): void
     {
+        /** @var ArrayObject<string, string> $ar */
         $ar      = new ArrayObject();
         $ar->foo = 'bar';
         $ar->bar = 'baz';
@@ -96,6 +97,7 @@ public function testArrayAsProps(): void
 
     public function testAppend(): void
     {
+        /** @var ArrayObject<int, string> $ar */
         $ar = new ArrayObject(['one', 'two']);
         self::assertEquals(2, $ar->count());
 
@@ -131,6 +133,7 @@ public function testCountable(): void
 
     public function testExchangeArray(): void
     {
+        /** @var ArrayObject<string, string> $ar */
         $ar  = new ArrayObject(['foo' => 'bar']);
         $old = $ar->exchangeArray(['bar' => 'baz']);