View helper for translating messages.

category Zend
package Zend_I18n
subpackage View

 Methods

Translate a message.

__invoke(string $message, string $textDomain, string $locale) : string

Parameters

$message

string

$textDomain

string

$locale

string

Exceptions

\Zend\I18n\Exception\RuntimeException

Returns

string

Returns translator used in helper

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

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

Returns

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

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

Sets translator to use in helper

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

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

Parameters

$translator

\Zend\I18n\Translator\Translator

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

$textDomain

string

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

Returns

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

[optional] whether translator should be used. Default is true.

Returns

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

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

Returns

 Properties

 

Translator (optional)

$translator : \Zend\I18n\Translator\Translator
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

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

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