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

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

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 bootstrap flash messages. This class renders flash messages as markup, based on the bootstrap HTML/CSS framework. It is used in backend context. The created output contains all classes which are required for the TYPO3 backend. Any kind of message contains also a nice icon.

Definition at line 29 of file BootstrapRenderer.php.

Member Function Documentation

getClass()

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

protected

Gets the message severity class name

Parameters

FlashMessage

$flashMessage

Returns

‪string The message severity class name

Definition at line 69 of file BootstrapRenderer.php.

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

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

getIconName()

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

protected

Gets the message severity icon name

Parameters

FlashMessage

$flashMessage

Returns

‪string The message severity icon name

Definition at line 81 of file BootstrapRenderer.php.

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

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

getMessageAsMarkup()

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

protected

Gets the message rendered as clean and secure markup

Parameters

FlashMessage[]

$flashMessages

Returns

‪string

Definition at line 92 of file BootstrapRenderer.php.

References TYPO3\CMS\Core\Messaging\Renderer\BootstrapRenderer\getClass(), and TYPO3\CMS\Core\Messaging\Renderer\BootstrapRenderer\getIconName().

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

render()

string TYPO3\CMS\Core\Messaging\Renderer\BootstrapRenderer::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 57 of file BootstrapRenderer.php.

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

Member Data Documentation

$classes

string [] TYPO3\CMS\Core\Messaging\Renderer\BootstrapRenderer::$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 33 of file BootstrapRenderer.php.

$icons

string [] TYPO3\CMS\Core\Messaging\Renderer\BootstrapRenderer::$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 43 of file BootstrapRenderer.php.