Fix implementsInterface() PHPDoc (#277)

webmozarts · Oct 17, 2024 · c4c6fb8 · c4c6fb8
1 parent 3a544a3
commit c4c6fb8
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 10 deletions.
diff --git a/src/Assert.php b/src/Assert.php
@@ -1609,7 +1609,7 @@ public static function interfaceExists($value, $message = '')
      *
      * @psalm-param class-string<ExpectedType> $interface
      *
-     * @psalm-assert class-string<ExpectedType> $value
+     * @psalm-assert class-string<ExpectedType>|ExpectedType $value
      *
      * @param mixed  $value
      * @param mixed  $interface

diff --git a/src/Mixin.php b/src/Mixin.php
@@ -4167,7 +4167,7 @@ public static function allNullOrInterfaceExists($value, $message = '')
      *
      * @psalm-template ExpectedType of object
      * @psalm-param class-string<ExpectedType> $interface
-     * @psalm-assert class-string<ExpectedType>|null $value
+     * @psalm-assert class-string<ExpectedType>|ExpectedType|null $value
      *
      * @param mixed  $value
      * @param mixed  $interface
@@ -4187,7 +4187,7 @@ public static function nullOrImplementsInterface($value, $interface, $message =
      *
      * @psalm-template ExpectedType of object
      * @psalm-param class-string<ExpectedType> $interface
-     * @psalm-assert iterable<class-string<ExpectedType>> $value
+     * @psalm-assert iterable<class-string<ExpectedType>|ExpectedType> $value
      *
      * @param mixed  $value
      * @param mixed  $interface
@@ -4211,7 +4211,7 @@ public static function allImplementsInterface($value, $interface, $message = '')
      *
      * @psalm-template ExpectedType of object
      * @psalm-param class-string<ExpectedType> $interface
-     * @psalm-assert iterable<class-string<ExpectedType>|null> $value
+     * @psalm-assert iterable<class-string<ExpectedType>|ExpectedType|null> $value
      *
      * @param mixed  $value
      * @param mixed  $interface

diff --git a/tests/AssertTest.php b/tests/AssertTest.php
@@ -14,6 +14,7 @@
 use ArrayIterator;
 use ArrayObject;
 use DateTime;
+use DateTimeImmutable;
 use Error;
 use Exception;
 use LogicException;
@@ -447,6 +448,10 @@ public function getTests()
             array('interfaceExists', array(__CLASS__), false),
             array('implementsInterface', array('ArrayIterator', 'Traversable'), true),
             array('implementsInterface', array(__CLASS__, 'Traversable'), false),
+            array('implementsInterface', array(new DateTimeImmutable(), 'DateTimeInterface'), true),
+            array('implementsInterface', array(new DateTimeImmutable(), 'Traversable'), false),
+            array('implementsInterface', array(new ArrayIterator(array()), 'DateTimeInterface'), false),
+            array('implementsInterface', array(new ArrayIterator(array()), 'Traversable'), true),
             array('propertyExists', array((object) array('property' => 0), 'property'), true),
             array('propertyExists', array((object) array('property' => null), 'property'), true),
             array('propertyExists', array((object) array('property' => null), 'foo'), false),

diff --git a/tests/static-analysis/assert-implementsInterface.php b/tests/static-analysis/assert-implementsInterface.php
@@ -10,9 +10,9 @@
  *
  * @param mixed $value
  *
- * @return class-string<Serializable>
+ * @return Serializable|class-string<Serializable>
  */
-function implementsInterface($value): string
+function implementsInterface($value)
 {
     Assert::implementsInterface($value, Serializable::class);
 
@@ -24,9 +24,9 @@ function implementsInterface($value): string
  *
  * @param mixed $value
  *
- * @return null|class-string<Serializable>
+ * @return Serializable|class-string<Serializable>|null
  */
-function nullOrImplementsInterface($value): ?string
+function nullOrImplementsInterface($value)
 {
     Assert::nullOrImplementsInterface($value, Serializable::class);
 
@@ -38,7 +38,7 @@ function nullOrImplementsInterface($value): ?string
  *
  * @param mixed $value
  *
- * @return iterable<class-string<Serializable>>
+ * @return iterable<mixed, Serializable|class-string<Serializable>>
  */
 function allImplementsInterface($value): iterable
 {
@@ -52,7 +52,7 @@ function allImplementsInterface($value): iterable
  *
  * @param mixed $value
  *
- * @return iterable<class-string<Serializable>|null>
+ * @return iterable<mixed, Serializable|class-string<Serializable>|null>
  */
 function allNullOrImplementsInterface($value): iterable
 {