[HttpKernel] Fix return type declarations

nicolas-grekas · nicolas-grekas · commit 05fe553666cb · 2019-08-26T09:50:50.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/ProfilerTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/ProfilerTest.php
@@ -24,16 +24,16 @@ public function testProfilerIsDisabled($insulate)
         }
 
         $client->request('GET', '/profiler');
-        $this->assertFalse($client->getProfile());
+        $this->assertNull($client->getProfile());
 
         // enable the profiler for the next request
         $client->enableProfiler();
-        $this->assertFalse($client->getProfile());
+        $this->assertNull($client->getProfile());
         $client->request('GET', '/profiler');
         $this->assertIsObject($client->getProfile());
 
         $client->request('GET', '/profiler');
-        $this->assertFalse($client->getProfile());
+        $this->assertNull($client->getProfile());
     }
 
     public function getConfigs()
diff --git a/src/Symfony/Component/BrowserKit/Request.php b/src/Symfony/Component/BrowserKit/Request.php
@@ -107,7 +107,7 @@ public function getServer()
     /**
      * Gets the request raw body data.
      *
-     * @return string The request raw body data
+     * @return string|null The request raw body data
      */
     public function getContent()
     {
diff --git a/src/Symfony/Component/DependencyInjection/Container.php b/src/Symfony/Component/DependencyInjection/Container.php
@@ -444,8 +444,6 @@ public static function underscore($id)
 
     /**
      * Creates a service by requiring its factory file.
-     *
-     * @return object The service created by the file
      */
     protected function load($file)
     {
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/DumperInterface.php b/src/Symfony/Component/DependencyInjection/Dumper/DumperInterface.php
@@ -21,9 +21,7 @@ interface DumperInterface
     /**
      * Dumps the service container.
      *
-     * @param array $options An array of options
-     *
-     * @return string The representation of the service container
+     * @return string|array The representation of the service container
      */
     public function dump(array $options = []);
 }
diff --git a/src/Symfony/Component/HttpKernel/Controller/ControllerResolver.php b/src/Symfony/Component/HttpKernel/Controller/ControllerResolver.php
@@ -85,10 +85,10 @@ public function getController(Request $request)
             }
         }
 
