9.5/_functional_2_messaging_2_flash_message_queue_test_8php_source.html

<?php

namespace ‪TYPO3\CMS\Core\Tests\Functional\Messaging;


/*

 * 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!

 */


use ‪TYPO3\CMS\Core\Messaging\FlashMessage;

use ‪TYPO3\CMS\Core\Messaging\FlashMessageQueue;


class ‪FlashMessageQueueTest extends \TYPO3\TestingFramework\Core\Functional\FunctionalTestCase

{

    public function ‪getAllMessagesContainsEnqueuedMessage()

    {

        $this->setUpBackendUserFromFixture(1);

        $flashMessage = new ‪FlashMessage('Foo', 'Bar', ‪FlashMessage::OK, true);

        $flashMessageQueue = new ‪FlashMessageQueue('core.template.flashMessages');

        $flashMessageQueue->addMessage($flashMessage);

        $this->assertEquals([$flashMessage], $flashMessageQueue->getAllMessages());

    }


    public function ‪messagesCanBeFilteredBySeverity()

    {

        $this->setUpBackendUserFromFixture(1);

        $flashMessageQueue = new ‪FlashMessageQueue('core.template.flashMessages');

        $messages = [

            0 => new ‪FlashMessage('This is a test message', '1', ‪FlashMessage::NOTICE),

            1 => new ‪FlashMessage('This is another test message', '2', ‪FlashMessage::WARNING)

        ];

        $flashMessageQueue->enqueue($messages[0]);

        $flashMessageQueue->enqueue($messages[1]);


        $filteredFlashMessages = $flashMessageQueue->getAllMessages(‪FlashMessage::NOTICE);


        $this->assertEquals(count($filteredFlashMessages), 1);


        reset($filteredFlashMessages);

        $flashMessage = current($filteredFlashMessages);

        $this->assertEquals($messages[0], $flashMessage);

    }


    public function ‪getAllMessagesAndFlushContainsEnqueuedMessage()

    {

        $this->setUpBackendUserFromFixture(1);

        $flashMessage = new ‪FlashMessage('Foo', 'Bar', ‪FlashMessage::OK, true);

        $flashMessageQueue = new ‪FlashMessageQueue('core.template.flashMessages');

        $flashMessageQueue->addMessage($flashMessage);

        $this->assertEquals([$flashMessage], $flashMessageQueue->getAllMessagesAndFlush());

    }


    public function ‪getAllMessagesAndFlushClearsSessionStack()

    {

        $this->setUpBackendUserFromFixture(1);

        $flashMessage = new ‪FlashMessage('Foo', 'Bar', ‪FlashMessage::OK, true);

        $flashMessageQueue = new ‪FlashMessageQueue('core.template.flashMessages');

        $flashMessageQueue->addMessage($flashMessage);

        $flashMessageQueue->getAllMessagesAndFlush();

        $this->assertEquals([], $flashMessageQueue->getAllMessagesAndFlush());

    }


    public function ‪getMessagesAndFlushCanFilterBySeverity()

    {

        $this->setUpBackendUserFromFixture(1);

        $flashMessageQueue = new ‪FlashMessageQueue('core.template.flashMessages');

        $messages = [

            0 => new ‪FlashMessage('This is a test message', '1', ‪FlashMessage::NOTICE),

            1 => new ‪FlashMessage('This is another test message', '2', ‪FlashMessage::WARNING)

        ];

        $flashMessageQueue->addMessage($messages[0]);

        $flashMessageQueue->addMessage($messages[1]);


        $filteredFlashMessages = $flashMessageQueue->getAllMessagesAndFlush(‪FlashMessage::NOTICE);


        $this->assertEquals(count($filteredFlashMessages), 1);


        reset($filteredFlashMessages);

        $flashMessage = current($filteredFlashMessages);

        $this->assertEquals($messages[0], $flashMessage);


        $this->assertEquals([], $flashMessageQueue->getAllMessages(‪FlashMessage::NOTICE));

        $this->assertEquals([$messages[1]], array_values($flashMessageQueue->getAllMessages()));

    }


    public function ‪getAllMessagesReturnsSessionFlashMessageAndTransientFlashMessage()

    {

        $this->setUpBackendUserFromFixture(1);

        $flashMessageQueue = new ‪FlashMessageQueue('core.template.flashMessages');

        $flashMessage1 = new ‪FlashMessage('Transient', 'Title', ‪FlashMessage::OK, false);

        $flashMessage2 = new ‪FlashMessage('Session', 'Title', ‪FlashMessage::OK, true);

        $flashMessageQueue->addMessage($flashMessage1);

        $flashMessageQueue->addMessage($flashMessage2);


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

    }


    public function ‪clearClearsTheQueue()

    {

        $this->setUpBackendUserFromFixture(1);

        $flashMessage = new ‪FlashMessage('Foo', 'Bar', ‪FlashMessage::OK, true);

        $flashMessageQueue = new ‪FlashMessageQueue('core.template.flashMessages');

        $flashMessageQueue->addMessage($flashMessage);

        $flashMessageQueue->clear();

        $this->assertCount(0, $flashMessageQueue);

    }


    public function ‪toArrayOnlyRespectsTransientFlashMessages()

    {

        $this->setUpBackendUserFromFixture(1);

        $flashMessageQueue = new ‪FlashMessageQueue('core.template.flashMessages');

        $flashMessage1 = new ‪FlashMessage('Transient', 'Title', ‪FlashMessage::OK, false);

        $flashMessage2 = new ‪FlashMessage('Session', 'Title', ‪FlashMessage::OK, true);

        $flashMessageQueue->addMessage($flashMessage1);

        $flashMessageQueue->addMessage($flashMessage2);


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

    }

}