minor symfony#57437 [Validator][Yaml] Add more precise types for the Yaml flags (stof)

This PR was merged into the 7.2 branch.

Discussion
----------

[Validator][Yaml] Add more precise types for the Yaml flags

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

Describing that the `$flags` parameter is a bit field of the appropriate constants allows static analyzers to report  invalid usages.

Commits
-------

31592e9 Add more precise types for the Yaml flags

Author: fabpot

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

@@ -28,6 +28,10 @@ class Yaml extends Constraint
         self::INVALID_YAML_ERROR => 'INVALID_YAML_ERROR',
     ];
 
+    /**
+     * @param int-mask-of<\Symfony\Component\Yaml\Yaml::PARSE_*> $flags
+     * @param string[]|null                                      $groups
+     */
     #[HasNamedArguments]
     public function __construct(
         public string $message = 'This value is not valid YAML.',

src/Symfony/Component/Yaml/Dumper.php

@@ -39,10 +39,10 @@ public function __construct(int $indentation = 4)
     /**
      * Dumps a PHP value to YAML.
      *
-     * @param mixed $input  The PHP value
-     * @param int   $inline The level where you switch to inline YAML
-     * @param int   $indent The level of indentation (used internally)
-     * @param int   $flags  A bit field of Yaml::DUMP_* constants to customize the dumped YAML string
+     * @param mixed                     $input  The PHP value
+     * @param int                       $inline The level where you switch to inline YAML
+     * @param int                       $indent The level of indentation (used internally)
+     * @param int-mask-of<Yaml::DUMP_*> $flags  A bit field of Yaml::DUMP_* constants to customize the dumped YAML string
      */
     public function dump(mixed $input, int $inline = 0, int $indent = 0, int $flags = 0): string
     {

src/Symfony/Component/Yaml/Parser.php

@@ -42,8 +42,8 @@ class Parser
     /**
      * Parses a YAML file into a PHP value.
      *
-     * @param string $filename The path to the YAML file to be parsed
-     * @param int    $flags    A bit field of Yaml::PARSE_* constants to customize the YAML parser behavior
+     * @param string                     $filename The path to the YAML file to be parsed
+     * @param int-mask-of<Yaml::PARSE_*> $flags    A bit field of Yaml::PARSE_* constants to customize the YAML parser behavior
      *
      * @throws ParseException If the file could not be read or the YAML is not valid
      */
@@ -69,8 +69,8 @@ public function parseFile(string $filename, int $flags = 0): mixed
     /**
      * Parses a YAML string to a PHP value.
      *
-     * @param string $value A YAML string
-     * @param int    $flags A bit field of Yaml::PARSE_* constants to customize the YAML parser behavior
+     * @param string                     $value A YAML string
+     * @param int-mask-of<Yaml::PARSE_*> $flags A bit field of Yaml::PARSE_* constants to customize the YAML parser behavior
      *
      * @throws ParseException If the YAML is not valid
      */

src/Symfony/Component/Yaml/Yaml.php

@@ -44,8 +44,8 @@ class Yaml
      *     $array = Yaml::parseFile('config.yml');
      *     print_r($array);
      *
-     * @param string $filename The path to the YAML file to be parsed
-     * @param int    $flags    A bit field of PARSE_* constants to customize the YAML parser behavior
+     * @param string                     $filename The path to the YAML file to be parsed
+     * @param int-mask-of<self::PARSE_*> $flags    A bit field of PARSE_* constants to customize the YAML parser behavior
      *
      * @throws ParseException If the file could not be read or the YAML is not valid
      */
@@ -65,8 +65,8 @@ public static function parseFile(string $filename, int $flags = 0): mixed
      *   print_r($array);
      *  </code>
      *
-     * @param string $input A string containing YAML
-     * @param int    $flags A bit field of PARSE_* constants to customize the YAML parser behavior
+     * @param string                     $input A string containing YAML
+     * @param int-mask-of<self::PARSE_*> $flags A bit field of PARSE_* constants to customize the YAML parser behavior
      *
      * @throws ParseException If the YAML is not valid
      */
@@ -83,10 +83,10 @@ public static function parse(string $input, int $flags = 0): mixed
      * The dump method, when supplied with an array, will do its best
      * to convert the array into friendly YAML.
      *
-     * @param mixed $input  The PHP value
-     * @param int   $inline The level where you switch to inline YAML
-     * @param int   $indent The amount of spaces to use for indentation of nested nodes
-     * @param int   $flags  A bit field of DUMP_* constants to customize the dumped YAML string
+     * @param mixed                     $input  The PHP value
+     * @param int                       $inline The level where you switch to inline YAML
+     * @param int                       $indent The amount of spaces to use for indentation of nested nodes
+     * @param int-mask-of<self::DUMP_*> $flags  A bit field of DUMP_* constants to customize the dumped YAML string
      */
     public static function dump(mixed $input, int $inline = 2, int $indent = 4, int $flags = 0): string
     {