Make dispatched events really final

Tobion · Tobion · commit 953057f28d82 · 2019-09-06T22:41:54.000+02:00
diff --git a/src/Symfony/Component/Console/Event/ConsoleCommandEvent.php b/src/Symfony/Component/Console/Event/ConsoleCommandEvent.php
@@ -15,10 +15,8 @@
  * Allows to do things before the command is executed, like skipping the command or changing the input.
  *
  * @author Fabien Potencier <fabien@symfony.com>
- *
- * @final since Symfony 4.4
  */
-class ConsoleCommandEvent extends ConsoleEvent
+final class ConsoleCommandEvent extends ConsoleEvent
 {
     /**
      * The return code for skipped commands, this will also be passed into the terminate event.
@@ -32,30 +30,21 @@ class ConsoleCommandEvent extends ConsoleEvent
 
     /**
      * Disables the command, so it won't be run.
-     *
-     * @return bool
      */
-    public function disableCommand()
+    public function disableCommand(): bool
     {
         return $this->commandShouldRun = false;
     }
 
-    /**
-     * Enables the command.
-     *
-     * @return bool
-     */
-    public function enableCommand()
+    public function enableCommand(): bool
     {
         return $this->commandShouldRun = true;
     }
 
     /**
      * Returns true if the command is runnable, false otherwise.
-     *
-     * @return bool
      */
-    public function commandShouldRun()
+    public function commandShouldRun(): bool
     {
         return $this->commandShouldRun;
     }
diff --git a/src/Symfony/Component/Console/Event/ConsoleTerminateEvent.php b/src/Symfony/Component/Console/Event/ConsoleTerminateEvent.php
@@ -19,10 +19,8 @@
  * Allows to manipulate the exit code of a command after its execution.
  *
  * @author Francesco Levorato <git@flevour.net>
- *
- * @final since Symfony 4.4
  */
-class ConsoleTerminateEvent extends ConsoleEvent
+final class ConsoleTerminateEvent extends ConsoleEvent
 {
     private $exitCode;
 
@@ -33,22 +31,12 @@ public function __construct(Command $command, InputInterface $input, OutputInter
         $this->setExitCode($exitCode);
     }
 
-    /**
-     * Sets the exit code.
-     *
-     * @param int $exitCode The command exit code
-     */
-    public function setExitCode($exitCode)
+    public function setExitCode(int $exitCode): void
     {
-        $this->exitCode = (int) $exitCode;
+        $this->exitCode = $exitCode;
     }
 
-    /**
-     * Gets the exit code.
-     *
-     * @return int The command exit code
-     */
-    public function getExitCode()
+    public function getExitCode(): int
     {
         return $this->exitCode;
     }
diff --git a/src/Symfony/Component/Form/Event/PostSetDataEvent.php b/src/Symfony/Component/Form/Event/PostSetDataEvent.php
@@ -17,9 +17,7 @@
  * This event is dispatched at the end of the Form::setData() method.
  *
  * This event is mostly here for reading data after having pre-populated the form.
- *
- * @final since Symfony 4.4
  */
-class PostSetDataEvent extends FormEvent
+final class PostSetDataEvent extends FormEvent
 {
 }
diff --git a/src/Symfony/Component/Form/Event/PostSubmitEvent.php b/src/Symfony/Component/Form/Event/PostSubmitEvent.php
@@ -18,9 +18,7 @@
  * once the model and view data have been denormalized.
  *
  * It can be used to fetch data after denormalization.
- *
- * @final since Symfony 4.4
  */
-class PostSubmitEvent extends FormEvent
+final class PostSubmitEvent extends FormEvent
 {
 }
diff --git a/src/Symfony/Component/Form/Event/PreSetDataEvent.php b/src/Symfony/Component/Form/Event/PreSetDataEvent.php
@@ -19,9 +19,7 @@
  * It can be used to:
  *  - Modify the data given during pre-population;
  *  - Modify a form depending on the pre-populated data (adding or removing fields dynamically).
- *
- * @final since Symfony 4.4
  */
-class PreSetDataEvent extends FormEvent
+final class PreSetDataEvent extends FormEvent
 {
 }
diff --git a/src/Symfony/Component/Form/Event/PreSubmitEvent.php b/src/Symfony/Component/Form/Event/PreSubmitEvent.php
@@ -19,9 +19,7 @@
  * It can be used to:
  *  - Change data from the request, before submitting the data to the form.
  *  - Add or remove form fields, before submitting the data to the form.
- *
- * @final since Symfony 4.4
  */
-class PreSubmitEvent extends FormEvent
+final class PreSubmitEvent extends FormEvent
 {
 }
diff --git a/src/Symfony/Component/Form/Event/SubmitEvent.php b/src/Symfony/Component/Form/Event/SubmitEvent.php
@@ -18,9 +18,7 @@
  * transforms back the normalized data to the model and view data.
  *
  * It can be used to change data from the normalized representation of the data.
- *
- * @final since Symfony 4.4
  */
-class SubmitEvent extends FormEvent
+final class SubmitEvent extends FormEvent
 {
 }
diff --git a/src/Symfony/Component/HttpKernel/Event/ControllerEvent.php b/src/Symfony/Component/HttpKernel/Event/ControllerEvent.php
@@ -24,10 +24,8 @@
  * Controllers should be callables.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
- *
- * @final since Symfony 4.4
  */
-class ControllerEvent extends KernelEvent
+final class ControllerEvent extends KernelEvent
 {
     private $controller;
 
@@ -38,17 +36,12 @@ public function __construct(HttpKernelInterface $kernel, callable $controller, R
         $this->setController($controller);
     }
 
-    /**
-     * Returns the current controller.
-     *
-     * @return callable
-     */
-    public function getController()
+    public function getController(): callable
     {
         return $this->controller;
     }
 
-    public function setController(callable $controller)
+    public function setController(callable $controller): void
     {
         $this->controller = $controller;
     }
diff --git a/src/Symfony/Component/HttpKernel/Event/ExceptionEvent.php b/src/Symfony/Component/HttpKernel/Event/ExceptionEvent.php
@@ -26,10 +26,8 @@
  * event.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
- *
- * @final since Symfony 4.4
  */
-class ExceptionEvent extends RequestEvent
+final class ExceptionEvent extends RequestEvent
 {
     /**
      * The exception object.
@@ -50,12 +48,7 @@ public function __construct(HttpKernelInterface $kernel, Request $request, int $
         $this->setException($e);
     }
 
-    /**
-     * Returns the thrown exception.
-     *
-     * @return \Exception The thrown exception
-     */
-    public function getException()
+    public function getException(): \Exception
     {
         return $this->exception;
     }
@@ -64,28 +57,24 @@ public function getException()
      * Replaces the thrown exception.
      *
      * This exception will be thrown if no response is set in the event.
-     *
-     * @param \Exception $exception The thrown exception
      */
-    public function setException(\Exception $exception)
+    public function setException(\Exception $exception): void
     {
         $this->exception = $exception;
     }
 
     /**
      * Mark the event as allowing a custom response code.
      */
-    public function allowCustomResponseCode()
+    public function allowCustomResponseCode(): void
     {
         $this->allowCustomResponseCode = true;
     }
 
     /**
      * Returns true if the event allows a custom response code.
-     *
-     * @return bool
      */
-    public function isAllowingCustomResponseCode()
+    public function isAllowingCustomResponseCode(): bool
     {
         return $this->allowCustomResponseCode;
     }
diff --git a/src/Symfony/Component/HttpKernel/Event/FinishRequestEvent.php b/src/Symfony/Component/HttpKernel/Event/FinishRequestEvent.php
@@ -15,9 +15,7 @@
  * Triggered whenever a request is fully processed.
  *
  * @author Benjamin Eberlei <kontakt@beberlei.de>
- *
- * @final since Symfony 4.4
  */
-class FinishRequestEvent extends KernelEvent
+final class FinishRequestEvent extends KernelEvent
 {
 }
diff --git a/src/Symfony/Component/HttpKernel/Event/ResponseEvent.php b/src/Symfony/Component/HttpKernel/Event/ResponseEvent.php
@@ -23,10 +23,8 @@
  * browser.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
- *
- * @final since Symfony 4.4
  */
-class ResponseEvent extends KernelEvent
+final class ResponseEvent extends KernelEvent
 {
     private $response;
 
@@ -37,17 +35,12 @@ public function __construct(HttpKernelInterface $kernel, Request $request, int $
         $this->setResponse($response);
     }
 
-    /**
-     * Returns the current response object.
-     *
-     * @return Response
-     */
-    public function getResponse()
+    public function getResponse(): Response
     {
         return $this->response;
     }
 
-    public function setResponse(Response $response)
+    public function setResponse(Response $response): void
     {
         $this->response = $response;
     }
diff --git a/src/Symfony/Component/HttpKernel/Event/TerminateEvent.php b/src/Symfony/Component/HttpKernel/Event/TerminateEvent.php
@@ -22,10 +22,8 @@
  * will always return the value of `HttpKernelInterface::MASTER_REQUEST`.
  *
  * @author Jordi Boggiano <j.boggiano@seld.be>
- *
- * @final since Symfony 4.4
  */
-class TerminateEvent extends KernelEvent
+final class TerminateEvent extends KernelEvent
 {
     private $response;
 
@@ -36,12 +34,7 @@ public function __construct(HttpKernelInterface $kernel, Request $request, Respo
         $this->response = $response;
     }
 
-    /**
-     * Returns the response for which this event was thrown.
-     *
-     * @return Response
-     */
-    public function getResponse()
+    public function getResponse(): Response
     {
         return $this->response;
     }
diff --git a/src/Symfony/Component/HttpKernel/Event/ViewEvent.php b/src/Symfony/Component/HttpKernel/Event/ViewEvent.php
@@ -22,10 +22,8 @@
  * response is set.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
- *
- * @final since Symfony 4.4
  */
-class ViewEvent extends RequestEvent
+final class ViewEvent extends RequestEvent
 {
     /**
      * The return value of the controller.
@@ -56,7 +54,7 @@ public function getControllerResult()
      *
      * @param mixed $controllerResult The controller return value
      */
-    public function setControllerResult($controllerResult)
+    public function setControllerResult($controllerResult): void
     {
         $this->controllerResult = $controllerResult;
     }
diff --git a/src/Symfony/Component/Security/Core/Event/AuthenticationFailureEvent.php b/src/Symfony/Component/Security/Core/Event/AuthenticationFailureEvent.php
@@ -18,10 +18,8 @@
  * This event is dispatched on authentication failure.
  *
  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
- *
- * @final since Symfony 4.4
  */
-class AuthenticationFailureEvent extends AuthenticationEvent
+final class AuthenticationFailureEvent extends AuthenticationEvent
 {
     private $authenticationException;
 
@@ -32,7 +30,7 @@ public function __construct(TokenInterface $token, AuthenticationException $ex)
         $this->authenticationException = $ex;
     }
 
-    public function getAuthenticationException()
+    public function getAuthenticationException(): AuthenticationException
     {
         return $this->authenticationException;
     }
diff --git a/src/Symfony/Component/Security/Core/Event/AuthenticationSuccessEvent.php b/src/Symfony/Component/Security/Core/Event/AuthenticationSuccessEvent.php
@@ -11,9 +11,6 @@
 
 namespace Symfony\Component\Security\Core\Event;
 
-/**
- * @final since Symfony 4.4
- */
-class AuthenticationSuccessEvent extends AuthenticationEvent
+final class AuthenticationSuccessEvent extends AuthenticationEvent
 {
 }
diff --git a/src/Symfony/Component/Security/Http/Event/DeauthenticatedEvent.php b/src/Symfony/Component/Security/Http/Event/DeauthenticatedEvent.php
@@ -18,10 +18,8 @@
  * Deauthentication happens in case the user has changed when trying to refresh the token.
  *
  * @author Hamza Amrouche <hamza.simperfit@gmail.com>
- *
- * @final since Symfony 4.4
  */
-class DeauthenticatedEvent extends Event
+final class DeauthenticatedEvent extends Event
 {
     private $originalToken;
     private $refreshedToken;
diff --git a/src/Symfony/Component/Security/Http/Event/InteractiveLoginEvent.php b/src/Symfony/Component/Security/Http/Event/InteractiveLoginEvent.php
@@ -17,10 +17,8 @@
 
 /**
  * @author Fabien Potencier <fabien@symfony.com>
- *
- * @final since Symfony 4.4
  */
-class InteractiveLoginEvent extends Event
+final class InteractiveLoginEvent extends Event
 {
     private $request;
     private $authenticationToken;
@@ -31,22 +29,12 @@ public function __construct(Request $request, TokenInterface $authenticationToke
         $this->authenticationToken = $authenticationToken;
     }
 
-    /**
-     * Gets the request.
-     *
-     * @return Request A Request instance
-     */
-    public function getRequest()
+    public function getRequest(): Request
     {
         return $this->request;
     }
 
-    /**
-     * Gets the authentication token.
-     *
-     * @return TokenInterface A TokenInterface instance
-     */
-    public function getAuthenticationToken()
+    public function getAuthenticationToken(): TokenInterface
     {
         return $this->authenticationToken;
     }
diff --git a/src/Symfony/Component/Security/Http/Event/SwitchUserEvent.php b/src/Symfony/Component/Security/Http/Event/SwitchUserEvent.php
diff --git a/src/Symfony/Component/Workflow/Event/AnnounceEvent.php b/src/Symfony/Component/Workflow/Event/AnnounceEvent.php
diff --git a/src/Symfony/Component/Workflow/Event/CompletedEvent.php b/src/Symfony/Component/Workflow/Event/CompletedEvent.php
diff --git a/src/Symfony/Component/Workflow/Event/EnterEvent.php b/src/Symfony/Component/Workflow/Event/EnterEvent.php
diff --git a/src/Symfony/Component/Workflow/Event/EnteredEvent.php b/src/Symfony/Component/Workflow/Event/EnteredEvent.php
diff --git a/src/Symfony/Component/Workflow/Event/GuardEvent.php b/src/Symfony/Component/Workflow/Event/GuardEvent.php
diff --git a/src/Symfony/Component/Workflow/Event/LeaveEvent.php b/src/Symfony/Component/Workflow/Event/LeaveEvent.php
diff --git a/src/Symfony/Component/Workflow/Event/TransitionEvent.php b/src/Symfony/Component/Workflow/Event/TransitionEvent.php

Original file line number	Diff line number	Diff line change
`@@ -15,10 +15,8 @@`
`15`	`15`	`* Allows to do things before the command is executed, like skipping the command or changing the input.`
`16`	`16`	`*`
`17`	`17`	`* @author Fabien Potencier <fabien@symfony.com>`
`18`		`- *`
`19`		`- * @final since Symfony 4.4`
`20`	`18`	`*/`
`21`		`-class ConsoleCommandEvent extends ConsoleEvent`
	`19`	`+final class ConsoleCommandEvent extends ConsoleEvent`
`22`	`20`	`{`
`23`	`21`	`/**`
`24`	`22`	`* The return code for skipped commands, this will also be passed into the terminate event.`
`@@ -32,30 +30,21 @@ class ConsoleCommandEvent extends ConsoleEvent`
`32`	`30`
`33`	`31`	`/**`
`34`	`32`	`* Disables the command, so it won't be run.`
`35`		`- *`
`36`		`- * @return bool`
`37`	`33`	`*/`
`38`		`- public function disableCommand()`
	`34`	`+ public function disableCommand(): bool`
`39`	`35`	`{`
`40`	`36`	`return $this->commandShouldRun = false;`
`41`	`37`	`}`
`42`	`38`
`43`		`- /**`
`44`		`- * Enables the command.`
`45`		`- *`
`46`		`- * @return bool`
`47`		`- */`
`48`		`- public function enableCommand()`
	`39`	`+ public function enableCommand(): bool`
`49`	`40`	`{`
`50`	`41`	`return $this->commandShouldRun = true;`
`51`	`42`	`}`
`52`	`43`
`53`	`44`	`/**`
`54`	`45`	`* Returns true if the command is runnable, false otherwise.`
`55`		`- *`
`56`		`- * @return bool`
`57`	`46`	`*/`
`58`		`- public function commandShouldRun()`
	`47`	`+ public function commandShouldRun(): bool`
`59`	`48`	`{`
`60`	`49`	`return $this->commandShouldRun;`
`61`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,10 +19,8 @@`
`19`	`19`	`* Allows to manipulate the exit code of a command after its execution.`
`20`	`20`	`*`
`21`	`21`	`* @author Francesco Levorato <git@flevour.net>`
`22`		`- *`
`23`		`- * @final since Symfony 4.4`
`24`	`22`	`*/`
`25`		`-class ConsoleTerminateEvent extends ConsoleEvent`
	`23`	`+final class ConsoleTerminateEvent extends ConsoleEvent`
`26`	`24`	`{`
`27`	`25`	`private $exitCode;`
`28`	`26`
`@@ -33,22 +31,12 @@ public function __construct(Command $command, InputInterface $input, OutputInter`
`33`	`31`	`$this->setExitCode($exitCode);`
`34`	`32`	`}`
`35`	`33`
`36`		`- /**`
`37`		`- * Sets the exit code.`
`38`		`- *`
`39`		`- * @param int $exitCode The command exit code`
`40`		`- */`
`41`		`- public function setExitCode($exitCode)`
	`34`	`+ public function setExitCode(int $exitCode): void`
`42`	`35`	`{`
`43`		`- $this->exitCode = (int) $exitCode;`
	`36`	`+ $this->exitCode = $exitCode;`
`44`	`37`	`}`
`45`	`38`
`46`		`- /**`
`47`		`- * Gets the exit code.`
`48`		`- *`
`49`		`- * @return int The command exit code`
`50`		`- */`
`51`		`- public function getExitCode()`
	`39`	`+ public function getExitCode(): int`
`52`	`40`	`{`
`53`	`41`	`return $this->exitCode;`
`54`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,9 +17,7 @@`
`17`	`17`	`* This event is dispatched at the end of the Form::setData() method.`
`18`	`18`	`*`
`19`	`19`	`* This event is mostly here for reading data after having pre-populated the form.`
`20`		`- *`
`21`		`- * @final since Symfony 4.4`
`22`	`20`	`*/`
`23`		`-class PostSetDataEvent extends FormEvent`
	`21`	`+final class PostSetDataEvent extends FormEvent`
`24`	`22`	`{`
`25`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,9 +18,7 @@`
`18`	`18`	`* once the model and view data have been denormalized.`
`19`	`19`	`*`
`20`	`20`	`* It can be used to fetch data after denormalization.`
`21`		`- *`
`22`		`- * @final since Symfony 4.4`
`23`	`21`	`*/`
`24`		`-class PostSubmitEvent extends FormEvent`
	`22`	`+final class PostSubmitEvent extends FormEvent`
`25`	`23`	`{`
`26`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,9 +19,7 @@`
`19`	`19`	`* It can be used to:`
`20`	`20`	`* - Modify the data given during pre-population;`
`21`	`21`	`* - Modify a form depending on the pre-populated data (adding or removing fields dynamically).`
`22`		`- *`
`23`		`- * @final since Symfony 4.4`
`24`	`22`	`*/`
`25`		`-class PreSetDataEvent extends FormEvent`
	`23`	`+final class PreSetDataEvent extends FormEvent`
`26`	`24`	`{`
`27`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,10 +24,8 @@`
`24`	`24`	`* Controllers should be callables.`
`25`	`25`	`*`
`26`	`26`	`* @author Bernhard Schussek <bschussek@gmail.com>`
`27`		`- *`
`28`		`- * @final since Symfony 4.4`
`29`	`27`	`*/`
`30`		`-class ControllerEvent extends KernelEvent`
	`28`	`+final class ControllerEvent extends KernelEvent`
`31`	`29`	`{`
`32`	`30`	`private $controller;`
`33`	`31`
`@@ -38,17 +36,12 @@ public function __construct(HttpKernelInterface $kernel, callable $controller, R`
`38`	`36`	`$this->setController($controller);`
`39`	`37`	`}`
`40`	`38`
`41`		`- /**`
`42`		`- * Returns the current controller.`
`43`		`- *`
`44`		`- * @return callable`
`45`		`- */`
`46`		`- public function getController()`
	`39`	`+ public function getController(): callable`
`47`	`40`	`{`
`48`	`41`	`return $this->controller;`
`49`	`42`	`}`
`50`	`43`
`51`		`- public function setController(callable $controller)`
	`44`	`+ public function setController(callable $controller): void`
`52`	`45`	`{`
`53`	`46`	`$this->controller = $controller;`
`54`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,10 +26,8 @@`
`26`	`26`	`* event.`
`27`	`27`	`*`
`28`	`28`	`* @author Bernhard Schussek <bschussek@gmail.com>`
`29`		`- *`
`30`		`- * @final since Symfony 4.4`
`31`	`29`	`*/`
`32`		`-class ExceptionEvent extends RequestEvent`
	`30`	`+final class ExceptionEvent extends RequestEvent`
`33`	`31`	`{`
`34`	`32`	`/**`
`35`	`33`	`* The exception object.`
`@@ -50,12 +48,7 @@ public function __construct(HttpKernelInterface $kernel, Request $request, int $`
`50`	`48`	`$this->setException($e);`
`51`	`49`	`}`
`52`	`50`
`53`		`- /**`
`54`		`- * Returns the thrown exception.`
`55`		`- *`
`56`		`- * @return \Exception The thrown exception`
`57`		`- */`
`58`		`- public function getException()`
	`51`	`+ public function getException(): \Exception`
`59`	`52`	`{`
`60`	`53`	`return $this->exception;`
`61`	`54`	`}`
`@@ -64,28 +57,24 @@ public function getException()`
`64`	`57`	`* Replaces the thrown exception.`
`65`	`58`	`*`
`66`	`59`	`* This exception will be thrown if no response is set in the event.`
`67`		`- *`
`68`		`- * @param \Exception $exception The thrown exception`
`69`	`60`	`*/`
`70`		`- public function setException(\Exception $exception)`
	`61`	`+ public function setException(\Exception $exception): void`
`71`	`62`	`{`
`72`	`63`	`$this->exception = $exception;`
`73`	`64`	`}`
`74`	`65`
`75`	`66`	`/**`
`76`	`67`	`* Mark the event as allowing a custom response code.`
`77`	`68`	`*/`
`78`		`- public function allowCustomResponseCode()`
	`69`	`+ public function allowCustomResponseCode(): void`
`79`	`70`	`{`
`80`	`71`	`$this->allowCustomResponseCode = true;`
`81`	`72`	`}`
`82`	`73`
`83`	`74`	`/**`
`84`	`75`	`* Returns true if the event allows a custom response code.`
`85`		`- *`
`86`		`- * @return bool`
`87`	`76`	`*/`
`88`		`- public function isAllowingCustomResponseCode()`
	`77`	`+ public function isAllowingCustomResponseCode(): bool`
`89`	`78`	`{`
`90`	`79`	`return $this->allowCustomResponseCode;`
`91`	`80`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,9 +15,7 @@`
`15`	`15`	`* Triggered whenever a request is fully processed.`
`16`	`16`	`*`
`17`	`17`	`* @author Benjamin Eberlei <kontakt@beberlei.de>`
`18`		`- *`
`19`		`- * @final since Symfony 4.4`
`20`	`18`	`*/`
`21`		`-class FinishRequestEvent extends KernelEvent`
	`19`	`+final class FinishRequestEvent extends KernelEvent`
`22`	`20`	`{`
`23`	`21`	`}`