symfony · javiereguiluz · Jul 13, 2023 · Jul 13, 2023
diff --git a/best_practices.rst b/best_practices.rst
@@ -411,15 +411,15 @@ checks that all application URLs load successfully::
         /**
          * @dataProvider urlProvider
          */
-        public function testPageIsSuccessful($url)
+        public function testPageIsSuccessful($url): void
         {
             $client = self::createClient();
             $client->request('GET', $url);
 
             $this->assertResponseIsSuccessful();
         }
 
-        public function urlProvider()
+        public function urlProvider(): \Generator
         {
             yield ['/'];
             yield ['/posts'];

diff --git a/bundles/configuration.rst b/bundles/configuration.rst
@@ -183,7 +183,7 @@ The ``Configuration`` class to handle the sample configuration looks like::
 
     class Configuration implements ConfigurationInterface
     {
-        public function getConfigTreeBuilder()
+        public function getConfigTreeBuilder(): TreeBuilder
         {
             $treeBuilder = new TreeBuilder('acme_social');
 
@@ -217,7 +217,7 @@ force validation (e.g. if an additional option was passed, an exception will be
 thrown)::
 
     // src/Acme/SocialBundle/DependencyInjection/AcmeSocialExtension.php
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $configuration = new Configuration();
 
@@ -259,7 +259,7 @@ In your extension, you can load this and dynamically set its arguments::
     use Symfony\Component\Config\FileLocator;
     use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $loader = new XmlFileLoader($container, new FileLocator(dirname(__DIR__).'/Resources/config'));
         $loader->load('services.xml');
@@ -288,7 +288,7 @@ In your extension, you can load this and dynamically set its arguments::
         class AcmeHelloExtension extends ConfigurableExtension
         {
             // note that this method is called loadInternal and not load
-            protected function loadInternal(array $mergedConfig, ContainerBuilder $container)
+            protected function loadInternal(array $mergedConfig, ContainerBuilder $container): void
             {
                 // ...
             }
@@ -304,7 +304,7 @@ In your extension, you can load this and dynamically set its arguments::
     (e.g. by overriding configurations and using :phpfunction:`isset` to check
     for the existence of a value). Be aware that it'll be very hard to support XML::
 
-        public function load(array $configs, ContainerBuilder $container)
+        public function load(array $configs, ContainerBuilder $container): void
         {
             $config = [];
             // let resources override the previous set value
@@ -458,7 +458,7 @@ the extension. You might want to change this to a more professional URL::
     {
         // ...
 
-        public function getNamespace()
+        public function getNamespace(): string
         {
             return 'http://acme_company.com/schema/dic/hello';
         }
@@ -490,7 +490,7 @@ can place it anywhere you like. You should return this path as the base path::
     {
         // ...
 
-        public function getXsdValidationBasePath()
+        public function getXsdValidationBasePath(): string
         {
             return __DIR__.'/../Resources/config/schema';
         }

diff --git a/bundles/extension.rst b/bundles/extension.rst
@@ -34,7 +34,7 @@ This is how the extension of an AcmeHelloBundle should look like::
 
     class AcmeHelloExtension extends Extension
     {
-        public function load(array $configs, ContainerBuilder $container)
+        public function load(array $configs, ContainerBuilder $container): void
         {
             // ... you'll load the files here later
         }
@@ -90,7 +90,7 @@ For instance, assume you have a file called ``services.xml`` in the
     use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 
     // ...
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $loader = new XmlFileLoader(
             $container,
@@ -167,7 +167,7 @@ they are compiled when generating the application cache to improve the overall
 performance. Define the list of annotated classes to compile in the
 ``addAnnotatedClassesToCompile()`` method::
 
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         // ...
 

diff --git a/bundles/prepend_extension.rst b/bundles/prepend_extension.rst
@@ -31,7 +31,7 @@ To give an Extension the power to do this, it needs to implement
     {
         // ...
 
-        public function prepend(ContainerBuilder $container)
+        public function prepend(ContainerBuilder $container): void
         {
             // ...
         }
@@ -52,7 +52,7 @@ a configuration setting in multiple bundles as well as disable a flag in multipl
 in case a specific other bundle is not registered::
 
     // src/Acme/HelloBundle/DependencyInjection/AcmeHelloExtension.php
-    public function prepend(ContainerBuilder $container)
+    public function prepend(ContainerBuilder $container): void
     {
         // get all bundles
         $bundles = $container->getParameter('kernel.bundles');

diff --git a/cache.rst b/cache.rst
@@ -307,9 +307,10 @@ with either :class:`Symfony\\Contracts\\Cache\\CacheInterface` or
 ``Psr\Cache\CacheItemPoolInterface``::
 
     use Symfony\Contracts\Cache\CacheInterface;
+    // ...
 
     // from a controller method
-    public function listProducts(CacheInterface $customThingCache)
+    public function listProducts(CacheInterface $customThingCache): Response
     {
         // ...
     }
@@ -555,7 +556,7 @@ the same key could be invalidated with one function call::
         ) {
         }
 
-        public function someMethod()
+        public function someMethod(): void
         {
             $value0 = $this->myCachePool->get('item_0', function (ItemInterface $item): string {
                 $item->tag(['foo', 'bar']);

diff --git a/components/asset.rst b/components/asset.rst
@@ -210,12 +210,12 @@ every day::
             $this->version = date('Ymd');
         }
 
-        public function getVersion(string $path)
+        public function getVersion(string $path): \DateTimeInterface
         {
             return $this->version;
         }
 
-        public function applyVersion(string $path)
+        public function applyVersion(string $path): string
         {
             return sprintf('%s?v=%s', $path, $this->getVersion($path));
         }

diff --git a/components/browser_kit.rst b/components/browser_kit.rst
@@ -38,7 +38,7 @@ This method accepts a request and should return a response::
 
     class Client extends AbstractBrowser
     {
-        protected function doRequest($request)
+        protected function doRequest($request): Response
         {
             // ... convert request into a response
 

diff --git a/components/config/definition.rst b/components/config/definition.rst
@@ -54,7 +54,7 @@ implements the :class:`Symfony\\Component\\Config\\Definition\\ConfigurationInte
 
     class DatabaseConfiguration implements ConfigurationInterface
     {
-        public function getConfigTreeBuilder()
+        public function getConfigTreeBuilder(): TreeBuilder
         {
             $treeBuilder = new TreeBuilder('database');
 
@@ -540,7 +540,9 @@ be large and you may want to split it up into sections. You can do this
 by making a section a separate node and then appending it into the main
 tree with ``append()``::
 
-    public function getConfigTreeBuilder()
+    use Symfony\Component\Config\Definition\Builder\NodeDefinition;
+
+    public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('database');
 
@@ -569,7 +571,7 @@ tree with ``append()``::
         return $treeBuilder;
     }
 
-    public function addParametersNode()
+    public function addParametersNode(): NodeDefinition
     {
         $treeBuilder = new TreeBuilder('parameters');
 

diff --git a/components/config/resources.rst b/components/config/resources.rst
@@ -43,7 +43,7 @@ which allows for recursively importing other resources::
 
     class YamlUserLoader extends FileLoader
     {
-        public function load($resource, $type = null)
+        public function load($resource, $type = null): void
         {
             $configValues = Yaml::parse(file_get_contents($resource));
 
@@ -54,7 +54,7 @@ which allows for recursively importing other resources::
             // $this->import('extra_users.yaml');
         }
 
-        public function supports($resource, $type = null)
+        public function supports($resource, $type = null): bool
         {
             return is_string($resource) && 'yaml' === pathinfo(
                 $resource,

diff --git a/components/console/changing_default_command.rst b/components/console/changing_default_command.rst
@@ -15,14 +15,16 @@ name to the ``setDefaultCommand()`` method::
     #[AsCommand(name: 'hello:world')]
     class HelloWorldCommand extends Command
     {
-        protected function configure()
+        protected function configure(): void
         {
             $this->setDescription('Outputs "Hello World"');
         }
 
-        protected function execute(InputInterface $input, OutputInterface $output)
+        protected function execute(InputInterface $input, OutputInterface $output): int
         {
             $output->writeln('Hello World');
+
+            return Command::SUCCESS;
         }
     }
 

diff --git a/components/console/console_arguments.rst b/components/console/console_arguments.rst
@@ -22,7 +22,7 @@ Have a look at the following command that has three options::
     #[AsCommand(name: 'demo:args', description: 'Describe args behaviors')]
     class DemoArgsCommand extends Command
     {
-        protected function configure()
+        protected function configure(): void
         {
             $this
                 ->setDefinition(
@@ -34,7 +34,7 @@ Have a look at the following command that has three options::
                 );
         }
 
-        protected function execute(InputInterface $input, OutputInterface $output)
+        protected function execute(InputInterface $input, OutputInterface $output): int
         {
             // ...
         }

diff --git a/components/console/helpers/questionhelper.rst b/components/console/helpers/questionhelper.rst
@@ -488,7 +488,7 @@ from the command line, you need to set the inputs that the command expects::
     use Symfony\Component\Console\Tester\CommandTester;
 
     // ...
-    public function testExecute()
+    public function testExecute(): void
     {
         // ...
         $commandTester = new CommandTester($command);

diff --git a/components/console/logger.rst b/components/console/logger.rst
@@ -21,7 +21,7 @@ PSR-3 compliant logger::
         ) {
         }
 
-        public function doStuff()
+        public function doStuff(): void
         {
             $this->logger->info('I love Tony Vairelles\' hairdresser.');
         }
@@ -44,12 +44,14 @@ You can rely on the logger to use this dependency inside a command::
     )]
     class MyCommand extends Command
     {
-        protected function execute(InputInterface $input, OutputInterface $output)
+        protected function execute(InputInterface $input, OutputInterface $output): int
         {
             $logger = new ConsoleLogger($output);
 
             $myDependency = new MyDependency($logger);
             $myDependency->doStuff();
+
+            // ...
         }
     }
 

diff --git a/components/dependency_injection.rst b/components/dependency_injection.rst
@@ -126,7 +126,7 @@ it was only optional then you could use setter injection instead::
     {
         private \Mailer $mailer;
 
-        public function setMailer(\Mailer $mailer)
+        public function setMailer(\Mailer $mailer): void
         {
             $this->mailer = $mailer;
         }