[Components] Convert to native return types

Author: wouterj

BinaryFileResponse.php

@@ -358,10 +358,8 @@ public function getContent(): string|false
 
     /**
      * Trust X-Sendfile-Type header.
-     *
-     * @return void
      */
-    public static function trustXSendfileTypeHeader()
+    public static function trustXSendfileTypeHeader(): void
     {
         self::$trustXSendfileTypeHeader = true;
     }

FileBag.php

@@ -31,19 +31,13 @@ public function __construct(array $parameters = [])
         $this->replace($parameters);
     }
 
-    /**
-     * @return void
-     */
-    public function replace(array $files = [])
+    public function replace(array $files = []): void
     {
         $this->parameters = [];
         $this->add($files);
     }
 
-    /**
-     * @return void
-     */
-    public function set(string $key, mixed $value)
+    public function set(string $key, mixed $value): void
     {
         if (!\is_array($value) && !$value instanceof UploadedFile) {
             throw new \InvalidArgumentException('An uploaded file must be an array or an instance of UploadedFile.');
@@ -52,10 +46,7 @@ public function set(string $key, mixed $value)
         parent::set($key, $this->convertFileInformation($value));
     }
 
-    /**
-     * @return void
-     */
-    public function add(array $files = [])
+    public function add(array $files = []): void
     {
         foreach ($files as $key => $file) {
             $this->set($key, $file);

HeaderBag.php

@@ -86,21 +86,17 @@ public function keys(): array
 
     /**
      * Replaces the current HTTP headers by a new set.
-     *
-     * @return void
      */
-    public function replace(array $headers = [])
+    public function replace(array $headers = []): void
     {
         $this->headers = [];
         $this->add($headers);
     }
 
     /**
      * Adds new headers the current HTTP headers set.
-     *
-     * @return void
      */
-    public function add(array $headers)
+    public function add(array $headers): void
     {
         foreach ($headers as $key => $values) {
             $this->set($key, $values);
@@ -130,10 +126,8 @@ public function get(string $key, string $default = null): ?string
      *
      * @param string|string[]|null $values  The value or an array of values
      * @param bool                 $replace Whether to replace the actual value or not (true by default)
-     *
-     * @return void
      */
-    public function set(string $key, string|array|null $values, bool $replace = true)
+    public function set(string $key, string|array|null $values, bool $replace = true): void
     {
         $key = strtr($key, self::UPPER, self::LOWER);
 
@@ -176,10 +170,8 @@ public function contains(string $key, string $value): bool
 
     /**
      * Removes a header.
-     *
-     * @return void
      */
-    public function remove(string $key)
+    public function remove(string $key): void
     {
         $key = strtr($key, self::UPPER, self::LOWER);
 
@@ -193,11 +185,9 @@ public function remove(string $key)
     /**
      * Returns the HTTP header value converted to a date.
      *
-     * @return \DateTimeImmutable|null
-     *
      * @throws \RuntimeException When the HTTP header is not parseable
      */
-    public function getDate(string $key, \DateTimeInterface $default = null): ?\DateTimeInterface
+    public function getDate(string $key, \DateTimeInterface $default = null): ?\DateTimeImmutable
     {
         if (null === $value = $this->get($key)) {
             return null !== $default ? \DateTimeImmutable::createFromInterface($default) : null;
@@ -212,10 +202,8 @@ public function getDate(string $key, \DateTimeInterface $default = null): ?\Date
 
     /**
      * Adds a custom Cache-Control directive.
-     *
-     * @return void
      */
-    public function addCacheControlDirective(string $key, bool|string $value = true)
+    public function addCacheControlDirective(string $key, bool|string $value = true): void
     {
         $this->cacheControl[$key] = $value;
 
@@ -240,10 +228,8 @@ public function getCacheControlDirective(string $key): bool|string|null
 
     /**
      * Removes a Cache-Control directive.
-     *
-     * @return void
      */
-    public function removeCacheControlDirective(string $key)
+    public function removeCacheControlDirective(string $key): void
     {
         unset($this->cacheControl[$key]);
 
@@ -268,10 +254,7 @@ public function count(): int
         return \count($this->headers);
     }
 
-    /**
-     * @return string
-     */
-    protected function getCacheControlHeader()
+    protected function getCacheControlHeader(): string
     {
         ksort($this->cacheControl);
 

ParameterBag.php

@@ -60,20 +60,16 @@ public function keys(): array
 
     /**
      * Replaces the current parameters by a new set.
-     *
-     * @return void
      */
-    public function replace(array $parameters = [])
+    public function replace(array $parameters = []): void
     {
         $this->parameters = $parameters;
     }
 
     /**
      * Adds parameters.
-     *
-     * @return void
      */
-    public function add(array $parameters = [])
+    public function add(array $parameters = []): void
     {
         $this->parameters = array_replace($this->parameters, $parameters);
     }
@@ -83,10 +79,7 @@ public function get(string $key, mixed $default = null): mixed
         return \array_key_exists($key, $this->parameters) ? $this->parameters[$key] : $default;
     }
 
-    /**
-     * @return void
-     */
-    public function set(string $key, mixed $value)
+    public function set(string $key, mixed $value): void
     {
         $this->parameters[$key] = $value;
     }
@@ -101,10 +94,8 @@ public function has(string $key): bool
 
     /**
      * Removes a parameter.
-     *
-     * @return void
      */
-    public function remove(string $key)
+    public function remove(string $key): void
     {
         unset($this->parameters[$key]);
     }

Request.php

@@ -265,10 +265,8 @@ public function __construct(array $query = [], array $request = [], array $attri
      * @param array                $files      The FILES parameters
      * @param array                $server     The SERVER parameters
      * @param string|resource|null $content    The raw body data
-     *
-     * @return void
      */
-    public function initialize(array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], $content = null)
+    public function initialize(array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], $content = null): void
     {
         $this->request = new InputBag($request);
         $this->query = new InputBag($query);
@@ -424,10 +422,8 @@ public static function create(string $uri, string $method = 'GET', array $parame
      * This is mainly useful when you need to override the Request class
      * to keep BC with an existing system. It should not be used for any
      * other purpose.
-     *
-     * @return void
      */
-    public static function setFactory(?callable $callable)
+    public static function setFactory(?callable $callable): void
     {
         self::$requestFactory = $callable;
     }
@@ -530,10 +526,8 @@ public function __toString(): string
      *
      * It overrides $_GET, $_POST, $_REQUEST, $_SERVER, $_COOKIE.
      * $_FILES is never overridden, see rfc1867
-     *
-     * @return void
      */
-    public function overrideGlobals()
+    public function overrideGlobals(): void
     {
         $this->server->set('QUERY_STRING', static::normalizeQueryString(http_build_query($this->query->all(), '', '&')));
 
@@ -572,10 +566,8 @@ public function overrideGlobals()
      *
      * @param array $proxies          A list of trusted proxies, the string 'REMOTE_ADDR' will be replaced with $_SERVER['REMOTE_ADDR']
      * @param int   $trustedHeaderSet A bit field of Request::HEADER_*, to set which headers to trust from your proxies
-     *
-     * @return void
      */
-    public static function setTrustedProxies(array $proxies, int $trustedHeaderSet)
+    public static function setTrustedProxies(array $proxies, int $trustedHeaderSet): void
     {
         self::$trustedProxies = array_reduce($proxies, function ($proxies, $proxy) {
             if ('REMOTE_ADDR' !== $proxy) {
@@ -615,10 +607,8 @@ public static function getTrustedHeaderSet(): int
      * You should only list the hosts you manage using regexs.
      *
      * @param array $hostPatterns A list of trusted host patterns
-     *
-     * @return void
      */
-    public static function setTrustedHosts(array $hostPatterns)
+    public static function setTrustedHosts(array $hostPatterns): void
     {
         self::$trustedHostPatterns = array_map(fn ($hostPattern) => sprintf('{%s}i', $hostPattern), $hostPatterns);
         // we need to reset trusted hosts on trusted host patterns change
@@ -663,10 +653,8 @@ public static function normalizeQueryString(?string $qs): string
      * If these methods are not protected against CSRF, this presents a possible vulnerability.
      *
      * The HTTP method can only be overridden when the real HTTP method is POST.
-     *
-     * @return void
      */
-    public static function enableHttpMethodParameterOverride()
+    public static function enableHttpMethodParameterOverride(): void
     {
         self::$httpMethodParameterOverride = true;
     }
@@ -750,10 +738,7 @@ public function hasSession(bool $skipIfUninitialized = false): bool
         return null !== $this->session && (!$skipIfUninitialized || $this->session instanceof SessionInterface);
     }
 
-    /**
-     * @return void
-     */
-    public function setSession(SessionInterface $session)
+    public function setSession(SessionInterface $session): void
     {
         $this->session = $session;
     }
@@ -1173,10 +1158,8 @@ public function getHost(): string
 
     /**
      * Sets the request method.
-     *
-     * @return void
      */
-    public function setMethod(string $method)
+    public function setMethod(string $method): void
     {
         $this->method = null;
         $this->server->set('REQUEST_METHOD', $method);
@@ -1296,10 +1279,8 @@ public function getFormat(?string $mimeType): ?string
      * Associates a format with mime types.
      *
      * @param string|string[] $mimeTypes The associated mime types (the preferred one must be the first as it will be used as the content type)
-     *
-     * @return void
      */
-    public function setFormat(?string $format, string|array $mimeTypes)
+    public function setFormat(?string $format, string|array $mimeTypes): void
     {
         if (null === static::$formats) {
             static::initializeFormats();
@@ -1328,10 +1309,8 @@ public function getRequestFormat(?string $default = 'html'): ?string
 
     /**
      * Sets the request format.
-     *
-     * @return void
      */
-    public function setRequestFormat(?string $format)
+    public function setRequestFormat(?string $format): void
     {
         $this->format = $format;
     }
@@ -1348,10 +1327,8 @@ public function getContentTypeFormat(): ?string
 
     /**
      * Sets the default locale.
-     *
-     * @return void
      */
-    public function setDefaultLocale(string $locale)
+    public function setDefaultLocale(string $locale): void
     {
         $this->defaultLocale = $locale;
 
@@ -1370,10 +1347,8 @@ public function getDefaultLocale(): string
 
     /**
      * Sets the locale.
-     *
-     * @return void
      */
-    public function setLocale(string $locale)
+    public function setLocale(string $locale): void
     {
         $this->setPhpDefaultLocale($this->locale = $locale);
     }
@@ -1739,10 +1714,7 @@ public function preferSafeContent(): bool
      * Copyright (c) 2005-2010 Zend Technologies USA Inc. (https://www.zend.com/)
      */
 
-    /**
-     * @return string
-     */
-    protected function prepareRequestUri()
+    protected function prepareRequestUri(): string
     {
         $requestUri = '';
 
@@ -1910,10 +1882,8 @@ protected function preparePathInfo(): string
 
     /**
      * Initializes HTTP request formats.
-     *
-     * @return void
      */
-    protected static function initializeFormats()
+    protected static function initializeFormats(): void
     {
         static::$formats = [
             'html' => ['text/html', 'application/xhtml+xml'],

RequestStack.php

@@ -31,10 +31,8 @@ class RequestStack
      *
      * This method should generally not be called directly as the stack
      * management should be taken care of by the application itself.
-     *
-     * @return void
      */
-    public function push(Request $request)
+    public function push(Request $request): void
     {
         $this->requests[] = $request;
     }

Response.php

@@ -331,8 +331,6 @@ public function prepare(Request $request): static
     /**
      * Sends HTTP headers.
      *
-     * @param null|positive-int $statusCode The status code to use, override the statusCode property if set and not null
-     *
      * @return $this
      */
     public function sendHeaders(/* int $statusCode = null */): static
@@ -372,7 +370,7 @@ public function sendHeaders(/* int $statusCode = null */): static
                 $newValues = null === $previousValues ? $values : array_diff($values, $previousValues);
             }
 
-            foreach ($newValues  as $value) {
+            foreach ($newValues as $value) {
                 header($name.': '.$value, $replace, $this->statusCode);
             }