Add return types

Changelog.md

@@ -9,11 +9,13 @@ Changelog
 * [BC break] Remove the `Symfony\Component\Security\Core\User\AdvancedUserInterface` methods from our `UserInterface`
 * [BC break] Made `\FOS\UserBundle\Model\User::serialize` and `\FOS\UserBundle\Model\User::unserialize` final. Child classes needing to extend the serialization must override `__serialize` and `__unserialize` instead.
 * [BC break] `\FOS\UserBundle\Event\GetResponseNullableUserEvent` no longer inherits from `\FOS\UserBundle\Event\GetResponseUserEvent` and `\FOS\UserBundle\Event\UserEvent` as that was breaking variance rules.
+* [BC break] A few methods of `FOS\UserBundle\Model\User` now have return types (in methods where Symfony 6 requires them)
 * Add support for Symfony 5.
+* Add return types in most methods.
 
 ### 2.2.4 (2022-01-14)
 
-* Fixed a deprecated warning reported by DebugClassLoader in the AdvancedUserInterface BC layer due to the change done in 2.2.3.
+* Fixed a deprecation warning reported by DebugClassLoader in the AdvancedUserInterface BC layer due to the change done in 2.2.3.
 
 ### 2.2.3 (2022-01-14)
 

Controller/ChangePasswordController.php

