minor #36057 [Validator] clarify stringable type annotations (nicolas-grekas)

nicolas-grekas · nicolas-grekas · commit cbb9d01b6cdb · 2020-03-13T11:26:47.000+01:00
This PR was merged into the 3.4 branch. Discussion ---------- [Validator] clarify stringable type annotations | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - Commits ------- 0ee97f2 [Validator] clarify stringable type annotations
diff --git a/src/Symfony/Component/Validator/ConstraintViolation.php b/src/Symfony/Component/Validator/ConstraintViolation.php
@@ -32,22 +32,22 @@ class ConstraintViolation implements ConstraintViolationInterface
     /**
      * Creates a new constraint violation.
      *
-     * @param string          $message         The violation message
-     * @param string          $messageTemplate The raw violation message
-     * @param array           $parameters      The parameters to substitute in the
-     *                                         raw violation message
-     * @param mixed           $root            The value originally passed to the
-     *                                         validator
-     * @param string          $propertyPath    The property path from the root
-     *                                         value to the invalid value
-     * @param mixed           $invalidValue    The invalid value that caused this
-     *                                         violation
-     * @param int|null        $plural          The number for determining the plural
-     *                                         form when translating the message
-     * @param mixed           $code            The error code of the violation
-     * @param Constraint|null $constraint      The constraint whose validation
-     *                                         caused the violation
-     * @param mixed           $cause           The cause of the violation
+     * @param string|\Stringable $message         The violation message as a string or a stringable object
+     * @param string             $messageTemplate The raw violation message
+     * @param array              $parameters      The parameters to substitute in the
+     *                                            raw violation message
+     * @param mixed              $root            The value originally passed to the
+     *                                            validator
+     * @param string             $propertyPath    The property path from the root
+     *                                            value to the invalid value
+     * @param mixed              $invalidValue    The invalid value that caused this
+     *                                            violation
+     * @param int|null           $plural          The number for determining the plural
+     *                                            form when translating the message
+     * @param mixed              $code            The error code of the violation
+     * @param Constraint|null    $constraint      The constraint whose validation
+     *                                            caused the violation
+     * @param mixed              $cause           The cause of the violation
      */
     public function __construct($message, $messageTemplate, array $parameters, $root, $propertyPath, $invalidValue, $plural = null, $code = null, Constraint $constraint = null, $cause = null)
     {
diff --git a/src/Symfony/Component/Validator/ConstraintViolationInterface.php b/src/Symfony/Component/Validator/ConstraintViolationInterface.php
@@ -36,7 +36,7 @@ interface ConstraintViolationInterface
     /**
      * Returns the violation message.
      *
-     * @return string The violation message
+     * @return string|\Stringable The violation message as a string or a stringable object
      */
     public function getMessage();
 
diff --git a/src/Symfony/Component/Validator/Context/ExecutionContextInterface.php b/src/Symfony/Component/Validator/Context/ExecutionContextInterface.php
@@ -64,8 +64,8 @@ interface ExecutionContextInterface
     /**
      * Adds a violation at the current node of the validation graph.
      *
-     * @param string $message The error message
-     * @param array  $params  The parameters substituted in the error message
+     * @param string|\Stringable $message The error message as a string or a stringable object
+     * @param array              $params  The parameters substituted in the error message
      */
     public function addViolation($message, array $params = []);
 
@@ -81,8 +81,8 @@ public function addViolation($message, array $params = []);
      *         ->setTranslationDomain('number_validation')
      *         ->addViolation();
      *
-     * @param string $message    The error message
-     * @param array  $parameters The parameters substituted in the error message
+     * @param string|\Stringable $message    The error message as a string or a stringable object
+     * @param array              $parameters The parameters substituted in the error message
      *
      * @return ConstraintViolationBuilderInterface The violation builder
      */

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ interface ConstraintViolationInterface`
`36`	`36`	`/**`
`37`	`37`	`* Returns the violation message.`
`38`	`38`	`*`
`39`		`- * @return string The violation message`
	`39`	`+ * @return string\|\Stringable The violation message as a string or a stringable object`
`40`	`40`	`*/`
`41`	`41`	`public function getMessage();`
`42`	`42`