-        $callable = $this->createController($controller);
-
-        if (!\is_callable($callable)) {
-            throw new \InvalidArgumentException(sprintf('The controller for URI "%s" is not callable. %s', $request->getPathInfo(), $this->getControllerError($callable)));
+        try {
+            $callable = $this->createController($controller);
+        } catch (\InvalidArgumentException $e) {
+            throw new \InvalidArgumentException(sprintf('The controller for URI "%s" is not callable. %s', $request->getPathInfo(), $e->getMessage()));
         }
 
         return $callable;
@@ -165,7 +165,7 @@ protected function doGetArguments(Request $request, $controller, array $paramete
      *
      * @return callable A PHP callable
      *
-     * @throws \InvalidArgumentException
+     * @throws \InvalidArgumentException When the controller cannot be created
      */
     protected function createController($controller)
     {
@@ -179,7 +179,13 @@ protected function createController($controller)
             throw new \InvalidArgumentException(sprintf('Class "%s" does not exist.', $class));
         }
 
-        return [$this->instantiateController($class), $method];
+        $controller = [$this->instantiateController($class), $method];
+
+        if (!\is_callable($controller)) {
+            throw new \InvalidArgumentException($this->getControllerError($controller));
+        }
+
+        return $controller;
     }
 
     /**
diff --git a/src/Symfony/Component/HttpKernel/DataCollector/ConfigDataCollector.php b/src/Symfony/Component/HttpKernel/DataCollector/ConfigDataCollector.php
@@ -119,7 +119,7 @@ public function getApplicationVersion()
     /**
      * Gets the token.
      *
-     * @return string The token
+     * @return string|null The token
      */
     public function getToken()
     {
diff --git a/src/Symfony/Component/HttpKernel/DataCollector/ExceptionDataCollector.php b/src/Symfony/Component/HttpKernel/DataCollector/ExceptionDataCollector.php
@@ -55,7 +55,7 @@ public function hasException()
     /**
      * Gets the exception.
      *
-     * @return \Exception The exception
+     * @return \Exception|FlattenException
      */
     public function getException()
     {
diff --git a/src/Symfony/Component/HttpKernel/DataCollector/LoggerDataCollector.php b/src/Symfony/Component/HttpKernel/DataCollector/LoggerDataCollector.php
@@ -72,11 +72,6 @@ public function lateCollect()
         }
     }
 
-    /**
-     * Gets the logs.
-     *
-     * @return array An array of logs
-     */
     public function getLogs()
     {
         return isset($this->data['logs']) ? $this->data['logs'] : [];
diff --git a/src/Symfony/Component/HttpKernel/DataCollector/TimeDataCollector.php b/src/Symfony/Component/HttpKernel/DataCollector/TimeDataCollector.php
@@ -132,7 +132,7 @@ public function getInitTime()
     /**
      * Gets the request time.
      *
-     * @return int The time
+     * @return float
      */
     public function getStartTime()
     {
diff --git a/src/Symfony/Component/HttpKernel/HttpCache/AbstractSurrogate.php b/src/Symfony/Component/HttpKernel/HttpCache/AbstractSurrogate.php
@@ -110,7 +110,7 @@ public function handle(HttpCache $cache, $uri, $alt, $ignoreErrors)
             }
         }
 
-        return null;
+        return '';
     }
 
     /**
diff --git a/src/Symfony/Component/HttpKernel/HttpCache/Ssi.php b/src/Symfony/Component/HttpKernel/HttpCache/Ssi.php
@@ -95,6 +95,6 @@ public function process(Request $request, Response $response)
         // remove SSI/1.0 from the Surrogate-Control header
         $this->removeFromControl($response);
 
-        return null;
+        return $response;
     }
 }
diff --git a/src/Symfony/Component/HttpKernel/Kernel.php b/src/Symfony/Component/HttpKernel/Kernel.php
@@ -206,7 +206,7 @@ public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQ
     /**
      * Gets a HTTP kernel from the container.
      *
-     * @return HttpKernel
+     * @return HttpKernelInterface
      */
     protected function getHttpKernel()
     {
@@ -425,7 +425,7 @@ public function setAnnotatedClassCache(array $annotatedClasses)
      */
     public function getStartTime()
     {
-        return $this->debug ? $this->startTime : -INF;
+        return $this->debug && null !== $this->startTime ? $this->startTime : -INF;
     }
 
     /**
diff --git a/src/Symfony/Component/HttpKernel/KernelInterface.php b/src/Symfony/Component/HttpKernel/KernelInterface.php
@@ -138,7 +138,7 @@ public function getContainer();
     /**
      * Gets the request start time (not available if debug is disabled).
      *
-     * @return int The request start timestamp
+     * @return float The request start timestamp
      */
     public function getStartTime();
 
diff --git a/src/Symfony/Component/HttpKernel/Profiler/Profile.php b/src/Symfony/Component/HttpKernel/Profiler/Profile.php
@@ -102,7 +102,7 @@ public function getParentToken()
     /**
      * Returns the IP.
      *
-     * @return string The IP
+     * @return string|null The IP
      */
     public function getIp()
     {
@@ -122,7 +122,7 @@ public function setIp($ip)
     /**
      * Returns the request method.
      *
-     * @return string The request method
+     * @return string|null The request method
      */
     public function getMethod()
     {
@@ -137,13 +137,16 @@ public function setMethod($method)
     /**
      * Returns the URL.
      *
-     * @return string The URL
+     * @return string|null The URL
      */
     public function getUrl()
     {
         return $this->url;
     }
 
+    /**
+     * @param string $url
+     */
     public function setUrl($url)
     {
         $this->url = $url;
@@ -180,7 +183,7 @@ public function setStatusCode($statusCode)
     }
 
     /**
-     * @return int
+     * @return int|null
      */
     public function getStatusCode()
     {
diff --git a/src/Symfony/Component/HttpKernel/Profiler/Profiler.php b/src/Symfony/Component/HttpKernel/Profiler/Profiler.php
@@ -65,12 +65,12 @@ public function enable()
     /**
      * Loads the Profile for the given Response.
      *
-     * @return Profile|false A Profile instance
+     * @return Profile|null A Profile instance
      */
     public function loadProfileFromResponse(Response $response)
     {
         if (!$token = $response->headers->get('X-Debug-Token')) {
-            return false;
+            return null;
         }
 
         return $this->loadProfile($token);
@@ -81,7 +81,7 @@ public function loadProfileFromResponse(Response $response)
      *
      * @param string $token A token
      *
-     * @return Profile A Profile instance
+     * @return Profile|null A Profile instance
      */
     public function loadProfile($token)
     {
diff --git a/src/Symfony/Component/HttpKernel/Tests/Bundle/BundleTest.php b/src/Symfony/Component/HttpKernel/Tests/Bundle/BundleTest.php
@@ -49,6 +49,9 @@ public function testRegisterCommands()
         $this->assertNull($bundle2->registerCommands($app));
     }
 
+    /**
+     * @group legacy
+     */
     public function testGetContainerExtensionWithInvalidClass()
     {
         $this->expectException('LogicException');
diff --git a/src/Symfony/Component/HttpKernel/Tests/DataCollector/LoggerDataCollectorTest.php b/src/Symfony/Component/HttpKernel/Tests/DataCollector/LoggerDataCollectorTest.php
@@ -23,7 +23,7 @@ public function testCollectWithUnexpectedFormat()
             ->getMockBuilder('Symfony\Component\HttpKernel\Log\DebugLoggerInterface')
             ->setMethods(['countErrors', 'getLogs', 'clear'])
             ->getMock();
-        $logger->expects($this->once())->method('countErrors')->willReturn('foo');
+        $logger->expects($this->once())->method('countErrors')->willReturn(123);
         $logger->expects($this->exactly(2))->method('getLogs')->willReturn([]);
 
         $c = new LoggerDataCollector($logger, __DIR__.'/');
diff --git a/src/Symfony/Component/HttpKernel/Tests/DataCollector/TimeDataCollectorTest.php b/src/Symfony/Component/HttpKernel/Tests/DataCollector/TimeDataCollectorTest.php
@@ -44,7 +44,7 @@ public function testCollect()
         $this->assertEquals(0, $c->getStartTime());
 
         $kernel = $this->getMockBuilder('Symfony\Component\HttpKernel\KernelInterface')->getMock();
-        $kernel->expects($this->once())->method('getStartTime')->willReturn(123456);
+        $kernel->expects($this->once())->method('getStartTime')->willReturn(123456.0);
 
         $c = new TimeDataCollector($kernel);
         $request = new Request();
diff --git a/src/Symfony/Component/HttpKernel/Tests/KernelTest.php b/src/Symfony/Component/HttpKernel/Tests/KernelTest.php
@@ -721,8 +721,8 @@ public function testInitializeBundleThrowsExceptionWhenRegisteringTwoBundlesWith
     {
         $this->expectException('LogicException');
         $this->expectExceptionMessage('Trying to register two bundles with the same name "DuplicateName"');
-        $fooBundle = $this->getBundle(null, null, 'FooBundle', 'DuplicateName');
-        $barBundle = $this->getBundle(null, null, 'BarBundle', 'DuplicateName');
+        $fooBundle = $this->getBundle(__DIR__.'/Fixtures/FooBundle', null, 'FooBundle', 'DuplicateName');
+        $barBundle = $this->getBundle(__DIR__.'/Fixtures/BarBundle', null, 'BarBundle', 'DuplicateName');
 
         $kernel = $this->getKernel([], [$fooBundle, $barBundle]);
         $kernel->boot();

Original file line number	Diff line number	Diff line change
`@@ -107,7 +107,7 @@ public function getServer()`
`107`	`107`	`/**`
`108`	`108`	`* Gets the request raw body data.`
`109`	`109`	`*`
`110`		`- * @return string The request raw body data`
	`110`	`+ * @return string\|null The request raw body data`
`111`	`111`	`*/`
`112`	`112`	`public function getContent()`
`113`	`113`	`{`
Original file line number	Diff line number	Diff line change
`@@ -444,8 +444,6 @@ public static function underscore($id)`
`444`	`444`
`445`	`445`	`/**`
`446`	`446`	`* Creates a service by requiring its factory file.`
`447`		`- *`
`448`		`- * @return object The service created by the file`
`449`	`447`	`*/`
`450`	`448`	`protected function load($file)`
`451`	`449`	`{`
Original file line number	Diff line number	Diff line change
`@@ -21,9 +21,7 @@ interface DumperInterface`
`21`	`21`	`/**`
`22`	`22`	`* Dumps the service container.`
`23`	`23`	`*`
`24`		`- * @param array $options An array of options`
`25`		`- *`
`26`		`- * @return string The representation of the service container`
	`24`	`+ * @return string\|array The representation of the service container`
`27`	`25`	`*/`
`28`	`26`	`public function dump(array $options = []);`
`29`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -85,10 +85,10 @@ public function getController(Request $request)`
`85`	`85`	`}`
`86`	`86`	`}`
`87`	`87`
`88`		`- $callable = $this->createController($controller);`
`89`		`-`
`90`		`- if (!\is_callable($callable)) {`
`91`		`- throw new \InvalidArgumentException(sprintf('The controller for URI "%s" is not callable. %s', $request->getPathInfo(), $this->getControllerError($callable)));`
	`88`	`+ try {`
	`89`	`+ $callable = $this->createController($controller);`
	`90`	`+ } catch (\InvalidArgumentException $e) {`
	`91`	`+ throw new \InvalidArgumentException(sprintf('The controller for URI "%s" is not callable. %s', $request->getPathInfo(), $e->getMessage()));`
`92`	`92`	`}`
`93`	`93`
`94`	`94`	`return $callable;`
`@@ -165,7 +165,7 @@ protected function doGetArguments(Request $request, $controller, array $paramete`
`165`	`165`	`*`
`166`	`166`	`* @return callable A PHP callable`
`167`	`167`	`*`
`168`		`- * @throws \InvalidArgumentException`
	`168`	`+ * @throws \InvalidArgumentException When the controller cannot be created`
`169`	`169`	`*/`
`170`	`170`	`protected function createController($controller)`
`171`	`171`	`{`
`@@ -179,7 +179,13 @@ protected function createController($controller)`
`179`	`179`	`throw new \InvalidArgumentException(sprintf('Class "%s" does not exist.', $class));`
`180`	`180`	`}`
`181`	`181`
`182`		`- return [$this->instantiateController($class), $method];`
	`182`	`+ $controller = [$this->instantiateController($class), $method];`
	`183`	`+`
	`184`	`+ if (!\is_callable($controller)) {`
	`185`	`+ throw new \InvalidArgumentException($this->getControllerError($controller));`
	`186`	`+ }`
	`187`	`+`
	`188`	`+ return $controller;`
`183`	`189`	`}`
`184`	`190`
`185`	`191`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -119,7 +119,7 @@ public function getApplicationVersion()`
`119`	`119`	`/**`
`120`	`120`	`* Gets the token.`
`121`	`121`	`*`
`122`		`- * @return string The token`
	`122`	`+ * @return string\|null The token`
`123`	`123`	`*/`
`124`	`124`	`public function getToken()`
`125`	`125`	`{`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ public function hasException()`
`55`	`55`	`/**`
`56`	`56`	`* Gets the exception.`
`57`	`57`	`*`
`58`		`- * @return \Exception The exception`
	`58`	`+ * @return \Exception\|FlattenException`
`59`	`59`	`*/`
`60`	`60`	`public function getException()`
`61`	`61`	`{`
Original file line number	Diff line number	Diff line change
`@@ -72,11 +72,6 @@ public function lateCollect()`
`72`	`72`	`}`
`73`	`73`	`}`
`74`	`74`
`75`		`- /**`
`76`		`- * Gets the logs.`
`77`		`- *`
`78`		`- * @return array An array of logs`
`79`		`- */`
`80`	`75`	`public function getLogs()`
`81`	`76`	`{`
`82`	`77`	`return isset($this->data['logs']) ? $this->data['logs'] : [];`
Original file line number	Diff line number	Diff line change
`@@ -132,7 +132,7 @@ public function getInitTime()`
`132`	`132`	`/**`
`133`	`133`	`* Gets the request time.`
`134`	`134`	`*`
`135`		`- * @return int The time`
	`135`	`+ * @return float`
`136`	`136`	`*/`
`137`	`137`	`public function getStartTime()`
`138`	`138`	`{`
Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,7 @@ public function handle(HttpCache $cache, $uri, $alt, $ignoreErrors)`
`110`	`110`	`}`
`111`	`111`	`}`
`112`	`112`
`113`		`- return null;`
	`113`	`+ return '';`
`114`	`114`	`}`
`115`	`115`
`116`	`116`	`/**`