Helper to proxy the plugin flash messenger. More...

Public Member Functions
	__invoke ($namespace=null)
	Returns the flash messenger plugin controller.

	__call ($method, $argv)
	Proxy the flash messenger plugin controller.

	render ($namespace= 'default', array $classes=[], $autoEscape=null)
	Render Messages.

	renderCurrent ($namespace= 'default', array $classes=[], $autoEscape=null)
	Render Current Messages.

	setAutoEscape ($autoEscape=true)
	Set whether or not auto escaping should be used.

	getAutoEscape ()
	Return whether auto escaping is enabled or disabled.

	setMessageCloseString ($messageCloseString)
	Set the string used to close message representation.

	getMessageCloseString ()
	Get the string used to close message representation.

	setMessageOpenFormat ($messageOpenFormat)
	Set the formatted string used to open message representation.

	getMessageOpenFormat ()
	Get the formatted string used to open message representation.

	setMessageSeparatorString ($messageSeparatorString)
	Set the string used to separate messages.

	getMessageSeparatorString ()
	Get the string used to separate messages.

	setPluginFlashMessenger ($pluginFlashMessenger)
	Set the flash messenger plugin.

	getPluginFlashMessenger ()
	Get the flash messenger plugin.

Public Member Functions inherited from AbstractHelper
	setView (Renderer $view)
	Set the View object.

	getView ()
	Get the view object.

Protected Member Functions
	renderMessages ($namespace= 'default', array $messages=[], array $classes=[], $autoEscape=null)
	Render Messages.

	getEscapeHtmlHelper ()
	Retrieve the escapeHtml helper.

Protected Attributes
	$classMessages

	$messageCloseString = '</li></ul>'

	$messageOpenFormat = '<ul%s><li>'

	$messageSeparatorString = '</li><li>'

	$autoEscape = true

	$escapeHtmlHelper

	$pluginFlashMessenger

Protected Attributes inherited from AbstractHelper
	$view = null

Detailed Description

Helper to proxy the plugin flash messenger.

Duck-types against Zend.

Deprecated:: This helper will be removed in version 3.0 of this component. At that time, it will be available in zendframework/zend-mvc-plugin-flashmessenger.

Member Function Documentation

__call	(	$method,
		$argv
	)

Proxy the flash messenger plugin controller.

Parameters

string	$method
array	$argv

Returns: mixed

__invoke ( $namespace = null )

Returns the flash messenger plugin controller.

Parameters

string | null $namespace

Returns: FlashMessenger|V2PluginFlashMessenger|PluginFlashMessenger

getAutoEscape ( )

Return whether auto escaping is enabled or disabled.

return bool

getEscapeHtmlHelper ( )

protected

Retrieve the escapeHtml helper.

Returns: EscapeHtml

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

render	(		$namespace = `'default'`,
		array	$classes = `[]`,
			$autoEscape = `null`
	)

Render Messages.

Parameters

string	$namespace
array	$classes
null \| bool	$autoEscape

Returns: string

renderCurrent	(		$namespace = `'default'`,
		array	$classes = `[]`,
			$autoEscape = `null`
	)

Render Current Messages.

Parameters

string	$namespace
array	$classes
bool \| null	$autoEscape

Returns: string

renderMessages	(		$namespace = `'default'`,
		array	$messages = `[]`,
		array	$classes = `[]`,
			$autoEscape = `null`
	)

protected

Render Messages.

Parameters

string	$namespace
array	$messages
array	$classes
bool \| null	$autoEscape

Returns: string

setAutoEscape ( $autoEscape = true )

Set whether or not auto escaping should be used.

Parameters

bool $autoEscape

Returns: self

setMessageCloseString ( $messageCloseString )

Set the string used to close message representation.

Parameters

string $messageCloseString

Returns: FlashMessenger

setMessageOpenFormat ( $messageOpenFormat )

Set the formatted string used to open message representation.

Parameters

string $messageOpenFormat

Returns: FlashMessenger

setMessageSeparatorString ( $messageSeparatorString )

Set the string used to separate messages.

Parameters

string $messageSeparatorString

Returns: FlashMessenger

setPluginFlashMessenger ( $pluginFlashMessenger )

Set the flash messenger plugin.

Parameters

V2PluginFlashMessenger | PluginFlashMessenger $pluginFlashMessenger

Returns: FlashMessenger

Exceptions

InvalidArgumentException for an invalid $pluginFlashMessenger

Member Data Documentation

$autoEscape = true

protected

$classMessages

protected

Initial value:

= [

'info' => 'info'

$escapeHtmlHelper

protected

$messageCloseString = '</li></ul>'

protected

$messageOpenFormat = '<ul%s><li>'

protected

$messageSeparatorString = '</li><li>'

protected

$pluginFlashMessenger

protected

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation