Public Member Functions | |
| __construct ($message, $title= '', $severity=self::OK, $storeInSession=FALSE) | |
| isSessionMessage () | |
| setStoreInSession ($storeInSession) | |
| render () | |
Protected Attributes | |
| $storeInSession = FALSE | |
Detailed Description
Definition at line 36 of file class.t3lib_flashmessage.php.
Constructor & Destructor Documentation
| t3lib_FlashMessage::__construct | ( | $ | message, |
| $ | title = '', |
||
| $ | severity = self::OK, |
||
| $ | storeInSession = FALSE |
||
| ) |
Constructor for a flash message
- Parameters:
-
string The message. string Optional message title. integer Optional severity, must be either of t3lib_FlashMessage::INFO, t3lib_FlashMessage::OK, t3lib_FlashMessage::WARNING or t3lib_FlashMessage::ERROR. Default is t3lib_FlashMessage::OK. bool Optional, defines whether the message should be stored in the session or only for one request (default)
- Returns:
- void
Definition at line 55 of file class.t3lib_flashmessage.php.
References t3lib_message_AbstractMessage\$message, t3lib_message_AbstractMessage\$severity, $storeInSession, t3lib_message_AbstractMessage\$title, t3lib_message_AbstractMessage\setMessage(), t3lib_message_AbstractMessage\setSeverity(), setStoreInSession(), and t3lib_message_AbstractMessage\setTitle().
Member Function Documentation
| t3lib_FlashMessage::isSessionMessage | ( | ) |
Gets the message's storeInSession flag.
- Returns:
- bool true if message should be stored in the session, otherwise false.
Definition at line 68 of file class.t3lib_flashmessage.php.
Referenced by t3lib_FlashMessageQueue\addMessage().
| t3lib_FlashMessage::render | ( | ) |
Renders the flash message.
- Returns:
- string The flash message as HTML.
Definition at line 87 of file class.t3lib_flashmessage.php.
References t3lib_message_AbstractMessage\$message, and t3lib_message_AbstractMessage\$title.
| t3lib_FlashMessage::setStoreInSession | ( | $ | storeInSession | ) |
Sets the message's storeInSession flag
- Parameters:
-
bool The persistence flag
- Returns:
- void
Definition at line 78 of file class.t3lib_flashmessage.php.
References $storeInSession.
Referenced by __construct().
Member Data Documentation
t3lib_FlashMessage::$storeInSession = FALSE [protected] |
Definition at line 43 of file class.t3lib_flashmessage.php.
Referenced by __construct(), and setStoreInSession().
The documentation for this class was generated from the following file:
