1428. Class¶

1428.1. Zend\Mvc\Controller\Plugin\FlashMessenger¶

Flash Messenger - implement session-based messages

1428.1.1. Methods¶

1428.1.1.1. setSessionManager¶

setSessionManager()¶

Set the session manager

Parameters:	Manager –
Return type:	FlashMessenger

1428.1.1.2. getSessionManager¶

getSessionManager()¶

Retrieve the session manager

If none composed, lazy-loads a SessionManager instance

Return type:	Manager

1428.1.1.3. getContainer¶

getContainer()¶

Get session container for flash messages

Return type:	Container

1428.1.1.4. setNamespace¶

setNamespace()¶

Change the namespace messages are added to

Useful for per action controller messaging between requests

Parameters:	string –
Return type:	FlashMessenger Provides a fluent interface

1428.1.1.5. getNamespace¶

getNamespace()¶

Get the message namespace

Return type:	string

1428.1.1.6. addMessage¶

addMessage()¶

Add a message

Parameters:	string –
Return type:	FlashMessenger Provides a fluent interface

1428.1.1.7. addInfoMessage¶

addInfoMessage()¶

Add a message with “info” type

Parameters:	string –
Return type:	FlashMessenger

1428.1.1.8. addSuccessMessage¶

addSuccessMessage()¶

Add a message with “success” type

Parameters:	string –
Return type:	FlashMessenger

1428.1.1.9. addErrorMessage¶

addErrorMessage()¶

Add a message with “error” type

Parameters:	string –
Return type:	FlashMessenger

1428.1.1.10. hasMessages¶

hasMessages()¶

Whether a specific namespace has messages

Return type:	bool

1428.1.1.11. hasInfoMessages¶

hasInfoMessages()¶

Whether “info” namespace has messages

Return type:	boolean

1428.1.1.12. hasSuccessMessages¶

hasSuccessMessages()¶

Whether “success” namespace has messages

Return type:	boolean

1428.1.1.13. hasErrorMessages¶

hasErrorMessages()¶

Whether “error” namespace has messages

Return type:	boolean

1428.1.1.14. getMessages¶

getMessages()¶

Get messages from a specific namespace

Return type:	array

1428.1.1.15. getInfoMessages¶

getInfoMessages()¶

Get messages from “info” namespace

Return type:	array

1428.1.1.16. getSuccessMessages¶

getSuccessMessages()¶

Get messages from “success” namespace

Return type:	array

1428.1.1.17. getErrorMessages¶

getErrorMessages()¶

Get messages from “error” namespace

Return type:	array

1428.1.1.18. clearMessages¶

clearMessages()¶

Clear all messages from the previous request & current namespace

Return type:	bool True if messages were cleared, false if none existed

1428.1.1.19. clearMessagesFromNamespace¶

clearMessagesFromNamespace()¶

Clear all messages from specific namespace

Return type:	boolean True if messages were cleared, false if none existed

1428.1.1.20. clearMessagesFromContainer¶

clearMessagesFromContainer()¶

Clear all messages from the container

Return type:	boolean True if messages were cleared, false if none existed

1428.1.1.21. hasCurrentMessages¶

hasCurrentMessages()¶

Check to see if messages have been added to the current namespace within this request

Return type:	bool

1428.1.1.22. hasCurrentInfoMessages¶

hasCurrentInfoMessages()¶

Check to see if messages have been added to “info” namespace within this request

Return type:	boolean

1428.1.1.23. hasCurrentSuccessMessages¶

hasCurrentSuccessMessages()¶

Check to see if messages have been added to “success” namespace within this request

Return type:	boolean

1428.1.1.24. hasCurrentErrorMessages¶

hasCurrentErrorMessages()¶

Check to see if messages have been added to “error” namespace within this request

Return type:	boolean

1428.1.1.25. getCurrentMessages¶

getCurrentMessages()¶

Get messages that have been added to the current namespace within this request

Return type:	array

1428.1.1.26. getCurrentInfoMessages¶

getCurrentInfoMessages()¶

Get messages that have been added to the “info” namespace within this request

Return type:	array

1428.1.1.27. getCurrentSuccessMessages¶

getCurrentSuccessMessages()¶

Get messages that have been added to the “success” namespace within this request

Return type:	array

1428.1.1.28. getCurrentErrorMessages¶

getCurrentErrorMessages()¶

Get messages that have been added to the “error” namespace within this request

Return type:	array

1428.1.1.29. getCurrentMessagesFromNamespace¶

getCurrentMessagesFromNamespace()¶

Get messages that have been added to the current namespace in specific namespace

Return type:	array

1428.1.1.30. clearCurrentMessages¶

clearCurrentMessages()¶

Clear messages from the current request and current namespace

Return type:	bool

1428.1.1.31. clearCurrentMessagesFromNamespace¶

clearCurrentMessagesFromNamespace()¶

Clear messages from the current namespace

Return type:	boolean

1428.1.1.32. clearCurrentMessagesFromContainer¶

clearCurrentMessagesFromContainer()¶

Clear messages from the container

Return type:	boolean

1428.1.1.33. getIterator¶

getIterator()¶

Complete the IteratorAggregate interface, for iterating

Return type:	ArrayIterator

1428.1.1.34. count¶

count()

Complete the countable interface

Return type:	int

1428.1.1.35. getMessagesFromNamespace¶

getMessagesFromNamespace()¶

Get messages from a specific namespace

Return type:	array

1428.1.1.36. getMessagesFromContainer¶

getMessagesFromContainer()¶

Pull messages from the session container

Iterates through the session container, removing messages into the local scope.

Return type:	void

1428.1.2. Constants¶

1428.1.2.1. NAMESPACE_DEFAULT¶

Default messages namespace

1428.1.2.2. NAMESPACE_SUCCESS¶

Success messages namespace

1428.1.2.3. NAMESPACE_ERROR¶

Error messages namespace

1428.1.2.4. NAMESPACE_INFO¶

Info messages namespace

Navigation