Zend\Mvc\Controller\Plugin\FlashMessenger
Flash Messenger - implement session-based messages
Synopsis
class FlashMessenger
extends AbstractPlugin
implements
IteratorAggregate,Countable
{
- // constants
- const NAMESPACE_DEFAULT = 'default';
- const NAMESPACE_SUCCESS = 'success';
- const NAMESPACE_WARNING = 'warning';
- const NAMESPACE_ERROR = 'error';
- const NAMESPACE_INFO = 'info';
- // members
- protected Container $container;
- protected array $messages;
- protected ManagerInterface $session;
- protected bool $messageAdded;
- protected string $namespace;
- // Inherited members from AbstractPlugin
- protected null|Dispatchable $controller;
- // methods
- public FlashMessenger setSessionManager()
- public ManagerInterface getSessionManager()
- public Container getContainer()
- public FlashMessenger setNamespace()
- public string getNamespace()
- public FlashMessenger addMessage()
- public FlashMessenger addInfoMessage()
- public FlashMessenger addSuccessMessage()
- public FlashMessenger addWarningMessage()
- public FlashMessenger addErrorMessage()
- public bool hasMessages()
- public bool hasInfoMessages()
- public bool hasSuccessMessages()
- public bool hasWarningMessages()
- public bool hasErrorMessages()
- public array getMessages()
- public array getInfoMessages()
- public array getSuccessMessages()
- public array getWarningMessages()
- public array getErrorMessages()
- public bool clearMessages()
- public bool clearMessagesFromNamespace()
- public bool clearMessagesFromContainer()
- public bool hasCurrentMessages()
- public bool hasCurrentInfoMessages()
- public bool hasCurrentSuccessMessages()
- public bool hasCurrentWarningMessages()
- public bool hasCurrentErrorMessages()
- public array getCurrentMessages()
- public array getCurrentInfoMessages()
- public array getCurrentSuccessMessages()
- public array getCurrentWarningMessages()
- public array getCurrentErrorMessages()
- public array getCurrentMessagesFromNamespace()
- public bool clearCurrentMessages()
- public bool clearCurrentMessagesFromNamespace()
- public bool clearCurrentMessagesFromContainer()
- public ArrayIterator getIterator()
- public int count()
- public array getMessagesFromNamespace()
- protected void getMessagesFromContainer()
- // Inherited methods from AbstractPlugin
- public void setController()
- public null|Dispatchable getController()
Hierarchy
Constants
Name | Value |
---|---|
NAMESPACE_DEFAULT | 'default' |
NAMESPACE_SUCCESS | 'success' |
NAMESPACE_WARNING | 'warning' |
NAMESPACE_ERROR | 'error' |
NAMESPACE_INFO | 'info' |
Members
protected
- $container — Zend\Session\Container
- $controller — Zend\Mvc\Controller\Plugin\null|Dispatchable
- $messageAdded
—
Zend\Mvc\Controller\Plugin\bool
Whether a message has been added during this request - $messages
—
array
Messages from previous request - $namespace
—
string
Instance namespace, default is 'default' - $session — Zend\Session\ManagerInterface
Methods
protected
- getMessagesFromContainer() — Pull messages from the session container
public
- addErrorMessage() — Add a message with "error" type
- addInfoMessage() — Add a message with "info" type
- addMessage() — Add a message
- addSuccessMessage() — Add a message with "success" type
- addWarningMessage() — Add a message with "warning" type
- clearCurrentMessages() — Clear messages from the current request and current namespace
- clearCurrentMessagesFromContainer() — Clear messages from the container
- clearCurrentMessagesFromNamespace() — Clear messages from the current namespace
- clearMessages() — Clear all messages from the previous request & current namespace
- clearMessagesFromContainer() — Clear all messages from the container
- clearMessagesFromNamespace() — Clear all messages from specific namespace
- count() — Complete the countable interface
- getContainer() — Get session container for flash messages
- getCurrentErrorMessages() — Get messages that have been added to the "error" namespace within this request
- getCurrentInfoMessages() — Get messages that have been added to the "info" namespace within this request
- getCurrentMessages() — Get messages that have been added to the current namespace within this request
- getCurrentMessagesFromNamespace() — Get messages that have been added to the current namespace in specific namespace
- getCurrentSuccessMessages() — Get messages that have been added to the "success" namespace within this request
- getCurrentWarningMessages() — Get messages that have been added to the "warning" namespace within this request
- getErrorMessages() — Get messages from "error" namespace
- getInfoMessages() — Get messages from "info" namespace
- getIterator() — Complete the IteratorAggregate interface, for iterating
- getMessages() — Get messages from a specific namespace
- getMessagesFromNamespace() — Get messages from a specific namespace
- getNamespace() — Get the message namespace
- getSessionManager() — Retrieve the session manager
- getSuccessMessages() — Get messages from "success" namespace
- getWarningMessages() — Get messages from "warning" namespace
- hasCurrentErrorMessages() — Check to see if messages have been added to "error" namespace within this request
- hasCurrentInfoMessages() — Check to see if messages have been added to "info" namespace within this request
- hasCurrentMessages() — Check to see if messages have been added to the current namespace within this request
- hasCurrentSuccessMessages() — Check to see if messages have been added to "success" namespace within this request
- hasCurrentWarningMessages() — Check to see if messages have been added to "warning" namespace within this request
- hasErrorMessages() — Whether "error" namespace has messages
- hasInfoMessages() — Whether "info" namespace has messages
- hasMessages() — Whether a specific namespace has messages
- hasSuccessMessages() — Whether "success" namespace has messages
- hasWarningMessages() — Whether "warning" namespace has messages
- setNamespace() — Change the namespace messages are added to
- setSessionManager() — Set the session manager
Inherited from Zend\Mvc\Controller\Plugin\AbstractPlugin
public
- getController() — Get the current controller instance
- setController() — Set the current controller instance