Zend\I18n\Translator\Translator
Translator.
Synopsis
class Translator
implements
TranslatorInterface
{
- // constants
- const EVENT_MISSING_TRANSLATION = 'missingTranslation';
- const EVENT_NO_MESSAGES_LOADED = 'noMessagesLoaded';
- // members
- protected array $messages;
- protected array $files;
- protected array $patterns;
- protected array $remote;
- protected string $locale;
- protected string $fallbackLocale;
- protected StorageInterface $cache;
- protected LoaderPluginManager $pluginManager;
- protected EventManagerInterface $events;
- protected bool $eventsEnabled;
- // methods
- public static Translator factory()
- public Translator setLocale()
- public string getLocale()
- public Translator setFallbackLocale()
- public string getFallbackLocale()
- public Translator setCache()
- public StorageInterface getCache()
- public Translator setPluginManager()
- public LoaderPluginManager getPluginManager()
- public string translate()
- public string translatePlural()
- protected string|null getTranslatedMessage()
- public Translator addTranslationFile()
- public Translator addTranslationFilePattern()
- public Translator addRemoteTranslations()
- protected void loadMessages()
- protected bool loadMessagesFromRemote()
- protected bool loadMessagesFromPatterns()
- protected bool loadMessagesFromFiles()
- public EventManagerInterface|null getEventManager()
- public Translator setEventManager()
- public boolean isEventManagerEnabled()
- public Translator enableEventManager()
- public Translator disableEventManager()
Hierarchy
Implements
Constants
Name | Value |
---|---|
EVENT_MISSING_TRANSLATION | 'missingTranslation' |
EVENT_NO_MESSAGES_LOADED | 'noMessagesLoaded' |
Members
protected
- $cache
—
Zend\Cache\Storage\StorageInterface
Translation cache. - $events
—
Zend\EventManager\EventManagerInterface
Event manager for triggering translator events. - $eventsEnabled
—
Zend\I18n\Translator\bool
Whether events are enabled - $fallbackLocale
—
string
Locale to use as fallback if there is no translation. - $files
—
array
Files used for loading messages. - $locale
—
string
Default locale. - $messages
—
array
Messages loaded by the translator. - $patterns
—
array
Patterns used for loading messages. - $pluginManager
—
Zend\I18n\Translator\LoaderPluginManager
Plugin manager for translation loaders. - $remote
—
array
Remote locations for loading messages.
Methods
protected
- getTranslatedMessage() — Get a translated message.
- loadMessages() — Load messages for a given language and domain.
- loadMessagesFromFiles() — Load messages from files.
- loadMessagesFromPatterns() — Load messages from patterns.
- loadMessagesFromRemote() — Load messages from remote sources.
public
- addRemoteTranslations() — Add remote translations.
- addTranslationFile() — Add a translation file.
- addTranslationFilePattern() — Add multiple translations with a file pattern.
- disableEventManager() — Disable the event manager.
- enableEventManager() — Enable the event manager.
- factory() — Instantiate a translator
- getCache() — Returns the set cache
- getEventManager() — Get the event manager.
- getFallbackLocale() — Get the fallback locale.
- getLocale() — Get the default locale.
- getPluginManager() — Retrieve the plugin manager for translation loaders.
- isEventManagerEnabled() — Check whether the event manager is enabled.
- setCache() — Sets a cache
- setEventManager() — Set the event manager instance used by this translator.
- setFallbackLocale() — Set the fallback locale.
- setLocale() — Set the default locale.
- setPluginManager() — Set the plugin manager for translation loaders
- translate() — Translate a message.
- translatePlural() — Translate a plural message.