Mark all dispatched event classes as final

Tobion · Tobion · commit 4bb38eec896e · 2019-08-21T17:17:54.000+02:00
diff --git a/src/Symfony/Component/Console/CHANGELOG.md b/src/Symfony/Component/Console/CHANGELOG.md
@@ -7,6 +7,7 @@ CHANGELOG
  * added `Question::setTrimmable` default to true to allow the answer to be trimmed
  * added method `preventRedrawFasterThan()` and `forceRedrawSlowerThan()` on `ProgressBar`
  * `Application` implements `ResetInterface`
+ * marked all dispatched event classes as `@final`
 
 4.3.0
 -----
diff --git a/src/Symfony/Component/Console/Event/ConsoleCommandEvent.php b/src/Symfony/Component/Console/Event/ConsoleCommandEvent.php
@@ -15,6 +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
 {
diff --git a/src/Symfony/Component/Console/Event/ConsoleTerminateEvent.php b/src/Symfony/Component/Console/Event/ConsoleTerminateEvent.php
@@ -19,6 +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
 {
diff --git a/src/Symfony/Component/Form/CHANGELOG.md b/src/Symfony/Component/Form/CHANGELOG.md
@@ -10,6 +10,7 @@ CHANGELOG
  * deprecated using `int` or `float` as data for the `NumberType` when the `input` option is set to `string`
  * The type guesser guesses the HTML accept attribute when a mime type is configured in the File or Image constraint.
  * Overriding the methods `FormIntegrationTestCase::setUp()`, `TypeTestCase::setUp()` and `TypeTestCase::tearDown()` without the `void` return-type is deprecated.
+ * marked all dispatched event classes as `@final`
 
 4.3.0
 -----
diff --git a/src/Symfony/Component/Form/Event/PostSetDataEvent.php b/src/Symfony/Component/Form/Event/PostSetDataEvent.php
@@ -17,6 +17,8 @@
  * 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
 {
diff --git a/src/Symfony/Component/Form/Event/PostSubmitEvent.php b/src/Symfony/Component/Form/Event/PostSubmitEvent.php
@@ -18,6 +18,8 @@
  * 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
 {
diff --git a/src/Symfony/Component/Form/Event/PreSetDataEvent.php b/src/Symfony/Component/Form/Event/PreSetDataEvent.php
@@ -19,6 +19,8 @@
  * 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
 {
diff --git a/src/Symfony/Component/Form/Event/PreSubmitEvent.php b/src/Symfony/Component/Form/Event/PreSubmitEvent.php
@@ -19,6 +19,8 @@
  * 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
 {
diff --git a/src/Symfony/Component/Form/Event/SubmitEvent.php b/src/Symfony/Component/Form/Event/SubmitEvent.php
@@ -18,6 +18,8 @@
  * 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
 {
diff --git a/src/Symfony/Component/HttpKernel/CHANGELOG.md b/src/Symfony/Component/HttpKernel/CHANGELOG.md
@@ -12,6 +12,7 @@ CHANGELOG
    fallback directories. Resources like service definitions are usually loaded relative to the
    current directory or with a glob pattern. The fallback directories have never been advocated
    so you likely do not use those in any app based on the SF Standard or Flex edition.
+ * Marked all dispatched event classes as `@final`
 
 4.3.0
 -----
diff --git a/src/Symfony/Component/HttpKernel/Event/ControllerArgumentsEvent.php b/src/Symfony/Component/HttpKernel/Event/ControllerArgumentsEvent.php
@@ -22,6 +22,8 @@
  * controller.
  *
  * @author Christophe Coevoet <stof@notk.org>
+ *
+ * @final since Symfony 4.4
  */
 class ControllerArgumentsEvent extends FilterControllerArgumentsEvent
 {
diff --git a/src/Symfony/Component/HttpKernel/Event/ControllerEvent.php b/src/Symfony/Component/HttpKernel/Event/ControllerEvent.php
@@ -21,6 +21,8 @@
  * Controllers should be callables.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @final since Symfony 4.4
  */
 class ControllerEvent extends FilterControllerEvent
 {
diff --git a/src/Symfony/Component/HttpKernel/Event/ExceptionEvent.php b/src/Symfony/Component/HttpKernel/Event/ExceptionEvent.php
@@ -23,6 +23,8 @@
  * event.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @final since Symfony 4.4
  */
 class ExceptionEvent extends GetResponseForExceptionEvent
 {
diff --git a/src/Symfony/Component/HttpKernel/Event/FinishRequestEvent.php b/src/Symfony/Component/HttpKernel/Event/FinishRequestEvent.php
@@ -15,6 +15,8 @@
  * Triggered whenever a request is fully processed.
  *
  * @author Benjamin Eberlei <kontakt@beberlei.de>
+ *
+ * @final since Symfony 4.4
  */
 class FinishRequestEvent extends KernelEvent
 {
diff --git a/src/Symfony/Component/HttpKernel/Event/ResponseEvent.php b/src/Symfony/Component/HttpKernel/Event/ResponseEvent.php
@@ -19,6 +19,8 @@
  * browser.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @final since Symfony 4.4
  */
 class ResponseEvent extends FilterResponseEvent
 {
diff --git a/src/Symfony/Component/HttpKernel/Event/TerminateEvent.php b/src/Symfony/Component/HttpKernel/Event/TerminateEvent.php
@@ -18,6 +18,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 PostResponseEvent
 {
diff --git a/src/Symfony/Component/HttpKernel/Event/ViewEvent.php b/src/Symfony/Component/HttpKernel/Event/ViewEvent.php
@@ -19,6 +19,8 @@
  * response is set.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @final since Symfony 4.4
  */
 class ViewEvent extends GetResponseForControllerResultEvent
 {
diff --git a/src/Symfony/Component/Mailer/CHANGELOG.md b/src/Symfony/Component/Mailer/CHANGELOG.md
@@ -19,6 +19,7 @@ CHANGELOG
    `Symfony\Component\Mailer\Transport\TransportFactoryInterface` and tagging with `mailer.transport_factory` tag in DI.
  * Added `Symfony\Component\Mailer\Test\TransportFactoryTestCase` to ease testing custom transport factories.
  * Added `SentMessage::getDebug()` and `TransportExceptionInterface::getDebug` to help debugging
+ * Made `MessageEvent` final
 
 4.3.0
 -----
diff --git a/src/Symfony/Component/Mailer/Event/MessageEvent.php b/src/Symfony/Component/Mailer/Event/MessageEvent.php
@@ -20,7 +20,7 @@
  *
  * @author Fabien Potencier <fabien@symfony.com>
  */
-class MessageEvent extends Event
+final class MessageEvent extends Event
 {
     private $message;
     private $envelope;
diff --git a/src/Symfony/Component/Messenger/CHANGELOG.md b/src/Symfony/Component/Messenger/CHANGELOG.md
@@ -8,6 +8,7 @@ CHANGELOG
    pass a `RoutableMessageBus`  instance instead.
  * Added support for auto trimming of Redis streams.
  * `InMemoryTransport` handle acknowledged and rejected messages.
+ * Made all dispatched worker event classes final.
 
 4.3.0
 -----
diff --git a/src/Symfony/Component/Messenger/Event/SendMessageToTransportsEvent.php b/src/Symfony/Component/Messenger/Event/SendMessageToTransportsEvent.php
@@ -24,7 +24,7 @@
  *
  * @author Ryan Weaver <ryan@symfonycasts.com>
  */
-class SendMessageToTransportsEvent
+final class SendMessageToTransportsEvent
 {
     private $envelope;
 
diff --git a/src/Symfony/Component/Messenger/Event/WorkerMessageFailedEvent.php b/src/Symfony/Component/Messenger/Event/WorkerMessageFailedEvent.php
@@ -18,7 +18,7 @@
  *
  * The event name is the class name.
  */
-class WorkerMessageFailedEvent extends AbstractWorkerMessageEvent
+final class WorkerMessageFailedEvent extends AbstractWorkerMessageEvent
 {
     private $throwable;
     private $willRetry;
diff --git a/src/Symfony/Component/Messenger/Event/WorkerMessageHandledEvent.php b/src/Symfony/Component/Messenger/Event/WorkerMessageHandledEvent.php
@@ -16,6 +16,6 @@
  *
  * The event name is the class name.
  */
-class WorkerMessageHandledEvent extends AbstractWorkerMessageEvent
+final class WorkerMessageHandledEvent extends AbstractWorkerMessageEvent
 {
 }
diff --git a/src/Symfony/Component/Messenger/Event/WorkerMessageReceivedEvent.php b/src/Symfony/Component/Messenger/Event/WorkerMessageReceivedEvent.php
@@ -16,7 +16,7 @@
  *
  * The event name is the class name.
  */
-class WorkerMessageReceivedEvent extends AbstractWorkerMessageEvent
+final class WorkerMessageReceivedEvent extends AbstractWorkerMessageEvent
 {
     private $shouldHandle = true;
 
diff --git a/src/Symfony/Component/Messenger/Event/WorkerStoppedEvent.php b/src/Symfony/Component/Messenger/Event/WorkerStoppedEvent.php
@@ -16,6 +16,6 @@
  *
  * @author Robin Chalas <robin.chalas@gmail.com>
  */
-class WorkerStoppedEvent
+final class WorkerStoppedEvent
 {
 }
diff --git a/src/Symfony/Component/Security/CHANGELOG.md b/src/Symfony/Component/Security/CHANGELOG.md
@@ -10,6 +10,7 @@ CHANGELOG
  * Added and implemented `PasswordUpgraderInterface`, for opportunistic password migrations
  * Added `Guard\PasswordAuthenticatedInterface`, an optional interface
    for "guard" authenticators that deal with user passwords
+ * Marked all dispatched event classes as `@final`
 
 4.3.0
 -----
diff --git a/src/Symfony/Component/Security/Core/Event/AuthenticationFailureEvent.php b/src/Symfony/Component/Security/Core/Event/AuthenticationFailureEvent.php
@@ -18,6 +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
 {
diff --git a/src/Symfony/Component/Security/Core/Event/AuthenticationSuccessEvent.php b/src/Symfony/Component/Security/Core/Event/AuthenticationSuccessEvent.php
@@ -11,6 +11,9 @@
 
 namespace Symfony\Component\Security\Core\Event;
 
+/**
+ * @final since Symfony 4.4
+ */
 class AuthenticationSuccessEvent extends AuthenticationEvent
 {
 }
diff --git a/src/Symfony/Component/Security/Core/Event/VoteEvent.php b/src/Symfony/Component/Security/Core/Event/VoteEvent.php
@@ -21,7 +21,7 @@
  *
  * @internal
  */
-class VoteEvent extends Event
+final class VoteEvent extends Event
 {
     private $voter;
     private $subject;
diff --git a/src/Symfony/Component/Security/Http/Event/DeauthenticatedEvent.php b/src/Symfony/Component/Security/Http/Event/DeauthenticatedEvent.php
@@ -18,6 +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
 {
diff --git a/src/Symfony/Component/Security/Http/Event/InteractiveLoginEvent.php b/src/Symfony/Component/Security/Http/Event/InteractiveLoginEvent.php
@@ -17,6 +17,8 @@
 
 /**
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 4.4
  */
 class InteractiveLoginEvent extends Event
 {
diff --git a/src/Symfony/Component/Security/Http/Event/SwitchUserEvent.php b/src/Symfony/Component/Security/Http/Event/SwitchUserEvent.php
@@ -20,6 +20,8 @@
  * SwitchUserEvent.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 4.4
  */
 class SwitchUserEvent extends Event
 {
diff --git a/src/Symfony/Component/Workflow/CHANGELOG.md b/src/Symfony/Component/Workflow/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+4.4.0
+-----
+
+* Marked all dispatched event classes as `@final`
+
 4.3.0
 -----
 
diff --git a/src/Symfony/Component/Workflow/Event/AnnounceEvent.php b/src/Symfony/Component/Workflow/Event/AnnounceEvent.php
@@ -11,6 +11,9 @@
 
 namespace Symfony\Component\Workflow\Event;
 
+/**
+ * @final since Symfony 4.4
+ */
 class AnnounceEvent extends Event
 {
 }
diff --git a/src/Symfony/Component/Workflow/Event/CompletedEvent.php b/src/Symfony/Component/Workflow/Event/CompletedEvent.php
@@ -11,6 +11,9 @@
 
 namespace Symfony\Component\Workflow\Event;
 
+/**
+ * @final since Symfony 4.4
+ */
 class CompletedEvent extends Event
 {
 }
diff --git a/src/Symfony/Component/Workflow/Event/EnterEvent.php b/src/Symfony/Component/Workflow/Event/EnterEvent.php
@@ -11,6 +11,9 @@
 
 namespace Symfony\Component\Workflow\Event;
 
+/**
+ * @final since Symfony 4.4
+ */
 class EnterEvent extends Event
 {
 }
diff --git a/src/Symfony/Component/Workflow/Event/EnteredEvent.php b/src/Symfony/Component/Workflow/Event/EnteredEvent.php
@@ -11,6 +11,9 @@
 
 namespace Symfony\Component\Workflow\Event;
 
+/**
+ * @final since Symfony 4.4
+ */
 class EnteredEvent extends Event
 {
 }
diff --git a/src/Symfony/Component/Workflow/Event/GuardEvent.php b/src/Symfony/Component/Workflow/Event/GuardEvent.php
@@ -19,6 +19,8 @@
 /**
  * @author Fabien Potencier <fabien@symfony.com>
  * @author Grégoire Pineau <lyrixx@lyrixx.info>
+ *
+ * @final since Symfony 4.4
  */
 class GuardEvent extends Event
 {
diff --git a/src/Symfony/Component/Workflow/Event/LeaveEvent.php b/src/Symfony/Component/Workflow/Event/LeaveEvent.php
@@ -11,6 +11,9 @@
 
 namespace Symfony\Component\Workflow\Event;
 
+/**
+ * @final since Symfony 4.4
+ */
 class LeaveEvent extends Event
 {
 }
diff --git a/src/Symfony/Component/Workflow/Event/TransitionEvent.php b/src/Symfony/Component/Workflow/Event/TransitionEvent.php
@@ -11,6 +11,9 @@
 
 namespace Symfony\Component\Workflow\Event;
 
+/**
+ * @final since Symfony 4.4
+ */
 class TransitionEvent extends Event
 {
     private $context;

Original file line number	Diff line number	Diff line change
`@@ -15,6 +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`
`18`	`20`	`*/`
`19`	`21`	`class ConsoleCommandEvent extends ConsoleEvent`
`20`	`22`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +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`
`22`	`24`	`*/`
`23`	`25`	`class ConsoleTerminateEvent extends ConsoleEvent`
`24`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,8 @@`
`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`
`20`	`22`	`*/`
`21`	`23`	`class PostSetDataEvent extends FormEvent`
`22`	`24`	`{`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,8 @@`
`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`
`21`	`23`	`*/`
`22`	`24`	`class PostSubmitEvent extends FormEvent`
`23`	`25`	`{`