Class FlashMessenger

Summary

Fully Qualified Name: Laminas\View\Helper\FlashMessenger
Extends: AbstractHelper

Description

Helper to proxy the plugin flash messenger

Duck-types against Laminas\I18n\Translator\TranslatorAwareInterface.

Methods

Name Description Defined By
__call() Proxy the flash messenger plugin controller FlashMessenger
__invoke() Returns the flash messenger plugin controller FlashMessenger
getAutoEscape() Return whether auto escaping is enabled or disabled FlashMessenger
getMessageCloseString() Get the string used to close message representation FlashMessenger
getMessageOpenFormat() Get the formatted string used to open message representation FlashMessenger
getMessageSeparatorString() Get the string used to separate messages FlashMessenger
getPluginFlashMessenger() Get the flash messenger plugin FlashMessenger
getView() Get the view object AbstractHelper
render() Render Messages FlashMessenger
renderCurrent() Render Current Messages FlashMessenger
setAutoEscape() Set whether or not auto escaping should be used FlashMessenger
setMessageCloseString() Set the string used to close message representation FlashMessenger
setMessageOpenFormat() Set the formatted string used to open message representation FlashMessenger
setMessageSeparatorString() Set the string used to separate messages FlashMessenger
setPluginFlashMessenger() Set the flash messenger plugin FlashMessenger
setView() Set the View object AbstractHelper

Method Details

__call()

Proxy the flash messenger plugin controller

Parameter Name Type Description
$method string
$argv array

Returns: mixed

__invoke()

Returns the flash messenger plugin controller

Parameter Name Type Description
$namespace string|null

Returns: \FlashMessenger|\V2PluginFlashMessenger|\PluginFlashMessenger

getAutoEscape()

Return whether auto escaping is enabled or disabled

return bool

Returns:

getMessageCloseString()

Get the string used to close message representation

Returns: string

getMessageOpenFormat()

Get the formatted string used to open message representation

Returns: string

getMessageSeparatorString()

Get the string used to separate messages

Returns: string

getPluginFlashMessenger()

Get the flash messenger plugin

Returns: \V2PluginFlashMessenger|\PluginFlashMessenger

getView()

Get the view object

Returns: null|\Renderer

render()

Render Messages

Parameter Name Type Description
$namespace string
$classes array
$autoEscape null|bool

Returns: string

renderCurrent()

Render Current Messages

Parameter Name Type Description
$namespace string
$classes array
$autoEscape bool|null

Returns: string

setAutoEscape()

Set whether or not auto escaping should be used

Parameter Name Type Description
$autoEscape bool

Returns: self

setMessageCloseString()

Set the string used to close message representation

Parameter Name Type Description
$messageCloseString string

Returns: \FlashMessenger

setMessageOpenFormat()

Set the formatted string used to open message representation

Parameter Name Type Description
$messageOpenFormat string

Returns: \FlashMessenger

setMessageSeparatorString()

Set the string used to separate messages

Parameter Name Type Description
$messageSeparatorString string

Returns: \FlashMessenger

setPluginFlashMessenger()

Set the flash messenger plugin

Parameter Name Type Description
$pluginFlashMessenger \V2PluginFlashMessenger|\PluginFlashMessenger

Returns: \FlashMessenger

setView()

Set the View object

Parameter Name Type Description
$view \Renderer

Returns: \AbstractHelper

Top