Make the ConstraintViolationInterface & ConstraintViolationListInterface stringable

HypeMC · HypeMC · commit 91bf1b1baea6 · 2022-03-05T04:41:34.000+01:00
diff --git a/UPGRADE-6.1.md b/UPGRADE-6.1.md
@@ -29,3 +29,5 @@ Validator
 ---------
 
  * Deprecate `Constraint::$errorNames`, use `Constraint::ERROR_NAMES` instead
+ * Implementing the `ConstraintViolationInterface` or `ConstraintViolationListInterface`
+   without implementing the `__toString()` method is deprecated
diff --git a/src/Symfony/Component/Validator/CHANGELOG.md b/src/Symfony/Component/Validator/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Deprecate `Constraint::$errorNames`, use `Constraint::ERROR_NAMES` instead
+ * Add method `__toString()` to `ConstraintViolationInterface` & `ConstraintViolationListInterface`
 
 6.0
 ---
diff --git a/src/Symfony/Component/Validator/ConstraintViolation.php b/src/Symfony/Component/Validator/ConstraintViolation.php
@@ -64,7 +64,7 @@ public function __construct(string|\Stringable $message, ?string $messageTemplat
     }
 
     /**
-     * Converts the violation into a string for debugging purposes.
+     * {@inheritdoc}
      */
     public function __toString(): string
     {
diff --git a/src/Symfony/Component/Validator/ConstraintViolationInterface.php b/src/Symfony/Component/Validator/ConstraintViolationInterface.php
@@ -30,6 +30,8 @@
  * element is still the person, but the property path is "address.street".
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @method string __toString() Converts the violation into a string for debugging purposes. Not implementing it is deprecated since Symfony 6.1.
  */
 interface ConstraintViolationInterface
 {
diff --git a/src/Symfony/Component/Validator/ConstraintViolationList.php b/src/Symfony/Component/Validator/ConstraintViolationList.php
@@ -46,7 +46,7 @@ public static function createFromMessage(string $message): self
     }
 
     /**
-     * Converts the violation into a string for debugging purposes.
+     * {@inheritdoc}
      */
     public function __toString(): string
     {
diff --git a/src/Symfony/Component/Validator/ConstraintViolationListInterface.php b/src/Symfony/Component/Validator/ConstraintViolationListInterface.php
@@ -18,6 +18,8 @@
  *
  * @extends \ArrayAccess<int, ConstraintViolationInterface>
  * @extends \Traversable<int, ConstraintViolationInterface>
+ *
+ * @method string __toString() Converts the violation into a string for debugging purposes. Not implementing it is deprecated since Symfony 6.1.
  */
 interface ConstraintViolationListInterface extends \Traversable, \Countable, \ArrayAccess
 {

Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ public function __construct(string\|\Stringable $message, ?string $messageTemplat`
`64`	`64`	`}`
`65`	`65`
`66`	`66`	`/**`
`67`		`- * Converts the violation into a string for debugging purposes.`
	`67`	`+ * {@inheritdoc}`
`68`	`68`	`*/`
`69`	`69`	`public function __toString(): string`
`70`	`70`	`{`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,8 @@`
`30`	`30`	`* element is still the person, but the property path is "address.street".`
`31`	`31`	`*`
`32`	`32`	`* @author Bernhard Schussek <bschussek@gmail.com>`
	`33`	`+ *`
	`34`	`+ * @method string __toString() Converts the violation into a string for debugging purposes. Not implementing it is deprecated since Symfony 6.1.`
`33`	`35`	`*/`
`34`	`36`	`interface ConstraintViolationInterface`
`35`	`37`	`{`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ public static function createFromMessage(string $message): self`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`/**`
`49`		`- * Converts the violation into a string for debugging purposes.`
	`49`	`+ * {@inheritdoc}`
`50`	`50`	`*/`
`51`	`51`	`public function __toString(): string`
`52`	`52`	`{`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,8 @@`
`18`	`18`	`*`
`19`	`19`	`* @extends \ArrayAccess<int, ConstraintViolationInterface>`
`20`	`20`	`* @extends \Traversable<int, ConstraintViolationInterface>`
	`21`	`+ *`
	`22`	`+ * @method string __toString() Converts the violation into a string for debugging purposes. Not implementing it is deprecated since Symfony 6.1.`
`21`	`23`	`*/`
`22`	`24`	`interface ConstraintViolationListInterface extends \Traversable, \Countable, \ArrayAccess`
`23`	`25`	`{`