Merge branch '6.1' into 6.2

xabbuh · xabbuh · commit 93da9d5b0392 · 2022-08-15T11:32:16.000+02:00
* 6.1: Adding info about login throttling add missing return statement [symfony#17180] add missing link target Typo fix Adding note box about valid values for "interval" Deleting duplicate "default" [Console] Add return hint [Console] Add return for execute() [Console] add SignalableCommandInterface link Adding type hint Adding missing `use` [Routing] add missing action return hints Trying to fix code sample syntax
diff --git a/best_practices.rst b/best_practices.rst
@@ -88,8 +88,10 @@ application behavior.
 :ref:`Use env vars in your project <config-env-vars>` to define these options
 and create multiple ``.env`` files to :ref:`configure env vars per environment <config-dot-env>`.
 
-Use Secret for Sensitive Information
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. _use-secret-for-sensitive-information:
+
+Use Secrets for Sensitive Information
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 When your application has sensitive configuration - like an API key - you should
 store those securely via :doc:`Symfony’s secrets management system </configuration/secrets>`.
diff --git a/components/console/events.rst b/components/console/events.rst
@@ -190,7 +190,7 @@ Listeners receive a
 
 If you use the Console component inside a Symfony application, commands can
 handle signals themselves. To do so, implement the
-``SignalableCommandInterface`` and subscribe to one or more signals::
+:class:`Symfony\\Component\\Console\\Command\\SignalableCommandInterface` and subscribe to one or more signals::
 
     // src/Command/SomeCommand.php
     namespace App\Command;
@@ -208,7 +208,7 @@ handle signals themselves. To do so, implement the
             return [\SIGINT, \SIGTERM];
         }
 
-        public function handleSignal(int $signal)
+        public function handleSignal(int $signal): void
         {
             if (\SIGINT === $signal) {
                 // ...
diff --git a/components/console/helpers/questionhelper.rst b/components/console/helpers/questionhelper.rst
@@ -34,14 +34,18 @@ the following to your command::
     {
         // ...
 
-        public function execute(InputInterface $input, OutputInterface $output)
+        public function execute(InputInterface $input, OutputInterface $output): int
         {
             $helper = $this->getHelper('question');
             $question = new ConfirmationQuestion('Continue with this action?', false);
 
             if (!$helper->ask($input, $output, $question)) {
                 return Command::SUCCESS;
             }
+
+            // ... do something here
+
+            return Command::SUCCESS;
         }
     }
 
@@ -75,12 +79,16 @@ if you want to know a bundle name, you can add this to your command::
     use Symfony\Component\Console\Question\Question;
 
     // ...
-    public function execute(InputInterface $input, OutputInterface $output)
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         // ...
         $question = new Question('Please enter the name of the bundle', 'AcmeDemoBundle');
 
         $bundleName = $helper->ask($input, $output, $question);
+        
+        // ... do something with the bundleName
+        
+        return Commande::SUCCESS;
     }
 
 The user will be asked "Please enter the name of the bundle". They can type
@@ -99,7 +107,7 @@ from a predefined list::
     use Symfony\Component\Console\Question\ChoiceQuestion;
 
     // ...
-    public function execute(InputInterface $input, OutputInterface $output)
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         // ...
         $helper = $this->getHelper('question');
@@ -115,6 +123,8 @@ from a predefined list::
         $output->writeln('You have just selected: '.$color);
 
         // ... do something with the color
+        
+        return Commande::SUCCESS;
     }
 
 The option which should be selected by default is provided with the third
@@ -138,7 +148,7 @@ this use :method:`Symfony\\Component\\Console\\Question\\ChoiceQuestion::setMult
     use Symfony\Component\Console\Question\ChoiceQuestion;
 
     // ...
-    public function execute(InputInterface $input, OutputInterface $output)
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         // ...
         $helper = $this->getHelper('question');
@@ -151,6 +161,8 @@ this use :method:`Symfony\\Component\\Console\\Question\\ChoiceQuestion::setMult
 
         $colors = $helper->ask($input, $output, $question);
         $output->writeln('You have just selected: ' . implode(', ', $colors));
+        
+        return Commande::SUCCESS;
     }
 
 Now, when the user enters ``1,2``, the result will be:
