minor #49599 [HttpFoundation][HttpKernel] Add missing void PHPdoc return types (wouterj)

nicolas-grekas · nicolas-grekas · commit 32f2ec93ded7 · 2023-03-06T11:35:16.000+01:00
This PR was merged into the 6.3 branch. Discussion ---------- [HttpFoundation][HttpKernel] Add missing void PHPdoc return types | Q | A | ------------- | --- | Branch? | 6.3 | Bug fix? | no | New feature? | no | Deprecations? | no (void return types don't get a deprecation notice) | Tickets | Fix part of #47551 , ref #49439 | License | MIT | Doc PR | - Commits ------- 9bb72d7 [HttpFoundation][HttpKernel] Add missing void PHPdoc return types
diff --git a/.github/expected-missing-return-types.diff b/.github/expected-missing-return-types.diff
diff --git a/src/Symfony/Bundle/FrameworkBundle/Kernel/MicroKernelTrait.php b/src/Symfony/Bundle/FrameworkBundle/Kernel/MicroKernelTrait.php
@@ -128,6 +128,9 @@ public function registerBundles(): iterable
         }
     }
 
+    /**
+     * @return void
+     */
     public function registerContainerConfiguration(LoaderInterface $loader)
     {
         $loader->load(function (ContainerBuilder $container) use ($loader) {
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/AppKernel.php b/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/AppKernel.php
@@ -75,7 +75,7 @@ public function getLogDir(): string
         return sys_get_temp_dir().'/'.$this->varDir.'/'.$this->testCase.'/logs';
     }
 
-    public function registerContainerConfiguration(LoaderInterface $loader)
+    public function registerContainerConfiguration(LoaderInterface $loader): void
     {
         foreach ($this->rootConfig as $config) {
             $loader->load($config);
diff --git a/src/Symfony/Bundle/TwigBundle/Tests/Functional/EmptyAppTest.php b/src/Symfony/Bundle/TwigBundle/Tests/Functional/EmptyAppTest.php
@@ -58,7 +58,7 @@ public function registerBundles(): iterable
         return [new TwigBundle()];
     }
 
-    public function registerContainerConfiguration(LoaderInterface $loader)
+    public function registerContainerConfiguration(LoaderInterface $loader): void
     {
         $loader->load(static function (ContainerBuilder $container) {
             $container->register('error_renderer.html', HtmlErrorRenderer::class);
diff --git a/src/Symfony/Bundle/TwigBundle/Tests/Functional/NoTemplatingEntryTest.php b/src/Symfony/Bundle/TwigBundle/Tests/Functional/NoTemplatingEntryTest.php
@@ -59,7 +59,7 @@ public function registerBundles(): iterable
         return [new FrameworkBundle(), new TwigBundle()];
     }
 
-    public function registerContainerConfiguration(LoaderInterface $loader)
+    public function registerContainerConfiguration(LoaderInterface $loader): void
     {
         $loader->load(function (ContainerBuilder $container) {
             $container
diff --git a/src/Symfony/Component/HttpFoundation/Session/Attribute/AttributeBagInterface.php b/src/Symfony/Component/HttpFoundation/Session/Attribute/AttributeBagInterface.php
@@ -32,6 +32,8 @@ public function get(string $name, mixed $default = null): mixed;
 
     /**
      * Sets an attribute.
+     *
+     * @return void
      */
     public function set(string $name, mixed $value);
 
@@ -42,6 +44,9 @@ public function set(string $name, mixed $value);
      */
     public function all(): array;
 
+    /**
+     * @return void
+     */
     public function replace(array $attributes);
 
     /**
diff --git a/src/Symfony/Component/HttpFoundation/Session/Flash/FlashBagInterface.php b/src/Symfony/Component/HttpFoundation/Session/Flash/FlashBagInterface.php
@@ -22,11 +22,15 @@ interface FlashBagInterface extends SessionBagInterface
 {
     /**
      * Adds a flash message for the given type.
+     *
+     * @return void
      */
     public function add(string $type, mixed $message);
 
     /**
      * Registers one or more messages for a given type.
+     *
+     * @return void
      */
     public function set(string $type, string|array $messages);
 
@@ -57,6 +61,8 @@ public function all(): array;
 
     /**
      * Sets all flash messages.
+     *
+     * @return void
      */
     public function setAll(array $messages);
 
diff --git a/src/Symfony/Component/HttpFoundation/Session/SessionBagInterface.php b/src/Symfony/Component/HttpFoundation/Session/SessionBagInterface.php
@@ -25,6 +25,8 @@ public function getName(): string;
 
     /**
      * Initializes the Bag.
+     *
+     * @return void
      */
     public function initialize(array &$array);
 
diff --git a/src/Symfony/Component/HttpFoundation/Session/SessionInterface.php b/src/Symfony/Component/HttpFoundation/Session/SessionInterface.php
@@ -34,6 +34,8 @@ public function getId(): string;
 
     /**
      * Sets the session ID.
+     *
+     * @return void
      */
     public function setId(string $id);
 
@@ -44,6 +46,8 @@ public function getName(): string;
 
     /**
      * Sets the session name.
+     *
+     * @return void
      */
     public function setName(string $name);
 
@@ -78,6 +82,8 @@ public function migrate(bool $destroy = false, int $lifetime = null): bool;
      * This method is generally not required for real sessions as
      * the session will be automatically saved at the end of
      * code execution.
+     *
+     * @return void
      */
     public function save();
 
@@ -93,6 +99,8 @@ public function get(string $name, mixed $default = null): mixed;
 
     /**
      * Sets an attribute.
+     *
+     * @return void
      */
     public function set(string $name, mixed $value);
 
@@ -103,6 +111,8 @@ public function all(): array;
 
     /**
      * Sets attributes.
+     *
+     * @return void
      */
     public function replace(array $attributes);
 
@@ -115,6 +125,8 @@ public function remove(string $name): mixed;
 
     /**
      * Clears all attributes.
+     *
+     * @return void
      */
     public function clear();
 
@@ -125,6 +137,8 @@ public function isStarted(): bool;
 
     /**
      * Registers a SessionBagInterface with the session.
+     *
+     * @return void
      */
     public function registerBag(SessionBagInterface $bag);
 
diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/SessionStorageInterface.php b/src/Symfony/Component/HttpFoundation/Session/Storage/SessionStorageInterface.php
@@ -40,6 +40,8 @@ public function getId(): string;
 
     /**
      * Sets the session ID.
+     *
+     * @return void
      */
     public function setId(string $id);
 
@@ -50,6 +52,8 @@ public function getName(): string;
 
     /**
      * Sets the session name.
+     *
+     * @return void
      */
     public function setName(string $name);
 
@@ -90,13 +94,17 @@ public function regenerate(bool $destroy = false, int $lifetime = null): bool;
      * a real PHP session would interfere with testing, in which case
      * it should actually persist the session data if required.
      *
+     * @return void
+     *
      * @throws \RuntimeException if the session is saved without being started, or if the session
      *                           is already closed
      */
     public function save();
 
     /**
      * Clear all session data in memory.
+     *
+     * @return void
      */
     public function clear();
 
@@ -109,6 +117,8 @@ public function getBag(string $name): SessionBagInterface;
 
     /**
      * Registers a SessionBagInterface for use.
+     *
+     * @return void
      */
     public function registerBag(SessionBagInterface $bag);
 
diff --git a/src/Symfony/Component/HttpKernel/CacheClearer/CacheClearerInterface.php b/src/Symfony/Component/HttpKernel/CacheClearer/CacheClearerInterface.php
@@ -20,6 +20,8 @@ interface CacheClearerInterface
 {
     /**
      * Clears any caches necessary.
+     *
+     * @return void
      */
     public function clear(string $cacheDir);
 }
diff --git a/src/Symfony/Component/HttpKernel/HttpCache/ResponseCacheStrategyInterface.php b/src/Symfony/Component/HttpKernel/HttpCache/ResponseCacheStrategyInterface.php
@@ -27,11 +27,15 @@ interface ResponseCacheStrategyInterface
 {
     /**
      * Adds a Response.
+     *
+     * @return void
      */
     public function add(Response $response);
 
     /**
      * Updates the Response HTTP headers based on the embedded Responses.
+     *
+     * @return void
      */
     public function update(Response $response);
 }
diff --git a/src/Symfony/Component/HttpKernel/HttpCache/StoreInterface.php b/src/Symfony/Component/HttpKernel/HttpCache/StoreInterface.php
@@ -41,6 +41,8 @@ public function write(Request $request, Response $response): string;
 
     /**
      * Invalidates all cache entries that match the request.
+     *
+     * @return void
      */
     public function invalidate(Request $request);
 
@@ -74,6 +76,8 @@ public function purge(string $url): bool;
 
     /**
      * Cleanups storage.
+     *
+     * @return void
      */
     public function cleanup();
 }
diff --git a/src/Symfony/Component/HttpKernel/HttpCache/SurrogateInterface.php b/src/Symfony/Component/HttpKernel/HttpCache/SurrogateInterface.php
@@ -33,13 +33,17 @@ public function hasSurrogateCapability(Request $request): bool;
 
     /**
      * Adds Surrogate-capability to the given Request.
+     *
+     * @return void
      */
     public function addSurrogateCapability(Request $request);
 
     /**
      * Adds HTTP headers to specify that the Response needs to be parsed for Surrogate.
      *
      * This method only adds an Surrogate HTTP header if the Response has some Surrogate tags.
+     *
+     * @return void
      */
     public function addSurrogateControl(Response $response);
 
diff --git a/src/Symfony/Component/HttpKernel/KernelInterface.php b/src/Symfony/Component/HttpKernel/KernelInterface.php
@@ -33,18 +33,24 @@ public function registerBundles(): iterable;
 
     /**
      * Loads the container configuration.
+     *
+     * @return void
      */
     public function registerContainerConfiguration(LoaderInterface $loader);
 
     /**
      * Boots the current kernel.
+     *
+     * @return void
      */
     public function boot();
 
     /**
      * Shutdowns the kernel.
      *
      * This method is mainly useful when doing functional testing.
+     *
+     * @return void
      */
     public function shutdown();
 
diff --git a/src/Symfony/Component/HttpKernel/Log/DebugLoggerInterface.php b/src/Symfony/Component/HttpKernel/Log/DebugLoggerInterface.php
@@ -44,6 +44,8 @@ public function countErrors(Request $request = null);
 
     /**
      * Removes all log records.
+     *
+     * @return void
      */
     public function clear();
 }
diff --git a/src/Symfony/Component/HttpKernel/Profiler/ProfilerStorageInterface.php b/src/Symfony/Component/HttpKernel/Profiler/ProfilerStorageInterface.php
@@ -49,6 +49,8 @@ public function write(Profile $profile): bool;
 
     /**
      * Purges all data from the database.
+     *
+     * @return void
      */
     public function purge();
 }
diff --git a/src/Symfony/Component/HttpKernel/RebootableInterface.php b/src/Symfony/Component/HttpKernel/RebootableInterface.php
@@ -25,6 +25,8 @@ interface RebootableInterface
      * while building the container. Use the %kernel.build_dir% parameter instead.
      *
      * @param string|null $warmupDir pass null to reboot in the regular build directory
+     *
+     * @return void
      */
     public function reboot(?string $warmupDir);
 }
diff --git a/src/Symfony/Component/HttpKernel/TerminableInterface.php b/src/Symfony/Component/HttpKernel/TerminableInterface.php
@@ -27,6 +27,8 @@ interface TerminableInterface
      * Terminates a request/response cycle.
      *
      * Should be called after sending the response and before shutting down the kernel.
+     *
+     * @return void
      */
     public function terminate(Request $request, Response $response);
 }
diff --git a/src/Symfony/Component/HttpKernel/Tests/DataCollector/ConfigDataCollectorTest.php b/src/Symfony/Component/HttpKernel/Tests/DataCollector/ConfigDataCollectorTest.php
@@ -90,7 +90,7 @@ public function getBundles(): array
         return [];
     }
 
-    public function registerContainerConfiguration(LoaderInterface $loader)
+    public function registerContainerConfiguration(LoaderInterface $loader): void
     {
     }
 }
diff --git a/src/Symfony/Component/HttpKernel/Tests/Logger.php b/src/Symfony/Component/HttpKernel/Tests/Logger.php
@@ -27,7 +27,7 @@ public function getLogs($level = false): array
         return false === $level ? $this->logs : $this->logs[$level];
     }
 
