Public Member Functions | |
| add ($message, $title= '', $severity=t3lib_FlashMessage::OK) | |
| getAll () | |
| getAllMessages () | |
| flush () | |
| getAllAndFlush () | |
| getAllMessagesAndFlush () | |
Detailed Description
This is a container for all Flash Messages. It is of scope session, but as Extbase has no session scope, we need to save it manually.
- Version:
- Id:
- FlashMessages.php 1729 2009-11-25 21:37:20Z stucki
http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later session
Definition at line 38 of file FlashMessages.php.
Member Function Documentation
| Tx_Extbase_MVC_Controller_FlashMessages::add | ( | $ | message, |
| $ | title = '', |
||
| $ | severity = t3lib_FlashMessage::OK |
||
| ) |
Add another flash message. Severity can be specified and must be one of t3lib_FlashMessage::NOTICE, t3lib_FlashMessage::INFO, t3lib_FlashMessage::OK, t3lib_FlashMessage::WARNING, t3lib_FlashMessage::ERROR
- Parameters:
-
string $message string $title optional message title integer $severity optional severity code. One of the t3lib_FlashMessage constants
- Returns:
- void
Definition at line 55 of file FlashMessages.php.
References t3lib_FlashMessageQueue\addMessage(), and t3lib_div\makeInstance().
| Tx_Extbase_MVC_Controller_FlashMessages::flush | ( | ) |
Reset all flash messages.
- Returns:
- void
Definition at line 102 of file FlashMessages.php.
References getAllMessagesAndFlush().
| Tx_Extbase_MVC_Controller_FlashMessages::getAll | ( | ) |
Get all flash messages currently available.
- Returns:
- array<string> An array of flash messages
- Deprecated:
- since Extbase 1.3.0; will be removed in Extbase 1.5.0. Use Use getAllMessages() instead
Definition at line 75 of file FlashMessages.php.
References getAllMessages(), and t3lib_div\logDeprecatedFunction().
| Tx_Extbase_MVC_Controller_FlashMessages::getAllAndFlush | ( | ) |
Get all flash messages currently available and delete them afterwards.
- Returns:
- array<string>
- Deprecated:
- since Extbase 1.3.0; will be removed in Extbase 1.5.0. Use getAllMessagesAndFlush() instead
Definition at line 112 of file FlashMessages.php.
References getAllMessagesAndFlush(), and t3lib_div\logDeprecatedFunction().
| Tx_Extbase_MVC_Controller_FlashMessages::getAllMessages | ( | ) |
Get all flash messages currently available.
- Returns:
- array<t3lib_FlashMessage> An array of flash messages
- See also:
- t3lib_FlashMessage
Definition at line 92 of file FlashMessages.php.
Referenced by getAll().
| Tx_Extbase_MVC_Controller_FlashMessages::getAllMessagesAndFlush | ( | ) |
Get all flash messages currently available. And removes them from the session.
- Returns:
- array<t3lib_FlashMessage> An array of flash messages
- See also:
- t3lib_FlashMessage
Definition at line 129 of file FlashMessages.php.
Referenced by flush(), and getAllAndFlush().
The documentation for this class was generated from the following file:
- typo3/sysext/extbase/Classes/MVC/Controller/FlashMessages.php