@@ -168,7 +180,7 @@ will be autocompleted as the user types::
     use Symfony\Component\Console\Question\Question;
 
     // ...
-    public function execute(InputInterface $input, OutputInterface $output)
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         // ...
         $helper = $this->getHelper('question');
@@ -178,6 +190,10 @@ will be autocompleted as the user types::
         $question->setAutocompleterValues($bundles);
 
         $bundleName = $helper->ask($input, $output, $question);
+        
+        // ... do something with the bundleName
+        
+        return Commande::SUCCESS;
     }
 
 In more complex use cases, it may be necessary to generate suggestions on the
@@ -187,7 +203,7 @@ provide a callback function to dynamically generate suggestions::
     use Symfony\Component\Console\Question\Question;
 
     // ...
-    public function execute(InputInterface $input, OutputInterface $output)
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         $helper = $this->getHelper('question');
 
@@ -213,6 +229,10 @@ provide a callback function to dynamically generate suggestions::
         $question->setAutocompleterCallback($callback);
 
         $filePath = $helper->ask($input, $output, $question);
+        
+        // ... do something with the filePath
+        
+        return Commande::SUCCESS;
     }
 
 Do not Trim the Answer
@@ -224,7 +244,7 @@ You can also specify if you want to not trim the answer by setting it directly w
     use Symfony\Component\Console\Question\Question;
 
     // ...
-    public function execute(InputInterface $input, OutputInterface $output)
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         // ...
         $helper = $this->getHelper('question');
@@ -233,6 +253,10 @@ You can also specify if you want to not trim the answer by setting it directly w
         $question->setTrimmable(false);
         // if the users inputs 'elsa ' it will not be trimmed and you will get 'elsa ' as value
         $name = $helper->ask($input, $output, $question);
+        
+        // ... do something with the name
+        
+        return Commande::SUCCESS;
     }
 
 Accept Multiline Answers
@@ -246,7 +270,7 @@ the response to a question should allow multiline answers by passing ``true`` to
     use Symfony\Component\Console\Question\Question;
 
     // ...
-    public function execute(InputInterface $input, OutputInterface $output)
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         // ...
         $helper = $this->getHelper('question');
@@ -255,6 +279,10 @@ the response to a question should allow multiline answers by passing ``true`` to
         $question->setMultiline(true);
 
         $answer = $helper->ask($input, $output, $question);
+        
+        // ... do something with the answer
+        
+        return Commande::SUCCESS;
     }
 
 Multiline questions stop reading user input after receiving an end-of-transmission
@@ -269,7 +297,7 @@ convenient for passwords::
     use Symfony\Component\Console\Question\Question;
 
     // ...
-    public function execute(InputInterface $input, OutputInterface $output)
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         // ...
         $helper = $this->getHelper('question');
@@ -279,6 +307,10 @@ convenient for passwords::
         $question->setHiddenFallback(false);
 
         $password = $helper->ask($input, $output, $question);
+        
+        // ... do something with the password
+        
+        return Commande::SUCCESS;
     }
 
 .. caution::
@@ -302,13 +334,15 @@ convenient for passwords::
         use Symfony\Component\Console\Question\ChoiceQuestion;
 
         // ...
-        public function execute(InputInterface $input, OutputInterface $output)
+        public function execute(InputInterface $input, OutputInterface $output): int
         {
             // ...
             $helper = $this->getHelper('question');
             QuestionHelper::disableStty();
 
             // ...
+            
+            return Commande::SUCCESS;
         }
 
 Normalizing the Answer
@@ -324,7 +358,7 @@ method::
     use Symfony\Component\Console\Question\Question;
 
     // ...
-    public function execute(InputInterface $input, OutputInterface $output)
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         // ...
         $helper = $this->getHelper('question');
@@ -336,6 +370,10 @@ method::
         });
 
         $bundleName = $helper->ask($input, $output, $question);
+        
+        // ... do something with the bundleName
+        
+        return Commande::SUCCESS;
     }
 
 .. caution::
@@ -358,7 +396,7 @@ method::
     use Symfony\Component\Console\Question\Question;
 
     // ...
-    public function execute(InputInterface $input, OutputInterface $output)
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         // ...
         $helper = $this->getHelper('question');
@@ -376,6 +414,10 @@ method::
         $question->setMaxAttempts(2);
 
         $bundleName = $helper->ask($input, $output, $question);
+        
+        // ... do something with the bundleName
+        
+        return Commande::SUCCESS;
     }
 
 The ``$validator`` is a callback which handles the validation. It should
@@ -414,7 +456,7 @@ You can also use a validator with a hidden question::
     use Symfony\Component\Console\Question\Question;
 
     // ...
-    public function execute(InputInterface $input, OutputInterface $output)
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         // ...
         $helper = $this->getHelper('question');
@@ -434,6 +476,10 @@ You can also use a validator with a hidden question::
         $question->setMaxAttempts(20);
 
         $password = $helper->ask($input, $output, $question);
+        
+        // ... do something with the password
+        
+        return Commande::SUCCESS;
     }
 
 Testing a Command that Expects Input
diff --git a/components/console/helpers/table.rst b/components/console/helpers/table.rst
@@ -28,7 +28,7 @@ set the headers, set the rows and then render the table::
 
     class SomeCommand extends Command
     {
-        public function execute(InputInterface $input, OutputInterface $output)
+        public function execute(InputInterface $input, OutputInterface $output): int
         {
             $table = new Table($output);
             $table
@@ -41,6 +41,8 @@ set the headers, set the rows and then render the table::
                 ])
             ;
             $table->render();
+            
+            return Command::SUCCESS;
         }
     }
 
@@ -427,7 +429,7 @@ The only requirement to append rows is that the table must be rendered inside a
 
     class SomeCommand extends Command
     {
-        public function execute(InputInterface $input, OutputInterface $output)
+        public function execute(InputInterface $input, OutputInterface $output): int
         {
             $section = $output->section();
             $table = new Table($section);
@@ -436,6 +438,8 @@ The only requirement to append rows is that the table must be rendered inside a
             $table->render();
 
             $table->appendRow(['Symfony']);
+            
+            return Command::SUCCESS;
         }
     }
 
diff --git a/rate_limiter.rst b/rate_limiter.rst
@@ -7,7 +7,7 @@ defensive measure to protect services from excessive use (intended or not) and
 maintain their availability. It's also useful to control your internal or
 outbound processes (e.g. limit the number of simultaneously processed messages).
 
-Symfony uses these rate limiters in built-in features like "login throttling",
+Symfony uses these rate limiters in built-in features like :ref:`login throttling <security-login-throttling>`,
 which limits how many failed login attempts a user can make in a given period of
 time, but you can use them for your own features too.
 
