FlashMessageQueueTest.php

Go to the documentation of this file.

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

class FlashMessageQueueTest extends \TYPO3\CMS\Core\Tests\UnitTestCase {

    protected $flashMessageQueue;

    protected $frontendUser;

    public function setUp() {
        $this->frontendUser = $this->getMock('TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication', array('dummy'));
        $this->flashMessageQueue = $this->getAccessibleMock(
            'TYPO3\CMS\Core\Messaging\FlashMessageQueue',
            array('getUserByContext'),
            array('core.template.flashMessages')
        );

        $this->flashMessageQueue->expects($this->any())->method('getUserByContext')->will($this->returnValue($this->frontendUser));
    }

    public function userSessionInitiallyIsEmpty() {
        $this->assertSame(array(), $this->flashMessageQueue->_call('getFlashMessagesFromSession'));
    }

    public function enqueueTransientFlashMessageKeepsSessionEmpty() {
        $this->flashMessageQueue->enqueue(new \TYPO3\CMS\Core\Messaging\FlashMessage('Foo', 'Bar', \TYPO3\CMS\Core\Messaging\FlashMessage::OK, FALSE));

        $this->assertSame(array(), $this->flashMessageQueue->_call('getFlashMessagesFromSession'));
    }

    public function enqueueSessionFlashMessageWritesSessionEntry() {
        $flashMessage = new \TYPO3\CMS\Core\Messaging\FlashMessage('Foo', 'Bar', \TYPO3\CMS\Core\Messaging\FlashMessage::OK, TRUE);
        $this->flashMessageQueue->enqueue($flashMessage);

        $this->assertSame(array($flashMessage), $this->flashMessageQueue->_call('getFlashMessagesFromSession'));
    }

    public function getAllMessagesReturnsSessionFlashMessageAndTransientFlashMessage() {
        $flashMessage1 = new \TYPO3\CMS\Core\Messaging\FlashMessage('Transient', 'Title', \TYPO3\CMS\Core\Messaging\FlashMessage::OK, FALSE);
        $flashMessage2 = new \TYPO3\CMS\Core\Messaging\FlashMessage('Session', 'Title', \TYPO3\CMS\Core\Messaging\FlashMessage::OK, TRUE);
        $this->flashMessageQueue->enqueue($flashMessage1);
        $this->flashMessageQueue->enqueue($flashMessage2);

        $this->assertCount(2, $this->flashMessageQueue->getAllMessages());
    }

    public function clearClearsTheQueue() {
        $flashMessage1 = new \TYPO3\CMS\Core\Messaging\FlashMessage('Transient', 'Title', \TYPO3\CMS\Core\Messaging\FlashMessage::OK, FALSE);
        $flashMessage2 = new \TYPO3\CMS\Core\Messaging\FlashMessage('Transient', 'Title', \TYPO3\CMS\Core\Messaging\FlashMessage::OK, FALSE);
        $this->flashMessageQueue->enqueue($flashMessage1);
        $this->flashMessageQueue->enqueue($flashMessage2);
        $this->flashMessageQueue->clear();

        $this->assertSame(0, $this->flashMessageQueue->count());
    }

    public function toArrayOnlyRespectsTransientFlashMessages() {
        $flashMessage1 = new \TYPO3\CMS\Core\Messaging\FlashMessage('Transient', 'Title', \TYPO3\CMS\Core\Messaging\FlashMessage::OK, FALSE);
        $flashMessage2 = new \TYPO3\CMS\Core\Messaging\FlashMessage('Transient', 'Title', \TYPO3\CMS\Core\Messaging\FlashMessage::OK, TRUE);
        $this->flashMessageQueue->enqueue($flashMessage1);
        $this->flashMessageQueue->enqueue($flashMessage2);

        $this->assertCount(1, $this->flashMessageQueue->toArray());
    }

    public function toArrayReturnsEmptyArrayWithForEmptyQueue() {
        $this->assertSame(array(), $this->flashMessageQueue->toArray());
    }

    public function getAllMessagesAndFlushClearsSessionStack() {
        $flashMessage = new \TYPO3\CMS\Core\Messaging\FlashMessage('Transient', 'Title', \TYPO3\CMS\Core\Messaging\FlashMessage::OK, TRUE);
        $this->flashMessageQueue->enqueue($flashMessage);
        $this->flashMessageQueue->getAllMessagesAndFlush();

        $frontendUser = $this->flashMessageQueue->_call('getUserByContext');

        $this->assertNull($frontendUser->getSessionData('core.template.flashMessages'));
    }

}