Add type hints

olivervogel · olivervogel · commit 573c1c437b59 · 2025-06-01T08:20:08.000+02:00
diff --git a/phpcs.xml b/phpcs.xml
@@ -78,6 +78,11 @@
   <rule ref="SlevomatCodingStandard.TypeHints.NullableTypeForNullDefaultValue"/>
   <rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHintSpacing"/>
   <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHintSpacing"/>
+  <rule ref="SlevomatCodingStandard.TypeHints.ClassConstantTypeHint"/>
+  <rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHint"/>
+  <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHint"/>
+  <rule ref="SlevomatCodingStandard.TypeHints.PropertyTypeHint"/>
+  <rule ref="SlevomatCodingStandard.TypeHints.UselessConstantTypeHint"/>
   <rule ref="SlevomatCodingStandard.TypeHints.DNFTypeHintFormat">
     <properties>
       <property name="withSpacesAroundOperators" value="no" />
diff --git a/src/AbstractRule.php b/src/AbstractRule.php
@@ -39,10 +39,8 @@ protected function shortname(): string
 
     /**
      * Return localized error message
-     *
-     * @return string
      */
-    public function message()
+    public function message(): string
     {
         // try key for application custom translation
         $key = 'validation.' . $this->shortname();
diff --git a/src/Laravel/ValidationServiceProvider.php b/src/Laravel/ValidationServiceProvider.php
@@ -12,10 +12,8 @@ class ValidationServiceProvider extends ServiceProvider
 {
     /**
      * Bootstrap the application events.
-     *
-     * @return void
      */
-    public function boot()
+    public function boot(): void
     {
         // load translation files
         $this->loadTranslationsFrom(
@@ -78,7 +76,7 @@ protected function errorMessage(string $rulename): string
      *
      * @return array<string>
      */
-    public function provides()
+    public function provides(): array
     {
         return ['validator'];
     }
diff --git a/src/Rules/Iban.php b/src/Rules/Iban.php
@@ -160,8 +160,6 @@ private function checksum(string $iban): int
 
     /**
      * Returns the designated length of IBAN for given IBAN
-     *
-     * @return int|false
      */
     private function designatedIbanLength(string $iban): int|false
     {
diff --git a/tests/Rules/AustrianInsuranceNumberTest.php b/tests/Rules/AustrianInsuranceNumberTest.php
@@ -12,7 +12,7 @@
 final class AustrianInsuranceNumberTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, string $value): void
     {
         $valid = (new AustrianInsuranceNumber())->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/Base64Test.php b/tests/Rules/Base64Test.php
@@ -12,7 +12,7 @@
 final class Base64Test extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, string $value): void
     {
         $valid = (new Base64())->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/BicTest.php b/tests/Rules/BicTest.php
@@ -12,7 +12,7 @@
 final class BicTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, string $value): void
     {
         $valid = (new Bic())->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/CamelcaseTest.php b/tests/Rules/CamelcaseTest.php
@@ -12,7 +12,7 @@
 final class CamelcaseTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, string $value): void
     {
         $valid = (new Camelcase())->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/CidrTest.php b/tests/Rules/CidrTest.php
@@ -12,7 +12,7 @@
 final class CidrTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, string $value): void
     {
         $valid = (new Cidr())->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/CreditcardTest.php b/tests/Rules/CreditcardTest.php
@@ -12,7 +12,7 @@
 final class CreditcardTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, string $value): void
     {
         $valid = (new Creditcard())->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/DataUriTest.php b/tests/Rules/DataUriTest.php
@@ -12,14 +12,14 @@
 final class DataUriTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, string $value): void
     {
         $valid = (new DataUri())->isValid($value);
         $this->assertEquals($result, $valid);
     }
 
     #[DataProvider('dataProviderImages')]
-    public function testValidationWithMimeTypes($result, $value): void
+    public function testValidationWithMimeTypes(bool $result, string $value): void
     {
         $valid = (new DataUri(['image/jpeg', 'image/png']))->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/DomainnameTest.php b/tests/Rules/DomainnameTest.php
@@ -12,7 +12,7 @@
 final class DomainnameTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, string $value): void
     {
         $valid = (new Domainname())->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/EanTest.php b/tests/Rules/EanTest.php
@@ -12,21 +12,21 @@
 final class EanTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, int|string $value): void
     {
         $valid = (new Ean())->isValid($value);
         $this->assertEquals($result, $valid);
     }
 
     #[DataProvider('dataProviderEan13')]
-    public function testValidationEan13($result, $value): void
+    public function testValidationEan13(bool $result, int|string $value): void
     {
         $valid = (new Ean([13]))->isValid($value);
         $this->assertEquals($result, $valid);
     }
 
     #[DataProvider('dataProviderEan8')]
-    public function testValidationEan8($result, $value): void
+    public function testValidationEan8(bool $result, int|string $value): void
     {
         $valid = (new Ean([8]))->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/GridTest.php b/tests/Rules/GridTest.php
@@ -12,7 +12,7 @@
 final class GridTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, string $value): void
     {
         $valid = (new Grid())->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/GtinTest.php b/tests/Rules/GtinTest.php
@@ -12,35 +12,35 @@
 final class GtinTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, string $value): void
     {
         $valid = (new Gtin())->isValid($value);
         $this->assertEquals($result, $valid);
     }
 
     #[DataProvider('dataProviderGtin8')]
-    public function testValidationGtin8($result, $value): void
+    public function testValidationGtin8(bool $result, string $value): void
     {
         $valid = (new Gtin([8]))->isValid($value);
         $this->assertEquals($result, $valid);
     }
 
     #[DataProvider('dataProviderGtin12')]
-    public function testValidationGtin12($result, $value): void
+    public function testValidationGtin12(bool $result, string $value): void
     {
         $valid = (new Gtin([12]))->isValid($value);
         $this->assertEquals($result, $valid);
     }
 
     #[DataProvider('dataProviderGtin13')]
-    public function testValidationGtin13($result, $value): void
+    public function testValidationGtin13(bool $result, string $value): void
     {
         $valid = (new Gtin([13]))->isValid($value);
         $this->assertEquals($result, $valid);
     }
 
     #[DataProvider('dataProviderGtin14')]
-    public function testValidationGtin14($result, $value): void
+    public function testValidationGtin14(bool $result, string $value): void
     {
         $valid = (new Gtin([14]))->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/HexadecimalcolorTest.php b/tests/Rules/HexadecimalcolorTest.php
@@ -12,35 +12,35 @@
 final class HexadecimalcolorTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, string $value): void
     {
         $valid = (new Hexadecimalcolor())->isValid($value);
         $this->assertEquals($result, $valid);
     }
 
     #[DataProvider('dataProviderShort')]
-    public function testValidationShort($result, $value): void
+    public function testValidationShort(bool $result, string $value): void
     {
         $valid = (new Hexadecimalcolor([3]))->isValid($value);
         $this->assertEquals($result, $valid);
     }
 
     #[DataProvider('dataProviderLongAlpha')]
-    public function testValidationLongAlpha($result, $value): void
+    public function testValidationLongAlpha(bool $result, string $value): void
     {
         $valid = (new Hexadecimalcolor([8]))->isValid($value);
         $this->assertEquals($result, $valid);
     }
 
     #[DataProvider('dataProviderShortAlpha')]
-    public function testValidationShortAlpha($result, $value): void
+    public function testValidationShortAlpha(bool $result, string $value): void
     {
         $valid = (new Hexadecimalcolor([4]))->isValid($value);
         $this->assertEquals($result, $valid);
     }
 
     #[DataProvider('dataProviderLong')]
-    public function testValidationLong($result, $value): void
+    public function testValidationLong(bool $result, string $value): void
     {
         $valid = (new Hexadecimalcolor([6]))->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/HslcolorTest.php b/tests/Rules/HslcolorTest.php
@@ -12,7 +12,7 @@
 final class HslcolorTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, string $value): void
     {
         $valid = (new Hslcolor())->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/HsvcolorTest.php b/tests/Rules/HsvcolorTest.php
@@ -12,7 +12,7 @@
 final class HsvcolorTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, string $value): void
     {
         $valid = (new Hsvcolor())->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/HtmlcleanTest.php b/tests/Rules/HtmlcleanTest.php
@@ -12,7 +12,7 @@
 final class HtmlcleanTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, ?string $value): void
     {
         $valid = (new Htmlclean())->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/IbanTest.php b/tests/Rules/IbanTest.php
@@ -12,7 +12,7 @@
 final class IbanTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, string $value): void
     {
         $valid = (new Iban())->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/ImeiTest.php b/tests/Rules/ImeiTest.php
@@ -12,7 +12,7 @@
 final class ImeiTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, string $value): void
     {
         $valid = (new Imei())->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/IsbnTest.php b/tests/Rules/IsbnTest.php
@@ -12,21 +12,21 @@
 final class IsbnTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, string $value): void
     {
         $valid = (new Isbn())->isValid($value);
         $this->assertEquals($result, $valid);
     }
 
     #[DataProvider('dataProviderShort')]
-    public function testValidationShort($result, $value): void
+    public function testValidationShort(bool $result, string $value): void
     {
         $valid = (new Isbn([10]))->isValid($value);
         $this->assertEquals($result, $valid);
     }
 
     #[DataProvider('dataProviderLong')]
-    public function testValidationLong($result, $value): void
+    public function testValidationLong(bool $result, string $value): void
     {
         $valid = (new Isbn([13]))->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/IsinTest.php b/tests/Rules/IsinTest.php
@@ -12,7 +12,7 @@
 final class IsinTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, string $value): void
     {
         $valid = (new Isin())->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/IssnTest.php b/tests/Rules/IssnTest.php
@@ -11,12 +11,15 @@
 final class IssnTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, string $value): void
     {
         $valid = (new Issn())->isValid($value);
         $this->assertEquals($result, $valid);
     }
 
+    /**
+     * @return array<mixed>
+     */
     public static function dataProvider(): array
     {
         return [
diff --git a/tests/Rules/JwtTest.php b/tests/Rules/JwtTest.php
@@ -12,7 +12,7 @@
 final class JwtTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, string $value): void
     {
         $valid = (new Jwt())->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/KebabcaseTest.php b/tests/Rules/KebabcaseTest.php
@@ -12,7 +12,7 @@
 final class KebabcaseTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, string $value): void
     {
         $valid = (new Kebabcase())->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/LatLngTest.php b/tests/Rules/LatLngTest.php
@@ -12,7 +12,7 @@
 final class LatLngTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, string $value): void
     {
         $valid = (new LatLng())->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/LatitudeTest.php b/tests/Rules/LatitudeTest.php
@@ -12,7 +12,7 @@
 final class LatitudeTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, string $value): void
     {
         $valid = (new Latitude())->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/LongitudeTest.php b/tests/Rules/LongitudeTest.php
@@ -12,7 +12,7 @@
 final class LongitudeTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, string $value): void
     {
         $valid = (new Longitude())->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/LowercaseTest.php b/tests/Rules/LowercaseTest.php
@@ -12,7 +12,7 @@
 final class LowercaseTest extends TestCase
 {
     #[DataProvider('dataProvider')]
-    public function testValidation($result, $value): void
+    public function testValidation(bool $result, string $value): void
     {
         $valid = (new Lowercase())->isValid($value);
         $this->assertEquals($result, $valid);
diff --git a/tests/Rules/LuhnTest.php b/tests/Rules/LuhnTest.php
diff --git a/tests/Rules/MimeTypeTest.php b/tests/Rules/MimeTypeTest.php
diff --git a/tests/Rules/PostalcodeTest.php b/tests/Rules/PostalcodeTest.php
diff --git a/tests/Rules/SemverTest.php b/tests/Rules/SemverTest.php
diff --git a/tests/Rules/SlugTest.php b/tests/Rules/SlugTest.php
diff --git a/tests/Rules/SnakecaseTest.php b/tests/Rules/SnakecaseTest.php
diff --git a/tests/Rules/TitlecaseTest.php b/tests/Rules/TitlecaseTest.php
diff --git a/tests/Rules/UlidTest.php b/tests/Rules/UlidTest.php
diff --git a/tests/Rules/UppercaseTest.php b/tests/Rules/UppercaseTest.php
diff --git a/tests/Rules/UsernameTest.php b/tests/Rules/UsernameTest.php
diff --git a/tests/phpstan/bootstrap.php b/tests/phpstan/bootstrap.php

Original file line number	Diff line number	Diff line change
`@@ -12,10 +12,8 @@ class ValidationServiceProvider extends ServiceProvider`
`12`	`12`	`{`
`13`	`13`	`/**`
`14`	`14`	`* Bootstrap the application events.`
`15`		`- *`
`16`		`- * @return void`
`17`	`15`	`*/`
`18`		`- public function boot()`
	`16`	`+ public function boot(): void`
`19`	`17`	`{`
`20`	`18`	`// load translation files`
`21`	`19`	`$this->loadTranslationsFrom(`
`@@ -78,7 +76,7 @@ protected function errorMessage(string $rulename): string`
`78`	`76`	`*`
`79`	`77`	`* @return array<string>`
`80`	`78`	`*/`
`81`		`- public function provides()`
	`79`	`+ public function provides(): array`
`82`	`80`	`{`
`83`	`81`	`return ['validator'];`
`84`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -160,8 +160,6 @@ private function checksum(string $iban): int`
`160`	`160`
`161`	`161`	`/**`
`162`	`162`	`* Returns the designated length of IBAN for given IBAN`
`163`		`- *`
`164`		`- * @return int\|false`
`165`	`163`	`*/`
`166`	`164`	`private function designatedIbanLength(string $iban): int\|false`
`167`	`165`	`{`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`final class AustrianInsuranceNumberTest extends TestCase`
`13`	`13`	`{`
`14`	`14`	`#[DataProvider('dataProvider')]`
`15`		`- public function testValidation($result, $value): void`
	`15`	`+ public function testValidation(bool $result, string $value): void`
`16`	`16`	`{`
`17`	`17`	`$valid = (new AustrianInsuranceNumber())->isValid($value);`
`18`	`18`	`$this->assertEquals($result, $valid);`