TYPO3
7.6
|
Public Member Functions | |
__construct ($identifier) | |
getIdentifier () | |
enqueue ($message) | |
addMessage (FlashMessage $message) | |
dequeue () | |
getAllMessages ($severity=null) | |
getAllMessagesAndFlush ($severity=null) | |
renderFlashMessages () | |
toArray () | |
clear ($severity=null) | |
Protected Member Functions | |
addFlashMessageToSession (FlashMessage $message) | |
storeFlashMessagesInSession (array $flashMessages=null) | |
removeAllFlashMessagesFromSession ($severity=null) | |
getFlashMessagesFromSession () | |
getUserByContext () | |
Protected Attributes | |
$identifier | |
A class which collects and renders flash messages.
Definition at line 22 of file FlashMessageQueue.php.
__construct | ( | $identifier | ) |
string | $identifier | The unique identifier for this queue |
Definition at line 34 of file FlashMessageQueue.php.
References FlashMessageQueue\$identifier.
|
protected |
Adds the given flash message to the array of flash messages that will be stored in the session.
FlashMessage | $message |
Definition at line 94 of file FlashMessageQueue.php.
References FlashMessageQueue\getFlashMessagesFromSession(), and FlashMessageQueue\storeFlashMessagesInSession().
Referenced by FlashMessageQueue\enqueue().
addMessage | ( | FlashMessage | $message | ) |
FlashMessage | $message |
Definition at line 74 of file FlashMessageQueue.php.
References FlashMessageQueue\enqueue().
clear | ( | $severity = null | ) |
Removes all items from the queue
int | $severity | Optional severity, must be one of constants |
Definition at line 243 of file FlashMessageQueue.php.
Referenced by FlashMessageQueue\getAllMessagesAndFlush().
dequeue | ( | ) |
Definition at line 82 of file FlashMessageQueue.php.
enqueue | ( | $message | ) |
Adds a message either to the BE_USER session (if the $message has the storeInSession flag set) or it enqueues the message.
FlashMessage | $message | Instance of , representing a message |
\TYPO3\CMS\Core\Exception |
Definition at line 55 of file FlashMessageQueue.php.
References FlashMessageQueue\addFlashMessageToSession().
Referenced by FlashMessageQueue\addMessage().
getAllMessages | ( | $severity = null | ) |
Returns all messages from the current PHP session and from the current request.
int | $severity | Optional severity, must be one of constants |
Definition at line 107 of file FlashMessageQueue.php.
References FlashMessageQueue\getFlashMessagesFromSession(), and FlashMessageQueue\toArray().
Referenced by FlashMessageQueue\getAllMessagesAndFlush().
getAllMessagesAndFlush | ( | $severity = null | ) |
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.
int | $severity | Optional severity, must be one of constants |
Definition at line 133 of file FlashMessageQueue.php.
References FlashMessageQueue\clear(), FlashMessageQueue\getAllMessages(), and FlashMessageQueue\removeAllFlashMessagesFromSession().
Referenced by FlashMessageQueue\renderFlashMessages().
|
protected |
Returns current flash messages from the session, making sure to always return an array.
Definition at line 181 of file FlashMessageQueue.php.
References FlashMessageQueue\getUserByContext().
Referenced by FlashMessageQueue\addFlashMessageToSession(), FlashMessageQueue\getAllMessages(), and FlashMessageQueue\removeAllFlashMessagesFromSession().
getIdentifier | ( | ) |
Definition at line 42 of file FlashMessageQueue.php.
References FlashMessageQueue\$identifier.
|
protected |
Gets user object by context
Definition at line 192 of file FlashMessageQueue.php.
References $GLOBALS.
Referenced by FlashMessageQueue\getFlashMessagesFromSession(), and FlashMessageQueue\storeFlashMessagesInSession().
|
protected |
Removes all flash messages from the session
int | $severity | Optional severity, must be one of constants |
Definition at line 160 of file FlashMessageQueue.php.
References FlashMessageQueue\getFlashMessagesFromSession(), and FlashMessageQueue\storeFlashMessagesInSession().
Referenced by FlashMessageQueue\getAllMessagesAndFlush().
renderFlashMessages | ( | ) |
Fetches and renders all available flash messages from the queue.
Definition at line 202 of file FlashMessageQueue.php.
References FlashMessageQueue\getAllMessagesAndFlush().
|
protected |
Stores given flash messages in the session
FlashMessage[] | $flashMessages |
Definition at line 149 of file FlashMessageQueue.php.
References FlashMessageQueue\getUserByContext().
Referenced by FlashMessageQueue\addFlashMessageToSession(), and FlashMessageQueue\removeAllFlashMessagesFromSession().
toArray | ( | ) |
Returns all items of the queue as array
Definition at line 226 of file FlashMessageQueue.php.
Referenced by FlashMessageQueue\getAllMessages().
|
protected |
Definition at line 29 of file FlashMessageQueue.php.
Referenced by FlashMessageQueue\__construct(), and FlashMessageQueue\getIdentifier().