[Validator] Add PHPDoc void return types

Author: mbuliard

ConstraintValidatorInterface.php

@@ -20,11 +20,15 @@ interface ConstraintValidatorInterface
 {
     /**
      * Initializes the constraint validator.
+     *
+     * @return void
      */
     public function initialize(ExecutionContextInterface $context);
 
     /**
      * Checks if the passed value is valid.
+     *
+     * @return void
      */
     public function validate(mixed $value, Constraint $constraint);
 }

ConstraintViolationListInterface.php

@@ -25,11 +25,15 @@ interface ConstraintViolationListInterface extends \Traversable, \Countable, \Ar
 {
     /**
      * Adds a constraint violation to this list.
+     *
+     * @return void
      */
     public function add(ConstraintViolationInterface $violation);
 
     /**
      * Merges an existing violation list into this list.
+     *
+     * @return void
      */
     public function addAll(self $otherList);
 
@@ -53,13 +57,17 @@ public function has(int $offset): bool;
      * Sets a violation at a given offset.
      *
      * @param int $offset The violation offset
+     *
+     * @return void
      */
     public function set(int $offset, ConstraintViolationInterface $violation);
 
     /**
      * Removes a violation at a given offset.
      *
      * @param int $offset The offset to remove
+     *
+     * @return void
      */
     public function remove(int $offset);
 }

Constraints/NoSuspiciousCharactersValidator.php

@@ -56,6 +56,9 @@ public function __construct(private readonly array $defaultLocales = [])
     {
     }
 
+    /**
+     * @return void
+     */
     public function validate(mixed $value, Constraint $constraint)
     {
         if (!$constraint instanceof NoSuspiciousCharacters) {

Context/ExecutionContextInterface.php

@@ -29,7 +29,7 @@
  * When you make another call to the validator, while the validation is in
  * progress, the violations will be isolated from each other:
  *
- *     public function validate(mixed $value, Constraint $constraint)
+ *     public function validate(mixed $value, Constraint $constraint): void
  *     {
  *         $validator = $this->context->getValidator();
  *
@@ -40,7 +40,7 @@
  * However, if you want to add the violations to the current context, use the
  * {@link ValidatorInterface::inContext()} method:
  *
- *     public function validate(mixed $value, Constraint $constraint)
+ *     public function validate(mixed $value, Constraint $constraint): void
  *     {
  *         $validator = $this->context->getValidator();
  *
@@ -93,7 +93,7 @@ public function buildViolation(string $message, array $parameters = []): Constra
      *
      * Useful if you want to validate additional constraints:
      *
-     *     public function validate(mixed $value, Constraint $constraint)
+     *     public function validate(mixed $value, Constraint $constraint): void
      *     {
      *         $validator = $this->context->getValidator();
      *

ObjectInitializerInterface.php

@@ -22,5 +22,8 @@
  */
 interface ObjectInitializerInterface
 {
+    /**
+     * @return void
+     */
     public function initialize(object $object);
 }

Tests/ConstraintValidatorTest.php

@@ -56,7 +56,7 @@ public static function formatValueProvider()
 
 final class TestFormatValueConstraintValidator extends ConstraintValidator
 {
-    public function validate($value, Constraint $constraint)
+    public function validate($value, Constraint $constraint): void
     {
     }
 

Tests/Fixtures/DummyConstraintValidator.php

@@ -16,7 +16,7 @@
 
 class DummyConstraintValidator extends ConstraintValidator
 {
-    public function validate($value, Constraint $constraint)
+    public function validate($value, Constraint $constraint): void
     {
     }
 }

Tests/Fixtures/FailingConstraintValidator.php

@@ -16,7 +16,7 @@
 
 class FailingConstraintValidator extends ConstraintValidator
 {
-    public function validate($value, Constraint $constraint)
+    public function validate($value, Constraint $constraint): void
     {
         $this->context->addViolation($constraint->message, []);
     }

Tests/Test/ConstraintValidatorTestCaseTest.php

@@ -55,7 +55,7 @@ public function testAssertingContextualValidatorRemainingExpectationsThrow()
 
 class TestCustomValidator extends ConstraintValidator
 {
-    public function validate($value, Constraint $constraint)
+    public function validate($value, Constraint $constraint): void
     {
         $validator = $this->context
             ->getValidator()

Tests/Validator/RecursiveValidatorTest.php

@@ -2362,7 +2362,7 @@ final class TestConstraintHashesDoNotCollide extends Constraint
 
 final class TestConstraintHashesDoNotCollideValidator extends ConstraintValidator
 {
-    public function validate($value, Constraint $constraint)
+    public function validate($value, Constraint $constraint): void
     {
         if (!$value instanceof Entity) {
             throw new \LogicException();

Violation/ConstraintViolationBuilderInterface.php

@@ -107,6 +107,8 @@ public function setCause(mixed $cause): static;
 
     /**
      * Adds the violation to the current execution context.
+     *
+     * @return void
      */
     public function addViolation();
 }