vendor/friendsofsymfony/user-bundle/EventListener/FlashListener.php line 72

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the FOSUserBundle package.
  5.  *
  6.  * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace FOS\UserBundle\EventListener;
  14. use FOS\UserBundle\FOSUserEvents;
  15. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  16. use Symfony\Component\HttpFoundation\RequestStack;
  17. use Symfony\Component\HttpFoundation\Session\Session;
  18. use Symfony\Contracts\EventDispatcher\Event;
  19. use Symfony\Contracts\Translation\TranslatorInterface;
  21. /**
  22.  * @internal
  23.  * @final
  24.  */
  25. class FlashListener implements EventSubscriberInterface
  26. {
  27.     /**
  28.      * @var string[]
  29.      */
  30.     private static $successMessages = [
  31.         FOSUserEvents::CHANGE_PASSWORD_COMPLETED => 'change_password.flash.success',
  32.         FOSUserEvents::PROFILE_EDIT_COMPLETED => 'profile.flash.updated',
  33.         FOSUserEvents::REGISTRATION_COMPLETED => 'registration.flash.user_created',
  34.         FOSUserEvents::RESETTING_RESET_COMPLETED => 'resetting.flash.success',
  35.     ];
  37.     /**
  38.      * @var RequestStack
  39.      */
  40.     private $requestStack;
  42.     /**
  43.      * @var TranslatorInterface
  44.      */
  45.     private $translator;
  47.     /**
  48.      * FlashListener constructor.
  49.      */
  50.     public function __construct(RequestStack $requestStack, TranslatorInterface $translator)
  51.     {
  52.         $this->translator = $translator;
  53.         $this->requestStack = $requestStack;
  54.     }
  56.     /**
  57.      * {@inheritdoc}
  58.      */
  59.     public static function getSubscribedEvents(): array
  60.     {
  61.         return [
  62.             FOSUserEvents::CHANGE_PASSWORD_COMPLETED => 'addSuccessFlash',
  63.             FOSUserEvents::PROFILE_EDIT_COMPLETED => 'addSuccessFlash',
  64.             FOSUserEvents::REGISTRATION_COMPLETED => 'addSuccessFlash',
  65.             FOSUserEvents::RESETTING_RESET_COMPLETED => 'addSuccessFlash',
  66.         ];
  67.     }
  69.     /**
  70.      * @param string $eventName
  71.      */
  72.     public function addSuccessFlash(Event $event, $eventName)
  73.     {
  74.         if (!isset(self::$successMessages[$eventName])) {
  75.             throw new \InvalidArgumentException('This event does not correspond to a known flash message');
  76.         }
  78.         $this->getSession()->getFlashBag()->add('success', $this->trans(self::$successMessages[$eventName]));
  79.     }
  81.     private function getSession(): Session
  82.     {
  83.         $request = $this->requestStack->getCurrentRequest();
  85.         if (null === $request) {
  86.             throw new \LogicException('Cannot get the session without an active request.');
  87.         }
  89.         return $request->getSession();
  90.     }
  92.     /**
  93.      * @param string $message
  94.      */
  95.     private function trans($message, array $params = []): string
  96.     {
  97.         return $this->translator->trans($message, $params, 'FOSUserBundle');
  98.     }
  99. }