Inheritance diagram for TYPO3\CMS\Core\Messaging\FlashMessageQueue:

Public Member Functions
	__construct ($identifier)

	enqueue ($message)

	dequeue ()

	toArray ()

	clear ()

	__call ($name, array $arguments)

Protected Member Functions
	addFlashMessageToSession (\TYPO3\CMS\Core\Messaging\FlashMessage $message)

	getAllMessages ()

	getAllMessagesAndFlush ()

	storeFlashMessagesInSession (array $flashMessages)

	removeAllFlashMessagesFromSession ()

	getFlashMessagesFromSession ()

	getUserByContext ()

Protected Attributes
	$identifier

Detailed Description

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! A class which collects and renders flash messages.

Author: Rupert Germann rupi@.nosp@m.gmx..nosp@m.li; Alexander Schnitzler alex..nosp@m.schn.nosp@m.itzle.nosp@m.r@ty.nosp@m.povis.nosp@m.ion..nosp@m.de

Definition at line 22 of file FlashMessageQueue.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Messaging\FlashMessageQueue::__construct ( $identifier )

Parameters

string $identifier The unique identifier for this queue

Definition at line 34 of file FlashMessageQueue.php.

References TYPO3\CMS\Core\Messaging\FlashMessageQueue\$identifier.

Member Function Documentation

◆ __call()

TYPO3\CMS\Core\Messaging\FlashMessageQueue::__call	(		$name,
		array	$arguments
	)

This method is deprecated but will not log a deprecation message because once the here used method names are 'free' again they will be implemented natively in this class. This is not possible at the moment because these methods have been static and need to be statically callable through __callStatic until 6.3.

Parameters

string	$name
array	$arguments

Exceptions

Definition at line 246 of file FlashMessageQueue.php.

References TYPO3\CMS\Core\Messaging\FlashMessageQueue\enqueue(), TYPO3\CMS\Core\Messaging\FlashMessageQueue\getAllMessages(), and TYPO3\CMS\Core\Messaging\FlashMessageQueue\getAllMessagesAndFlush().

◆ addFlashMessageToSession()

TYPO3\CMS\Core\Messaging\FlashMessageQueue::addFlashMessageToSession ( \TYPO3\CMS\Core\Messaging\FlashMessage $message )

protected

Adds the given flash message to the array of flash messages that will be stored in the session.

Parameters

\TYPO3\CMS\Core\Messaging\FlashMessage $message

Returns: void

Definition at line 73 of file FlashMessageQueue.php.

References TYPO3\CMS\Core\Messaging\FlashMessageQueue\getFlashMessagesFromSession(), and TYPO3\CMS\Core\Messaging\FlashMessageQueue\storeFlashMessagesInSession().

Referenced by TYPO3\CMS\Core\Messaging\FlashMessageQueue\enqueue().

◆ clear()

TYPO3\CMS\Core\Messaging\FlashMessageQueue::clear ( )

Removes all items from the queue

Returns: void

Definition at line 183 of file FlashMessageQueue.php.

References TYPO3\CMS\Core\Messaging\FlashMessageQueue\$identifier, TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Core\Messaging\FlashMessageQueue\getAllMessagesAndFlush().

◆ dequeue()

TYPO3\CMS\Core\Messaging\FlashMessageQueue::dequeue ( )

Returns: void

Definition at line 62 of file FlashMessageQueue.php.

◆ enqueue()

TYPO3\CMS\Core\Messaging\FlashMessageQueue::enqueue ( $message )

Adds a message either to the BE_USER session (if the $message has the storeInSession flag set) or it enqueues the message.

Parameters

\TYPO3\CMS\Core\Messaging\FlashMessage $message Instance of , representing a message

Returns: void

Definition at line 45 of file FlashMessageQueue.php.

References TYPO3\CMS\Core\Messaging\FlashMessageQueue\addFlashMessageToSession().

Referenced by TYPO3\CMS\Core\Messaging\FlashMessageQueue\__call().

◆ getAllMessages()

TYPO3\CMS\Core\Messaging\FlashMessageQueue::getAllMessages ( )

protected

Returns all messages from the current PHP session and from the current request.

Returns: array Array of objects

Definition at line 84 of file FlashMessageQueue.php.

References TYPO3\CMS\Core\Messaging\FlashMessageQueue\getFlashMessagesFromSession(), and TYPO3\CMS\Core\Messaging\FlashMessageQueue\toArray().

Referenced by TYPO3\CMS\Core\Messaging\FlashMessageQueue\__call(), and TYPO3\CMS\Core\Messaging\FlashMessageQueue\getAllMessagesAndFlush().

◆ getAllMessagesAndFlush()

TYPO3\CMS\Core\Messaging\FlashMessageQueue::getAllMessagesAndFlush ( )

protected

Returns all messages from the current PHP session and from the current request. After fetching the messages the internal queue and the message queue in the session will be emptied.