-    public function clear()
+    public function clear(): void
     {
         $this->logs = [
             'emergency' => [],

Original file line number	Diff line number	Diff line change
`@@ -128,6 +128,9 @@ public function registerBundles(): iterable`
`128`	`128`	`}`
`129`	`129`	`}`
`130`	`130`
	`131`	`+ /**`
	`132`	`+ * @return void`
	`133`	`+ */`
`131`	`134`	`public function registerContainerConfiguration(LoaderInterface $loader)`
`132`	`135`	`{`
`133`	`136`	`$loader->load(function (ContainerBuilder $container) use ($loader) {`
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ public function getLogDir(): string`
`75`	`75`	`return sys_get_temp_dir().'/'.$this->varDir.'/'.$this->testCase.'/logs';`
`76`	`76`	`}`
`77`	`77`
`78`		`- public function registerContainerConfiguration(LoaderInterface $loader)`
	`78`	`+ public function registerContainerConfiguration(LoaderInterface $loader): void`
`79`	`79`	`{`
`80`	`80`	`foreach ($this->rootConfig as $config) {`
`81`	`81`	`$loader->load($config);`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ public function registerBundles(): iterable`
`58`	`58`	`return [new TwigBundle()];`
`59`	`59`	`}`
`60`	`60`
`61`		`- public function registerContainerConfiguration(LoaderInterface $loader)`
	`61`	`+ public function registerContainerConfiguration(LoaderInterface $loader): void`
`62`	`62`	`{`
`63`	`63`	`$loader->load(static function (ContainerBuilder $container) {`
`64`	`64`	`$container->register('error_renderer.html', HtmlErrorRenderer::class);`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ public function registerBundles(): iterable`
`59`	`59`	`return [new FrameworkBundle(), new TwigBundle()];`
`60`	`60`	`}`
`61`	`61`
`62`		`- public function registerContainerConfiguration(LoaderInterface $loader)`
	`62`	`+ public function registerContainerConfiguration(LoaderInterface $loader): void`
`63`	`63`	`{`
`64`	`64`	`$loader->load(function (ContainerBuilder $container) {`
`65`	`65`	`$container`