Exponential 6.0.13 Exponential Enterprise Open Source CMS - PHP Class Reference

Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
eZTranslatorManager Class Reference
Internationalization » Translation

This provides internationalization support for text output. More...

## Public Member Functions
| __construct ()
| findKey ( $key)
| findMessage ( $context, $source, $comment=null)
| keyTranslate ( $key)
| translate ( $context, $source, $comment=null)

## Static Public Member Functions
static | instance ()
static | registerHandler ( $handler)
static | createKey ( $context, $source, $comment=null)
static | createMessage ( $context, $source, $comment=null, $translation=null)
static | resetGlobals ()
static | resetTranslations ()
static | dynamicTranslationsEnabled ()
static | enableDynamicTranslations ( $enable=true)
static | setActiveTranslation ( $locale, $permanently=true)

## Public Attributes
const | DYNAMIC_TRANSLATIONS_ENABLED = 'eZTMDynamicTranslationsEnabled'
| $Handlers

## Detailed Description

This provides internationalization support for text output.

Each message consists of:

- context - the context of the translation
- source - the source string
- comment - a variation of the context/source
- key - the uniquely generated key taken from context, source and eventually comment

Definition at line 30 of file eztranslatormanager.php.

## Constructor & Destructor Documentation

## ◆ __construct()

eZTranslatorManager::__construct | ( |  | ) |

Definition at line 34 of file eztranslatormanager.php.

## Member Function Documentation

## ◆ createKey()

static eZTranslatorManager::createKey | ( |  | $context,
|  |  | $source,
|  |  | $comment = `null`
| ) |  |
| static

Creates an md5 key based on the $context, $source and $comment and returns it.

Definition at line 150 of file eztranslatormanager.php.

## ◆ createMessage()

static eZTranslatorManager::createMessage | ( |  | $context,
|  |  | $source,
|  |  | $comment = `null`,
|  |  | $translation = `null`
| ) |  |
| static

Creates a message structure out of $context, $source and $comment and returns it.

Definition at line 162 of file eztranslatormanager.php.

## ◆ dynamicTranslationsEnabled()

static eZTranslatorManager::dynamicTranslationsEnabled | ( |  | ) |
| static

Definition at line 193 of file eztranslatormanager.php.

Referenced by ezpI18n\isEnabled(), and setActiveTranslation().

## ◆ enableDynamicTranslations()

static eZTranslatorManager::enableDynamicTranslations | ( |  | $enable = `true` | ) |
| static

Definition at line 201 of file eztranslatormanager.php.

References DYNAMIC_TRANSLATIONS_ENABLED.

## ◆ findKey()

eZTranslatorManager::findKey | ( |  | $key | ) |

Tries to find the translation message that matches $key in all it's handlers and returns it. If no message could be found it either means that none of the handlers have a translation for the key or that some of the handlers are not key based, for instance realtime translators. In the latter case an extra call to findMessage() or translate() is required.

Use keyTranslate if you only want to translate a message.

See also
  findMessage, keyTranslate

Definition at line 50 of file eztranslatormanager.php.

## ◆ findMessage()

eZTranslatorManager::findMessage | ( |  | $context,
|  |  | $source,
|  |  | $comment = `null`
| ) |  |

Tries to find the translation message that matches $context, $source and $comment. If that fails it tries $context and $source only. The message is then returned or null if no translation message could be found/generated for it.

Use translate if you only want to translate a message.

See also
  findKey, translate

Definition at line 71 of file eztranslatormanager.php.

## ◆ instance()

static eZTranslatorManager::instance | ( |  | ) |
| static

Returns a shared instance of the eZTranslatorManager class.

Returns
  eZTranslatorManager

Definition at line 127 of file eztranslatormanager.php.

Referenced by eZ1337Translator\findMessage(), eZBorkTranslator\findMessage(), eZShuffleTranslator\findMessage(), eZTSTranslator\findMessage(), eZi18nOperator\i18nTrans(), eZTSTranslator\initialize(), eZ1337Translator\initialize(), eZBorkTranslator\initialize(), eZTSTranslator\insert(), registerHandler(), eZTSTranslator\remove(), and ezpI18n\translateText().

## ◆ keyTranslate()

eZTranslatorManager::keyTranslate | ( |  | $key | ) |

Returns
  the translation string for $key.

Note this returns the exact translation for the given key, use translate() instead if you want to have variable comment support.

See also
  findKey, translate

Definition at line 92 of file eztranslatormanager.php.

## ◆ registerHandler()

static eZTranslatorManager::registerHandler | ( |  | $handler | ) |
| static

Registers the handler object $handler.

Definition at line 140 of file eztranslatormanager.php.

References instance().

## ◆ resetGlobals()

static eZTranslatorManager::resetGlobals | ( |  | ) |
| static

Definition at line 174 of file eztranslatormanager.php.

Referenced by resetTranslations().

## ◆ resetTranslations()

static eZTranslatorManager::resetTranslations | ( |  | ) |
| static

Definition at line 182 of file eztranslatormanager.php.

References eZLocale\resetGlobals(), eZTranslationCache\resetGlobals(), resetGlobals(), and eZTSTranslator\resetGlobals().

Referenced by setActiveTranslation().

## ◆ setActiveTranslation()

static eZTranslatorManager::setActiveTranslation | ( |  | $locale,
|  |  | $permanently = `true`
| ) |  |
| static

Definition at line 216 of file eztranslatormanager.php.

References dynamicTranslationsEnabled(), and resetTranslations().

## ◆ translate()

eZTranslatorManager::translate | ( |  | $context,
|  |  | $source,
|  |  | $comment = `null`
| ) |  |

Returns
  the translation string for $source and $context or null if the key does not exist.

See also
  findMessage, findKey

Definition at line 109 of file eztranslatormanager.php.

## Member Data Documentation

## ◆ $Handlers

eZTranslatorManager::$Handlers

The array of handler objects

Definition at line 242 of file eztranslatormanager.php.

## ◆ DYNAMIC_TRANSLATIONS_ENABLED

const eZTranslatorManager::DYNAMIC_TRANSLATIONS_ENABLED = 'eZTMDynamicTranslationsEnabled'

Definition at line 32 of file eztranslatormanager.php.

Referenced by enableDynamicTranslations().

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

- eztranslatormanager.php

Copyright © 1998 – 2026 7x. All rights reserved. Licensed under the GNU GPLv2+.