TYPO3 API  SVNRelease
Static Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Member Functions
t3lib_FlashMessageQueue Class Reference

List of all members.

Static Public Member Functions

static addMessage (t3lib_FlashMessage $message)
static getAllMessages ()
static getAllMessagesAndFlush ()
static renderFlashMessages ()

Static Public Attributes

static $messages = array()

Protected Member Functions

 __construct ()

Static Protected Member Functions

static storeFlashMessagesInSession (array $flashMessages)
static removeAllFlashMessagesFromSession ()
static getFlashMessagesFromSession ()
static getUserByContext ()

Detailed Description

Definition at line 36 of file class.t3lib_flashmessagequeue.php.


Constructor & Destructor Documentation

t3lib_FlashMessageQueue::__construct ( ) [protected]

Static class, no instances allowed.

Definition at line 43 of file class.t3lib_flashmessagequeue.php.


Member Function Documentation

static t3lib_FlashMessageQueue::addMessage ( t3lib_FlashMessage message) [static]
static t3lib_FlashMessageQueue::getAllMessages ( ) [static]

Returns all messages from the current PHP session and from the current request.

Returns:
array array of t3lib_FlashMessage objects

Definition at line 69 of file class.t3lib_flashmessagequeue.php.

References getFlashMessagesFromSession().

Referenced by getAllMessagesAndFlush().

static t3lib_FlashMessageQueue::getAllMessagesAndFlush ( ) [static]

Returns all messages from the current PHP session and from the current request. After fetching the messages the internal queue and the message queue in the session will be emptied.

Returns:
array array of t3lib_FlashMessage objects

Definition at line 84 of file class.t3lib_flashmessagequeue.php.

References getAllMessages(), and removeAllFlashMessagesFromSession().

Referenced by t3lib_formprotection_BackendFormProtectionTest\createValidationErrorMessageAddsErrorFlashMessage(), tx_em_ExtensionManager\render(), renderFlashMessages(), t3lib_formprotection_InstallToolFormProtectionTest\tearDown(), and t3lib_formprotection_BackendFormProtectionTest\tearDown().

static t3lib_FlashMessageQueue::getFlashMessagesFromSession ( ) [static, protected]

Returns current flash messages from the session, making sure to always return an array.

Returns:
array An array of t3lib_FlashMessage flash messages.

Definition at line 121 of file class.t3lib_flashmessagequeue.php.

References getUserByContext().

Referenced by addMessage(), and getAllMessages().

static t3lib_FlashMessageQueue::getUserByContext ( ) [static, protected]

Gets user object by context

Returns:
object user object

Definition at line 132 of file class.t3lib_flashmessagequeue.php.

References $GLOBALS.

Referenced by getFlashMessagesFromSession(), removeAllFlashMessagesFromSession(), and storeFlashMessagesInSession().

static t3lib_FlashMessageQueue::removeAllFlashMessagesFromSession ( ) [static, protected]

Removes all flash messages from the session

Returns:
void

Definition at line 111 of file class.t3lib_flashmessagequeue.php.

References getUserByContext().

Referenced by getAllMessagesAndFlush().

static t3lib_FlashMessageQueue::renderFlashMessages ( ) [static]

Fetches and renders all available flash messages from the queue.

Returns:
string All flash messages in the queue rendered as HTML.

Definition at line 141 of file class.t3lib_flashmessagequeue.php.

References $content, and getAllMessagesAndFlush().

Referenced by template\moduleBody().

static t3lib_FlashMessageQueue::storeFlashMessagesInSession ( array $  flashMessages) [static, protected]

Stores given flash messages in the session

Parameters:
arrayarray of t3lib_FlashMessage
Returns:
void

Definition at line 101 of file class.t3lib_flashmessagequeue.php.

References getUserByContext().

Referenced by addMessage().


Member Data Documentation

t3lib_FlashMessageQueue::$messages = array() [static]

Definition at line 38 of file class.t3lib_flashmessagequeue.php.


The documentation for this class was generated from the following file: