[HttpFoundation] fix return type declarations

nicolas-grekas · nicolas-grekas · commit ef5ead00059f · 2019-08-26T09:50:50.000+02:00
diff --git a/src/Symfony/Component/HttpFoundation/BinaryFileResponse.php b/src/Symfony/Component/HttpFoundation/BinaryFileResponse.php
@@ -327,12 +327,12 @@ public function setContent($content)
         if (null !== $content) {
             throw new \LogicException('The content cannot be set on a BinaryFileResponse instance.');
         }
+
+        return $this;
     }
 
     /**
      * {@inheritdoc}
-     *
-     * @return false
      */
     public function getContent()
     {
diff --git a/src/Symfony/Component/HttpFoundation/FileBag.php b/src/Symfony/Component/HttpFoundation/FileBag.php
@@ -75,8 +75,8 @@ protected function convertFileInformation($file)
             return $file;
         }
 
-        $file = $this->fixPhpFilesArray($file);
         if (\is_array($file)) {
+            $file = $this->fixPhpFilesArray($file);
             $keys = array_keys($file);
             sort($keys);
 
@@ -109,14 +109,12 @@ protected function convertFileInformation($file)
      * It's safe to pass an already converted array, in which case this method
      * just returns the original array unmodified.
      *
+     * @param array $data
+     *
      * @return array
      */
     protected function fixPhpFilesArray($data)
     {
-        if (!\is_array($data)) {
-            return $data;
-        }
-
         $keys = array_keys($data);
         sort($keys);
 
diff --git a/src/Symfony/Component/HttpFoundation/HeaderBag.php b/src/Symfony/Component/HttpFoundation/HeaderBag.php
@@ -121,7 +121,7 @@ public function get($key, $default = null, $first = true)
         }
 
         if ($first) {
-            return \count($headers[$key]) ? $headers[$key][0] : $default;
+            return \count($headers[$key]) ? (string) $headers[$key][0] : $default;
         }
 
         return $headers[$key];
diff --git a/src/Symfony/Component/HttpFoundation/Request.php b/src/Symfony/Component/HttpFoundation/Request.php
@@ -528,6 +528,10 @@ public function __toString()
         try {
             $content = $this->getContent();
         } catch (\LogicException $e) {
+            if (\PHP_VERSION_ID >= 70400) {
+                throw $e;
+            }
+
             return trigger_error($e, E_USER_ERROR);
         }
 
@@ -912,7 +916,7 @@ public function getClientIps()
      * ("Client-Ip" for instance), configure it via the $trustedHeaderSet
      * argument of the Request::setTrustedProxies() method instead.
      *
-     * @return string The client IP address
+     * @return string|null The client IP address
      *
      * @see getClientIps()
      * @see https://wikipedia.org/wiki/X-Forwarded-For
diff --git a/src/Symfony/Component/HttpFoundation/Response.php b/src/Symfony/Component/HttpFoundation/Response.php
@@ -407,7 +407,7 @@ public function setContent($content)
     /**
      * Gets the current response content.
      *
-     * @return string Content
+     * @return string|false
      */
     public function getContent()
     {
diff --git a/src/Symfony/Component/HttpFoundation/Session/Attribute/NamespacedAttributeBag.php b/src/Symfony/Component/HttpFoundation/Session/Attribute/NamespacedAttributeBag.php
@@ -97,7 +97,7 @@ public function remove($name)
      * @param string $name         Key name
      * @param bool   $writeContext Write context, default false
      *
-     * @return array
+     * @return array|null
      */
     protected function &resolveAttributePath($name, $writeContext = false)
     {
diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MemcachedSessionHandler.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MemcachedSessionHandler.php
@@ -40,9 +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
-     * @param array      $options   An associative array of Memcached options
-     *
      * @throws \InvalidArgumentException When unsupported options are passed
      */
     public function __construct(\Memcached $memcached, array $options = [])
@@ -58,7 +55,7 @@ public function __construct(\Memcached $memcached, array $options = [])
     }
 
     /**
-     * {@inheritdoc}
+     * @return bool
      */
     public function close()
     {
@@ -74,7 +71,7 @@ protected function doRead($sessionId)
     }
 
     /**
-     * {@inheritdoc}
+     * @return bool
      */
     public function updateTimestamp($sessionId, $data)
     {
@@ -102,7 +99,7 @@ protected function doDestroy($sessionId)
     }
 
     /**
-     * {@inheritdoc}
+     * @return bool
      */
     public function gc($maxlifetime)
     {
diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/NullSessionHandler.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/NullSessionHandler.php
@@ -67,7 +67,7 @@ protected function doDestroy($sessionId)
     }
 
     /**
-     * {@inheritdoc}
+     * @return bool
      */
     public function gc($maxlifetime)
     {
diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/PdoSessionHandler.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/PdoSessionHandler.php
@@ -286,7 +286,7 @@ public function read($sessionId)
     }
 
     /**
-     * {@inheritdoc}
+     * @return bool
      */
     public function gc($maxlifetime)
     {
diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/StrictSessionHandler.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/StrictSessionHandler.php
@@ -94,7 +94,7 @@ public function close()
     }
 
     /**
-     * {@inheritdoc}
+     * @return bool
      */
     public function gc($maxlifetime)
     {
diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Proxy/AbstractProxy.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Proxy/AbstractProxy.php
@@ -31,7 +31,7 @@ abstract class AbstractProxy
     /**
      * Gets the session.save_handler name.
      *
-     * @return string
+     * @return string|null
      */
     public function getSaveHandlerName()
     {
diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Proxy/SessionHandlerProxy.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Proxy/SessionHandlerProxy.php
@@ -76,7 +76,7 @@ public function destroy($sessionId)
     }
 
     /**
-     * {@inheritdoc}
+     * @return bool
      */
     public function gc($maxlifetime)
     {
diff --git a/src/Symfony/Component/HttpFoundation/StreamedResponse.php b/src/Symfony/Component/HttpFoundation/StreamedResponse.php
@@ -136,8 +136,6 @@ public function setContent($content)
 
     /**
      * {@inheritdoc}
-     *
-     * @return false
      */
     public function getContent()
     {
diff --git a/src/Symfony/Component/HttpFoundation/Tests/BinaryFileResponseTest.php b/src/Symfony/Component/HttpFoundation/Tests/BinaryFileResponseTest.php
@@ -107,7 +107,7 @@ public function testRequests($requestRange, $offset, $length, $responseRange)
 
         $this->assertEquals(206, $response->getStatusCode());
         $this->assertEquals($responseRange, $response->headers->get('Content-Range'));
-        $this->assertSame($length, $response->headers->get('Content-Length'));
+        $this->assertSame((string) $length, $response->headers->get('Content-Length'));
     }
 
     /**
diff --git a/src/Symfony/Component/HttpFoundation/Tests/Session/Storage/Proxy/SessionHandlerProxyTest.php b/src/Symfony/Component/HttpFoundation/Tests/Session/Storage/Proxy/SessionHandlerProxyTest.php
@@ -144,7 +144,8 @@ public function testUpdateTimestamp()
     {
         $mock = $this->getMockBuilder(['SessionHandlerInterface', 'SessionUpdateTimestampHandlerInterface'])->getMock();
         $mock->expects($this->once())
-            ->method('updateTimestamp');
+            ->method('updateTimestamp')
+            ->willReturn(false);
 
         $proxy = new SessionHandlerProxy($mock);
         $proxy->updateTimestamp('id', 'data');
diff --git a/src/Symfony/Component/HttpKernel/Tests/KernelTest.php b/src/Symfony/Component/HttpKernel/Tests/KernelTest.php
@@ -22,6 +22,7 @@
 use Symfony\Component\HttpKernel\Config\EnvParametersResource;
 use Symfony\Component\HttpKernel\DependencyInjection\ResettableServicePass;
 use Symfony\Component\HttpKernel\DependencyInjection\ServicesResetter;
+use Symfony\Component\HttpKernel\HttpKernel;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
 use Symfony\Component\HttpKernel\Kernel;
 use Symfony\Component\HttpKernel\Tests\Fixtures\KernelForOverrideName;
diff --git a/src/Symfony/Component/HttpKernel/Tests/Logger.php b/src/Symfony/Component/HttpKernel/Tests/Logger.php
@@ -22,6 +22,9 @@ public function __construct()
         $this->clear();
     }
 
+    /**
+     * @return array
+     */
     public function getLogs($level = false)
     {
         return false === $level ? $this->logs : $this->logs[$level];
diff --git a/src/Symfony/Component/Process/Process.php b/src/Symfony/Component/Process/Process.php
@@ -71,7 +71,7 @@ class Process implements \IteratorAggregate
     private $status = self::STATUS_READY;
     private $incrementalOutputOffset = 0;
     private $incrementalErrorOutputOffset = 0;
-    private $tty;
+    private $tty = false;
     private $pty;
     private $inheritEnv = false;
 
diff --git a/src/Symfony/Component/Security/Http/RememberMe/RememberMeServicesInterface.php b/src/Symfony/Component/Security/Http/RememberMe/RememberMeServicesInterface.php
@@ -46,7 +46,7 @@ interface RememberMeServicesInterface
      * make sure to throw an AuthenticationException as this will consequentially
      * result in a call to loginFail() and therefore an invalidation of the cookie.
      *
-     * @return TokenInterface
+     * @return TokenInterface|null
      */
     public function autoLogin(Request $request);
 
diff --git a/src/Symfony/Component/VarDumper/Dumper/AbstractDumper.php b/src/Symfony/Component/VarDumper/Dumper/AbstractDumper.php
@@ -35,7 +35,7 @@ abstract class AbstractDumper implements DataDumperInterface, DumperInterface
     protected $indentPad = '  ';
     protected $flags;
 
-    private $charset;
+    private $charset = '';
 
     /**
      * @param callable|resource|string|null $output  A line dumper callable, an opened stream or an output path, defaults to static::$defaultOutput

Original file line number	Diff line number	Diff line change
`@@ -327,12 +327,12 @@ public function setContent($content)`
`327`	`327`	`if (null !== $content) {`
`328`	`328`	`throw new \LogicException('The content cannot be set on a BinaryFileResponse instance.');`
`329`	`329`	`}`
	`330`	`+`
	`331`	`+ return $this;`
`330`	`332`	`}`
`331`	`333`
`332`	`334`	`/**`
`333`	`335`	`* {@inheritdoc}`
`334`		`- *`
`335`		`- * @return false`
`336`	`336`	`*/`
`337`	`337`	`public function getContent()`
`338`	`338`	`{`
Original file line number	Diff line number	Diff line change
`@@ -121,7 +121,7 @@ public function get($key, $default = null, $first = true)`
`121`	`121`	`}`
`122`	`122`
`123`	`123`	`if ($first) {`
`124`		`- return \count($headers[$key]) ? $headers[$key][0] : $default;`
	`124`	`+ return \count($headers[$key]) ? (string) $headers[$key][0] : $default;`
`125`	`125`	`}`
`126`	`126`
`127`	`127`	`return $headers[$key];`
Original file line number	Diff line number	Diff line change
`@@ -528,6 +528,10 @@ public function __toString()`
`528`	`528`	`try {`
`529`	`529`	`$content = $this->getContent();`
`530`	`530`	`} catch (\LogicException $e) {`
	`531`	`+ if (\PHP_VERSION_ID >= 70400) {`
	`532`	`+ throw $e;`
	`533`	`+ }`
	`534`	`+`
`531`	`535`	`return trigger_error($e, E_USER_ERROR);`
`532`	`536`	`}`
`533`	`537`
`@@ -912,7 +916,7 @@ public function getClientIps()`
`912`	`916`	`* ("Client-Ip" for instance), configure it via the $trustedHeaderSet`
`913`	`917`	`* argument of the Request::setTrustedProxies() method instead.`
`914`	`918`	`*`
`915`		`- * @return string The client IP address`
	`919`	`+ * @return string\|null The client IP address`
`916`	`920`	`*`
`917`	`921`	`* @see getClientIps()`
`918`	`922`	`* @see https://wikipedia.org/wiki/X-Forwarded-For`
Original file line number	Diff line number	Diff line change
`@@ -407,7 +407,7 @@ public function setContent($content)`
`407`	`407`	`/**`
`408`	`408`	`* Gets the current response content.`
`409`	`409`	`*`
`410`		`- * @return string Content`
	`410`	`+ * @return string\|false`
`411`	`411`	`*/`
`412`	`412`	`public function getContent()`
`413`	`413`	`{`
Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@ public function remove($name)`
`97`	`97`	`* @param string $name Key name`
`98`	`98`	`* @param bool $writeContext Write context, default false`
`99`	`99`	`*`
`100`		`- * @return array`
	`100`	`+ * @return array\|null`
`101`	`101`	`*/`
`102`	`102`	`protected function &resolveAttributePath($name, $writeContext = false)`
`103`	`103`	`{`
Original file line number	Diff line number	Diff line change
`@@ -40,9 +40,6 @@ class MemcachedSessionHandler extends AbstractSessionHandler`
`40`	`40`	`* * prefix: The prefix to use for the memcached keys in order to avoid collision`
`41`	`41`	`* * expiretime: The time to live in seconds.`
`42`	`42`	`*`
`43`		`- * @param \Memcached $memcached A \Memcached instance`
`44`		`- * @param array $options An associative array of Memcached options`
`45`		`- *`
`46`	`43`	`* @throws \InvalidArgumentException When unsupported options are passed`
`47`	`44`	`*/`
`48`	`45`	`public function __construct(\Memcached $memcached, array $options = [])`
`@@ -58,7 +55,7 @@ public function __construct(\Memcached $memcached, array $options = [])`
`58`	`55`	`}`
`59`	`56`
`60`	`57`	`/**`
`61`		`- * {@inheritdoc}`
	`58`	`+ * @return bool`
`62`	`59`	`*/`
`63`	`60`	`public function close()`
`64`	`61`	`{`
`@@ -74,7 +71,7 @@ protected function doRead($sessionId)`
`74`	`71`	`}`
`75`	`72`
`76`	`73`	`/**`
`77`		`- * {@inheritdoc}`
	`74`	`+ * @return bool`
`78`	`75`	`*/`
`79`	`76`	`public function updateTimestamp($sessionId, $data)`
`80`	`77`	`{`
`@@ -102,7 +99,7 @@ protected function doDestroy($sessionId)`
`102`	`99`	`}`
`103`	`100`
`104`	`101`	`/**`
`105`		`- * {@inheritdoc}`
	`102`	`+ * @return bool`
`106`	`103`	`*/`
`107`	`104`	`public function gc($maxlifetime)`
`108`	`105`	`{`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ protected function doDestroy($sessionId)`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`/**`
`70`		`- * {@inheritdoc}`
	`70`	`+ * @return bool`
`71`	`71`	`*/`
`72`	`72`	`public function gc($maxlifetime)`
`73`	`73`	`{`
Original file line number	Diff line number	Diff line change
`@@ -286,7 +286,7 @@ public function read($sessionId)`
`286`	`286`	`}`
`287`	`287`
`288`	`288`	`/**`
`289`		`- * {@inheritdoc}`
	`289`	`+ * @return bool`
`290`	`290`	`*/`
`291`	`291`	`public function gc($maxlifetime)`
`292`	`292`	`{`
Original file line number	Diff line number	Diff line change
`@@ -94,7 +94,7 @@ public function close()`
`94`	`94`	`}`
`95`	`95`
`96`	`96`	`/**`
`97`		`- * {@inheritdoc}`
	`97`	`+ * @return bool`
`98`	`98`	`*/`
`99`	`99`	`public function gc($maxlifetime)`
`100`	`100`	`{`