filter_var() accepts string|object, so the input is asserted to b…

…e `string|object`

An object implementing `#__toString()` suffices for `filter_var()` to
work, so we can't assume that after the assertion, the value being
asserted upon is a `string`. Instead, `string|object` is our closest
bet.

Ref: webmozarts#160 (comment)

Note: will fail until vimeo/psalm#2452 has some
sort of resolution.

src/Assert.php

@@ -701,7 +701,8 @@ public static function false($value, $message = '')
     }
 
     /**
-     * @psalm-assert string $value
+     * @psalm-assert string|object $value note: can be an object implementing __toString
+     * @psalm-assert !empty $value
      *
      * @param mixed  $value
      * @param string $message
@@ -719,7 +720,8 @@ public static function ip($value, $message = '')
     }
 
     /**
-     * @psalm-assert string $value
+     * @psalm-assert string|object $value note: can be an object implementing __toString
+     * @psalm-assert !empty $value
      *
      * @param mixed  $value
      * @param string $message
@@ -737,7 +739,8 @@ public static function ipv4($value, $message = '')
     }
 
     /**
-     * @psalm-assert string $value
+     * @psalm-assert string|object $value note: can be an object implementing __toString
+     * @psalm-assert !empty $value
      *
      * @param mixed  $value
      * @param string $message
@@ -755,7 +758,8 @@ public static function ipv6($value, $message = '')
     }
 
     /**
-     * @psalm-assert string $value
+     * @psalm-assert string|object $value note: can be an object implementing __toString
+     * @psalm-assert !empty $value
      *
      * @param mixed  $value
      * @param string $message

tests/static-analysis/assert-email.php

@@ -4,10 +4,14 @@
 
 use Webmozart\Assert\Assert;
 
-/**
- * @psalm-param mixed $value
- */
-function consume($value): string
+function consume(?string $value): string
+{
+    Assert::email($value);
+
+    return $value;
+}
+
+function consumeObject(?object $value): object
 {
     Assert::email($value);
 

tests/static-analysis/assert-ip.php

@@ -4,12 +4,17 @@
 
 use Webmozart\Assert\Assert;
 
-/**
- * @psalm-param mixed $value
- */
-function consume($value): string
+function consume(?string $value): string
 {
     Assert::ip($value);
 
     return $value;
 }
+
+function consumeObject(?object $value): object
+{
+    Assert::ip($value);
+
+    return $value;
+}
+

tests/static-analysis/assert-ipv4.php

@@ -4,12 +4,17 @@
 
 use Webmozart\Assert\Assert;
 
-/**
- * @psalm-param mixed $value
- */
-function consume($value): string
+function consume(?string $value): string
 {
     Assert::ipv4($value);
 
     return $value;
 }
+
+function consumeObject(?object $value): object
+{
+    Assert::ipv4($value);
+
+    return $value;
+}
+

tests/static-analysis/assert-ipv6.php

@@ -4,12 +4,17 @@
 
 use Webmozart\Assert\Assert;
 
-/**
- * @psalm-param mixed $value
- */
-function consume($value): string
+function consume(?string $value): string
 {
     Assert::ipv6($value);
 
     return $value;
 }
+
+function consumeObject(?object $value): object
+{
+    Assert::ipv6($value);
+
+    return $value;
+}
+