FlashMessage Class Reference

Inheritance diagram for FlashMessage:

Public Member Functions
	__construct ($message, $title= '', $severity=self::OK, $storeInSession=false)
	isSessionMessage ()
	setStoreInSession ($storeInSession)
	getClass ()
	getIconName ()
	render ()
Public Member Functions inherited from AbstractMessage
	getTitle ()
	setTitle ($title)
	getMessage ()
	setMessage ($message)
	getSeverity ()
	setSeverity ($severity=self::OK)
	__toString ()

Protected Attributes
	$storeInSession = false
	$classes
	$icons
Protected Attributes inherited from AbstractMessage
	$title = ''
	$message = ''
	$severity = self::OK

Additional Inherited Members
Public Attributes inherited from AbstractMessage
const	NOTICE = -2
const	INFO = -1
const	OK = 0
const	WARNING = 1
const	ERROR = 2

Detailed Description

A class representing flash messages.

Definition at line 22 of file FlashMessage.php.

Constructor & Destructor Documentation

__construct	(		$message,
			$title = '',
			$severity = self::OK,
			$storeInSession = false
	)

Constructor for a flash message

Parameters

string	$message	The message.
string	$title	Optional message title.
int	$severity	Optional severity, must be either of one of constants
bool	$storeInSession	Optional, defines whether the message should be stored in the session or only for one request (default)

Definition at line 61 of file FlashMessage.php.

References AbstractMessage\$message, AbstractMessage\$severity, FlashMessage\$storeInSession, AbstractMessage\$title, AbstractMessage\setMessage(), AbstractMessage\setSeverity(), FlashMessage\setStoreInSession(), and AbstractMessage\setTitle().

Member Function Documentation

getClass

(

)

Gets the message severity class name

Returns

string The message severity class name

Definition at line 95 of file FlashMessage.php.

References AbstractMessage\$severity.

Referenced by FlashMessage\render().

getIconName

(

)

Gets the message severity icon name

Returns

string The message severity icon name

Definition at line 105 of file FlashMessage.php.

References AbstractMessage\$severity.

Referenced by FlashMessage\render().

isSessionMessage

(

)

Gets the message's storeInSession flag.

Returns

bool TRUE if message should be stored in the session, otherwise FALSE.

Definition at line 74 of file FlashMessage.php.

References FlashMessage\$storeInSession.

render

(

)

Renders the flash message.

Returns

string The flash message as HTML.

Deprecated:

since TYPO3 CMS 7, will be removed in TYPO3 CMS 8

Definition at line 116 of file FlashMessage.php.

References AbstractMessage\$message, AbstractMessage\$title, FlashMessage\getClass(), FlashMessage\getIconName(), and GeneralUtility\logDeprecatedFunction().

setStoreInSession

(

$storeInSession

)

Sets the message's storeInSession flag

Parameters

bool

$storeInSession

The persistence flag

Returns

void

Definition at line 85 of file FlashMessage.php.

References FlashMessage\$storeInSession.

Referenced by FlashMessage\__construct().

Member Data Documentation

$classes

protected

Initial value:

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

Definition at line 34 of file FlashMessage.php.

$icons

protected

Initial value:

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

Definition at line 45 of file FlashMessage.php.

$storeInSession = false

protected

Definition at line 29 of file FlashMessage.php.

Referenced by FlashMessage\__construct(), FlashMessage\isSessionMessage(), and FlashMessage\setStoreInSession().