Improve psalm annotations in Result class (#636)

vjik · web-flow · commit 8adee52b25ec · 2023-11-22T13:02:11.000+03:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,7 @@
 - Chg #625: Improve meaning and use pluralization in error message for `OneOf` and `AtLeast` rules (@arogachev)
 - Chg #626: Disallow `$min` greater than amount of `$attributes` in `AtLeast` configuration (@arogachev)
 - Bug #632: Fix property name usage in error messages of rules in `Nested` rule (@vjik) 
+- Enh #636: Improve psalm annotations in `Result` class (@vjik)
 
 ## 1.1.0 April 06, 2023
 
diff --git a/src/Result.php b/src/Result.php
@@ -17,6 +17,7 @@ final class Result
 {
     /**
      * @var Error[] Validation errors.
+     * @psalm-var list<Error>
      */
     private array $errors = [];
 
@@ -61,6 +62,8 @@ public function getErrors(): array
      * Get errors messages as an array of strings.
      *
      * @return string[] Array messages as strings.
+     *
+     * @psalm-return list<string>
      */
     public function getErrorMessages(): array
     {
@@ -121,6 +124,8 @@ public function getErrorMessagesIndexedByAttribute(): array
      * @param string $attribute Attribute name.
      *
      * @return Error[] Array of error objects.
+     *
+     * @psalm-return list<Error>
      */
     public function getAttributeErrors(string $attribute): array
     {
@@ -139,6 +144,8 @@ public function getAttributeErrors(string $attribute): array
      * Get an array of error messages for the attribute specified.
      *
      * @return string[] Error messages.
+     *
+     * @psalm-return list<string>
      */
     public function getAttributeErrorMessages(string $attribute): array
     {
@@ -190,6 +197,8 @@ public function getAttributeErrorMessagesIndexedByPath(
      * Get common error messages that are not attached to any attribute.
      *
      * @return string[] Error messages.
+     *
+     * @psalm-return list<string>
      */
     public function getCommonErrorMessages(): array
     {

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ final class Result`
`17`	`17`	`{`
`18`	`18`	`/**`
`19`	`19`	`* @var Error[] Validation errors.`
	`20`	`+ * @psalm-var list<Error>`
`20`	`21`	`*/`
`21`	`22`	`private array $errors = [];`
`22`	`23`
`@@ -61,6 +62,8 @@ public function getErrors(): array`
`61`	`62`	`* Get errors messages as an array of strings.`
`62`	`63`	`*`
`63`	`64`	`* @return string[] Array messages as strings.`
	`65`	`+ *`
	`66`	`+ * @psalm-return list<string>`
`64`	`67`	`*/`
`65`	`68`	`public function getErrorMessages(): array`
`66`	`69`	`{`
`@@ -121,6 +124,8 @@ public function getErrorMessagesIndexedByAttribute(): array`
`121`	`124`	`* @param string $attribute Attribute name.`
`122`	`125`	`*`
`123`	`126`	`* @return Error[] Array of error objects.`
	`127`	`+ *`
	`128`	`+ * @psalm-return list<Error>`
`124`	`129`	`*/`
`125`	`130`	`public function getAttributeErrors(string $attribute): array`
`126`	`131`	`{`
`@@ -139,6 +144,8 @@ public function getAttributeErrors(string $attribute): array`
`139`	`144`	`* Get an array of error messages for the attribute specified.`
`140`	`145`	`*`
`141`	`146`	`* @return string[] Error messages.`
	`147`	`+ *`
	`148`	`+ * @psalm-return list<string>`
`142`	`149`	`*/`
`143`	`150`	`public function getAttributeErrorMessages(string $attribute): array`
`144`	`151`	`{`
`@@ -190,6 +197,8 @@ public function getAttributeErrorMessagesIndexedByPath(`
`190`	`197`	`* Get common error messages that are not attached to any attribute.`
`191`	`198`	`*`
`192`	`199`	`* @return string[] Error messages.`
	`200`	`+ *`
	`201`	`+ * @psalm-return list<string>`
`193`	`202`	`*/`
`194`	`203`	`public function getCommonErrorMessages(): array`
`195`	`204`	`{`