Add Assert::numericString()

Author: simPod

CHANGELOG.md

@@ -3,6 +3,8 @@ Changelog
 
 ## UNRELEASED
 
+* Added `Assert::numericString()`
+
 ## 1.10.0
 
 ### Added

README.md

@@ -86,6 +86,7 @@ Method                                                   | Description
 -------------------------------------------------------- | --------------------------------------------------
 `string($value, $message = '')`                          | Check that a value is a string
 `stringNotEmpty($value, $message = '')`                  | Check that a value is a non-empty string
+`numericString($value, $message = '')`                  | Check that a value is a numeric-string
 `integer($value, $message = '')`                         | Check that a value is an integer
 `integerish($value, $message = '')`                      | Check that a value casts to an integer
 `positiveInteger($value, $message = '')`                 | Check that a value is a positive (non-zero) integer

src/Assert.php

@@ -53,6 +53,26 @@ public static function string($value, $message = '')
         }
     }
 
+    /**
+     * @psalm-pure
+     * @psalm-assert numeric-string $value
+     *
+     * @param mixed  $value
+     *
+     * @throws InvalidArgumentException
+     */
+    public static function numericString($value, string $message = ''): void
+    {
+        static::string($value, $message ?? 'Expected a numeric string. Got: %s');
+
+        if (!\is_numeric($value)) {
+            static::reportInvalidArgument(\sprintf(
+                $message ?? 'Expected a numeric string. Got: %s',
+                static::typeToString($value)
+            ));
+        }
+    }
+
     /**
      * @psalm-pure
      * @psalm-assert non-empty-string $value

src/Mixin.php

@@ -49,6 +49,40 @@ public static function allString($value, $message = '')
         }
     }
 
+    /**
+     * @psalm-pure
+     * @psalm-assert numeric-string|null $value
+     *
+     * @param mixed $value
+     *
+     * @throws InvalidArgumentException
+     *
+     * @return void
+     */
+    public static function nullOrNumericString($value, $message = '')
+    {
+        null === $value || static::numericString($value, $message);
+    }
+
+    /**
+     * @psalm-pure
+     * @psalm-assert iterable<numeric-string> $value
+     *
+     * @param mixed $value
+     *
+     * @throws InvalidArgumentException
+     *
+     * @return void
+     */
+    public static function allNumericString($value, $message = '')
+    {
+        static::isIterable($value);
+
+        foreach ($value as $entry) {
+            static::numericString($entry, $message);
+        }
+    }
+
     /**
      * @psalm-pure
      * @psalm-assert non-empty-string|null $value

tests/static-analysis/assert-numericString.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Webmozart\Assert\Tests\StaticAnalysis;
+
+use Webmozart\Assert\Assert;
+
+/**
+ * @psalm-pure
+ *
+ * @param mixed $value
+ *
+ * @return numeric-string
+ */
+function numericString($value): string
+{
+    Assert::numericString($value);
+
+    return $value;
+}
+
+/**
+ * @psalm-pure
+ *
+ * @param mixed $value
+ *
+ * @return numeric-string
+ */
+function nullOrNumericString($value): ?string
+{
+    Assert::nullOrNumericString($value);
+
+    return $value;
+}
+
+/**
+ * @psalm-pure
+ *
+ * @param mixed $value
+ *
+ * @return iterable<numeric-string>
+ */
+function allNumericString($value): iterable
+{
+    Assert::allNumericString($value);
+
+    return $value;
+}