Added custom event to fix email confirmation system (#156)

* Added custom event to fix email confirmation system

* Update UserFormEvent.php

Use `FormEvent` as base class

* Update composer.json

Updated user bundle dependency

* Fix CS

* Make event class final

Co-authored-by: Christian Gripp <core23@users.noreply.github.com>

composer.json

@@ -19,7 +19,7 @@
     "require": {
         "php": "^7.3 || ^8.0",
         "egulias/email-validator": "^2.1.10",
-        "nucleos/user-bundle": "^1.6",
+        "nucleos/user-bundle": "^1.7",
         "symfony/config": "^4.4 || ^5.0",
         "symfony/dependency-injection": "^4.4 || ^5.0",
         "symfony/event-dispatcher": "^4.4 || ^5.0",

src/Action/RegistrationAction.php

@@ -12,6 +12,7 @@
 namespace Nucleos\ProfileBundle\Action;
 
 use Nucleos\ProfileBundle\Event\GetResponseRegistrationEvent;
+use Nucleos\ProfileBundle\Event\UserFormEvent;
 use Nucleos\ProfileBundle\Form\Model\Registration;
 use Nucleos\ProfileBundle\Form\Type\RegistrationFormType;
 use Nucleos\ProfileBundle\NucleosProfileEvents;
@@ -119,7 +120,7 @@ private function updateUser(Request $request, Registration $formModel, FormInter
     {
         $user = $formModel->toUser($this->userManager);
 
-        $event = new FormEvent($form, $request);
+        $event = new UserFormEvent($user, $form, $request);
         $this->eventDispatcher->dispatch($event, NucleosProfileEvents::REGISTRATION_SUCCESS);
 
         $this->userManager->updateUser($user);

src/Event/UserFormEvent.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the NucleosProfileBundle package.
+ *
+ * (c) Christian Gripp <mail@core23.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Nucleos\ProfileBundle\Event;
+
+use Nucleos\UserBundle\Event\FormEvent ;
+use Nucleos\UserBundle\Model\UserInterface;
+use Symfony\Component\Form\FormInterface;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+final class UserFormEvent extends FormEvent
+{
+    /**
+     * @var UserInterface
+     */
+    private $user;
+
+    public function __construct(UserInterface $user, FormInterface $form, Request $request)
+    {
+        parent::__construct($form, $request);
+        $this->user = $user;
+    }
+
+    public function getUser(): UserInterface
+    {
+        return $this->user;
+    }
+}

src/EventListener/EmailConfirmationListener.php

@@ -11,10 +11,9 @@
 
 namespace Nucleos\ProfileBundle\EventListener;
 
+use Nucleos\ProfileBundle\Event\UserFormEvent;
 use Nucleos\ProfileBundle\Mailer\MailerInterface;
 use Nucleos\ProfileBundle\NucleosProfileEvents;
-use Nucleos\UserBundle\Event\FormEvent;
-use Nucleos\UserBundle\Model\UserInterface;
 use Nucleos\UserBundle\Util\TokenGeneratorInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpFoundation\RedirectResponse;
@@ -65,14 +64,9 @@ public static function getSubscribedEvents(): array
         ];
     }
 
-    public function onRegistrationSuccess(FormEvent $event): void
+    public function onRegistrationSuccess(UserFormEvent $event): void
     {
-        $user = $event->getForm()->getData();
-
-        if (!$user instanceof UserInterface) {
-            return;
-        }
-
+        $user = $event->getUser();
         $user->setEnabled(false);
 
         if (null === $user->getConfirmationToken()) {

src/NucleosProfileEvents.php

@@ -57,7 +57,7 @@ final class NucleosProfileEvents
      *
      * This event allows you to set the response instead of using the default one.
      *
-     * @Event("Nucleos\UserBundle\Event\FormEvent")
+     * @Event("Nucleos\ProfileBundle\Event\UserFormEvent")
      */
     public const REGISTRATION_SUCCESS = 'nucleos_profile.registration.success';