📚 Looking for current Exponential documentation? This site contains legacy SDK & API reference docs (eZ Publish era). For up-to-date 2026 product documentation, visit doc.exponential.earth.

  class / eZTranslatorHandler  

API Reference
 

Sections

Todo

eZTranslatorHandler Class Reference
[Translation]

Base class for translation handling. More...

Inheritance diagram for eZTranslatorHandler: 

TODO — Image not available in archive

Title:   eZTranslatorHandler Class Inheritance Diagram (Doxygen)
File:    /doc/generated/html/classeZTranslatorHandler.png

What this image shows:
Doxygen-generated class inheritance diagram for the eZTranslatorHandler PHP class. Shows the inheritance hierarchy: which classes eZTranslatorHandler extends and which classes inherit from it, with links to parent and child class documentation. This diagram was auto-generated from the Exponential 3.1 PHP source code using Doxygen circa 2003.

Replacement instructions:
Run Doxygen on the Exponential 3.1 PHP source and locate the generated classeZTranslatorHandler.png in the output. Or draw the inheritance tree manually from the API reference. Save as /doc/generated/html/classeZTranslatorHandler.png

See /sdk/missing.html for the full list of missing images.
eZ1337Translator eZBorkTranslator eZShuffleTranslator eZTranslatorGroup eZTSTranslator eZRandomTranslator List of all members.

Public Methods

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

Private Attributes

 IsKeyBased

Detailed Description

Base class for translation handling.

Definition at line eztranslatorhandler.php.

Constructor & Destructor Documentation

eZTranslatorHandler::eZTranslatorHandler (  $    is_key_based ) 
 

Constructor

Definition at line eztranslatorhandler.php.

References IsKeyBased.

Referenced by eZTSTranslator::eZTSTranslator().

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.

Definition at line eztranslatorhandler.php.

& 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.

Definition at line eztranslatorhandler.php.

eZTranslatorHandler::isKeyBased (    ) 
 

Returns:
true if the handler can lookup translations with translation keys.

Definition at line eztranslatorhandler.php.

References IsKeyBased.

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.

Definition at line eztranslatorhandler.php.

& 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.

Definition at line eztranslatorhandler.php.

Member Data Documentation

eZTranslatorHandler::IsKeyBased [private]
 

Tells whether the handler is key based or not

Definition at line eztranslatorhandler.php.

Referenced by isKeyBased().

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

Exponential Copyright © 1998 - 2026 7x