minor #50831 [7.0] Fix various `@psalm-return` annotations (nicolas-grekas)

nicolas-grekas · nicolas-grekas · commit b1deb512da2e · 2023-06-30T11:29:32.000+02:00
This PR was merged into the 7.0 branch. Discussion ---------- [7.0] Fix various ``@psalm`-return` annotations | Q | A | ------------- | --- | Branch? | 7.0 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - Commits ------- 47e6324 [7.0] Fix various ``@psalm`-return` annotations
diff --git a/.github/expected-missing-return-types.diff b/.github/expected-missing-return-types.diff
diff --git a/src/Symfony/Component/DependencyInjection/ParameterBag/ContainerBagInterface.php b/src/Symfony/Component/DependencyInjection/ParameterBag/ContainerBagInterface.php
@@ -33,13 +33,11 @@ public function all(): array;
      *
      * @param TValue $value
      *
-     * @return mixed
-     *
      * @psalm-return (TValue is scalar ? array|scalar : array<array|scalar>)
      *
      * @throws ParameterNotFoundException if a placeholder references a parameter that does not exist
      */
-    public function resolveValue(mixed $value);
+    public function resolveValue(mixed $value): mixed;
 
     /**
      * Escape parameter placeholders %.
diff --git a/src/Symfony/Component/DependencyInjection/ParameterBag/ParameterBagInterface.php b/src/Symfony/Component/DependencyInjection/ParameterBag/ParameterBagInterface.php
@@ -82,11 +82,9 @@ public function resolve();
     /**
      * Replaces parameter placeholders (%name%) by their values.
      *
-     * @return mixed
-     *
      * @throws ParameterNotFoundException if a placeholder references a parameter that does not exist
      */
-    public function resolveValue(mixed $value);
+    public function resolveValue(mixed $value): mixed;
 
     /**
      * Escape parameter placeholders %.
diff --git a/src/Symfony/Component/Form/DataTransformerInterface.php b/src/Symfony/Component/Form/DataTransformerInterface.php
@@ -58,13 +58,11 @@ interface DataTransformerInterface
      *
      * @param TValue|null $value The value in the original representation
      *
-     * @return mixed
-     *
-     * @psalm-return TTransformedValue|null
+     * @return TTransformedValue|null
      *
      * @throws TransformationFailedException when the transformation fails
      */
-    public function transform(mixed $value);
+    public function transform(mixed $value): mixed;
 
     /**
      * Transforms a value from the transformed representation to its original
@@ -89,11 +87,9 @@ public function transform(mixed $value);
      *
      * @param TTransformedValue|null $value The value in the transformed representation
      *
-     * @return mixed
-     *
-     * @psalm-return TValue|null
+     * @return TValue|null
      *
      * @throws TransformationFailedException when the transformation fails
      */
-    public function reverseTransform(mixed $value);
+    public function reverseTransform(mixed $value): mixed;
 }
diff --git a/src/Symfony/Component/Security/Core/Authorization/Voter/VoterInterface.php b/src/Symfony/Component/Security/Core/Authorization/Voter/VoterInterface.php
@@ -33,9 +33,7 @@ interface VoterInterface
      * @param mixed $subject    The subject to secure
      * @param array $attributes An array of attributes associated with the method being invoked
      *
-     * @return int either ACCESS_GRANTED, ACCESS_ABSTAIN, or ACCESS_DENIED
-     *
-     * @psalm-return self::ACCESS_* must be transformed into @return on Symfony 7
+     * @return self::ACCESS_*
      */
-    public function vote(TokenInterface $token, mixed $subject, array $attributes);
+    public function vote(TokenInterface $token, mixed $subject, array $attributes): int;
 }
diff --git a/src/Symfony/Component/Validator/Test/ConstraintValidatorTestCase.php b/src/Symfony/Component/Validator/Test/ConstraintValidatorTestCase.php
@@ -286,11 +286,9 @@ protected function buildViolation(string|\Stringable $message): ConstraintViolat
     }
 
     /**
-     * @return ConstraintValidatorInterface
-     *
-     * @psalm-return T
+     * @return T
      */
