Merge branch '5.4' into 6.0

* 5.4:
  [Serializer] cs fix
  Cleanup more `@return` annotations
  [Form] Fix phpdoc on FormBuilderInterface

Author: nicolas-grekas

BinaryFileResponse.php

@@ -95,8 +95,6 @@ public function setFile(\SplFileInfo|string $file, string $contentDisposition =
 
     /**
      * Gets the file.
-     *
-     * @return File The file to stream
      */
     public function getFile(): File
     {

File/File.php

@@ -47,8 +47,6 @@ public function __construct(string $path, bool $checkPath = true)
      * This method uses the mime type as guessed by getMimeType()
      * to guess the file extension.
      *
-     * @return string|null The guessed extension or null if it cannot be guessed
-     *
      * @see MimeTypes
      * @see getMimeType()
      */
@@ -68,8 +66,6 @@ public function guessExtension(): ?string
      * which uses finfo_file() then the "file" system binary,
      * depending on which of those are available.
      *
-     * @return string|null The guessed mime type (e.g. "application/pdf")
-     *
      * @see MimeTypes
      */
     public function getMimeType(): ?string
@@ -84,8 +80,6 @@ public function getMimeType(): ?string
     /**
      * Moves the file to a new location.
      *
-     * @return self A File object representing the new file
-     *
      * @throws FileException if the target file could not be created
      */
     public function move(string $directory, string $name = null): self

File/UploadedFile.php

@@ -75,8 +75,6 @@ public function __construct(string $path, string $originalName, string $mimeType
      *
      * It is extracted from the request from which the file has been uploaded.
      * Then it should not be considered as a safe value.
-     *
-     * @return string The original name
      */
     public function getClientOriginalName(): string
     {
@@ -88,8 +86,6 @@ public function getClientOriginalName(): string
      *
      * It is extracted from the original file name that was uploaded.
      * Then it should not be considered as a safe value.
-     *
-     * @return string The extension
      */
     public function getClientOriginalExtension(): string
     {
@@ -105,8 +101,6 @@ public function getClientOriginalExtension(): string
      * For a trusted mime type, use getMimeType() instead (which guesses the mime
      * type based on the file content).
      *
-     * @return string The mime type
-     *
      * @see getMimeType()
      */
     public function getClientMimeType(): string
@@ -126,8 +120,6 @@ public function getClientMimeType(): string
      * For a trusted extension, use guessExtension() instead (which guesses
      * the extension based on the guessed mime type for the file).
      *
-     * @return string|null The guessed extension or null if it cannot be guessed
-     *
      * @see guessExtension()
      * @see getClientMimeType()
      */
@@ -145,18 +137,14 @@ public function guessClientExtension(): ?string
      *
      * If the upload was successful, the constant UPLOAD_ERR_OK is returned.
      * Otherwise one of the other UPLOAD_ERR_XXX constants is returned.
-     *
-     * @return int The upload error
      */
     public function getError(): int
     {
         return $this->error;
     }
 
     /**
-     * Returns whether the file was uploaded successfully.
-     *
-     * @return bool True if the file has been uploaded with HTTP and no error occurred
+     * Returns whether the file has been uploaded with HTTP and no error occurred.
      */
     public function isValid(): bool
     {
@@ -168,8 +156,6 @@ public function isValid(): bool
     /**
      * Moves the file to a new location.
      *
-     * @return File A File object representing the new file
-     *
      * @throws FileException if, for any reason, the file could not have been moved
      */
     public function move(string $directory, string $name = null): File
@@ -258,8 +244,6 @@ private static function parseFilesize(string $size): int|float
 
     /**
      * Returns an informative upload error message.
-     *
-     * @return string The error message regarding the specified error code
      */
     public function getErrorMessage(): string
     {

HeaderBag.php

@@ -57,8 +57,6 @@ public function __toString(): string
      * Returns the headers.
      *
      * @param string|null $key The name of the headers to return or null to get them all
-     *
-     * @return array An array of headers
      */
     public function all(string $key = null): array
     {
@@ -71,8 +69,6 @@ public function all(string $key = null): array
 
     /**
      * Returns the parameter keys.
-     *
-     * @return array An array of parameter keys
      */
     public function keys(): array
     {
@@ -99,9 +95,7 @@ public function add(array $headers)
     }
 
     /**
-     * Returns a header value by name.
-     *
-     * @return string|null The first header value or default value
+     * Returns the first header by name or the default one.
      */
     public function get(string $key, string $default = null): ?string
     {
@@ -151,8 +145,6 @@ public function set(string $key, string|array|null $values, bool $replace = true
 
     /**
      * Returns true if the HTTP header is defined.
-     *
-     * @return bool true if the parameter exists, false otherwise
      */
     public function has(string $key): bool
     {
@@ -161,8 +153,6 @@ public function has(string $key): bool
 
     /**
      * Returns true if the given HTTP header contains the given value.
-     *
-     * @return bool true if the value is contained in the header, false otherwise
      */
     public function contains(string $key, string $value): bool
     {
@@ -186,8 +176,6 @@ public function remove(string $key)
     /**
      * Returns the HTTP header value converted to a date.
      *
-     * @return \DateTimeInterface|null The parsed DateTime or the default value if the header does not exist
-     *
      * @throws \RuntimeException When the HTTP header is not parseable
      */
     public function getDate(string $key, \DateTime $default = null): ?\DateTimeInterface
@@ -215,8 +203,6 @@ public function addCacheControlDirective(string $key, bool|string $value = true)
 
     /**
      * Returns true if the Cache-Control directive is defined.
-     *
-     * @return bool true if the directive exists, false otherwise
      */
     public function hasCacheControlDirective(string $key): bool
     {
@@ -225,8 +211,6 @@ public function hasCacheControlDirective(string $key): bool
 
     /**
      * Returns a Cache-Control directive value by name.
-     *
-     * @return bool|string|null The directive value if defined, null otherwise
      */
     public function getCacheControlDirective(string $key): bool|string|null
     {
@@ -268,8 +252,6 @@ protected function getCacheControlHeader()
 
     /**
      * Parses a Cache-Control HTTP header.
-     *
-     * @return array An array representing the attribute values
      */
     protected function parseCacheControl(string $header): array
     {

HeaderUtils.php

@@ -154,8 +154,6 @@ public static function unquote(string $s): string
      *                                 is semantically equivalent to $filename. If the filename is already ASCII,
      *                                 it can be omitted, or just copied from $filename
      *
-     * @return string A string suitable for use as a Content-Disposition field-value
-     *
      * @throws \InvalidArgumentException
      *
      * @see RFC 6266

IpUtils.php

@@ -31,8 +31,6 @@ private function __construct()
      * Checks if an IPv4 or IPv6 address is contained in the list of given IPs or subnets.
      *
      * @param string|array $ips List of IPs or subnets (can be a string if only a single one)
-     *
-     * @return bool Whether the IP is valid
      */
     public static function checkIp(?string $requestIp, string|array $ips): bool
     {
@@ -102,8 +100,6 @@ public static function checkIp4(?string $requestIp, string $ip): bool
      *
      * @param string $ip IPv6 address or subnet in CIDR notation
      *
-     * @return bool Whether the IP is valid
-     *
      * @throws \RuntimeException When IPV6 support is not enabled
      */
     public static function checkIp6(?string $requestIp, string $ip): bool

ParameterBag.php

@@ -34,8 +34,6 @@ public function __construct(array $parameters = [])
      * Returns the parameters.
      *
      * @param string|null $key The name of the parameter to return or null to get them all
-     *
-     * @return array An array of parameters
      */
     public function all(/*string $key = null*/): array
     {
@@ -54,8 +52,6 @@ public function all(/*string $key = null*/): array
 
     /**
      * Returns the parameter keys.
-     *
-     * @return array An array of parameter keys
      */
     public function keys(): array
     {
@@ -90,8 +86,6 @@ public function set(string $key, mixed $value)
 
     /**
      * Returns true if the parameter is defined.
-     *
-     * @return bool true if the parameter exists, false otherwise
      */
     public function has(string $key): bool
     {
@@ -108,8 +102,6 @@ public function remove(string $key)
 
     /**
      * Returns the alphabetic characters of the parameter value.
-     *
-     * @return string The filtered value
      */
     public function getAlpha(string $key, string $default = ''): string
     {
@@ -118,8 +110,6 @@ public function getAlpha(string $key, string $default = ''): string
 
     /**
      * Returns the alphabetic characters and digits of the parameter value.
-     *
-     * @return string The filtered value
      */
     public function getAlnum(string $key, string $default = ''): string
     {
@@ -128,8 +118,6 @@ public function getAlnum(string $key, string $default = ''): string
 
     /**
      * Returns the digits of the parameter value.
-     *
-     * @return string The filtered value
      */
     public function getDigits(string $key, string $default = ''): string
     {
@@ -139,8 +127,6 @@ public function getDigits(string $key, string $default = ''): string
 
     /**
      * Returns the parameter value converted to integer.
-     *
-     * @return int The filtered value
      */
     public function getInt(string $key, int $default = 0): int
     {
@@ -149,8 +135,6 @@ public function getInt(string $key, int $default = 0): int
 
     /**
      * Returns the parameter value converted to boolean.
-     *
-     * @return bool The filtered value
      */
     public function getBoolean(string $key, bool $default = false): bool
     {

RedirectResponse.php

@@ -49,8 +49,6 @@ public function __construct(string $url, int $status = 302, array $headers = [])
 
     /**
      * Returns the target URL.
-     *
-     * @return string target URL
      */
     public function getTargetUrl(): string
     {