Zend\View\Helper\FlashMessenger
Helper to proxy the plugin flash messenger
Synopsis
class FlashMessenger
extends AbstractTranslatorHelper
implements
ServiceLocatorAwareInterface
{
- // members
- protected array $classMessages;
- protected string $messageCloseString;
- protected string $messageOpenFormat;
- protected string $messageSeparatorString;
- protected EscapeHtml $escapeHtmlHelper;
- protected FlashMessenger $pluginFlashMessenger;
- protected ServiceLocatorInterface $serviceLocator;
- // Inherited members from AbstractTranslatorHelper
- protected TranslatorInterface $translator;
- protected string $translatorTextDomain;
- protected bool $translatorEnabled;
- // Inherited members from AbstractHelper
- protected RendererInterface $view;
- // methods
- public FlashMessenger|PluginFlashMessenger __invoke()
- public mixed __call()
- public string render()
- public string renderCurrent()
- protected string renderMessages()
- public FlashMessenger setMessageCloseString()
- public string getMessageCloseString()
- public FlashMessenger setMessageOpenFormat()
- public string getMessageOpenFormat()
- public FlashMessenger setMessageSeparatorString()
- public string getMessageSeparatorString()
- public FlashMessenger setPluginFlashMessenger()
- public FlashMessenger getPluginFlashMessenger()
- public AbstractHelper setServiceLocator()
- public ServiceLocatorInterface getServiceLocator()
- protected EscapeHtml getEscapeHtmlHelper()
- // Inherited methods from AbstractTranslatorHelper
- public AbstractTranslatorHelper setTranslator()
- public Translator|null getTranslator()
- public bool hasTranslator()
- public AbstractTranslatorHelper setTranslatorEnabled()
- public bool isTranslatorEnabled()
- public AbstractTranslatorHelper setTranslatorTextDomain()
- public string getTranslatorTextDomain()
- // Inherited methods from AbstractHelper
- public AbstractHelper setView()
- public null|Renderer getView()
Hierarchy
Extends
Implements
Members
protected
- $classMessages
—
array
Default attributes for the open format tag - $escapeHtmlHelper
—
Zend\View\Helper\EscapeHtml
Html escape helper - $messageCloseString
—
string
Templates for the open/close/separators for message tags - $messageOpenFormat
- $messageSeparatorString
- $pluginFlashMessenger
—
Zend\Mvc\Controller\Plugin\FlashMessenger
Flash messenger plugin - $serviceLocator
—
Zend\ServiceManager\ServiceLocatorInterface
Service locator - $translator
—
Zend\I18n\Translator\TranslatorInterface
Translator (optional) - $translatorEnabled
—
Zend\I18n\View\Helper\bool
Whether translator should be used - $translatorTextDomain
—
string
Translator text domain (optional) - $view
—
Zend\View\Renderer\RendererInterface
View object instance
Methods
protected
- getEscapeHtmlHelper() — Retrieve the escapeHtml helper
- renderMessages() — Render Messages
public
- __call() — Proxy the flash messenger plugin controller
- __invoke() — Returns the flash messenger plugin controller
- getMessageCloseString() — Get the string used to close message representation
- getMessageOpenFormat() — Get the formatted string used to open message representation
- getMessageSeparatorString() — Get the string used to separate messages
- getPluginFlashMessenger() — Get the flash messenger plugin
- getServiceLocator() — Get the service locator.
- render() — Render Messages
- renderCurrent() — Render Current Messages
- setMessageCloseString() — Set the string used to close message representation
- setMessageOpenFormat() — Set the formatted string used to open message representation
- setMessageSeparatorString() — Set the string used to separate messages
- setPluginFlashMessenger() — Set the flash messenger plugin
- setServiceLocator() — Set the service locator.
Inherited from Zend\I18n\View\Helper\AbstractTranslatorHelper
public
- getTranslator() — Returns translator used in helper
- getTranslatorTextDomain() — Return the translation text domain
- hasTranslator() — Checks if the helper has a translator
- isTranslatorEnabled() — Returns whether translator is enabled and should be used
- setTranslator() — Sets translator to use in helper
- setTranslatorEnabled() — Sets whether translator is enabled and should be used
- setTranslatorTextDomain() — Set translation text domain