-    abstract protected function createValidator();
+    abstract protected function createValidator(): ConstraintValidatorInterface;
 }
 
 final class ConstraintViolationAssertion

Original file line number	Diff line number	Diff line change
`@@ -33,13 +33,11 @@ public function all(): array;`
`33`	`33`	`*`
`34`	`34`	`* @param TValue $value`
`35`	`35`	`*`
`36`		`- * @return mixed`
`37`		`- *`
`38`	`36`	`* @psalm-return (TValue is scalar ? array\|scalar : array<array\|scalar>)`
`39`	`37`	`*`
`40`	`38`	`* @throws ParameterNotFoundException if a placeholder references a parameter that does not exist`
`41`	`39`	`*/`
`42`		`- public function resolveValue(mixed $value);`
	`40`	`+ public function resolveValue(mixed $value): mixed;`
`43`	`41`
`44`	`42`	`/**`
`45`	`43`	`* Escape parameter placeholders %.`
Original file line number	Diff line number	Diff line change
`@@ -58,13 +58,11 @@ interface DataTransformerInterface`
`58`	`58`	`*`
`59`	`59`	`* @param TValue\|null $value The value in the original representation`
`60`	`60`	`*`
`61`		`- * @return mixed`
`62`		`- *`
`63`		`- * @psalm-return TTransformedValue\|null`
	`61`	`+ * @return TTransformedValue\|null`
`64`	`62`	`*`
`65`	`63`	`* @throws TransformationFailedException when the transformation fails`
`66`	`64`	`*/`
`67`		`- public function transform(mixed $value);`
	`65`	`+ public function transform(mixed $value): mixed;`
`68`	`66`
`69`	`67`	`/**`
`70`	`68`	`* Transforms a value from the transformed representation to its original`
`@@ -89,11 +87,9 @@ public function transform(mixed $value);`
`89`	`87`	`*`
`90`	`88`	`* @param TTransformedValue\|null $value The value in the transformed representation`
`91`	`89`	`*`
`92`		`- * @return mixed`
`93`		`- *`
`94`		`- * @psalm-return TValue\|null`
	`90`	`+ * @return TValue\|null`
`95`	`91`	`*`
`96`	`92`	`* @throws TransformationFailedException when the transformation fails`
`97`	`93`	`*/`
`98`		`- public function reverseTransform(mixed $value);`
	`94`	`+ public function reverseTransform(mixed $value): mixed;`
`99`	`95`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,9 +33,7 @@ interface VoterInterface`
`33`	`33`	`* @param mixed $subject The subject to secure`
`34`	`34`	`* @param array $attributes An array of attributes associated with the method being invoked`
`35`	`35`	`*`
`36`		`- * @return int either ACCESS_GRANTED, ACCESS_ABSTAIN, or ACCESS_DENIED`
`37`		`- *`
`38`		`- * @psalm-return self::ACCESS_* must be transformed into @return on Symfony 7`
	`36`	`+ * @return self::ACCESS_*`
`39`	`37`	`*/`
`40`		`- public function vote(TokenInterface $token, mixed $subject, array $attributes);`
	`38`	`+ public function vote(TokenInterface $token, mixed $subject, array $attributes): int;`
`41`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -286,11 +286,9 @@ protected function buildViolation(string\|\Stringable $message): ConstraintViolat`
`286`	`286`	`}`
`287`	`287`
`288`	`288`	`/**`
`289`		`- * @return ConstraintValidatorInterface`
`290`		`- *`
`291`		`- * @psalm-return T`
	`289`	`+ * @return T`
`292`	`290`	`*/`
`293`		`- abstract protected function createValidator();`
	`291`	`+ abstract protected function createValidator(): ConstraintValidatorInterface;`
`294`	`292`	`}`
`295`	`293`
`296`	`294`	`final class ConstraintViolationAssertion`