FlashMessageQueue.php

Go to the documentation of this file.

<?php
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Messaging;
 
use ‪TYPO3\CMS\Core\Authentication\AbstractUserAuthentication;
use ‪TYPO3\CMS\Core\Exception;
use ‪TYPO3\CMS\Core\Messaging\Renderer\FlashMessageRendererInterface;
use ‪TYPO3\CMS\Core\Type\ContextualFeedbackSeverity;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication;
use ‪TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
 
class ‪FlashMessageQueue extends \SplQueue implements \JsonSerializable
{
    public const ‪FLASHMESSAGE_QUEUE = 'core.template.flashMessages';
    public const ‪NOTIFICATION_QUEUE = 'core.template.notifications';
 
    protected ‪$identifier;
 
    public function ‪__construct(‪$identifier)
    {
        $this->identifier = ‪$identifier;
    }
 
    public function ‪getIdentifier()
    {
        return ‪$this->identifier;
    }
 
    public function ‪enqueue($message): void
    {
        if (!($message instanceof FlashMessage)) {
            throw new ‪Exception(
                'FlashMessageQueue::enqueue() expects an object of type \TYPO3\CMS\Core\Messaging\FlashMessage but got type "' . get_debug_type($message) . '"',
                1376833554
            );
        }
        if ($message->isSessionMessage()) {
            $this->‪addFlashMessageToSession($message);
        } else {
            parent::enqueue($message);
        }
    }
 
    public function ‪addMessage(‪FlashMessage $message)
    {
        $this->‪enqueue($message);
    }
 
    #[\ReturnTypeWillChange]
    public function ‪dequeue()
    {
        // deliberately empty
    }
 
    protected function ‪addFlashMessageToSession(‪FlashMessage $message)
    {
        $queuedFlashMessages = $this->‪getFlashMessagesFromSession();
        $queuedFlashMessages[] = $message;
        $this->‪storeFlashMessagesInSession($queuedFlashMessages);
    }
 
    public function ‪getAllMessages(int|‪ContextualFeedbackSeverity|null $severity = null)
    {
        if (is_int($severity)) {
            // @deprecated int type for $severity deprecated in v12, will change to Severity only in v13.
            $severity = ContextualFeedbackSeverity::transform($severity);
        }
        // Get messages from user session
        $queuedFlashMessagesFromSession = $this->‪getFlashMessagesFromSession();
        $queuedFlashMessages = array_merge($queuedFlashMessagesFromSession, $this->‪toArray());
        if ($severity !== null) {
            $filteredFlashMessages = [];
            foreach ($queuedFlashMessages as $message) {
                if ($message->getSeverity() === $severity) {
                    $filteredFlashMessages[] = $message;
                }
            }
            return $filteredFlashMessages;
        }
 
        return $queuedFlashMessages;
    }
 
    public function ‪getAllMessagesAndFlush(int|‪ContextualFeedbackSeverity|null $severity = null)
    {
        if (is_int($severity)) {
            // @deprecated int type for $severity deprecated in v12, will change to Severity only in v13.
            $severity = ContextualFeedbackSeverity::transform($severity);
        }
        $queuedFlashMessages = $this->‪getAllMessages($severity);
        // Reset messages in user session
        $this->‪removeAllFlashMessagesFromSession($severity);
        // Reset internal messages
        $this->‪clear($severity);
        return $queuedFlashMessages;
    }
 
    protected function ‪storeFlashMessagesInSession(array $flashMessages = null)
    {
        if (is_array($flashMessages)) {
            $flashMessages = array_map('json_encode', $flashMessages);
        }
        $user = $this->‪getUserByContext();
        if ($user instanceof AbstractUserAuthentication) {
            $user->setAndSaveSessionData($this->identifier, $flashMessages);
        }
    }
 
    protected function ‪removeAllFlashMessagesFromSession(int|‪ContextualFeedbackSeverity|null $severity = null)
    {
        if (is_int($severity)) {
            // @deprecated int type for $severity deprecated in v12, will change to Severity only in v13.
            $severity = ContextualFeedbackSeverity::transform($severity);
        }
        if (!$this->‪getUserByContext() instanceof AbstractUserAuthentication) {
            return;
        }
        if ($severity === null) {
            $this->‪storeFlashMessagesInSession(null);
        } else {
            $messages = $this->‪getFlashMessagesFromSession();
            foreach ($messages as $index => $message) {
                if ($message->getSeverity() === $severity) {
                    unset($messages[$index]);
                }
            }
            $this->‪storeFlashMessagesInSession($messages);
        }
    }
 
    protected function ‪getFlashMessagesFromSession(): array
    {
        $sessionMessages = [];
        $user = $this->‪getUserByContext();
        if ($user instanceof AbstractUserAuthentication) {
            $messagesFromSession = $user->getSessionData($this->identifier);
            $messagesFromSession = is_array($messagesFromSession) ? $messagesFromSession : [];
            foreach ($messagesFromSession as $messageData) {
                $sessionMessages[] = ‪FlashMessage::createFromArray(json_decode($messageData, true));
            }
        }
        return $sessionMessages;
    }
 
    protected function ‪getUserByContext(): ?AbstractUserAuthentication
    {
        if ((‪$GLOBALS['TSFE'] ?? null) instanceof TypoScriptFrontendController && ‪$GLOBALS['TSFE']->fe_user instanceof FrontendUserAuthentication) {
            return ‪$GLOBALS['TSFE']->fe_user;
        }
        return ‪$GLOBALS['BE_USER'] ?? null;
    }
 
    public function ‪renderFlashMessages(FlashMessageRendererInterface $flashMessageRenderer = null)
    {
        $content = '';
        $flashMessages = $this->‪getAllMessagesAndFlush();
 
        if (!empty($flashMessages)) {
            if ($flashMessageRenderer === null) {
                $flashMessageRenderer = GeneralUtility::makeInstance(FlashMessageRendererResolver::class)->resolve();
            }
            $content = $flashMessageRenderer->render($flashMessages);
        }
 
        return $content;
    }
 
    public function ‪toArray()
    {
        $array = [];
        $this->rewind();
        while ($this->valid()) {
            $array[] = $this->current();
            $this->next();
        }
        return $array;
    }
 
    public function ‪clear(int|‪ContextualFeedbackSeverity|null $severity = null)
    {
        if (is_int($severity)) {
            // @deprecated int type for $severity deprecated in v12, will change to Severity only in v13.
            $severity = ContextualFeedbackSeverity::transform($severity);
        }
        $this->rewind();
        if ($severity === null) {
            while (!$this->isEmpty()) {
                parent::dequeue();
            }
        } else {
            $keysToRemove = [];
            while ($cur = $this->current()) {
                if ($cur->getSeverity() === $severity) {
                    $keysToRemove[] = $this->key();
                }
                $this->next();
            }
            // keys are renumbered when unsetting elements
            // so unset them from last to first
            $keysToRemove = array_reverse($keysToRemove);
            foreach ($keysToRemove as $key) {
                $this->offsetUnset($key);
            }
        }
    }
 
    public function ‪jsonSerialize(): array
    {
        return $this->‪toArray();
    }
}