Tag classes as internal or final as appropriate

stof · stof · commit a480b9f2843d · 2021-08-26T17:28:47.000+02:00
Classes are tagged in phpdoc rather than actually becoming final for
backward compatibility in the 2.x branch.
diff --git a/Command/ActivateUserCommand.php b/Command/ActivateUserCommand.php
@@ -20,6 +20,9 @@
 
 /**
  * @author Antoine Hérault <antoine.herault@gmail.com>
+ *
+ * @internal
+ * @final
  */
 class ActivateUserCommand extends Command
 {
diff --git a/Command/ChangePasswordCommand.php b/Command/ChangePasswordCommand.php
@@ -18,6 +18,10 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Question\Question;
 
+/**
+ * @internal
+ * @final
+ */
 class ChangePasswordCommand extends Command
 {
     protected static $defaultName = 'fos:user:change-password';
diff --git a/Command/CreateUserCommand.php b/Command/CreateUserCommand.php
@@ -23,6 +23,9 @@
  * @author Matthieu Bontemps <matthieu@knplabs.com>
  * @author Thibault Duplessis <thibault.duplessis@gmail.com>
  * @author Luis Cordova <cordoval@gmail.com>
+ *
+ * @internal
+ * @final
  */
 class CreateUserCommand extends Command
 {
diff --git a/Command/DeactivateUserCommand.php b/Command/DeactivateUserCommand.php
@@ -20,6 +20,9 @@
 
 /**
  * @author Antoine Hérault <antoine.herault@gmail.com>
+ *
+ * @internal
+ * @final
  */
 class DeactivateUserCommand extends Command
 {
diff --git a/Command/DemoteUserCommand.php b/Command/DemoteUserCommand.php
@@ -17,6 +17,9 @@
 /**
  * @author Antoine Hérault <antoine.herault@gmail.com>
  * @author Lenar Lõhmus <lenar@city.ee>
+ *
+ * @internal
+ * @final
  */
 class DemoteUserCommand extends RoleCommand
 {
diff --git a/Command/PromoteUserCommand.php b/Command/PromoteUserCommand.php
@@ -19,6 +19,9 @@
  * @author Thibault Duplessis <thibault.duplessis@gmail.com>
  * @author Luis Cordova <cordoval@gmail.com>
  * @author Lenar Lõhmus <lenar@city.ee>
+ *
+ * @internal
+ * @final
  */
 class PromoteUserCommand extends RoleCommand
 {
diff --git a/Command/RoleCommand.php b/Command/RoleCommand.php
@@ -21,6 +21,8 @@
 
 /**
  * @author Lenar Lõhmus <lenar@city.ee>
+ *
+ * @internal
  */
 abstract class RoleCommand extends Command
 {
diff --git a/DependencyInjection/Compiler/CheckForMailerPass.php b/DependencyInjection/Compiler/CheckForMailerPass.php
@@ -19,6 +19,9 @@
  * Checks to see if the mailer service exists.
  *
  * @author Ryan Weaver <ryan@knpuniversity.com>
+ *
+ * @internal
+ * @final
  */
 class CheckForMailerPass implements CompilerPassInterface
 {
diff --git a/DependencyInjection/Compiler/CheckForSessionPass.php b/DependencyInjection/Compiler/CheckForSessionPass.php
@@ -19,6 +19,9 @@
  * Checks to see if the session service exists.
  *
  * @author Ryan Weaver <ryan@knpuniversity.com>
+ *
+ * @internal
+ * @final
  */
 class CheckForSessionPass implements CompilerPassInterface
 {
diff --git a/DependencyInjection/Compiler/InjectRememberMeServicesPass.php b/DependencyInjection/Compiler/InjectRememberMeServicesPass.php
@@ -19,6 +19,9 @@
  * Inject RememberMeServices into LoginManager.
  *
  * @author Vasily Khayrulin <sirianru@gmail.com>
+ *
+ * @internal
+ * @final
  */
 class InjectRememberMeServicesPass implements CompilerPassInterface
 {
diff --git a/DependencyInjection/Compiler/InjectUserCheckerPass.php b/DependencyInjection/Compiler/InjectUserCheckerPass.php
@@ -19,6 +19,9 @@
  * Injects firewall's UserChecker into LoginManager.
  *
  * @author Gocha Ossinkine <ossinkine@ya.ru>
+ *
+ * @internal
+ * @final
  */
 class InjectUserCheckerPass implements CompilerPassInterface
 {
diff --git a/DependencyInjection/Compiler/ValidationPass.php b/DependencyInjection/Compiler/ValidationPass.php
@@ -18,6 +18,9 @@
  * Registers the additional validators according to the storage.
  *
  * @author Christophe Coevoet <stof@notk.org>
+ *
+ * @internal
+ * @final
  */
 class ValidationPass implements CompilerPassInterface
 {
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -23,6 +23,9 @@
  * sections are normalized, and merged.
  *
  * @author Christophe Coevoet <stof@notk.org>
+ *
+ * @internal
+ * @final
  */
 class Configuration implements ConfigurationInterface
 {
diff --git a/DependencyInjection/FOSUserExtension.php b/DependencyInjection/FOSUserExtension.php
@@ -19,6 +19,10 @@
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
+/**
+ * @internal
+ * @final
+ */
 class FOSUserExtension extends Extension
 {
     /**
diff --git a/Doctrine/CouchDB/UserListener.php b/Doctrine/CouchDB/UserListener.php
@@ -18,6 +18,10 @@
 use FOS\UserBundle\Util\CanonicalFieldsUpdater;
 use FOS\UserBundle\Util\PasswordUpdaterInterface;
 
+/**
+ * @internal
+ * @final
+ */
 class UserListener implements EventSubscriber
 {
     private $passwordUpdater;
diff --git a/Doctrine/UserListener.php b/Doctrine/UserListener.php
@@ -25,6 +25,9 @@
  *
  * @author Christophe Coevoet <stof@notk.org>
  * @author David Buchmann <mail@davidbu.ch>
+ *
+ * @internal
+ * @final
  */
 class UserListener implements EventSubscriber
 {
diff --git a/Event/FilterGroupResponseEvent.php b/Event/FilterGroupResponseEvent.php
@@ -15,6 +15,9 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 
+/**
+ * @final
+ */
 class FilterGroupResponseEvent extends GroupEvent
 {
     /**
diff --git a/Event/FilterUserResponseEvent.php b/Event/FilterUserResponseEvent.php
@@ -15,6 +15,9 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 
+/**
+ * @final
+ */
 class FilterUserResponseEvent extends UserEvent
 {
     private $response;
diff --git a/Event/FormEvent.php b/Event/FormEvent.php
@@ -16,6 +16,9 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 
+/**
+ * @final
+ */
 class FormEvent extends Event
 {
     /**
diff --git a/Event/GetResponseGroupEvent.php b/Event/GetResponseGroupEvent.php
@@ -13,6 +13,9 @@
 
 use Symfony\Component\HttpFoundation\Response;
 
+/**
+ * @final
+ */
 class GetResponseGroupEvent extends GroupEvent
 {
     /**
diff --git a/EventListener/AuthenticationListener.php b/EventListener/AuthenticationListener.php
@@ -20,6 +20,10 @@
 use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;
 use Symfony\Component\Security\Core\Exception\AccountStatusException;
 
+/**
+ * @internal
+ * @final
+ */
 class AuthenticationListener implements EventSubscriberInterface
 {
     /**
diff --git a/EventListener/EmailConfirmationListener.php b/EventListener/EmailConfirmationListener.php
@@ -20,6 +20,10 @@
 use Symfony\Component\HttpFoundation\Session\SessionInterface;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 
+/**
+ * @internal
+ * @final
+ */
 class EmailConfirmationListener implements EventSubscriberInterface
 {
     private $mailer;
diff --git a/EventListener/FlashListener.php b/EventListener/FlashListener.php
@@ -17,6 +17,10 @@
 use Symfony\Component\HttpFoundation\Session\SessionInterface;
 use Symfony\Component\Translation\TranslatorInterface;
 
+/**
+ * @internal
+ * @final
+ */
 class FlashListener implements EventSubscriberInterface
 {
     /**
diff --git a/EventListener/LastLoginListener.php b/EventListener/LastLoginListener.php
@@ -19,6 +19,10 @@
 use Symfony\Component\Security\Http\Event\InteractiveLoginEvent;
 use Symfony\Component\Security\Http\SecurityEvents;
 
+/**
+ * @internal
+ * @final
+ */
 class LastLoginListener implements EventSubscriberInterface
 {
     protected $userManager;
diff --git a/EventListener/ResettingListener.php b/EventListener/ResettingListener.php
@@ -18,6 +18,10 @@
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 
+/**
+ * @internal
+ * @final
+ */
 class ResettingListener implements EventSubscriberInterface
 {
     /**
diff --git a/FOSUserBundle.php b/FOSUserBundle.php
@@ -25,6 +25,8 @@
 /**
  * @author Matthieu Bontemps <matthieu@knplabs.com>
  * @author Thibault Duplessis <thibault.duplessis@gmail.com>
+ *
+ * @final
  */
 class FOSUserBundle extends Bundle
 {
diff --git a/Form/DataTransformer/UserToUsernameTransformer.php b/Form/DataTransformer/UserToUsernameTransformer.php
@@ -20,6 +20,8 @@
  * Transforms between a UserInterface instance and a username string.
  *
  * @author Thibault Duplessis <thibault.duplessis@gmail.com>
+ *
+ * @final
  */
 class UserToUsernameTransformer implements DataTransformerInterface
 {
diff --git a/Form/Type/ChangePasswordFormType.php b/Form/Type/ChangePasswordFormType.php
@@ -19,6 +19,9 @@
 use Symfony\Component\Security\Core\Validator\Constraints\UserPassword;
 use Symfony\Component\Validator\Constraints\NotBlank;
 
+/**
+ * @final
+ */
 class ChangePasswordFormType extends AbstractType
 {
     /**
diff --git a/Form/Type/ProfileFormType.php b/Form/Type/ProfileFormType.php
@@ -19,6 +19,9 @@
 use Symfony\Component\Security\Core\Validator\Constraints\UserPassword;
 use Symfony\Component\Validator\Constraints\NotBlank;
 
+/**
+ * @final
+ */
 class ProfileFormType extends AbstractType
 {
     /**
diff --git a/Form/Type/RegistrationFormType.php b/Form/Type/RegistrationFormType.php
@@ -18,6 +18,9 @@
 use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
+/**
+ * @final
+ */
 class RegistrationFormType extends AbstractType
 {
     /**
diff --git a/Form/Type/ResettingFormType.php b/Form/Type/ResettingFormType.php
@@ -17,6 +17,9 @@
 use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
+/**
+ * @final
+ */
 class ResettingFormType extends AbstractType
 {
     /**
diff --git a/Form/Type/UsernameFormType.php b/Form/Type/UsernameFormType.php
@@ -20,6 +20,8 @@
  * Form type for representing a UserInterface instance by its username string.
  *
  * @author Thibault Duplessis <thibault.duplessis@gmail.com>
+ *
+ * @final
  */
 class UsernameFormType extends AbstractType
 {
diff --git a/Mailer/NoopMailer.php b/Mailer/NoopMailer.php
@@ -19,6 +19,8 @@
  * and allows to use this bundle without swiftmailer.
  *
  * @author Thibault Duplessis <thibault.duplessis@gmail.com>
+ *
+ * @final
  */
 class NoopMailer implements MailerInterface
 {
diff --git a/Util/CanonicalFieldsUpdater.php b/Util/CanonicalFieldsUpdater.php
@@ -17,6 +17,8 @@
  * Class updating the canonical fields of the user.
  *
  * @author Christophe Coevoet <stof@notk.org>
+ *
+ * @final
  */
 class CanonicalFieldsUpdater
 {
diff --git a/Util/UserManipulator.php b/Util/UserManipulator.php
@@ -23,6 +23,9 @@
  *
  * @author Christophe Coevoet <stof@notk.org>
  * @author Luis Cordova <cordoval@gmail.com>
+ *
+ * @internal
+ * @final
  */
 class UserManipulator
 {
diff --git a/Validator/Initializer.php b/Validator/Initializer.php
@@ -19,6 +19,9 @@
  * Automatically updates the canonical fields before validation.
  *
  * @author Christophe Coevoet <stof@notk.org>
+ *
+ * @internal
+ * @final
  */
 class Initializer implements ObjectInitializerInterface
 {

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,9 @@`
`20`	`20`
`21`	`21`	`/**`
`22`	`22`	`* @author Antoine Hérault <antoine.herault@gmail.com>`
	`23`	`+ *`
	`24`	`+ * @internal`
	`25`	`+ * @final`
`23`	`26`	`*/`
`24`	`27`	`class ActivateUserCommand extends Command`
`25`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,8 @@`
`21`	`21`
`22`	`22`	`/**`
`23`	`23`	`* @author Lenar Lõhmus <lenar@city.ee>`
	`24`	`+ *`
	`25`	`+ * @internal`
`24`	`26`	`*/`
`25`	`27`	`abstract class RoleCommand extends Command`
`26`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,9 @@`
`19`	`19`	`* Checks to see if the mailer service exists.`
`20`	`20`	`*`
`21`	`21`	`* @author Ryan Weaver <ryan@knpuniversity.com>`
	`22`	`+ *`
	`23`	`+ * @internal`
	`24`	`+ * @final`
`22`	`25`	`*/`
`23`	`26`	`class CheckForMailerPass implements CompilerPassInterface`
`24`	`27`	`{`