Converted phpstan doc comments to generic

Signed-off-by: Tom Wright <tom@inflatablecookie.com>
decodelabs · Sep 26, 2023 · d73772a · d73772a
1 parent 22074eb
commit d73772a
Show file tree

Hide file tree

Showing 15 changed files with 42 additions and 41 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,4 @@
+* Converted phpstan doc comments to generic
 * Migrated to use effigy in CI workflow
 * Fixed PHP8.1 testing
 * Updated getChildValues() return signature

diff --git a/src/Constraint.php b/src/Constraint.php
@@ -19,7 +19,7 @@
 interface Constraint
 {
     /**
-     * @phpstan-param Processor<TValue> $processor
+     * @param Processor<TValue> $processor
      */
     public function __construct(Processor $processor);
 
@@ -32,12 +32,12 @@ public function getName(): string;
     public function getWeight(): int;
 
     /**
-     * @phpstan-return Processor<TValue>
+     * @return Processor<TValue>
      */
     public function getProcessor(): Processor;
 
     /**
-     * @phpstan-param TParam $param
+     * @param TParam $param
      * @return $this
      */
     public function setParameter(mixed $param): static;
@@ -46,14 +46,14 @@ public function getParameter(): mixed;
     public function prepareValue(mixed $value): mixed;
 
     /**
-     * @phpstan-param TValue $value
-     * @phpstan-return TValue|null
+     * @param TValue $value
+     * @return TValue|null
      */
     public function alterValue(mixed $value): mixed;
 
     /**
-     * @phpstan-param TValue|null $value
-     * @phpstan-return Generator<int, Error|null, mixed, bool>
+     * @param TValue|null $value
+     * @return Generator<int, Error|null, mixed, bool>
      */
     public function validate(mixed $value): Generator;
 }
