‪TYPO3CMS  ‪main
TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper Class Reference
Inheritance diagram for TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper:

Public Member Functions

 initializeArguments ()
 

Static Public Member Functions

static mixed renderStatic (array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
 

Protected Attributes

bool $escapeOutput = false
 

Detailed Description

ViewHelper which renders the flash messages (if there are any) as an unsorted list.

In case you need custom Flash Message HTML output, please write your own ViewHelper for the moment.

Examples

Simple

::

<f:flashMessages />

A list of flash messages.

TYPO3 core style

::

<f:flashMessages />

Output::

<svg class="icon-color"><use xlink:href="/typo3/sysext/core/Resources/Public/Icons/T3Icons/sprites/actions.svg#actions-info"></use></svg>

Info - Title for Info message

Message text here.

Output flash messages as a description list

::

<f:flashMessages as="flashMessages">

f:for each="{flashMessages}" as="flashMessage">

{flashMessage.code} {flashMessage.message} </f:for>

</f:flashMessages>

Output::

1013
‪Some Warning Message.

Using a specific queue

::

<f:flashMessages queueIdentifier="myQueue" />

Definition at line 106 of file FlashMessagesViewHelper.php.

Member Function Documentation

◆ initializeArguments()

TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper::initializeArguments ( )

Definition at line 115 of file FlashMessagesViewHelper.php.

◆ renderStatic()

static mixed TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper::renderStatic ( array  $arguments,
\Closure  $renderChildrenClosure,
RenderingContextInterface  $renderingContext 
)
static

Renders FlashMessages and flushes the FlashMessage queue

Note: This does not disable the current page cache in order to prevent FlashMessage output from being cached. In case of conditional flash message rendering, caching must be disabled (e.g. for a controller action). Custom caching using the Caching Framework can be used in this case.

Returns
‪mixed

Definition at line 132 of file FlashMessagesViewHelper.php.

Member Data Documentation

◆ $escapeOutput

bool TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper::$escapeOutput = false
protected

ViewHelper outputs HTML therefore output escaping has to be disabled

Definition at line 113 of file FlashMessagesViewHelper.php.