minor #18439 Add type-hints and return types (alexandre-daubois)

This PR was merged into the 6.2 branch.

Discussion
----------

Add type-hints and return types

Here we go 🙂

Commits
-------

8728589 Add type-hints and return types

Author: javiereguiluz

bundles/configuration.rst

@@ -85,7 +85,7 @@ can add some configuration that looks like this:
         // config/packages/acme_social.php
         use Symfony\Config\AcmeSocialConfig;
 
-        return static function (AcmeSocialConfig $acmeSocial) {
+        return static function (AcmeSocialConfig $acmeSocial): void {
             $acmeSocial->twitter()
                 ->clientId(123)
                 ->clientSecret('your_secret');
@@ -394,7 +394,7 @@ logic to the bundle class directly::
         // config/definition.php
         use Symfony\Component\Config\Definition\Configurator\DefinitionConfigurator;
 
-        return static function (DefinitionConfigurator $definition) {
+        return static function (DefinitionConfigurator $definition): void {
             $definition->rootNode()
                 ->children()
                     ->scalarNode('foo')->defaultValue('bar')->end()

cache.rst

@@ -10,7 +10,7 @@ The following example shows a typical usage of the cache::
     use Symfony\Contracts\Cache\ItemInterface;
 
     // The callable will only be executed on a cache miss.
-    $value = $pool->get('my_cache_key', function (ItemInterface $item) {
+    $value = $pool->get('my_cache_key', function (ItemInterface $item): string {
         $item->expiresAfter(3600);
 
         // ... do some HTTP request or heavy computations
@@ -557,13 +557,13 @@ the same key could be invalidated with one function call::
 
         public function someMethod()
         {
-            $value0 = $this->myCachePool->get('item_0', function (ItemInterface $item) {
+            $value0 = $this->myCachePool->get('item_0', function (ItemInterface $item): string {
                 $item->tag(['foo', 'bar']);
 
                 return 'debug';
             });
 
-            $value1 = $this->myCachePool->get('item_1', function (ItemInterface $item) {
+            $value1 = $this->myCachePool->get('item_1', function (ItemInterface $item): string {
                 $item->tag('foo');
 
                 return 'debug';

components/cache.rst

@@ -65,7 +65,7 @@ generate and return the value::
     use Symfony\Contracts\Cache\ItemInterface;
 
     // The callable will only be executed on a cache miss.
-    $value = $cache->get('my_cache_key', function (ItemInterface $item) {
+    $value = $cache->get('my_cache_key', function (ItemInterface $item): string {
         $item->expiresAfter(3600);
 
         // ... do some HTTP request or heavy computations
@@ -115,7 +115,7 @@ recompute::
     use Symfony\Contracts\Cache\ItemInterface;
 
     $beta = 1.0;
-    $value = $cache->get('my_cache_key', function (ItemInterface $item) {
+    $value = $cache->get('my_cache_key', function (ItemInterface $item): string {
         $item->expiresAfter(3600);
         $item->tag(['tag_0', 'tag_1']);
 

components/cache/cache_invalidation.rst

@@ -24,7 +24,7 @@ To attach tags to cached items, you need to use the
 :method:`Symfony\\Contracts\\Cache\\ItemInterface::tag` method that is implemented by
 cache items::
 
-    $item = $cache->get('cache_key', function (ItemInterface $item) {
+    $item = $cache->get('cache_key', function (ItemInterface $item): string {
         // [...]
         // add one or more tags
         $item->tag('tag_1');

components/cache/cache_items.rst

@@ -27,7 +27,7 @@ The only way to create cache items is via cache pools. When using the Cache
 Contracts, they are passed as arguments to the recomputation callback::
 
     // $cache pool object was created before
-    $productsCount = $cache->get('stats.products_count', function (ItemInterface $item) {
+    $productsCount = $cache->get('stats.products_count', function (ItemInterface $item): string {
         // [...]
     });
 

components/cache/cache_pools.rst

@@ -38,7 +38,7 @@ and deleting cache items using only two methods and a callback::
     $cache = new FilesystemAdapter();
 
     // The callable will only be executed on a cache miss.
-    $value = $cache->get('my_cache_key', function (ItemInterface $item) {
+    $value = $cache->get('my_cache_key', function (ItemInterface $item): string {
         $item->expiresAfter(3600);
 
         // ... do some HTTP request or heavy computations

components/config/definition.rst

@@ -737,7 +737,7 @@ By changing a string value into an associative array with ``name`` as the key::
             ->arrayNode('connection')
                 ->beforeNormalization()
                     ->ifString()
-                    ->then(function ($v) { return ['name' => $v]; })
+                    ->then(function (string $v): array { return ['name' => $v]; })
                 ->end()
                 ->children()
                     ->scalarNode('name')->isRequired()->end()

components/console/events.rst

@@ -33,7 +33,7 @@ dispatched. Listeners receive a
     use Symfony\Component\Console\ConsoleEvents;
     use Symfony\Component\Console\Event\ConsoleCommandEvent;
 
-    $dispatcher->addListener(ConsoleEvents::COMMAND, function (ConsoleCommandEvent $event) {
+    $dispatcher->addListener(ConsoleEvents::COMMAND, function (ConsoleCommandEvent $event): void {
         // gets the input instance
         $input = $event->getInput();
 
@@ -64,7 +64,7 @@ C/C++ standard::
     use Symfony\Component\Console\ConsoleEvents;
     use Symfony\Component\Console\Event\ConsoleCommandEvent;
 
-    $dispatcher->addListener(ConsoleEvents::COMMAND, function (ConsoleCommandEvent $event) {
+    $dispatcher->addListener(ConsoleEvents::COMMAND, function (ConsoleCommandEvent $event): void {
         // gets the command to be executed
         $command = $event->getCommand();
 
@@ -97,7 +97,7 @@ Listeners receive a
     use Symfony\Component\Console\ConsoleEvents;
     use Symfony\Component\Console\Event\ConsoleErrorEvent;
 
-    $dispatcher->addListener(ConsoleEvents::ERROR, function (ConsoleErrorEvent $event) {
+    $dispatcher->addListener(ConsoleEvents::ERROR, function (ConsoleErrorEvent $event): void {
         $output = $event->getOutput();
 
         $command = $event->getCommand();
@@ -131,7 +131,7 @@ Listeners receive a
     use Symfony\Component\Console\ConsoleEvents;
     use Symfony\Component\Console\Event\ConsoleTerminateEvent;
 
-    $dispatcher->addListener(ConsoleEvents::TERMINATE, function (ConsoleTerminateEvent $event) {
+    $dispatcher->addListener(ConsoleEvents::TERMINATE, function (ConsoleTerminateEvent $event): void {
         // gets the output
         $output = $event->getOutput();
 
@@ -170,11 +170,11 @@ Listeners receive a
     use Symfony\Component\Console\ConsoleEvents;
     use Symfony\Component\Console\Event\ConsoleSignalEvent;
 
-    $dispatcher->addListener(ConsoleEvents::SIGNAL, function (ConsoleSignalEvent $event) {
-       
+    $dispatcher->addListener(ConsoleEvents::SIGNAL, function (ConsoleSignalEvent $event): void {
+
         // gets the signal number
         $signal = $event->getHandlingSignal();
-        
+
         if (\SIGINT === $signal) {
             echo "bye bye!";
         }

components/console/helpers/debug_formatter.rst

@@ -78,7 +78,7 @@ using
     // ...
     $process = new Process(...);
 
-    $process->run(function ($type, $buffer) use ($output, $debugFormatter, $process) {
+    $process->run(function (string $type, string $buffer) use ($output, $debugFormatter, $process): void {
         $output->writeln(
             $debugFormatter->progress(
                 spl_object_hash($process),

components/console/helpers/processhelper.rst

@@ -69,7 +69,7 @@ A custom process callback can be passed as the fourth argument. Refer to the
 
     use Symfony\Component\Process\Process;
 
-    $helper->run($output, $process, 'The process failed :(', function ($type, $data) {
+    $helper->run($output, $process, 'The process failed :(', function (string $type, string $data): void {
         if (Process::ERR === $type) {
             // ... do something with the stderr output
         } else {