Merge branch '5.4' into 6.0

nicolas-grekas · nicolas-grekas · commit d94a2758f5ba · 2021-08-12T16:08:08.000+02:00
* 5.4:
  More return type fixes (bis)
  Cleanup `@return` annotations
diff --git a/DataCollector/RequestDataCollector.php b/DataCollector/RequestDataCollector.php
@@ -22,6 +22,7 @@
 use Symfony\Component\HttpKernel\Event\ControllerEvent;
 use Symfony\Component\HttpKernel\Event\ResponseEvent;
 use Symfony\Component\HttpKernel\KernelEvents;
+use Symfony\Component\VarDumper\Cloner\Data;
 
 /**
  * @author Fabien Potencier <fabien@symfony.com>
@@ -339,8 +340,8 @@ public function getRouteParams(): array
     /**
      * Gets the parsed controller.
      *
-     * @return array|string The controller as a string or array of data
-     *                      with keys 'class', 'method', 'file' and 'line'
+     * @return array|string|Data The controller as a string or array of data
+     *                           with keys 'class', 'method', 'file' and 'line'
      */
     public function getController()
     {
@@ -350,8 +351,8 @@ public function getController()
     /**
      * Gets the previous request attributes.
      *
-     * @return array|bool A legacy array of data from the previous redirection response
-     *                    or false otherwise
+     * @return array|Data|false A legacy array of data from the previous redirection response
+     *                          or false otherwise
      */
     public function getRedirect()
     {
diff --git a/EventListener/AbstractSessionListener.php b/EventListener/AbstractSessionListener.php
@@ -191,7 +191,7 @@ public static function getSubscribedEvents(): array
     /**
      * Gets the session object.
      *
-     * @return SessionInterface|null A SessionInterface instance or null if no session is available
+     * @return SessionInterface|null
      */
     abstract protected function getSession();
 }
diff --git a/EventListener/AbstractTestSessionListener.php b/EventListener/AbstractTestSessionListener.php
@@ -112,7 +112,7 @@ public static function getSubscribedEvents(): array
      *
      * @deprecated since Symfony 5.4, will be removed in 6.0.
      *
-     * @return SessionInterface|null A SessionInterface instance or null if no session is available
+     * @return SessionInterface|null
      */
     abstract protected function getSession();
 }
diff --git a/Fragment/FragmentRendererInterface.php b/Fragment/FragmentRendererInterface.php
@@ -25,7 +25,7 @@ interface FragmentRendererInterface
     /**
      * Renders a URI and returns the Response content.
      *
-     * @return Response A Response instance
+     * @return Response
      */
     public function render(string|ControllerReference $uri, Request $request, array $options = []);
 