diff --git a/routing.rst b/routing.rst
@@ -63,7 +63,7 @@ do so, create a :doc:`controller class </controller>` like the following:
         class BlogController extends AbstractController
         {
             #[Route('/blog', name: 'blog_list')]
-            public function list()
+            public function list(): Response
             {
                 // ...
             }
@@ -895,7 +895,7 @@ optional ``priority`` parameter in those routes to control their priority:
              * This route has a greedy pattern and is defined first.
              */
             #[Route('/blog/{slug}', name: 'blog_show')]
-            public function show(string $slug)
+            public function show(string $slug): Response
             {
                 // ...
             }
@@ -904,7 +904,7 @@ optional ``priority`` parameter in those routes to control their priority:
              * This route could not be matched without defining a higher priority than 0.
              */
             #[Route('/blog/list', name: 'blog_list', priority: 2)]
-            public function list()
+            public function list(): Response
             {
                 // ...
             }
@@ -2107,7 +2107,7 @@ session shouldn't be used when matching a request:
         class MainController extends AbstractController
         {
             #[Route('/', name: 'homepage', stateless: true)]
-            public function homepage()
+            public function homepage(): Response
             {
                 // ...
             }
diff --git a/security.rst b/security.rst
diff --git a/security/custom_authenticator.rst b/security/custom_authenticator.rst

Original file line number	Diff line number	Diff line change
`@@ -190,7 +190,7 @@ Listeners receive a`
`190`	`190`
`191`	`191`	`If you use the Console component inside a Symfony application, commands can`
`192`	`192`	`handle signals themselves. To do so, implement the`
`193`		-``SignalableCommandInterface`` and subscribe to one or more signals::
	`193`	+:class:`Symfony\\Component\\Console\\Command\\SignalableCommandInterface` and subscribe to one or more signals::
`194`	`194`
`195`	`195`	`// src/Command/SomeCommand.php`
`196`	`196`	`namespace App\Command;`
`@@ -208,7 +208,7 @@ handle signals themselves. To do so, implement the`
`208`	`208`	`return [\SIGINT, \SIGTERM];`
`209`	`209`	`}`
`210`	`210`
`211`		`- public function handleSignal(int $signal)`
	`211`	`+ public function handleSignal(int $signal): void`
`212`	`212`	`{`
`213`	`213`	`if (\SIGINT === $signal) {`
`214`	`214`	`// ...`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ set the headers, set the rows and then render the table::`
`28`	`28`
`29`	`29`	`class SomeCommand extends Command`
`30`	`30`	`{`
`31`		`- public function execute(InputInterface $input, OutputInterface $output)`
	`31`	`+ public function execute(InputInterface $input, OutputInterface $output): int`
`32`	`32`	`{`
`33`	`33`	`$table = new Table($output);`
`34`	`34`	`$table`
`@@ -41,6 +41,8 @@ set the headers, set the rows and then render the table::`
`41`	`41`	`])`
`42`	`42`	`;`
`43`	`43`	`$table->render();`
	`44`	`+`
	`45`	`+ return Command::SUCCESS;`
`44`	`46`	`}`
`45`	`47`	`}`
`46`	`48`
`@@ -427,7 +429,7 @@ The only requirement to append rows is that the table must be rendered inside a`
`427`	`429`
`428`	`430`	`class SomeCommand extends Command`
`429`	`431`	`{`
`430`		`- public function execute(InputInterface $input, OutputInterface $output)`
	`432`	`+ public function execute(InputInterface $input, OutputInterface $output): int`
`431`	`433`	`{`
`432`	`434`	`$section = $output->section();`
`433`	`435`	`$table = new Table($section);`
`@@ -436,6 +438,8 @@ The only requirement to append rows is that the table must be rendered inside a`
`436`	`438`	`$table->render();`
`437`	`439`
`438`	`440`	`$table->appendRow(['Symfony']);`
	`441`	`+`
	`442`	`+ return Command::SUCCESS;`
`439`	`443`	`}`
`440`	`444`	`}`
`441`	`445`
Original file line number	Diff line number	Diff line change
@@ -63,7 +63,7 @@ do so, create a :doc:`controller class </controller>` like the following:
`63`	`63`	`class BlogController extends AbstractController`
`64`	`64`	`{`
`65`	`65`	`#[Route('/blog', name: 'blog_list')]`
`66`		`- public function list()`
	`66`	`+ public function list(): Response`
`67`	`67`	`{`
`68`	`68`	`// ...`
`69`	`69`	`}`
@@ -895,7 +895,7 @@ optional ``priority`` parameter in those routes to control their priority:
`895`	`895`	`* This route has a greedy pattern and is defined first.`
`896`	`896`	`*/`
`897`	`897`	`#[Route('/blog/{slug}', name: 'blog_show')]`
`898`		`- public function show(string $slug)`
	`898`	`+ public function show(string $slug): Response`
`899`	`899`	`{`
`900`	`900`	`// ...`
`901`	`901`	`}`
@@ -904,7 +904,7 @@ optional ``priority`` parameter in those routes to control their priority:
`904`	`904`	`* This route could not be matched without defining a higher priority than 0.`
`905`	`905`	`*/`
`906`	`906`	`#[Route('/blog/list', name: 'blog_list', priority: 2)]`
`907`		`- public function list()`
	`907`	`+ public function list(): Response`
`908`	`908`	`{`
`909`	`909`	`// ...`
`910`	`910`	`}`
`@@ -2107,7 +2107,7 @@ session shouldn't be used when matching a request:`
`2107`	`2107`	`class MainController extends AbstractController`
`2108`	`2108`	`{`
`2109`	`2109`	`#[Route('/', name: 'homepage', stateless: true)]`
`2110`		`- public function homepage()`
	`2110`	`+ public function homepage(): Response`
`2111`	`2111`	`{`
`2112`	`2112`	`// ...`
`2113`	`2113`	`}`