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

Public Member Functions
	__construct ($identifier)

	getIdentifier ()

	enqueue ($message)

	addMessage (FlashMessage $message)

	dequeue ()

	getAllMessages ($severity=null)

	getAllMessagesAndFlush ($severity=null)

	renderFlashMessages ()

	toArray ()

	clear ($severity=null)

Protected Member Functions
	addFlashMessageToSession (FlashMessage $message)

	storeFlashMessagesInSession (array $flashMessages=null)

	removeAllFlashMessagesFromSession ($severity=null)

	getFlashMessagesFromSession ()

	getUserByContext ()

Protected Attributes
	$identifier

Detailed Description

A class which collects and renders flash messages.

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

◆ addFlashMessageToSession()

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

protected

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

Parameters

FlashMessage $message

Returns: void

Definition at line 94 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().

◆ addMessage()

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

Parameters

FlashMessage $message

Returns: void

Definition at line 74 of file FlashMessageQueue.php.

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

◆ clear()

TYPO3\CMS\Core\Messaging\FlashMessageQueue::clear ( $severity = null )

Removes all items from the queue

Parameters

int $severity Optional severity, must be one of constants

Returns: void

Definition at line 243 of file FlashMessageQueue.php.

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

◆ dequeue()

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

Returns: void

Definition at line 82 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

FlashMessage $message Instance of , representing a message

Exceptions

Definition at line 55 of file FlashMessageQueue.php.

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

Referenced by TYPO3\CMS\Core\Messaging\FlashMessageQueue\addMessage(), and TYPO3\CMS\Core\FormProtection\FormProtectionFactory\isFrontendSession().

◆ getAllMessages()

TYPO3\CMS\Core\Messaging\FlashMessageQueue::getAllMessages ( $severity = null )

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

Parameters

int $severity Optional severity, must be one of constants

Returns: FlashMessage[]

Definition at line 107 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\getAllMessagesAndFlush().

◆ getAllMessagesAndFlush()

TYPO3\CMS\Core\Messaging\FlashMessageQueue::getAllMessagesAndFlush ( $severity = null )

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.

Parameters

int $severity Optional severity, must be one of constants