minor symfony#58049 [Validator] Add more precise PHPDoc on constraints (alexandre-daubois)

This PR was merged into the 7.2 branch.

Discussion
----------

[Validator] Add more precise PHPDoc on constraints

| Q             | A
| ------------- | ---
| Branch?       | 7.2
| Bug fix?      | no
| New feature?  | no
| Deprecations? | no
| Issues        | -
| License       | MIT

Commits
-------

923b0c6 [Validator] Add more precise PHPDoc

Author: fabpot

src/Symfony/Component/Validator/Constraints/CardScheme.php

@@ -47,9 +47,9 @@ class CardScheme extends Constraint
     public array|string|null $schemes = null;
 
     /**
-     * @param string|string[]|array<string,mixed>|null $schemes Name(s) of the number scheme(s) used to validate the credit card number
-     * @param string[]|null                            $groups
-     * @param array<string,mixed>                      $options
+     * @param non-empty-string|non-empty-string[]|array<string,mixed>|null $schemes Name(s) of the number scheme(s) used to validate the credit card number
+     * @param string[]|null                                                $groups
+     * @param array<string,mixed>                                          $options
      */
     public function __construct(array|string|null $schemes, ?string $message = null, ?array $groups = null, mixed $payload = null, array $options = [])
     {

src/Symfony/Component/Validator/Constraints/Cascade.php

@@ -25,8 +25,8 @@ class Cascade extends Constraint
     public array $exclude = [];
 
     /**
-     * @param string[]|string|array<string,mixed>|null $exclude Properties excluded from validation
-     * @param array<string,mixed>|null                 $options
+     * @param non-empty-string[]|non-empty-string|array<string,mixed>|null $exclude Properties excluded from validation
+     * @param array<string,mixed>|null                                     $options
      */
     public function __construct(array|string|null $exclude = null, ?array $options = null)
     {

src/Symfony/Component/Validator/Constraints/Choice.php

@@ -54,8 +54,8 @@ public function getDefaultOption(): ?string
      * @param callable|string|null $callback Callback method to use instead of the choice option to get the choices
      * @param bool|null            $multiple Whether to expect the value to be an array of valid choices (defaults to false)
      * @param bool|null            $strict   This option defaults to true and should not be used
-     * @param int|null             $min      Minimum of valid choices if multiple values are expected
-     * @param int|null             $max      Maximum of valid choices if multiple values are expected
+     * @param int<0, max>|null     $min      Minimum of valid choices if multiple values are expected
+     * @param positive-int|null    $max      Maximum of valid choices if multiple values are expected
      * @param string[]|null        $groups
      * @param bool|null            $match    Whether to validate the values are part of the choices or not (defaults to true)
      */

src/Symfony/Component/Validator/Constraints/Count.php

@@ -43,12 +43,12 @@ class Count extends Constraint
     public ?int $divisibleBy = null;
 
     /**
-     * @param int|array<string,mixed>|null $exactly     The exact expected number of elements
-     * @param int|null                     $min         Minimum expected number of elements
-     * @param int|null                     $max         Maximum expected number of elements
-     * @param int|null                     $divisibleBy The number the collection count should be divisible by
-     * @param string[]|null                $groups
-     * @param array<mixed,string>          $options
+     * @param int<0, max>|array<string,mixed>|null $exactly     The exact expected number of elements
+     * @param int<0, max>|null                     $min         Minimum expected number of elements
+     * @param positive-int|null                    $max         Maximum expected number of elements
+     * @param positive-int|null                    $divisibleBy The number the collection count should be divisible by
+     * @param string[]|null                        $groups
+     * @param array<mixed,string>                  $options
      */
     public function __construct(
         int|array|null $exactly = null,

src/Symfony/Component/Validator/Constraints/CssColor.php

@@ -62,9 +62,9 @@ class CssColor extends Constraint
     public array|string $formats;
 
     /**
-     * @param string[]|string|array<string,mixed> $formats The types of CSS colors allowed ({@see https://symfony.com/doc/current/reference/constraints/CssColor.html#formats})
-     * @param string[]|null                       $groups
-     * @param array<string,mixed>|null            $options
+     * @param non-empty-string[]|non-empty-string|array<string,mixed> $formats The types of CSS colors allowed ({@see https://symfony.com/doc/current/reference/constraints/CssColor.html#formats})
+     * @param string[]|null                                           $groups
+     * @param array<string,mixed>|null                                $options
      */
     public function __construct(array|string $formats = [], ?string $message = null, ?array $groups = null, $payload = null, ?array $options = null)
     {

src/Symfony/Component/Validator/Constraints/DateTime.php

@@ -37,9 +37,9 @@ class DateTime extends Constraint
     public string $message = 'This value is not a valid datetime.';
 
     /**
-     * @param string|array<string,mixed>|null $format  The datetime format to match (defaults to 'Y-m-d H:i:s')
-     * @param string[]|null                   $groups
-     * @param array<string,mixed>             $options
+     * @param non-empty-string|array<string,mixed>|null $format  The datetime format to match (defaults to 'Y-m-d H:i:s')
+     * @param string[]|null                             $groups
+     * @param array<string,mixed>                       $options
      */
     public function __construct(string|array|null $format = null, ?string $message = null, ?array $groups = null, mixed $payload = null, array $options = [])
     {

src/Symfony/Component/Validator/Constraints/Expression.php

@@ -43,7 +43,7 @@ class Expression extends Constraint
      * @param array<string,mixed>|null                         $values     The values of the custom variables used in the expression (defaults to an empty array)
      * @param string[]|null                                    $groups
      * @param array<string,mixed>                              $options
-     * @param bool|null                                        $negate     Whether to fail is the expression evaluates to true (defaults to false)
+     * @param bool|null                                        $negate     Whether to fail if the expression evaluates to true (defaults to false)
      */
     public function __construct(
         string|ExpressionObject|array|null $expression,

src/Symfony/Component/Validator/Constraints/ExpressionSyntax.php

@@ -33,7 +33,7 @@ class ExpressionSyntax extends Constraint
 
     /**
      * @param array<string,mixed>|null $options
-     * @param string|null              $service          The service used to validate the constraint instead of the default one
+     * @param non-empty-string|null    $service          The service used to validate the constraint instead of the default one
      * @param string[]|null            $allowedVariables Restrict the available variables in the expression to these values (defaults to null that allows any variable)
      * @param string[]|null            $groups
      */

src/Symfony/Component/Validator/Constraints/File.php

@@ -73,10 +73,10 @@ class File extends Constraint
 
     /**
      * @param array<string,mixed>|null           $options
-     * @param int|string|null                    $maxSize                     The max size of the underlying file
+     * @param positive-int|string|null           $maxSize                     The max size of the underlying file
      * @param bool|null                          $binaryFormat                Pass true to use binary-prefixed units (KiB, MiB, etc.) or false to use SI-prefixed units (kB, MB) in displayed messages. Pass null to guess the format from the maxSize option. (defaults to null)
      * @param string[]|string|null               $mimeTypes                   Acceptable media type(s). Prefer the extensions option that also enforce the file's extension consistency.
-     * @param int|null                           $filenameMaxLength           Maximum length of the file name
+     * @param positive-int|null                  $filenameMaxLength           Maximum length of the file name
      * @param string|null                        $disallowEmptyMessage        Enable empty upload validation with this message in case of error
      * @param string|null                        $uploadIniSizeErrorMessage   Message if the file size exceeds the max size configured in php.ini
      * @param string|null                        $uploadFormSizeErrorMessage  Message if the file size exceeds the max size configured in the HTML input field

src/Symfony/Component/Validator/Constraints/Image.php

@@ -90,10 +90,10 @@ class Image extends File
 
     /**
      * @param array<string,mixed>|null $options
-     * @param int|string|null          $maxSize                     The max size of the underlying file
+     * @param positive-int|string|null $maxSize                     The max size of the underlying file
      * @param bool|null                $binaryFormat                Pass true to use binary-prefixed units (KiB, MiB, etc.) or false to use SI-prefixed units (kB, MB) in displayed messages. Pass null to guess the format from the maxSize option. (defaults to null)
-     * @param string[]|null            $mimeTypes                   Acceptable media types
-     * @param int|null                 $filenameMaxLength           Maximum length of the file name
+     * @param non-empty-string[]|null  $mimeTypes                   Acceptable media types
+     * @param positive-int|null        $filenameMaxLength           Maximum length of the file name
      * @param string|null              $disallowEmptyMessage        Enable empty upload validation with this message in case of error
      * @param string|null              $uploadIniSizeErrorMessage   Message if the file size exceeds the max size configured in php.ini
      * @param string|null              $uploadFormSizeErrorMessage  Message if the file size exceeds the max size configured in the HTML input field
@@ -102,14 +102,14 @@ class Image extends File
      * @param string|null              $uploadCantWriteErrorMessage Message if the uploaded file can not be stored in the temporary directory
      * @param string|null              $uploadErrorMessage          Message if an unknown error occurred on upload
      * @param string[]|null            $groups
-     * @param int|null                 $minWidth                    Minimum image width
-     * @param int|null                 $maxWidth                    Maximum image width
-     * @param int|null                 $maxHeight                   Maximum image height
-     * @param int|null                 $minHeight                   Minimum image weight
-     * @param int|float|null           $maxRatio                    Maximum image ratio
-     * @param int|float|null           $minRatio                    Minimum image ration
-     * @param int|float|null           $minPixels                   Minimum amount of pixels
-     * @param int|float|null           $maxPixels                   Maximum amount of pixels
+     * @param int<0, int>|null         $minWidth                    Minimum image width
+     * @param positive-int|null        $maxWidth                    Maximum image width
+     * @param positive-int|null        $maxHeight                   Maximum image height
+     * @param int<0, int>|null         $minHeight                   Minimum image weight
+     * @param positive-int|float|null  $maxRatio                    Maximum image ratio
+     * @param int<0, max>|float|null   $minRatio                    Minimum image ration
+     * @param int<0, max>|float|null   $minPixels                   Minimum amount of pixels
+     * @param positive-int|float|null  $maxPixels                   Maximum amount of pixels
      * @param bool|null                $allowSquare                 Whether to allow a square image (defaults to true)
      * @param bool|null                $allowLandscape              Whether to allow a landscape image (defaults to true)
      * @param bool|null                $allowPortrait               Whether to allow a portrait image (defaults to true)