eZPublishCommunityProject(LegacyStack)  2013.9
eZTranslatorHandler Class Referenceabstract

Base class for translation handling. More...

+ Inheritance diagram for eZTranslatorHandler:

Public Member Functions

 eZTranslatorHandler ($is_key_based)
 
 findKey ($key)
 
 findMessage ($context, $source, $comment=null)
 
 isKeyBased ()
 
 keyTranslate ($key)
 
 translate ($context, $source, $comment=null)
 

Public Attributes

 $IsKeyBased
 Tells whether the handler is key based or not. More...
 

Detailed Description

Base class for translation handling.

Member Function Documentation

eZTranslatorHandler::findKey (   $key)
pure virtual
Returns
the translation message for the key $key or null if the key does not exist.

This function must overridden if isKeyBased() is true.

Implemented in eZTSTranslator, and eZTranslatorGroup.

eZTranslatorHandler::findMessage (   $context,
  $source,
  $comment = null 
)
pure virtual
Returns
the translation message for $source and $context or null if the key does not exist.

If you know the translation key use findKey() instead.

This function must overridden if isKeyBased() is true.

Implemented in eZTSTranslator, eZBorkTranslator, eZTranslatorGroup, eZ1337Translator, and eZShuffleTranslator.

eZTranslatorHandler::isKeyBased ( )
Returns
true if the handler can lookup translations with translation keys.

Referenced by eZTranslatorGroup\registerHandler().

eZTranslatorHandler::keyTranslate (   $key)
pure virtual
Returns
the translation string for $key or null if the translation does not exist.
See Also
findMessage, findKey

Implemented in eZTSTranslator, and eZTranslatorGroup.

eZTranslatorHandler::translate (   $context,
  $source,
  $comment = null 
)
pure virtual
Returns
the translation string for $source and $context or null if the translation does not exist.
See Also
findMessage, findKey

Implemented in eZTSTranslator, eZBorkTranslator, eZ1337Translator, eZTranslatorGroup, and eZShuffleTranslator.

Member Data Documentation

eZTranslatorHandler::$IsKeyBased

Tells whether the handler is key based or not.

Referenced by isKeyBased().


The documentation for this class was generated from the following file: