vendor/sonata-project/twig-extensions/src/FlashMessage/FlashManager.php line 51

  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of the Sonata Project package.
  7.  *
  8.  * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
  9.  *
  10.  * For the full copyright and license information, please view the LICENSE
  11.  * file that was distributed with this source code.
  12.  */
  14. namespace Sonata\Twig\FlashMessage;
  16. use Symfony\Component\HttpFoundation\RequestStack;
  17. use Symfony\Component\HttpFoundation\Session\Session;
  18. use Symfony\Component\HttpFoundation\Session\SessionInterface;
  20. /**
  21.  * @author Vincent Composieux <composieux@ekino.com>
  22.  */
  23. final class FlashManager implements FlashManagerInterface
  24. {
  25.     /**
  26.      * @param array<string, array<string>> $types      Sonata flash message types array (defined in configuration)
  27.      * @param array<string, string>        $cssClasses Css classes associated with $types
  28.      */
  29.     public function __construct(
  30.         private RequestStack $requestStack,
  31.         private array $types,
  32.         private array $cssClasses
  33.     ) {
  34.     }
  36.     /**
  37.      * Returns Sonata flash message types.
  38.      */
  39.     public function getTypes(): array
  40.     {
  41.         return $this->types;
  42.     }
  44.     /**
  45.      * Returns flash bag messages for correct type after renaming with Sonata flash message type.
  46.      */
  47.     public function get(string $type): array
  48.     {
  49.         $this->handle();
  51.         return $this->getSession()->getFlashBag()->get($type);
  52.     }
  54.     /**
  55.      * Gets handled Sonata flash message types.
  56.      */
  57.     public function getHandledTypes(): array
  58.     {
  59.         return array_keys($this->getTypes());
  60.     }
  62.     public function getRenderedHtmlClassAttribute(string $type, string $default = ''): string
  63.     {
  64.         return \array_key_exists($type, $this->cssClasses)
  65.             ? $this->cssClasses[$type]
  66.             : $default;
  67.     }
  69.     public function handlesType(string $type): bool
  70.     {
  71.         return \array_key_exists($type, $this->cssClasses);
  72.     }
  74.     /**
  75.      * Add flash message to session.
  76.      */
  77.     public function addFlash(string $type, string $message): void
  78.     {
  79.         $this->getSession()->getFlashBag()->add($type, $message);
  80.     }
  82.     /**
  83.      * Handles flash bag types renaming.
  84.      */
  85.     private function handle(): void
  86.     {
  87.         foreach ($this->getTypes() as $type => $values) {
  88.             foreach ($values as $value) {
  89.                 $this->rename($type, $value);
  90.             }
  91.         }
  92.     }
  94.     /**
  95.      * Process Sonata flash message type rename.
  96.      *
  97.      * @param string $type  Sonata flash message type
  98.      * @param string $value Original flash message type
  99.      */
  100.     private function rename(string $type, string $value): void
  101.     {
  102.         $flashBag = $this->getSession()->getFlashBag();
  104.         foreach ($flashBag->get($value) as $message) {
  105.             $flashBag->add($type, $message);
  106.         }
  107.     }
  109.     /**
  110.      * Returns Symfony session service.
  111.      *
  112.      * @return Session
  113.      */
  114.     private function getSession(): SessionInterface
  115.     {
  116.         // @phpstan-ignore-next-line
  117.         if (method_exists($this->requestStack, 'getMainRequest')) {
  118.             $request = $this->requestStack->getMainRequest();
  119.         } else {
  120.             // @phpstan-ignore-next-line
  121.             $request = $this->requestStack->getMasterRequest();
  122.         }
  124.         if (null === $request) {
  125.             throw new \RuntimeException('No request was found.');
  126.         }
  128.         $session = $request->getSession();
  129.         if (!$session instanceof Session) {
  130.             throw new \UnexpectedValueException(sprintf(
  131.                 'The flash manager only works with a "%s" session.',
  132.                 Session::class
  133.             ));
  134.         }
  136.         return $session;
  137.     }
  138. }