Zend Framework
Back to top  

Helper to proxy the plugin flash messenger

 Methods

Proxy the flash messenger plugin controller

__call(string $method, array $argv) : mixed

Parameters

$method

string

$argv

array

Returns

mixed

Returns the flash messenger plugin controller

__invoke(string | null $namespace) : \Zend\View\Helper\FlashMessenger | \Zend\Mvc\Controller\Plugin\FlashMessenger

Parameters

$namespace

stringnull

Returns

\Zend\View\Helper\FlashMessenger\Zend\Mvc\Controller\Plugin\FlashMessenger

Return whether auto escaping is enabled or disabled

getAutoEscape() 

return bool

Get the string used to close message representation

getMessageCloseString() : string

Returns

string

Get the formatted string used to open message representation

getMessageOpenFormat() : string

Returns

string

Get the string used to separate messages

getMessageSeparatorString() : string

Returns

string

Get the flash messenger plugin

getPluginFlashMessenger() : \Zend\Mvc\Controller\Plugin\FlashMessenger

Returns

\Zend\Mvc\Controller\Plugin\FlashMessenger

Get the service locator.

getServiceLocator() : \Zend\ServiceManager\ServiceLocatorInterface

Returns

\Zend\ServiceManager\ServiceLocatorInterface

Returns translator used in helper

getTranslator() : \Zend\I18n\Translator\TranslatorInterface | null
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::getTranslator()

Returns

\Zend\I18n\Translator\TranslatorInterfacenull

Return the translation text domain

getTranslatorTextDomain() : string
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::getTranslatorTextDomain()

Returns

string

Get the view object

getView() : null | \Zend\View\Renderer\RendererInterface
Inherited

inherited_from \Zend\View\Helper\AbstractHelper::getView()
inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::getView()

Returns

null\Zend\View\Renderer\RendererInterface

Checks if the helper has a translator

hasTranslator() : bool
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::hasTranslator()

Returns

bool

Returns whether translator is enabled and should be used

isTranslatorEnabled() : bool
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::isTranslatorEnabled()

Returns

bool

Render Messages

render(string $namespace, array $classes, null | bool $autoEscape) : string

Parameters

$namespace

string

$classes

array

$autoEscape

nullbool

Returns

string

Render Current Messages

renderCurrent(string $namespace, array $classes, bool | null $autoEscape) : string

Parameters

$namespace

string

$classes

array

$autoEscape

boolnull

Returns

string

Set whether or not auto escaping should be used

setAutoEscape(bool $autoEscape) : \Zend\View\Helper\self

Parameters

$autoEscape

bool

Returns

\Zend\View\Helper\self

Set the string used to close message representation

setMessageCloseString(string $messageCloseString) : \Zend\View\Helper\FlashMessenger

Parameters

$messageCloseString

string

Returns

\Zend\View\Helper\FlashMessenger

Set the formatted string used to open message representation

setMessageOpenFormat(string $messageOpenFormat) : \Zend\View\Helper\FlashMessenger

Parameters

$messageOpenFormat

string

Returns

\Zend\View\Helper\FlashMessenger

Set the string used to separate messages

setMessageSeparatorString(string $messageSeparatorString) : \Zend\View\Helper\FlashMessenger

Parameters

$messageSeparatorString

string

Returns

\Zend\View\Helper\FlashMessenger

Set the flash messenger plugin

setPluginFlashMessenger(\Zend\Mvc\Controller\Plugin\FlashMessenger $pluginFlashMessenger) : \Zend\View\Helper\FlashMessenger

Parameters

$pluginFlashMessenger

\Zend\Mvc\Controller\Plugin\FlashMessenger

Returns

\Zend\View\Helper\FlashMessenger

Set the service locator.

setServiceLocator(\Zend\ServiceManager\ServiceLocatorInterface $serviceLocator) : \Zend\View\Helper\AbstractHelper

Parameters

$serviceLocator

\Zend\ServiceManager\ServiceLocatorInterface

Returns

\Zend\View\Helper\AbstractHelper

Sets translator to use in helper

setTranslator(\Zend\I18n\Translator\TranslatorInterface $translator, string $textDomain) : \Zend\I18n\View\Helper\AbstractTranslatorHelper
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::setTranslator()

Parameters

$translator

\Zend\I18n\Translator\TranslatorInterface

[optional] translator. Default is null, which sets no translator.

$textDomain

string

[optional] text domain Default is null, which skips setTranslatorTextDomain

Returns

\Zend\I18n\View\Helper\AbstractTranslatorHelper

Sets whether translator is enabled and should be used

setTranslatorEnabled(bool $enabled) : \Zend\I18n\View\Helper\AbstractTranslatorHelper
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::setTranslatorEnabled()

Parameters

$enabled

bool

Returns

\Zend\I18n\View\Helper\AbstractTranslatorHelper

Set translation text domain

setTranslatorTextDomain(string $textDomain) : \Zend\I18n\View\Helper\AbstractTranslatorHelper
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::setTranslatorTextDomain()

Parameters

$textDomain

string

Returns

\Zend\I18n\View\Helper\AbstractTranslatorHelper

Set the View object

setView(\Zend\View\Renderer\RendererInterface $view) : \Zend\View\Helper\AbstractHelper
Inherited

inherited_from \Zend\View\Helper\AbstractHelper::setView()
inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::setView()

Parameters

$view

\Zend\View\Renderer\RendererInterface

Returns

\Zend\View\Helper\AbstractHelper

Retrieve the escapeHtml helper

getEscapeHtmlHelper() : \Zend\View\Helper\EscapeHtml

Returns

\Zend\View\Helper\EscapeHtml

Render Messages

renderMessages(string $namespace, array $messages, array $classes, bool | null $autoEscape) : string

Parameters

$namespace

string

$messages

array

$classes

array

$autoEscape

boolnull

Returns

string

 Properties

 

Flag whether to escape messages

$autoEscape : bool

 

Default attributes for the open format tag

$classMessages : array

 

Html escape helper

$escapeHtmlHelper : \Zend\View\Helper\EscapeHtml

 

Templates for the open/close/separators for message tags

$messageCloseString : string

 

$messageOpenFormat

$messageOpenFormat 

 

$messageSeparatorString

$messageSeparatorString 

 

Flash messenger plugin

$pluginFlashMessenger : \Zend\Mvc\Controller\Plugin\FlashMessenger

 

Service locator

$serviceLocator : \Zend\ServiceManager\ServiceLocatorInterface

 

Translator (optional)

$translator : \Zend\I18n\Translator\TranslatorInterface
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::$$translator
 

Whether translator should be used

$translatorEnabled : bool
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::$$translatorEnabled
 

Translator text domain (optional)

$translatorTextDomain : string
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::$$translatorTextDomain
 

View object instance

$view : \Zend\View\Renderer\RendererInterface
Inherited

inherited_from \Zend\View\Helper\AbstractHelper::$$view
inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::$$view