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

  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.  *
  24.  * @final
  25.  */
  26. class FlashListener implements EventSubscriberInterface
  27. {
  28.     /**
  29.      * @var string[]
  30.      */
  31.     private static $successMessages = [
  32.         FOSUserEvents::CHANGE_PASSWORD_COMPLETED => 'change_password.flash.success',
  33.         FOSUserEvents::PROFILE_EDIT_COMPLETED => 'profile.flash.updated',
  34.         FOSUserEvents::REGISTRATION_COMPLETED => 'registration.flash.user_created',
  35.         FOSUserEvents::RESETTING_RESET_COMPLETED => 'resetting.flash.success',
  36.     ];
  38.     /**
  39.      * @var RequestStack
  40.      */
  41.     private $requestStack;
  43.     /**
  44.      * @var TranslatorInterface
  45.      */
  46.     private $translator;
  48.     /**
  49.      * FlashListener constructor.
  50.      */
  51.     public function __construct(RequestStack $requestStack, TranslatorInterface $translator)
  52.     {
  53.         $this->translator = $translator;
  54.         $this->requestStack = $requestStack;
  55.     }
  57.     /**
  58.      * {@inheritdoc}
  59.      */
  60.     public static function getSubscribedEvents(): array
  61.     {
  62.         return [
  63.             FOSUserEvents::CHANGE_PASSWORD_COMPLETED => 'addSuccessFlash',
  64.             FOSUserEvents::PROFILE_EDIT_COMPLETED => 'addSuccessFlash',
  65.             FOSUserEvents::REGISTRATION_COMPLETED => 'addSuccessFlash',
  66.             FOSUserEvents::RESETTING_RESET_COMPLETED => 'addSuccessFlash',
  67.         ];
  68.     }
  70.     /**
  71.      * @param string $eventName
  72.      */
  73.     public function addSuccessFlash(Event $event, $eventName)
  74.     {
  75.         if (!isset(self::$successMessages[$eventName])) {
  76.             throw new \InvalidArgumentException('This event does not correspond to a known flash message');
  77.         }
  79.         $this->getSession()->getFlashBag()->add('success', $this->trans(self::$successMessages[$eventName]));
  80.     }
  82.     private function getSession(): Session
  83.     {
  84.         $request = $this->requestStack->getCurrentRequest();
  86.         if (null === $request) {
  87.             throw new \LogicException('Cannot get the session without an active request.');
  88.         }
  90.         return $request->getSession();
  91.     }
  93.     /**
  94.      * @param string $message
  95.      */
  96.     private function trans($message, array $params = []): string
  97.     {
  98.         return $this->translator->trans($message, $params, 'FOSUserBundle');
  99.     }
  100. }