FlashMessageQueue.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Messaging;

class FlashMessageQueue extends \SplQueue {

    protected $identifier;

    public function __construct($identifier) {
        $this->identifier = $identifier;
    }

    public function enqueue($message) {
        if (!($message instanceof FlashMessage)) {
            throw new \TYPO3\CMS\Core\Exception(
                'FlashMessageQueue::enqueue() expects an object of type \TYPO3\CMS\Core\Messaging\FlashMessage but got type "' . (is_object($message) ? get_class($message) : gettype($message)) . '"',
                1376833554
            );
        }
        if ($message->isSessionMessage()) {
            $this->addFlashMessageToSession($message);
        } else {
            parent::enqueue($message);
        }
    }

    public function dequeue() {
        // deliberately empty
    }

    protected function addFlashMessageToSession(\TYPO3\CMS\Core\Messaging\FlashMessage $message) {
        $queuedFlashMessages = $this->getFlashMessagesFromSession();
        $queuedFlashMessages[] = $message;
        $this->storeFlashMessagesInSession($queuedFlashMessages);
    }

    protected function getAllMessages() {
        // Get messages from user session
        $queuedFlashMessagesFromSession = $this->getFlashMessagesFromSession();
        $queuedFlashMessages = array_merge($queuedFlashMessagesFromSession, $this->toArray());
        return $queuedFlashMessages;
    }

    protected function getAllMessagesAndFlush() {
        $queuedFlashMessages = $this->getAllMessages();
        // Reset messages in user session
        $this->removeAllFlashMessagesFromSession();
        // Reset internal messages
        $this->clear();
        return $queuedFlashMessages;
    }

    protected function storeFlashMessagesInSession(array $flashMessages) {
        $this->getUserByContext()->setAndSaveSessionData($this->identifier, $flashMessages);
    }

    protected function removeAllFlashMessagesFromSession() {
        $this->getUserByContext()->setAndSaveSessionData($this->identifier, NULL);
    }

    protected function getFlashMessagesFromSession() {
        $flashMessages = $this->getUserByContext()->getSessionData($this->identifier);
        return is_array($flashMessages) ? $flashMessages : array();
    }

    protected function getUserByContext() {
        return TYPO3_MODE === 'BE' ? $GLOBALS['BE_USER'] : $GLOBALS['TSFE']->fe_user;
    }

    protected function renderFlashMessages() {
        $content = '';
        $flashMessages = $this->getAllMessagesAndFlush();
        if (count($flashMessages)) {
            foreach ($flashMessages as $flashMessage) {
                $content .= $flashMessage->render();
            }
        }
        return $content;
    }

    public function toArray() {
        $array = array();
        $this->rewind();
        while ($this->valid()) {
            $array[] = $this->current();
            $this->next();
        }
        return $array;
    }

    public function clear() {
        $this->rewind();
        while (!$this->isEmpty()) {
            parent::dequeue();
        }
    }

    static public function __callStatic($name, array $arguments) {
        \TYPO3\CMS\Core\Utility\GeneralUtility::logDeprecatedFunction();
        $flashMessageService = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\CMS\Core\Messaging\FlashMessageService');
        $identifier = 'core.template.flashMessages';
        switch ($name) {
            case 'renderFlashMessages':
                return $flashMessageService->getMessageQueueByIdentifier($identifier)->renderFlashMessages();
                break;
            case 'getAllMessagesAndFlush':
                return $flashMessageService->getMessageQueueByIdentifier($identifier)->getAllMessagesAndFlush();
                break;
            case 'getAllMessages':
                return $flashMessageService->getMessageQueueByIdentifier($identifier)->getAllMessages();
                break;
            case 'addMessage':
                $flashMessageService->getMessageQueueByIdentifier($identifier)->enqueue(current($arguments));
                break;
            default:
                throw new \RuntimeException('The requested method "' . $name . '" cannot be called via __callStatic.', 1363300030);
        }
    }

    public function __call($name, array $arguments) {
        switch ($name) {
            case 'renderFlashMessages':
                return $this->renderFlashMessages();
                break;
            case 'getAllMessagesAndFlush':
                return $this->getAllMessagesAndFlush();
                break;
            case 'getAllMessages':
                return $this->getAllMessages();
                break;
            case 'addMessage':
                $this->enqueue(current($arguments));
                break;
            default:
                throw new \RuntimeException('The requested method "' . $name . '" cannot be called via __call.', 1363300072);
        }
    }
}