minor symfony#57809 [BrowserKit][HttpKernel] make use of the @template annotation to improve type information (xabbuh)

This PR was merged into the 7.2 branch.

Discussion
----------

[BrowserKit][HttpKernel] make use of the ``@template`` annotation to improve type information

| Q             | A
| ------------- | ---
| Branch?       | 7.2
| Bug fix?      | no
| New feature?  | no
| Deprecations? | no
| Issues        |
| License       | MIT

I was wondering why we had ``@method`` annotations in the `HttpKernelBrowser` class. It looks like they were introduced in symfony#21537 to satisfy static analysis tools and to improve auto-completion in IDEs. Given that we have more than one subclass of the `AbstractBrowser` class I thought it might be good to properly make use of the ``@template`` annotation to cover all methods of that class without having to list them all explicitly in all child classes.

Commits
-------

44e4e43 make use of the `@template` annotation to improve type information

Author: fabpot

src/Symfony/Component/BrowserKit/AbstractBrowser.php

@@ -29,15 +29,20 @@
  * you need to also implement the getScript() method.
  *
  * @author Fabien Potencier <[email protected]>
+ *
+ * @template TRequest of object
+ * @template TResponse of object
  */
 abstract class AbstractBrowser
 {
     protected History $history;
     protected CookieJar $cookieJar;
     protected array $server = [];
     protected Request $internalRequest;
+    /** @psalm-var TRequest */
     protected object $request;
     protected Response $internalResponse;
+    /** @psalm-var TResponse */
     protected object $response;
     protected Crawler $crawler;
     protected bool $useHtml5Parser = true;
@@ -221,6 +226,8 @@ public function getInternalResponse(): Response
      * The origin response is the response instance that is returned
      * by the code that handles requests.
      *
+     * @psalm-return TResponse
+     *
      * @see doRequest()
      */
     public function getResponse(): object
@@ -242,6 +249,8 @@ public function getInternalRequest(): Request
      * The origin request is the request instance that is sent
      * to the code that handles requests.
      *
+     * @psalm-return TRequest
+     *
      * @see doRequest()
      */
     public function getRequest(): object
@@ -402,7 +411,9 @@ public function request(string $method, string $uri, array $parameters = [], arr
     /**
      * Makes a request in another process.
      *
-     * @return object
+     * @psalm-param TRequest $request
+     *
+     * @psalm-return TResponse
      *
      * @throws \RuntimeException When processing returns exit code
      */
@@ -437,13 +448,17 @@ protected function doRequestInProcess(object $request)
     /**
      * Makes a request.
      *
-     * @return object
+     * @psalm-param TRequest $request
+     *
+     * @psalm-return TResponse
      */
     abstract protected function doRequest(object $request);
 
     /**
      * Returns the script to execute when the request must be insulated.
      *
+     * @psalm-param TRequest $request
+     *
      * @param object $request An origin request instance
      *
      * @return string
@@ -459,6 +474,8 @@ protected function getScript(object $request)
      * Filters the BrowserKit request to the origin one.
      *
      * @return object
+     *
+     * @psalm-return TRequest
      */
     protected function filterRequest(Request $request)
     {
@@ -468,6 +485,8 @@ protected function filterRequest(Request $request)
     /**
      * Filters the origin response to the BrowserKit one.
      *
+     * @psalm-param TResponse $response
+     *
      * @return Response
      */
     protected function filterResponse(object $response)

src/Symfony/Component/BrowserKit/HttpBrowser.php

@@ -24,6 +24,8 @@
  * to make real HTTP requests.
  *
  * @author Fabien Potencier <[email protected]>
+ *
+ * @template-extends AbstractBrowser<Request, Response>
  */
 class HttpBrowser extends AbstractBrowser
 {

src/Symfony/Component/HttpKernel/HttpKernelBrowser.php

@@ -25,8 +25,7 @@
  *
  * @author Fabien Potencier <[email protected]>
  *
- * @method Request  getRequest()
- * @method Response getResponse()
+ * @template-extends AbstractBrowser<Request, Response>
  */
 class HttpKernelBrowser extends AbstractBrowser
 {