src/Service/MessageService.php line 82

Open in your IDE?
  1. <?php
  3. namespace App\Service;
  5. use Exception;
  6. use Psr\Log\LoggerInterface;
  7. use Symfony\Component\HttpFoundation\Request;
  8. use Symfony\Component\HttpFoundation\RequestStack;
  9. use Symfony\Component\HttpFoundation\Session\SessionInterface;
  11. class MessageService
  12. {
  13.     /**
  14.      * @var Request|null
  15.      */
  16.     private $request;
  18.     /**
  19.      * @var SessionInterface
  20.      */
  21.     private $session;
  23.     /**
  24.      * @var LoggerInterface
  25.      */
  26.     private $logger;
  28.     /**
  29.      * @var array
  30.      */
  31.     private $allowed_types;
  33.     /**
  34.      * MessageService constructor.
  35.      * @param RequestStack $request_stack
  36.      * @param LoggerInterface $logger
  37.      */
  38.     public function __construct(RequestStack $request_stack, LoggerInterface $logger)
  39.     {
  40.         // init request
  41.         $this->request = $request_stack->getCurrentRequest();
  43.         // init session
  44.         $this->session = $this->request->getSession();
  46.         // init logger
  47.         $this->logger = $logger;
  49.         // set allowed message types
  50.         $this->allowed_types = array(
  51.             'primary',
  52.             'secondary',
  53.             'success',
  54.             'danger',
  55.             'warning',
  56.             'info',
  57.             'light',
  58.             'dark'
  59.         );
  61.         // preset messages in session if not set yet
  62.         if (!$this->session->get('messages', false)) {
  63.             $this->session->set('messages', array());
  64.         }
  65.     }
  67.     /**
  68.      * @param string $message
  69.      * @param string $type
  70.      * @throws Exception
  71.      */
  72.     public function setMessage(string $message, $type = 'primary', $override = false)
  73.     {
  74.         // check on valid message type
  75.         if (!in_array($type, $this->allowed_types)) {
  76.             throw new Exception("Message type $type is not allowed.");
  77.         }
  79.         // Remove all previous messages
  80.         if (!$override) {
  81.             // load all set messages from session
  82.             $messages_array = $this->session->get('messages');
  84.             // concatenate messages of same type
  85.             $message_set = false;
  86.             if(is_array($messages_array)){
  87.                 foreach ($messages_array as &$message_array) {
  88.                     if ($message_array[1] == $type) {
  89.                         $message_array[0] .= " " . $message;
  90.                         $message_set = true;
  91.                     }
  92.                 }
  93.             }
  94.             // add new message with new type
  95.             if (!$message_set) {
  96.                 $messages_array[] = array($message, $type);
  97.             }
  98.         } else {
  99.             //Override
  100.            $messages_array = [[$message, $type]];
  101.         }
  103.         // save all messages to session
  104.         $this->session->set('messages', $messages_array);
  105.     }
  107.     /**
  108.      * @return mixed
  109.      */
  110.     public function getMessages(){
  111.         return $this->session->get('messages');
  112.     }
  113.     /**
  114.      * Remove a specific message type from the session
  115.      * @param string $type
  116.      */
  117.     public function removeMessage(string $type){
  118.         // Get all messages from session
  119.         $messages_array = $this->session->get('messages', []);
  121.         // Filter out messages of the given type
  122.         $messages_array = array_filter($messages_array, function ($message_array) use ($type) {
  123.             return $message_array[1] !== $type;
  124.         });
  126.         // Save the updated messages back to session
  127.         $this->session->set('messages', $messages_array);
  128.     }
  130.     /**
  131.      * Clear all messages from the session
  132.      */
  133.     public function clearMessages(){
  134.         $this->session->remove('messages'); // Completely removes messages from session
  135.     }
  137. }