FlashMessages
Flash Messages - implement messages based on session.
Table of Contents
- TYPE_DEFAULT = 'default'
- Default type messages.
- TYPE_ERROR = 'error'
- Error type messages.
- TYPE_INFO = 'info'
- Info type messages.
- TYPE_SUCCESS = 'success'
- Success type messages.
- TYPE_WARNING = 'warning'
- Warning type messages.
- TYPES = [self::TYPE_DEFAULT, self::TYPE_SUCCESS, self::TYPE_WARNING, self::TYPE_ERROR, self::TYPE_INFO]
- Array of all types of messages.
- $messageAdded : bool
- Whether a message has been added during this request.
- $messages : array<string|int, mixed>
- Messages of request.
- $session : ManagerInterface
- $sessionContainer : Container
- addErrorMessage() : FlashMessages
- Add a "error" message.
- addInfoMessage() : FlashMessages
- Add a "info" message.
- addMessage() : FlashMessages
- Add message.
- addSuccessMessage() : FlashMessages
- Add a "success" message.
- addWarningMessage() : FlashMessages
- Add a "warning" message.
- clearMessagesFromContainer() : bool
- Clear all messages from the container.
- getContainer() : Container
- Get container for flash messages.
- getMessages() : array<string|int, mixed>
- Get all current messages.
- getSessionManager() : ManagerInterface
- Get the session manager.
- hasMessages() : bool
- Whether a specific namespace has messages.
- setSessionManager() : FlashMessages
- Set the session manager.
- getMessagesFromContainer() : void
- Pull messages from the session container.
Constants
TYPE_DEFAULT
Default type messages.
public
mixed
TYPE_DEFAULT
= 'default'
TYPE_ERROR
Error type messages.
public
mixed
TYPE_ERROR
= 'error'
TYPE_INFO
Info type messages.
public
mixed
TYPE_INFO
= 'info'
TYPE_SUCCESS
Success type messages.
public
mixed
TYPE_SUCCESS
= 'success'
TYPE_WARNING
Warning type messages.
public
mixed
TYPE_WARNING
= 'warning'
TYPES
Array of all types of messages.
public
mixed
TYPES
= [self::TYPE_DEFAULT, self::TYPE_SUCCESS, self::TYPE_WARNING, self::TYPE_ERROR, self::TYPE_INFO]
Properties
$messageAdded
Whether a message has been added during this request.
protected
bool
$messageAdded
= false
$messages
Messages of request.
protected
array<string|int, mixed>
$messages
= []
$session
protected
ManagerInterface
$session
$sessionContainer
protected
Container
$sessionContainer
Methods
addErrorMessage()
Add a "error" message.
public
addErrorMessage(array<string|int, mixed>|string $message) : FlashMessages
Parameters
- $message : array<string|int, mixed>|string
Return values
FlashMessages —addInfoMessage()
Add a "info" message.
public
addInfoMessage(array<string|int, mixed>|string $message) : FlashMessages
Parameters
- $message : array<string|int, mixed>|string
Return values
FlashMessages —addMessage()
Add message.
public
addMessage(array<string|int, mixed>|string $message[, string $type = null ]) : FlashMessages
Parameters
- $message : array<string|int, mixed>|string
- $type : string = null
Return values
FlashMessages —addSuccessMessage()
Add a "success" message.
public
addSuccessMessage(array<string|int, mixed>|string $message) : FlashMessages
Parameters
- $message : array<string|int, mixed>|string
Return values
FlashMessages —addWarningMessage()
Add a "warning" message.
public
addWarningMessage(array<string|int, mixed>|string $message) : FlashMessages
Parameters
- $message : array<string|int, mixed>|string
Return values
FlashMessages —clearMessagesFromContainer()
Clear all messages from the container.
public
clearMessagesFromContainer() : bool
Return values
bool —True if messages were cleared, false if none existed
getContainer()
Get container for flash messages.
public
getContainer() : Container
Return values
Container —getMessages()
Get all current messages.
public
getMessages([string|null $type = null ]) : array<string|int, mixed>
Parameters
- $type : string|null = null
Return values
array<string|int, mixed> —getSessionManager()
Get the session manager.
public
getSessionManager() : ManagerInterface
Return values
ManagerInterface —hasMessages()
Whether a specific namespace has messages.
public
hasMessages(string $type) : bool
Parameters
- $type : string
Return values
bool —setSessionManager()
Set the session manager.
public
setSessionManager(ManagerInterface $manager) : FlashMessages
Parameters
- $manager : ManagerInterface
Return values
FlashMessages —getMessagesFromContainer()
Pull messages from the session container.
protected
getMessagesFromContainer() : void
Iterates through the session container, removing messages into the local scope.