diff --git a/src/Constraint/Processor.php b/src/Constraint/Processor.php
@@ -22,7 +22,7 @@
 class Processor implements Constraint
 {
     /**
-     * @phpstan-use ConstraintTrait<TValue, TValue>
+     * @use ConstraintTrait<TValue, TValue>
      */
     use ConstraintTrait;
 

diff --git a/src/ConstraintTrait.php b/src/ConstraintTrait.php
@@ -19,12 +19,12 @@
 trait ConstraintTrait
 {
     /**
-     * @phpstan-var Processor<TValue>
+     * @var Processor<TValue>
      */
     protected Processor $processor;
 
     /**
-     * @phpstan-param Processor<TValue> $processor
+     * @param Processor<TValue> $processor
      */
     public function __construct(Processor $processor)
     {
@@ -62,7 +62,7 @@ public function getProcessor(): Processor
     }
 
     /**
-     * @phpstan-param TParam $param
+     * @param TParam $param
      * @return $this
      */
     public function setParameter(mixed $param): static
@@ -86,7 +86,7 @@ public function alterValue(mixed $value): mixed
     }
 
     /**
-     * @phpstan-param TValue $value
+     * @param TValue $value
      */
     public function validate(mixed $value): Generator
     {

diff --git a/src/Processor.php b/src/Processor.php
@@ -40,15 +40,15 @@ public function prepareValue(mixed $value): mixed;
     /**
      * Apply value processing before validation
      *
-     * @phpstan-param TOutput $value
-     * @phpstan-return TOutput|null
+     * @param TOutput $value
+     * @return TOutput|null
      */
     public function alterValue(mixed $value): mixed;
 
     /**
      * Coerce input to output type or null
      *
-     * @phpstan-return TOutput|null
+     * @return TOutput|null
      */
     public function coerce(mixed $value): mixed;
 
@@ -71,23 +71,23 @@ public function getDefaultConstraints(): array;
 
 
     /**
-     * @phpstan-return array<string, Constraint<mixed, TOutput>>
+     * @return array<string, Constraint<mixed, TOutput>>
      */
     public function prepareConstraints(): array;
 
 
     /**
      * Test constraints and yield errors in sequence
      *
-     * @phpstan-param TOutput|null $value
+     * @param TOutput|null $value
      * @return Generator<Error|null>
      */
     public function validate(mixed $value): Generator;
 
     /**
      * Test type and yield errors in sequence
      *
-     * @phpstan-param TOutput|null $value
+     * @param TOutput|null $value
      * @return Generator<Error|null>
      */
     public function validateType(mixed $value): Generator;

diff --git a/src/Provider/DirectContext.php b/src/Provider/DirectContext.php
@@ -18,7 +18,7 @@ interface DirectContext extends Provider
 {
     /**
      * @template TInput
-     * @phpstan-param TInput $value
+     * @param TInput $value
      * @param array<string, mixed>|Closure|null $setup
      */
     public function make(
@@ -29,7 +29,7 @@ public function make(
 
     /**
      * @template TInput
-     * @phpstan-param TInput $value
+     * @param TInput $value
      * @param array<string, mixed>|Closure|null $setup
      * @return Result<mixed>
      */
@@ -41,7 +41,7 @@ public function validate(
 
     /**
      * @template TInput
-     * @phpstan-param TInput $value
+     * @param TInput $value
      * @param array<string, mixed>|Closure|null $setup
      */
     public function is(

diff --git a/src/Provider/MultiContextTrait.php b/src/Provider/MultiContextTrait.php
@@ -60,7 +60,7 @@ public function sanitize(
     }
 
     /**
-     * @phpstan-return TValue|null
+     * @return TValue|null
      */
     abstract protected function getValue(
         int|string $key

diff --git a/src/Provider/SingleContextTrait.php b/src/Provider/SingleContextTrait.php
@@ -56,7 +56,7 @@ public function sanitize(): Sanitizer
     }
 
     /**
-     * @phpstan-return TValue
+     * @return TValue
      */
     abstract protected function getValue(): mixed;
 }
diff --git a/src/Sanitizer.php b/src/Sanitizer.php
@@ -41,7 +41,7 @@ public function validate(
      * Load processor for value
      *
      * @param array<string, mixed>|Closure|null $setup
-     * @phpstan-return Processor<mixed>
+     * @return Processor<mixed>
      */
     public function loadProcessor(
         string $type,

diff --git a/src/Validate/Error.php b/src/Validate/Error.php
@@ -25,13 +25,13 @@ class Error
     protected array $params = [];
 
     /**
-     * @phpstan-var Constraint<mixed, mixed>
+     * @var Constraint<mixed, mixed>
      */
     protected Constraint $constraint;
     protected string $constraintKey;
 
     /**
-     * @phpstan-param Constraint<mixed, mixed>|Processor<mixed> $constraint
+     * @param Constraint<mixed, mixed>|Processor<mixed> $constraint
      * @param array<string, mixed> $params
      */
     public function __construct(
@@ -61,7 +61,7 @@ public function getId(): string
     }
 
     /**
-     * @phpstan-return Constraint<mixed, mixed>
+     * @return Constraint<mixed, mixed>
      */
     public function getConstraint(): Constraint
     {

diff --git a/src/Validate/Result.php b/src/Validate/Result.php
@@ -17,12 +17,12 @@
 class Result
 {
     /**
-     * @phpstan-var TValue|null
+     * @var TValue|null
      */
     protected mixed $value = null;
 
     /**
-     * @phpstan-var Processor<TValue>
+     * @var Processor<TValue>
      */
     protected Processor $processor;
 
@@ -34,7 +34,7 @@ class Result
     /**
      * Init with processor
      *
-     * @phpstan-param Processor<TValue> $processor
+     * @param Processor<TValue> $processor
      */
     public function __construct(Processor $processor)
     {
@@ -45,7 +45,7 @@ public function __construct(Processor $processor)
     /**
      * Set value
      *
-     * @phpstan-param TValue $value
+     * @param TValue $value
      * @return $this
      */
     public function setValue(mixed $value): static
@@ -58,7 +58,7 @@ public function setValue(mixed $value): static
     /**
      * Get value
      *
-     * @phpstan-return TValue|null
+     * @return TValue|null
      */
     public function getValue(): mixed
     {
@@ -68,7 +68,7 @@ public function getValue(): mixed
     /**
      * Get processor
      *
-     * @phpstan-return Processor<TValue>
+     * @return Processor<TValue>
      */
     public function getProcessor(): Processor
     {

diff --git a/tests/AnalyzeMixedContextProvider.php b/tests/AnalyzeMixedContextProvider.php
@@ -25,7 +25,7 @@ class AnalyzeMixedContextProvider implements MixedContext
     use MixedContextTrait;
 
     /**
-     * @phpstan-var TValue
+     * @var TValue
      */
     protected mixed $value;
 
@@ -35,15 +35,15 @@ public function __construct(mixed $value)
     }
 
     /**
-     * @phpstan-return TValue
+     * @return TValue
      */
     public function getValue(): mixed
     {
         return $this->value;
     }
 
     /**
-     * @phpstan-return array<TValue>
+     * @return array<TValue>
      */
     public function getChildValues(): array
     {

diff --git a/tests/AnalyzeMultiContextProvider.php b/tests/AnalyzeMultiContextProvider.php
@@ -25,7 +25,7 @@ class AnalyzeMultiContextProvider implements MultiContext
     use MultiContextTrait;
 
     /**
-     * @phpstan-var array<string, TValue>
+     * @var array<string, TValue>
      */
     protected array $values;
 
@@ -37,7 +37,7 @@ public function __construct(
     }
 
     /**
-     * @phpstan-return TValue|null
+     * @return TValue|null
      */
     public function getValue(
         int|string $key

diff --git a/tests/AnalyzeSingleContextProvider.php b/tests/AnalyzeSingleContextProvider.php
@@ -25,7 +25,7 @@ class AnalyzeSingleContextProvider implements SingleContext
     use SingleContextTrait;
 
     /**
-     * @phpstan-var TValue
+     * @var TValue
      */
     protected mixed $value;
 
@@ -35,7 +35,7 @@ public function __construct(mixed $value)
     }
 
     /**
-     * @phpstan-return TValue
+     * @return TValue
      */
     public function getValue(): mixed
     {

diff --git a/tests/SanitizerImplementation.php b/tests/SanitizerImplementation.php
@@ -43,7 +43,7 @@ public function validate(
      * Load processor for value
      *
      * @param array<string, mixed>|Closure|null $setup
-     * @phpstan-return Processor<mixed>
+     * @return Processor<mixed>
      */
     public function loadProcessor(
         string $type,