ListRenderer implements FlashMessageRendererInterface
A class representing a html flash message as unordered markup list.
It is used in frontend context per default. The created output contains css classes which can be used to style the output individual. Any message contains the message and an optional title which is rendered as
tag if it is set in the FlashMessage object.
Table of Contents
Interfaces
- FlashMessageRendererInterface
- Interface must be implemented by all flash message renderer classes
Properties
Methods
- render() : string
- Render method
- getClass() : string
- Gets the message severity class name
- getIconName() : string
- Gets the message severity icon name
- getMessageAsMarkup() : string
- Gets the message rendered as clean and secure markup
Properties
$classes
protected
static array<string|int, string>
$classes
= [\TYPO3\CMS\Core\Messaging\FlashMessage::NOTICE => 'notice', \TYPO3\CMS\Core\Messaging\FlashMessage::INFO => 'info', \TYPO3\CMS\Core\Messaging\FlashMessage::OK => 'success', \TYPO3\CMS\Core\Messaging\FlashMessage::WARNING => 'warning', \TYPO3\CMS\Core\Messaging\FlashMessage::ERROR => 'danger']
The message severity class names
$icons
protected
static array<string|int, string>
$icons
= [\TYPO3\CMS\Core\Messaging\FlashMessage::NOTICE => 'lightbulb-o', \TYPO3\CMS\Core\Messaging\FlashMessage::INFO => 'info', \TYPO3\CMS\Core\Messaging\FlashMessage::OK => 'check', \TYPO3\CMS\Core\Messaging\FlashMessage::WARNING => 'exclamation', \TYPO3\CMS\Core\Messaging\FlashMessage::ERROR => 'times']
The message severity icon names
Methods
render()
Render method
public
render(array<string|int, FlashMessage> $flashMessages) : string
Parameters
- $flashMessages : array<string|int, FlashMessage>
Return values
string —Representation of the flash message
getClass()
Gets the message severity class name
protected
getClass(FlashMessage $flashMessage) : string
Parameters
- $flashMessage : FlashMessage
Return values
string —The message severity class name
getIconName()
Gets the message severity icon name
protected
getIconName(FlashMessage $flashMessage) : string
Parameters
- $flashMessage : FlashMessage
Return values
string —The message severity icon name
getMessageAsMarkup()
Gets the message rendered as clean and secure markup
protected
getMessageAsMarkup(array<string|int, FlashMessage> $flashMessages) : string
Parameters
- $flashMessages : array<string|int, FlashMessage>