diff --git a/HttpCache/AbstractSurrogate.php b/HttpCache/AbstractSurrogate.php
@@ -41,7 +41,7 @@ public function __construct(array $contentTypes = ['text/html', 'text/xml', 'app
     /**
      * Returns a new cache strategy instance.
      *
-     * @return ResponseCacheStrategyInterface A ResponseCacheStrategyInterface instance
+     * @return ResponseCacheStrategyInterface
      */
     public function createCacheStrategy()
     {
diff --git a/HttpCache/HttpCache.php b/HttpCache/HttpCache.php
@@ -106,7 +106,7 @@ public function __construct(HttpKernelInterface $kernel, StoreInterface $store,
     /**
      * Gets the current store.
      *
-     * @return StoreInterface A StoreInterface instance
+     * @return StoreInterface
      */
     public function getStore()
     {
@@ -158,7 +158,7 @@ public function getLog()
     /**
      * Gets the Request instance associated with the main request.
      *
-     * @return Request A Request instance
+     * @return Request
      */
     public function getRequest()
     {
@@ -168,7 +168,7 @@ public function getRequest()
     /**
      * Gets the Kernel instance.
      *
-     * @return HttpKernelInterface An HttpKernelInterface instance
+     * @return HttpKernelInterface
      */
     public function getKernel()
     {
@@ -178,7 +178,7 @@ public function getKernel()
     /**
      * Gets the Surrogate instance.
      *
-     * @return SurrogateInterface A Surrogate instance
+     * @return SurrogateInterface
      *
      * @throws \LogicException
      */
@@ -258,7 +258,7 @@ public function terminate(Request $request, Response $response)
      *
      * @param bool $catch Whether to process exceptions
      *
-     * @return Response A Response instance
+     * @return Response
      */
     protected function pass(Request $request, bool $catch = false)
     {
@@ -272,7 +272,7 @@ protected function pass(Request $request, bool $catch = false)
      *
      * @param bool $catch Whether to process exceptions
      *
-     * @return Response A Response instance
+     * @return Response
      *
      * @throws \Exception
      *
@@ -320,7 +320,7 @@ protected function invalidate(Request $request, bool $catch = false)
      *
      * @param bool $catch Whether to process exceptions
      *
-     * @return Response A Response instance
+     * @return Response
      *
      * @throws \Exception
      */
@@ -369,7 +369,7 @@ protected function lookup(Request $request, bool $catch = false)
      *
      * @param bool $catch Whether to process exceptions
      *
-     * @return Response A Response instance
+     * @return Response
      */
     protected function validate(Request $request, Response $entry, bool $catch = false)
     {
@@ -432,7 +432,7 @@ protected function validate(Request $request, Response $entry, bool $catch = fal
      *
      * @param bool $catch Whether to process exceptions
      *
-     * @return Response A Response instance
+     * @return Response
      */
     protected function fetch(Request $request, bool $catch = false)
     {
@@ -465,7 +465,7 @@ protected function fetch(Request $request, bool $catch = false)
      * @param bool          $catch Whether to catch exceptions or not
      * @param Response|null $entry A Response instance (the stale entry if present, null otherwise)
      *
-     * @return Response A Response instance
+     * @return Response
      */
     protected function forward(Request $request, bool $catch = false, Response $entry = null)
     {
diff --git a/HttpCache/Store.php b/HttpCache/Store.php
@@ -125,7 +125,7 @@ public function isLocked(Request $request)
     /**
      * Locates a cached Response for the Request provided.
      *
-     * @return Response|null A Response instance, or null if no cache entry was found
+     * @return Response|null
      */
     public function lookup(Request $request)
     {
diff --git a/HttpCache/StoreInterface.php b/HttpCache/StoreInterface.php
@@ -27,7 +27,7 @@ interface StoreInterface
     /**
      * Locates a cached Response for the Request provided.
      *
-     * @return Response|null A Response instance, or null if no cache entry was found
+     * @return Response|null
      */
     public function lookup(Request $request);
 
diff --git a/HttpCache/SurrogateInterface.php b/HttpCache/SurrogateInterface.php
@@ -26,7 +26,7 @@ public function getName();
     /**
      * Returns a new cache strategy instance.
      *
-     * @return ResponseCacheStrategyInterface A ResponseCacheStrategyInterface instance
+     * @return ResponseCacheStrategyInterface
      */
     public function createCacheStrategy();
 
diff --git a/HttpKernelBrowser.php b/HttpKernelBrowser.php
@@ -58,7 +58,7 @@ public function catchExceptions(bool $catchExceptions)
      *
      * @param Request $request
      *
-     * @return Response A Response instance
+     * @return Response
      */
     protected function doRequest(object $request)
     {
@@ -130,7 +130,7 @@ protected function getHandleScript()
     /**
      * {@inheritdoc}
      *
-     * @return Request A Request instance
+     * @return Request
      */
     protected function filterRequest(DomRequest $request)
     {
@@ -194,7 +194,7 @@ protected function filterFiles(array $files)
      *
      * @param Request $request
      *
-     * @return DomResponse A DomResponse instance
+     * @return DomResponse
      */
     protected function filterResponse(object $response)
     {
diff --git a/HttpKernelInterface.php b/HttpKernelInterface.php
@@ -40,7 +40,7 @@ interface HttpKernelInterface
      *                    (one of HttpKernelInterface::MAIN_REQUEST or HttpKernelInterface::SUB_REQUEST)
      * @param bool $catch Whether to catch exceptions or not
      *
-     * @return Response A Response instance
+     * @return Response
      *
      * @throws \Exception When an Exception occurs during processing
      */
diff --git a/KernelInterface.php b/KernelInterface.php
@@ -27,7 +27,7 @@ interface KernelInterface extends HttpKernelInterface
     /**
      * Returns an array of bundles to register.
      *
-     * @return iterable|BundleInterface[] An iterable of bundle instances
+     * @return iterable|BundleInterface[]
      */
     public function registerBundles();
 
@@ -51,14 +51,14 @@ public function shutdown();
     /**
      * Gets the registered bundle instances.
      *
-     * @return BundleInterface[] An array of registered bundle instances
+     * @return BundleInterface[]
      */
     public function getBundles();
 
     /**
      * Returns a bundle.
      *
-     * @return BundleInterface A BundleInterface instance
+     * @return BundleInterface
      *
      * @throws \InvalidArgumentException when the bundle is not enabled
      */
diff --git a/Profiler/Profile.php b/Profiler/Profile.php
@@ -74,7 +74,7 @@ public function setParent(self $parent)
     /**
      * Returns the parent profile.
      *
-     * @return self
+     * @return self|null
      */
     public function getParent()
     {
@@ -208,7 +208,7 @@ public function getChildByToken(string $token): ?self
     /**
      * Gets a Collector by name.
      *
-     * @return DataCollectorInterface A DataCollectorInterface instance
+     * @return DataCollectorInterface
      *
      * @throws \InvalidArgumentException if the collector does not exist
      */
diff --git a/Profiler/Profiler.php b/Profiler/Profiler.php
@@ -63,7 +63,7 @@ public function enable()
     /**
      * Loads the Profile for the given Response.
      *
-     * @return Profile|null A Profile instance
+     * @return Profile|null
      */
     public function loadProfileFromResponse(Response $response)
     {
@@ -77,7 +77,7 @@ public function loadProfileFromResponse(Response $response)
     /**
      * Loads the Profile for the given token.
      *
-     * @return Profile|null A Profile instance
+     * @return Profile|null
      */
     public function loadProfile(string $token)
     {
@@ -132,7 +132,7 @@ public function find(?string $ip, ?string $url, ?string $limit, ?string $method,
     /**
      * Collects data for the given Response.
      *
-     * @return Profile|null A Profile instance or null if the profiler is disabled
+     * @return Profile|null
      */
     public function collect(Request $request, Response $response, \Throwable $exception = null)
     {
@@ -223,7 +223,7 @@ public function has(string $name)
      *
      * @param string $name A collector name
      *
-     * @return DataCollectorInterface A DataCollectorInterface instance
+     * @return DataCollectorInterface
      *
      * @throws \InvalidArgumentException if the collector does not exist
      */
diff --git a/Tests/DataCollector/RequestDataCollectorTest.php b/Tests/DataCollector/RequestDataCollectorTest.php
@@ -22,6 +22,7 @@
 use Symfony\Component\HttpFoundation\Session\Session;
 use Symfony\Component\HttpFoundation\Session\SessionBagInterface;
 use Symfony\Component\HttpFoundation\Session\SessionInterface;
+use Symfony\Component\HttpFoundation\Session\Storage\MetadataBag;
 use Symfony\Component\HttpFoundation\Session\Storage\MockArraySessionStorage;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolverInterface;
 use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;
@@ -268,6 +269,8 @@ public function testItCollectsTheSessionTraceProperly()
         $session = $this->createMock(SessionInterface::class);
         $session->method('getMetadataBag')->willReturnCallback(static function () use ($collector) {
             $collector->collectSessionUsage();
+
+            return new MetadataBag();
         });
         $session->getMetadataBag();
 

Original file line number	Diff line number	Diff line change
`@@ -191,7 +191,7 @@ public static function getSubscribedEvents(): array`
`191`	`191`	`/**`
`192`	`192`	`* Gets the session object.`
`193`	`193`	`*`
`194`		`- * @return SessionInterface\|null A SessionInterface instance or null if no session is available`
	`194`	`+ * @return SessionInterface\|null`
`195`	`195`	`*/`
`196`	`196`	`abstract protected function getSession();`
`197`	`197`	`}`
Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@ public static function getSubscribedEvents(): array`
`112`	`112`	`*`
`113`	`113`	`* @deprecated since Symfony 5.4, will be removed in 6.0.`
`114`	`114`	`*`
`115`		`- * @return SessionInterface\|null A SessionInterface instance or null if no session is available`
	`115`	`+ * @return SessionInterface\|null`
`116`	`116`	`*/`
`117`	`117`	`abstract protected function getSession();`
`118`	`118`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ interface FragmentRendererInterface`
`25`	`25`	`/**`
`26`	`26`	`* Renders a URI and returns the Response content.`
`27`	`27`	`*`
`28`		`- * @return Response A Response instance`
	`28`	`+ * @return Response`
`29`	`29`	`*/`
`30`	`30`	`public function render(string\|ControllerReference $uri, Request $request, array $options = []);`
`31`	`31`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public function __construct(array $contentTypes = ['text/html', 'text/xml', 'app`
`41`	`41`	`/**`
`42`	`42`	`* Returns a new cache strategy instance.`
`43`	`43`	`*`
`44`		`- * @return ResponseCacheStrategyInterface A ResponseCacheStrategyInterface instance`
	`44`	`+ * @return ResponseCacheStrategyInterface`
`45`	`45`	`*/`
`46`	`46`	`public function createCacheStrategy()`
`47`	`47`	`{`
Original file line number	Diff line number	Diff line change
`@@ -106,7 +106,7 @@ public function __construct(HttpKernelInterface $kernel, StoreInterface $store,`
`106`	`106`	`/**`
`107`	`107`	`* Gets the current store.`
`108`	`108`	`*`
`109`		`- * @return StoreInterface A StoreInterface instance`
	`109`	`+ * @return StoreInterface`
`110`	`110`	`*/`
`111`	`111`	`public function getStore()`
`112`	`112`	`{`
`@@ -158,7 +158,7 @@ public function getLog()`
`158`	`158`	`/**`
`159`	`159`	`* Gets the Request instance associated with the main request.`
`160`	`160`	`*`
`161`		`- * @return Request A Request instance`
	`161`	`+ * @return Request`
`162`	`162`	`*/`
`163`	`163`	`public function getRequest()`
`164`	`164`	`{`
`@@ -168,7 +168,7 @@ public function getRequest()`
`168`	`168`	`/**`
`169`	`169`	`* Gets the Kernel instance.`
`170`	`170`	`*`
`171`		`- * @return HttpKernelInterface An HttpKernelInterface instance`
	`171`	`+ * @return HttpKernelInterface`
`172`	`172`	`*/`
`173`	`173`	`public function getKernel()`
`174`	`174`	`{`
`@@ -178,7 +178,7 @@ public function getKernel()`
`178`	`178`	`/**`
`179`	`179`	`* Gets the Surrogate instance.`
`180`	`180`	`*`
`181`		`- * @return SurrogateInterface A Surrogate instance`
	`181`	`+ * @return SurrogateInterface`
`182`	`182`	`*`
`183`	`183`	`* @throws \LogicException`
`184`	`184`	`*/`
`@@ -258,7 +258,7 @@ public function terminate(Request $request, Response $response)`
`258`	`258`	`*`
`259`	`259`	`* @param bool $catch Whether to process exceptions`
`260`	`260`	`*`
`261`		`- * @return Response A Response instance`
	`261`	`+ * @return Response`
`262`	`262`	`*/`
`263`	`263`	`protected function pass(Request $request, bool $catch = false)`
`264`	`264`	`{`
`@@ -272,7 +272,7 @@ protected function pass(Request $request, bool $catch = false)`
`272`	`272`	`*`
`273`	`273`	`* @param bool $catch Whether to process exceptions`
`274`	`274`	`*`
`275`		`- * @return Response A Response instance`
	`275`	`+ * @return Response`
`276`	`276`	`*`
`277`	`277`	`* @throws \Exception`
`278`	`278`	`*`
`@@ -320,7 +320,7 @@ protected function invalidate(Request $request, bool $catch = false)`
`320`	`320`	`*`
`321`	`321`	`* @param bool $catch Whether to process exceptions`
`322`	`322`	`*`
`323`		`- * @return Response A Response instance`
	`323`	`+ * @return Response`
`324`	`324`	`*`
`325`	`325`	`* @throws \Exception`
`326`	`326`	`*/`
`@@ -369,7 +369,7 @@ protected function lookup(Request $request, bool $catch = false)`
`369`	`369`	`*`
`370`	`370`	`* @param bool $catch Whether to process exceptions`
`371`	`371`	`*`
`372`		`- * @return Response A Response instance`
	`372`	`+ * @return Response`
`373`	`373`	`*/`
`374`	`374`	`protected function validate(Request $request, Response $entry, bool $catch = false)`
`375`	`375`	`{`
`@@ -432,7 +432,7 @@ protected function validate(Request $request, Response $entry, bool $catch = fal`
`432`	`432`	`*`
`433`	`433`	`* @param bool $catch Whether to process exceptions`
`434`	`434`	`*`
`435`		`- * @return Response A Response instance`
	`435`	`+ * @return Response`
`436`	`436`	`*/`
`437`	`437`	`protected function fetch(Request $request, bool $catch = false)`
`438`	`438`	`{`
`@@ -465,7 +465,7 @@ protected function fetch(Request $request, bool $catch = false)`
`465`	`465`	`* @param bool $catch Whether to catch exceptions or not`
`466`	`466`	`* @param Response\|null $entry A Response instance (the stale entry if present, null otherwise)`
`467`	`467`	`*`
`468`		`- * @return Response A Response instance`
	`468`	`+ * @return Response`
`469`	`469`	`*/`
`470`	`470`	`protected function forward(Request $request, bool $catch = false, Response $entry = null)`
`471`	`471`	`{`
Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,7 @@ public function isLocked(Request $request)`
`125`	`125`	`/**`
`126`	`126`	`* Locates a cached Response for the Request provided.`
`127`	`127`	`*`
`128`		`- * @return Response\|null A Response instance, or null if no cache entry was found`
	`128`	`+ * @return Response\|null`
`129`	`129`	`*/`
`130`	`130`	`public function lookup(Request $request)`
`131`	`131`	`{`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ interface StoreInterface`
`27`	`27`	`/**`
`28`	`28`	`* Locates a cached Response for the Request provided.`
`29`	`29`	`*`
`30`		`- * @return Response\|null A Response instance, or null if no cache entry was found`
	`30`	`+ * @return Response\|null`
`31`	`31`	`*/`
`32`	`32`	`public function lookup(Request $request);`
`33`	`33`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ public function getName();`
`26`	`26`	`/**`
`27`	`27`	`* Returns a new cache strategy instance.`
`28`	`28`	`*`
`29`		`- * @return ResponseCacheStrategyInterface A ResponseCacheStrategyInterface instance`
	`29`	`+ * @return ResponseCacheStrategyInterface`
`30`	`30`	`*/`
`31`	`31`	`public function createCacheStrategy();`
`32`	`32`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ public function catchExceptions(bool $catchExceptions)`
`58`	`58`	`*`
`59`	`59`	`* @param Request $request`
`60`	`60`	`*`
`61`		`- * @return Response A Response instance`
	`61`	`+ * @return Response`
`62`	`62`	`*/`
`63`	`63`	`protected function doRequest(object $request)`
`64`	`64`	`{`
`@@ -130,7 +130,7 @@ protected function getHandleScript()`
`130`	`130`	`/**`
`131`	`131`	`* {@inheritdoc}`
`132`	`132`	`*`
`133`		`- * @return Request A Request instance`
	`133`	`+ * @return Request`
`134`	`134`	`*/`
`135`	`135`	`protected function filterRequest(DomRequest $request)`
`136`	`136`	`{`
`@@ -194,7 +194,7 @@ protected function filterFiles(array $files)`
`194`	`194`	`*`
`195`	`195`	`* @param Request $request`
`196`	`196`	`*`
`197`		`- * @return DomResponse A DomResponse instance`
	`197`	`+ * @return DomResponse`
`198`	`198`	`*/`
`199`	`199`	`protected function filterResponse(object $response)`
`200`	`200`	`{`