minor #33112 [HttpFoundation] some cleanups (azjezz)

nicolas-grekas · nicolas-grekas · commit 17f15b362463 · 2019-08-11T11:24:24.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [HttpFoundation] some cleanups | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - As found by @azjezz in #33088 Commits ------- f62a3c0 [HttpFoundation] some cleanups
diff --git a/src/Symfony/Component/HttpFoundation/AcceptHeader.php b/src/Symfony/Component/HttpFoundation/AcceptHeader.php
@@ -153,7 +153,7 @@ public function first()
     /**
      * Sorts items by descending quality.
      */
-    private function sort()
+    private function sort(): void
     {
         if (!$this->sorted) {
             uasort($this->items, function (AcceptHeaderItem $a, AcceptHeaderItem $b) {
diff --git a/src/Symfony/Component/HttpFoundation/BinaryFileResponse.php b/src/Symfony/Component/HttpFoundation/BinaryFileResponse.php
@@ -269,7 +269,7 @@ public function prepare(Request $request)
         return $this;
     }
 
-    private function hasValidIfRangeHeader(?string $header)
+    private function hasValidIfRangeHeader(?string $header): bool
     {
         if ($this->getEtag() === $header) {
             return true;
diff --git a/src/Symfony/Component/HttpFoundation/File/Exception/AccessDeniedException.php b/src/Symfony/Component/HttpFoundation/File/Exception/AccessDeniedException.php
@@ -18,9 +18,6 @@
  */
 class AccessDeniedException extends FileException
 {
-    /**
-     * @param string $path The path to the accessed file
-     */
     public function __construct(string $path)
     {
         parent::__construct(sprintf('The file %s could not be accessed', $path));
diff --git a/src/Symfony/Component/HttpFoundation/File/Exception/FileNotFoundException.php b/src/Symfony/Component/HttpFoundation/File/Exception/FileNotFoundException.php
@@ -18,9 +18,6 @@
  */
 class FileNotFoundException extends FileException
 {
-    /**
-     * @param string $path The path to the file that was not found
-     */
     public function __construct(string $path)
     {
         parent::__construct(sprintf('The file "%s" does not exist', $path));
diff --git a/src/Symfony/Component/HttpFoundation/File/File.php b/src/Symfony/Component/HttpFoundation/File/File.php
@@ -99,6 +99,9 @@ public function move($directory, $name = null)
         return $target;
     }
 
+    /**
+     * @return self
+     */
     protected function getTargetFile($directory, $name = null)
     {
         if (!is_dir($directory)) {
@@ -119,7 +122,7 @@ protected function getTargetFile($directory, $name = null)
      *
      * @param string $name The new file name
      *
-     * @return string containing
+     * @return string
      */
     protected function getName($name)
     {
diff --git a/src/Symfony/Component/HttpFoundation/FileBag.php b/src/Symfony/Component/HttpFoundation/FileBag.php
@@ -24,7 +24,7 @@ class FileBag extends ParameterBag
     private static $fileKeys = ['error', 'name', 'size', 'tmp_name', 'type'];
 
     /**
-     * @param array $parameters An array of HTTP files
+     * @param array|UploadedFile[] $parameters An array of HTTP files
      */
     public function __construct(array $parameters = [])
     {
diff --git a/src/Symfony/Component/HttpFoundation/HeaderBag.php b/src/Symfony/Component/HttpFoundation/HeaderBag.php
@@ -21,9 +21,6 @@ class HeaderBag implements \IteratorAggregate, \Countable
     protected $headers = [];
     protected $cacheControl = [];
 
-    /**
-     * @param array $headers An array of HTTP headers
-     */
     public function __construct(array $headers = [])
     {
         foreach ($headers as $key => $values) {
@@ -85,8 +82,6 @@ public function keys()
 
     /**
      * Replaces the current HTTP headers by a new set.
-     *
-     * @param array $headers An array of HTTP headers
      */
     public function replace(array $headers = [])
     {
@@ -96,8 +91,6 @@ public function replace(array $headers = [])
 
     /**
      * Adds new headers the current HTTP headers set.
-     *
-     * @param array $headers An array of HTTP headers
      */
     public function add(array $headers)
     {
@@ -204,10 +197,9 @@ public function remove($key)
     /**
      * Returns the HTTP header value converted to a date.
      *
-     * @param string    $key     The parameter key
-     * @param \DateTime $default The default value
+     * @param string $key The parameter key
      *
-     * @return \DateTime|null The parsed DateTime or the default value if the header does not exist
+     * @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
      */
diff --git a/src/Symfony/Component/HttpFoundation/ParameterBag.php b/src/Symfony/Component/HttpFoundation/ParameterBag.php
@@ -23,9 +23,6 @@ class ParameterBag implements \IteratorAggregate, \Countable
      */
     protected $parameters;
 
-    /**
-     * @param array $parameters An array of parameters
-     */
     public function __construct(array $parameters = [])
     {
         $this->parameters = $parameters;
@@ -53,8 +50,6 @@ public function keys()
 
     /**
      * Replaces the current parameters by a new set.
-     *
-     * @param array $parameters An array of parameters
      */
     public function replace(array $parameters = [])
     {
@@ -63,8 +58,6 @@ public function replace(array $parameters = [])
 
     /**
      * Adds parameters.
-     *
-     * @param array $parameters An array of parameters
      */
     public function add(array $parameters = [])
     {
diff --git a/src/Symfony/Component/HttpFoundation/Request.php b/src/Symfony/Component/HttpFoundation/Request.php
@@ -632,7 +632,7 @@ public static function getTrustedHosts()
      */
     public static function normalizeQueryString($qs)
     {
-        if ('' == $qs) {
+        if ('' === ($qs ?? '')) {
             return '';
         }
 
@@ -702,7 +702,7 @@ public function get($key, $default = null)
     /**
      * Gets the Session.
      *
-     * @return SessionInterface|null The session
+     * @return SessionInterface The session
      */
     public function getSession()
     {
@@ -1591,7 +1591,7 @@ public function getPreferredFormat(?string $default = 'html'): ?string
     /**
      * Returns the preferred language.
      *
-     * @param array $locales An array of ordered available locales
+     * @param string[] $locales An array of ordered available locales
      *
      * @return string|null The preferred locale
      */
@@ -1920,7 +1920,7 @@ protected static function initializeFormats()
         ];
     }
 
-    private function setPhpDefaultLocale(string $locale)
+    private function setPhpDefaultLocale(string $locale): void
     {
         // if either the class Locale doesn't exist, or an exception is thrown when
         // setting the default locale, the intl module is not installed, and
@@ -1982,7 +1982,7 @@ public function isFromTrustedProxy()
         return self::$trustedProxies && IpUtils::checkIp($this->server->get('REMOTE_ADDR'), self::$trustedProxies);
     }
 
-    private function getTrustedValues(int $type, string $ip = null)
+    private function getTrustedValues(int $type, string $ip = null): array
     {
         $clientValues = [];
         $forwardedValues = [];
@@ -2033,7 +2033,7 @@ private function getTrustedValues(int $type, string $ip = null)
         throw new ConflictingHeadersException(sprintf('The request has both a trusted "%s" header and a trusted "%s" header, conflicting with each other. You should either configure your proxy to remove one of them, or configure your project to distrust the offending one.', self::$trustedHeaders[self::HEADER_FORWARDED], self::$trustedHeaders[$type]));
     }
 
-    private function normalizeAndFilterClientIps(array $clientIps, string $ip)
+    private function normalizeAndFilterClientIps(array $clientIps, string $ip): array
     {
         if (!$clientIps) {
             return [];
diff --git a/src/Symfony/Component/HttpFoundation/RequestMatcher.php b/src/Symfony/Component/HttpFoundation/RequestMatcher.php
@@ -54,11 +54,8 @@ class RequestMatcher implements RequestMatcherInterface
     private $schemes = [];
 
     /**
-     * @param string|null          $path
-     * @param string|null          $host
      * @param string|string[]|null $methods
      * @param string|string[]|null $ips
-     * @param array                $attributes
      * @param string|string[]|null $schemes
      */
     public function __construct(string $path = null, string $host = null, $methods = null, $ips = null, array $attributes = [], $schemes = null, int $port = null)
diff --git a/src/Symfony/Component/HttpFoundation/Response.php b/src/Symfony/Component/HttpFoundation/Response.php
@@ -1208,7 +1208,7 @@ public function isEmpty(): bool
      *
      * @final
      */
-    public static function closeOutputBuffers(int $targetLevel, bool $flush)
+    public static function closeOutputBuffers(int $targetLevel, bool $flush): void
     {
         $status = ob_get_status(true);
         $level = \count($status);
@@ -1230,7 +1230,7 @@ public static function closeOutputBuffers(int $targetLevel, bool $flush)
      *
      * @final
      */
-    protected function ensureIEOverSSLCompatibility(Request $request)
+    protected function ensureIEOverSSLCompatibility(Request $request): void
     {
         if (false !== stripos($this->headers->get('Content-Disposition'), 'attachment') && 1 == preg_match('/MSIE (.*?);/i', $request->server->get('HTTP_USER_AGENT'), $match) && true === $request->isSecure()) {
             if ((int) preg_replace('/(MSIE )(.*?);/', '$2', $match[0]) < 9) {
diff --git a/src/Symfony/Component/HttpFoundation/ResponseHeaderBag.php b/src/Symfony/Component/HttpFoundation/ResponseHeaderBag.php
@@ -298,7 +298,7 @@ protected function computeCacheControlValue()
         return $header;
     }
 
-    private function initDate()
+    private function initDate(): void
     {
         $now = \DateTime::createFromFormat('U', time());
         $now->setTimezone(new \DateTimeZone('UTC'));
diff --git a/src/Symfony/Component/HttpFoundation/Session/Attribute/AttributeBagInterface.php b/src/Symfony/Component/HttpFoundation/Session/Attribute/AttributeBagInterface.php
@@ -50,15 +50,10 @@ public function set($name, $value);
     /**
      * Returns attributes.
      *
-     * @return array Attributes
+     * @return array
      */
     public function all();
 
-    /**
-     * Sets attributes.
-     *
-     * @param array $attributes Attributes
-     */
     public function replace(array $attributes);
 
     /**
diff --git a/src/Symfony/Component/HttpFoundation/Session/Session.php b/src/Symfony/Component/HttpFoundation/Session/Session.php
@@ -129,7 +129,7 @@ public function getIterator()
     /**
      * Returns the number of attributes.
      *
-     * @return int The number of attributes
+     * @return int
      */
     public function count()
     {
diff --git a/src/Symfony/Component/HttpFoundation/Session/SessionBagProxy.php b/src/Symfony/Component/HttpFoundation/Session/SessionBagProxy.php
@@ -63,7 +63,7 @@ public function getName()
     /**
      * {@inheritdoc}
      */
-    public function initialize(array &$array)
+    public function initialize(array &$array): void
     {
         ++$this->usageIndex;
         $this->data[$this->bag->getStorageKey()] = &$array;
diff --git a/src/Symfony/Component/HttpFoundation/Session/SessionInterface.php b/src/Symfony/Component/HttpFoundation/Session/SessionInterface.php
@@ -23,7 +23,7 @@ interface SessionInterface
     /**
      * Starts the session storage.
      *
-     * @return bool True if session started
+     * @return bool
      *
      * @throws \RuntimeException if session fails to start
      */
@@ -32,7 +32,7 @@ public function start();
     /**
      * Returns the session ID.
      *
-     * @return string The session ID
+     * @return string
      */
     public function getId();
 
@@ -46,7 +46,7 @@ public function setId($id);
     /**
      * Returns the session name.
      *
-     * @return mixed The session name
+     * @return string
      */
     public function getName();
 
@@ -68,7 +68,7 @@ public function setName($name);
      *                      to expire with browser session. Time is in seconds, and is
      *                      not a Unix timestamp.
      *
-     * @return bool True if session invalidated, false if error
+     * @return bool
      */
     public function invalidate($lifetime = null);
 
@@ -82,7 +82,7 @@ public function invalidate($lifetime = null);
      *                       to expire with browser session. Time is in seconds, and is
      *                       not a Unix timestamp.
      *
-     * @return bool True if session migrated, false if error
+     * @return bool
      */
     public function migrate($destroy = false, $lifetime = null);
 
@@ -100,7 +100,7 @@ public function save();
      *
      * @param string $name The attribute name
      *
-     * @return bool true if the attribute is defined, false otherwise
+     * @return bool
      */
     public function has($name);
 
@@ -125,14 +125,12 @@ public function set($name, $value);
     /**
      * Returns attributes.
      *
-     * @return array Attributes
+     * @return array
      */
     public function all();
 
     /**
      * Sets attributes.
-     *
-     * @param array $attributes Attributes
      */
     public function replace(array $attributes);
 
diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MemcachedSessionHandler.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MemcachedSessionHandler.php
@@ -40,8 +40,6 @@ class MemcachedSessionHandler extends AbstractSessionHandler
      *  * prefix: The prefix to use for the memcached keys in order to avoid collision
      *  * expiretime: The time to live in seconds.
      *
-     * @param \Memcached $memcached A \Memcached instance
-     *
      * @throws \InvalidArgumentException When unsupported options are passed
      */
     public function __construct(\Memcached $memcached, array $options = [])
diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/PdoSessionHandler.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/PdoSessionHandler.php
@@ -423,7 +423,7 @@ public function close()
     /**
      * Lazy-connects to the database.
      */
-    private function connect(string $dsn)
+    private function connect(string $dsn): void
     {
         $this->pdo = new \PDO($dsn, $this->username, $this->password, $this->connectionOptions);
         $this->pdo->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION);
@@ -534,7 +534,7 @@ private function buildDsnFromUrl(string $dsnOrUrl): string
      * due to https://percona.com/blog/2013/12/12/one-more-innodb-gap-lock-to-avoid/ .
      * So we change it to READ COMMITTED.
      */
-    private function beginTransaction()
+    private function beginTransaction(): void
     {
         if (!$this->inTransaction) {
             if ('sqlite' === $this->driver) {
@@ -552,7 +552,7 @@ private function beginTransaction()
     /**
      * Helper method to commit a transaction.
      */
-    private function commit()
+    private function commit(): void
     {
         if ($this->inTransaction) {
             try {
@@ -574,7 +574,7 @@ private function commit()
     /**
      * Helper method to rollback a transaction.
      */
-    private function rollback()
+    private function rollback(): void
     {
         // We only need to rollback if we are in a transaction. Otherwise the resulting
         // error would hide the real problem why rollback was called. We might not be
diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/MetadataBag.php b/src/Symfony/Component/HttpFoundation/Session/Storage/MetadataBag.php
@@ -159,7 +159,7 @@ public function setName($name)
         $this->name = $name;
     }
 
-    private function stampCreated(int $lifetime = null)
+    private function stampCreated(int $lifetime = null): void
     {
         $timeStamp = time();
         $this->meta[self::CREATED] = $this->meta[self::UPDATED] = $this->lastUsed = $timeStamp;
diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/MockFileSessionStorage.php b/src/Symfony/Component/HttpFoundation/Session/Storage/MockFileSessionStorage.php
diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/NativeSessionStorage.php b/src/Symfony/Component/HttpFoundation/Session/Storage/NativeSessionStorage.php
diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/PhpBridgeSessionStorage.php b/src/Symfony/Component/HttpFoundation/Session/Storage/PhpBridgeSessionStorage.php
diff --git a/src/Symfony/Component/HttpFoundation/StreamedResponse.php b/src/Symfony/Component/HttpFoundation/StreamedResponse.php

Original file line number	Diff line number	Diff line change
`@@ -153,7 +153,7 @@ public function first()`
`153`	`153`	`/**`
`154`	`154`	`* Sorts items by descending quality.`
`155`	`155`	`*/`
`156`		`- private function sort()`
	`156`	`+ private function sort(): void`
`157`	`157`	`{`
`158`	`158`	`if (!$this->sorted) {`
`159`	`159`	`uasort($this->items, function (AcceptHeaderItem $a, AcceptHeaderItem $b) {`
Original file line number	Diff line number	Diff line change
`@@ -269,7 +269,7 @@ public function prepare(Request $request)`
`269`	`269`	`return $this;`
`270`	`270`	`}`
`271`	`271`
`272`		`- private function hasValidIfRangeHeader(?string $header)`
	`272`	`+ private function hasValidIfRangeHeader(?string $header): bool`
`273`	`273`	`{`
`274`	`274`	`if ($this->getEtag() === $header) {`
`275`	`275`	`return true;`
Original file line number	Diff line number	Diff line change
`@@ -18,9 +18,6 @@`
`18`	`18`	`*/`
`19`	`19`	`class AccessDeniedException extends FileException`
`20`	`20`	`{`
`21`		`- /**`
`22`		`- * @param string $path The path to the accessed file`
`23`		`- */`
`24`	`21`	`public function __construct(string $path)`
`25`	`22`	`{`
`26`	`23`	`parent::__construct(sprintf('The file %s could not be accessed', $path));`
Original file line number	Diff line number	Diff line change
`@@ -99,6 +99,9 @@ public function move($directory, $name = null)`
`99`	`99`	`return $target;`
`100`	`100`	`}`
`101`	`101`
	`102`	`+ /**`
	`103`	`+ * @return self`
	`104`	`+ */`
`102`	`105`	`protected function getTargetFile($directory, $name = null)`
`103`	`106`	`{`
`104`	`107`	`if (!is_dir($directory)) {`
`@@ -119,7 +122,7 @@ protected function getTargetFile($directory, $name = null)`
`119`	`122`	`*`
`120`	`123`	`* @param string $name The new file name`
`121`	`124`	`*`
`122`		`- * @return string containing`
	`125`	`+ * @return string`
`123`	`126`	`*/`
`124`	`127`	`protected function getName($name)`
`125`	`128`	`{`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ class FileBag extends ParameterBag`
`24`	`24`	`private static $fileKeys = ['error', 'name', 'size', 'tmp_name', 'type'];`
`25`	`25`
`26`	`26`	`/**`
`27`		`- * @param array $parameters An array of HTTP files`
	`27`	`+ * @param array\|UploadedFile[] $parameters An array of HTTP files`
`28`	`28`	`*/`
`29`	`29`	`public function __construct(array $parameters = [])`
`30`	`30`	`{`
Original file line number	Diff line number	Diff line change
`@@ -632,7 +632,7 @@ public static function getTrustedHosts()`
`632`	`632`	`*/`
`633`	`633`	`public static function normalizeQueryString($qs)`
`634`	`634`	`{`
`635`		`- if ('' == $qs) {`
	`635`	`+ if ('' === ($qs ?? '')) {`
`636`	`636`	`return '';`
`637`	`637`	`}`
`638`	`638`
`@@ -702,7 +702,7 @@ public function get($key, $default = null)`
`702`	`702`	`/**`
`703`	`703`	`* Gets the Session.`
`704`	`704`	`*`
`705`		`- * @return SessionInterface\|null The session`
	`705`	`+ * @return SessionInterface The session`
`706`	`706`	`*/`
`707`	`707`	`public function getSession()`
`708`	`708`	`{`
`@@ -1591,7 +1591,7 @@ public function getPreferredFormat(?string $default = 'html'): ?string`
`1591`	`1591`	`/**`
`1592`	`1592`	`* Returns the preferred language.`
`1593`	`1593`	`*`
`1594`		`- * @param array $locales An array of ordered available locales`
	`1594`	`+ * @param string[] $locales An array of ordered available locales`
`1595`	`1595`	`*`
`1596`	`1596`	`* @return string\|null The preferred locale`
`1597`	`1597`	`*/`
`@@ -1920,7 +1920,7 @@ protected static function initializeFormats()`
`1920`	`1920`	`];`
`1921`	`1921`	`}`
`1922`	`1922`
`1923`		`- private function setPhpDefaultLocale(string $locale)`
	`1923`	`+ private function setPhpDefaultLocale(string $locale): void`
`1924`	`1924`	`{`
`1925`	`1925`	`// if either the class Locale doesn't exist, or an exception is thrown when`
`1926`	`1926`	`// setting the default locale, the intl module is not installed, and`
`@@ -1982,7 +1982,7 @@ public function isFromTrustedProxy()`
`1982`	`1982`	`return self::$trustedProxies && IpUtils::checkIp($this->server->get('REMOTE_ADDR'), self::$trustedProxies);`
`1983`	`1983`	`}`
`1984`	`1984`
`1985`		`- private function getTrustedValues(int $type, string $ip = null)`
	`1985`	`+ private function getTrustedValues(int $type, string $ip = null): array`
`1986`	`1986`	`{`
`1987`	`1987`	`$clientValues = [];`
`1988`	`1988`	`$forwardedValues = [];`
`@@ -2033,7 +2033,7 @@ private function getTrustedValues(int $type, string $ip = null)`
`2033`	`2033`	`throw new ConflictingHeadersException(sprintf('The request has both a trusted "%s" header and a trusted "%s" header, conflicting with each other. You should either configure your proxy to remove one of them, or configure your project to distrust the offending one.', self::$trustedHeaders[self::HEADER_FORWARDED], self::$trustedHeaders[$type]));`
`2034`	`2034`	`}`
`2035`	`2035`
`2036`		`- private function normalizeAndFilterClientIps(array $clientIps, string $ip)`
	`2036`	`+ private function normalizeAndFilterClientIps(array $clientIps, string $ip): array`
`2037`	`2037`	`{`
`2038`	`2038`	`if (!$clientIps) {`
`2039`	`2039`	`return [];`