@@ -49,10 +49,8 @@ public function __construct(EventDispatcherInterface $eventDispatcher, FactoryIn
 
     /**
      * Change user password.
-     *
-     * @return Response
      */
-    public function changePasswordAction(Request $request)
+    public function changePasswordAction(Request $request): Response
     {
         $user = $this->getUser();
         if (!is_object($user) || !$user instanceof UserInterface) {

Controller/ProfileController.php

@@ -49,7 +49,7 @@ public function __construct(EventDispatcherInterface $eventDispatcher, FactoryIn
     /**
      * Show the user.
      */
-    public function showAction()
+    public function showAction(): Response
     {
         $user = $this->getUser();
         if (!is_object($user) || !$user instanceof UserInterface) {
@@ -63,10 +63,8 @@ public function showAction()
 
     /**
      * Edit the user.
-     *
-     * @return Response
      */
-    public function editAction(Request $request)
+    public function editAction(Request $request): Response
     {
         $user = $this->getUser();
         if (!is_object($user) || !$user instanceof UserInterface) {

Controller/RegistrationController.php

@@ -51,10 +51,7 @@ public function __construct(EventDispatcherInterface $eventDispatcher, FactoryIn
         $this->tokenStorage = $tokenStorage;
     }
 
-    /**
-     * @return Response
-     */
-    public function registerAction(Request $request)
+    public function registerAction(Request $request): Response
     {
         $user = $this->userManager->createUser();
         $user->setEnabled(true);
@@ -104,7 +101,7 @@ public function registerAction(Request $request)
     /**
      * Tell the user to check their email provider.
      */
-    public function checkEmailAction(Request $request)
+    public function checkEmailAction(Request $request): Response
     {
         $email = $request->getSession()->get('fos_user_send_confirmation_email/email');
 
@@ -128,10 +125,8 @@ public function checkEmailAction(Request $request)
      * Receive the confirmation token from user email provider, login the user.
      *
      * @param string $token
-     *
-     * @return Response
      */
-    public function confirmAction(Request $request, $token)
+    public function confirmAction(Request $request, $token): Response
     {
         $userManager = $this->userManager;
 
@@ -162,7 +157,7 @@ public function confirmAction(Request $request, $token)
     /**
      * Tell the user his account is now confirmed.
      */
-    public function confirmedAction(Request $request)
+    public function confirmedAction(Request $request): Response
     {
         $user = $this->getUser();
         if (!is_object($user) || !$user instanceof UserInterface) {
@@ -175,10 +170,7 @@ public function confirmedAction(Request $request)
         ]);
     }
 
-    /**
-     * @return string|null
-     */
-    private function getTargetUrlFromSession(SessionInterface $session)
+    private function getTargetUrlFromSession(SessionInterface $session): ?string
     {
         $key = sprintf('_security.%s.target_path', $this->tokenStorage->getToken()->getProviderKey());
 

Controller/ResettingController.php

@@ -64,17 +64,15 @@ public function __construct(EventDispatcherInterface $eventDispatcher, FactoryIn
     /**
      * Request reset user password: show form.
      */
-    public function requestAction()
+    public function requestAction(): Response
     {
         return $this->render('@FOSUser/Resetting/request.html.twig');
     }
 
     /**
      * Request reset user password: submit form and send email.
-     *
-     * @return Response
      */
-    public function sendEmailAction(Request $request)
+    public function sendEmailAction(Request $request): Response
     {
         $username = $request->request->get('username');
 
@@ -123,10 +121,8 @@ public function sendEmailAction(Request $request)
 
     /**
      * Tell the user to check his email provider.
-     *
-     * @return Response
      */
-    public function checkEmailAction(Request $request)
+    public function checkEmailAction(Request $request): Response
     {
         $username = $request->query->get('username');
 
@@ -144,10 +140,8 @@ public function checkEmailAction(Request $request)
      * Reset user password.
      *
      * @param string $token
-     *
-     * @return Response
      */
-    public function resetAction(Request $request, $token)
+    public function resetAction(Request $request, $token): Response
     {
         $user = $this->userManager->findUserByConfirmationToken($token);
 

Controller/SecurityController.php

@@ -35,10 +35,7 @@ public function __construct(AuthenticationUtils $authenticationUtils, CsrfTokenM
         $this->tokenManager = $tokenManager;
     }
 
-    /**
-     * @return Response
-     */
-    public function loginAction()
+    public function loginAction(): Response
     {
         $error = $this->authenticationUtils->getLastAuthenticationError();
         $lastUsername = $this->authenticationUtils->getLastUsername();
@@ -67,10 +64,8 @@ public function logoutAction()
     /**
      * Renders the login template with the given parameters. Overwrite this function in
      * an extended controller to provide additional data for the login template.
-     *
-     * @return Response
      */
-    protected function renderLogin(array $data)
+    protected function renderLogin(array $data): Response
     {
         return $this->render('@FOSUser/Security/login.html.twig', $data);
     }

DependencyInjection/Configuration.php

@@ -29,10 +29,7 @@
  */
 class Configuration implements ConfigurationInterface
 {
-    /**
-     * {@inheritdoc}
-     */
-    public function getConfigTreeBuilder()
+    public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('fos_user');
         $rootNode = $treeBuilder->getRootNode();

DependencyInjection/FOSUserExtension.php

@@ -143,10 +143,7 @@ public function load(array $configs, ContainerBuilder $container)
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getNamespace()
+    public function getNamespace(): string
     {
         return 'http://friendsofsymfony.github.io/schema/dic/user';
     }

Doctrine/CouchDB/UserListener.php

@@ -36,7 +36,7 @@ public function __construct(PasswordUpdaterInterface $passwordUpdater, Canonical
     /**
      * {@inheritdoc}
      */
-    public function getSubscribedEvents()
+    public function getSubscribedEvents(): array
     {
         return [
             Event::prePersist,

Doctrine/UserListener.php

@@ -43,7 +43,7 @@ public function __construct(PasswordUpdaterInterface $passwordUpdater, Canonical
     /**
      * {@inheritdoc}
      */
-    public function getSubscribedEvents()
+    public function getSubscribedEvents(): array
     {
         return [
             'prePersist',

Event/FilterUserResponseEvent.php

@@ -31,10 +31,7 @@ public function __construct(UserInterface $user, Request $request, Response $res
         $this->response = $response;
     }
 
-    /**
-     * @return Response
-     */
-    public function getResponse()
+    public function getResponse(): Response
     {
         return $this->response;
     }

Event/FormEvent.php

@@ -45,18 +45,12 @@ public function __construct(FormInterface $form, Request $request)
         $this->request = $request;
     }
 
-    /**
-     * @return FormInterface
-     */
-    public function getForm()
+    public function getForm(): FormInterface
     {
         return $this->form;
     }
 
-    /**
-     * @return Request
-     */
-    public function getRequest()
+    public function getRequest(): Request
     {
         return $this->request;
     }
@@ -66,10 +60,7 @@ public function setResponse(Response $response)
         $this->response = $response;
     }
 
-    /**
-     * @return Response|null
-     */
-    public function getResponse()
+    public function getResponse(): ?Response
     {
         return $this->response;
     }

Event/GetResponseNullableUserEvent.php

@@ -20,6 +20,7 @@
  * Response user event that allows null user.
  *
  * @author Konstantinos Christofilos <kostas.christofilos@gmail.com>
+ * @final
  */
 class GetResponseNullableUserEvent extends Event
 {
@@ -38,24 +39,18 @@ class GetResponseNullableUserEvent extends Event
      */
     private $response;
 
-    public function __construct(UserInterface $user = null, Request $request)
+    public function __construct(?UserInterface $user, Request $request)
     {
         $this->user = $user;
         $this->request = $request;
     }
 
-    /**
-     * @return UserInterface|null
-     */
-    public function getUser()
+    public function getUser(): ?UserInterface
     {
         return $this->user;
     }
 
-    /**
-     * @return Request
-     */
-    public function getRequest()
+    public function getRequest(): Request
     {
         return $this->request;
     }
@@ -65,10 +60,7 @@ public function setResponse(Response $response)
         $this->response = $response;
     }
 
-    /**
-     * @return Response|null
-     */
-    public function getResponse()
+    public function getResponse(): ?Response
     {
         return $this->response;
     }

Event/GetResponseUserEvent.php

@@ -13,6 +13,9 @@
 
 use Symfony\Component\HttpFoundation\Response;
 
+/**
+ * @final
+ */
 class GetResponseUserEvent extends UserEvent
 {
     /**
@@ -25,10 +28,7 @@ public function setResponse(Response $response)
         $this->response = $response;
     }
 
-    /**
-     * @return Response|null
-     */
-    public function getResponse()
+    public function getResponse(): ?Response
     {
         return $this->response;
     }

Event/UserEvent.php

@@ -27,27 +27,18 @@ class UserEvent extends Event
      */
     protected $user;
 
-    /**
-     * UserEvent constructor.
-     */
     public function __construct(UserInterface $user, Request $request = null)
     {
         $this->user = $user;
         $this->request = $request;
     }
 
-    /**
-     * @return UserInterface
-     */
-    public function getUser()
+    public function getUser(): UserInterface
     {
         return $this->user;
     }
 
-    /**
-     * @return Request|null
-     */
-    public function getRequest()
+    public function getRequest(): ?Request
     {
         return $this->request;
     }

EventListener/AuthenticationListener.php

@@ -50,7 +50,7 @@ public function __construct(LoginManagerInterface $loginManager, $firewallName)
     /**
      * {@inheritdoc}
      */
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
         return [
             FOSUserEvents::REGISTRATION_COMPLETED => 'authenticate',

EventListener/EmailConfirmationListener.php

@@ -42,10 +42,7 @@ public function __construct(MailerInterface $mailer, TokenGeneratorInterface $to
         $this->session = $session;
     }
 
-    /**
-     * @return array
-     */
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
         return [
             FOSUserEvents::REGISTRATION_SUCCESS => 'onRegistrationSuccess',

EventListener/FlashListener.php

@@ -56,7 +56,7 @@ public function __construct(RequestStack $requestStack, TranslatorInterface $tra
     /**
      * {@inheritdoc}
      */
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
         return [
             FOSUserEvents::CHANGE_PASSWORD_COMPLETED => 'addSuccessFlash',
@@ -91,10 +91,8 @@ private function getSession(): Session
 
     /**
      * @param string $message
-     *
-     * @return string
      */
-    private function trans($message, array $params = [])
+    private function trans($message, array $params = []): string
     {
         return $this->translator->trans($message, $params, 'FOSUserBundle');
     }