TYPO3\CMS\Core\Messaging\Renderer\ListRenderer Class Reference

Inheritance diagram for TYPO3\CMS\Core\Messaging\Renderer\ListRenderer:

Public Member Functions
string	render (array $flashMessages)

Protected Member Functions
string	getClass (FlashMessage $flashMessage)
string	getIconName (FlashMessage $flashMessage)
string	getMessageAsMarkup (array $flashMessages)

Static Protected Attributes
static string[]	$classes
static string[]	$icons

Detailed Description

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.

Definition at line 30 of file ListRenderer.php.

Member Function Documentation

getClass()

string TYPO3\CMS\Core\Messaging\Renderer\ListRenderer::getClass ( FlashMessage  $flashMessage )

protected

Gets the message severity class name

Parameters

FlashMessage

$flashMessage

Returns

‪string The message severity class name

Definition at line 70 of file ListRenderer.php.

References TYPO3\CMS\Core\Messaging\AbstractMessage\getSeverity().

Referenced by TYPO3\CMS\Core\Messaging\Renderer\ListRenderer\getMessageAsMarkup().

getIconName()

string TYPO3\CMS\Core\Messaging\Renderer\ListRenderer::getIconName ( FlashMessage  $flashMessage )

protected

Gets the message severity icon name

Parameters

FlashMessage

$flashMessage

Returns

‪string The message severity icon name

Definition at line 82 of file ListRenderer.php.

References $icons, and TYPO3\CMS\Core\Messaging\AbstractMessage\getSeverity().

getMessageAsMarkup()

string TYPO3\CMS\Core\Messaging\Renderer\ListRenderer::getMessageAsMarkup ( array  $flashMessages )

protected

Gets the message rendered as clean and secure markup

Parameters

FlashMessage[]

$flashMessages

Returns

‪string

Definition at line 93 of file ListRenderer.php.

References TYPO3\CMS\Core\Messaging\Renderer\ListRenderer\getClass().

Referenced by TYPO3\CMS\Core\Messaging\Renderer\ListRenderer\render().

render()

string TYPO3\CMS\Core\Messaging\Renderer\ListRenderer::render

(

array

$flashMessages

)

Render method

Parameters

FlashMessage[]

$flashMessages

Returns

‪string Representation of the flash message

Implements TYPO3\CMS\Core\Messaging\Renderer\FlashMessageRendererInterface.

Definition at line 58 of file ListRenderer.php.

References TYPO3\CMS\Core\Messaging\Renderer\ListRenderer\getMessageAsMarkup().

Member Data Documentation

$classes

string [] TYPO3\CMS\Core\Messaging\Renderer\ListRenderer::$classes

staticprotected

Initial value:

= array( 
        ‪FlashMessage::NOTICE => 'notice',
        ‪FlashMessage::INFO => 'info',
        ‪FlashMessage::OK => 'success',
        ‪FlashMessage::WARNING => 'warning',
        ‪FlashMessage::ERROR => 'danger'
     )

The message severity class names

Definition at line 34 of file ListRenderer.php.

$icons

string [] TYPO3\CMS\Core\Messaging\Renderer\ListRenderer::$icons

staticprotected

Initial value:

= array( 
        ‪FlashMessage::NOTICE => 'lightbulb-o',
        ‪FlashMessage::INFO => 'info',
        ‪FlashMessage::OK => 'check',
        ‪FlashMessage::WARNING => 'exclamation',
        ‪FlashMessage::ERROR => 'times'
     )

The message severity icon names

Definition at line 44 of file ListRenderer.php.