Zend Framework  3.0
Public Member Functions | List of all members
TranslatorAwareInterface Interface Reference

Public Member Functions

 setTranslator (TranslatorInterface $translator=null, $textDomain=null)
 Sets translator to use in helper.
 
 getTranslator ()
 Returns translator used in object.
 
 hasTranslator ()
 Checks if the object has a translator.
 
 setTranslatorEnabled ($enabled=true)
 Sets whether translator is enabled and should be used.
 
 isTranslatorEnabled ()
 Returns whether translator is enabled and should be used.
 
 setTranslatorTextDomain ($textDomain= 'default')
 Set translation text domain.
 
 getTranslatorTextDomain ()
 Return the translation text domain.
 

Member Function Documentation

getTranslator ( )

Returns translator used in object.

Returns
TranslatorInterface|null

Implemented in AbstractValidator.

getTranslatorTextDomain ( )

Return the translation text domain.

Returns
string

Implemented in AbstractValidator.

hasTranslator ( )

Checks if the object has a translator.

Returns
bool

Implemented in AbstractValidator.

isTranslatorEnabled ( )

Returns whether translator is enabled and should be used.

Returns
bool

Implemented in AbstractValidator.

setTranslator ( TranslatorInterface  $translator = null,
  $textDomain = null 
)

Sets translator to use in helper.

Parameters
TranslatorInterface$translator[optional] translator. Default is null, which sets no translator.
string$textDomain[optional] text domain Default is null, which skips setTranslatorTextDomain
Returns
self
setTranslatorEnabled (   $enabled = true)

Sets whether translator is enabled and should be used.

Parameters
bool$enabled[optional] whether translator should be used. Default is true.
Returns
self

Implemented in AbstractValidator.

setTranslatorTextDomain (   $textDomain = 'default')

Set translation text domain.

Parameters
string$textDomain
Returns
TranslatorAwareInterface

Implemented in AbstractValidator.