Docs For Class Zend_Translate

Description

copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
abstract:
license: New BSD License

Located in /Translate/Adapter.php (line 35)

Direct descendents

Class	Description
Zend_Translate_Adapter_Array
Zend_Translate_Adapter_Csv
Zend_Translate_Adapter_Gettext
Zend_Translate_Adapter_Qt
Zend_Translate_Adapter_Tmx
Zend_Translate_Adapter_Xliff

Variable Summary

array $_languages

string|null $_locale

array $_options

array $_translate

Method Summary

Zend_Translate_Adapter __construct (string|array $data, [string|Zend_Locale $locale = null], [ $options = array()])

void addTranslation (array|string $data, string|Zend_Locale $locale, [ $options = array()])

array getList ()

Zend_Locale|null getLocale ()

integer|string|array getOptions ([string|null $optionKey = null])

boolean isAvailable (string|Zend_Locale $locale)

boolean isTranslated (string $messageId, [boolean $original = false], [string|Zend_Locale $locale = null])

void setLocale (string|Zend_Locale $locale)

void setOptions ([ $options = array()])

string toString ()

string translate (string $messageId, [string|Zend_Locale $locale = null])

void _loadTranslationData (mixed $data, string|Zend_Locale $locale, [ $options = array()])

Variables

array $_languages = array() (line 48)

Table of all supported languages

access: protected

string|null $_locale (line 41)

Current locale/language

access: protected

array $_options = array('clear' => false) (line 55)

Array with all options, each adapter can have own additional options

access: protected

array $_translate = array() (line 62)

Translation table

access: protected

Methods

Constructor __construct (line 74)

Generates the adapter

throws: Zend_Translate_Exception
access: public

Zend_Translate_Adapter __construct (string|array $data, [string|Zend_Locale $locale = null], [ $options = array()])

string|array $data: Translation data for this adapter
string|Zend_Locale $locale: OPTIONAL Locale/Language to set, identical with Locale identifiers see Zend_Locale for more information
string|array $options: Options for the adaptor

Redefined in descendants as:

Zend_Translate_Adapter_Array::__construct() : Generates the adapter
Zend_Translate_Adapter_Csv::__construct() : Generates the adapter
Zend_Translate_Adapter_Gettext::__construct() : Generates the adapter
Zend_Translate_Adapter_Qt::__construct() : Generates the Qt adapter This adapter reads with php's xml_parser
Zend_Translate_Adapter_Tmx::__construct() : Generates the tmx adapter This adapter reads with php's xml_parser
Zend_Translate_Adapter_Xliff::__construct() : Generates the xliff adapter This adapter reads with php's xml_parser

addTranslation (line 199)

Add translation data

It may be a new language or additional data for existing language If $clear parameter is true, then translation data for specified language is replaced and added otherwise

throws: Zend_Translate_Exception
access: public

void addTranslation (array|string $data, string|Zend_Locale $locale, [ $options = array()])

array|string $data: Translation data
string|Zend_Locale $locale: Locale/Language to add data for, identical with locale identifier, see Zend_Locale for more information
array $options: OPTIONAL Option for this Adapter

getList (line 155)

Returns the avaiable languages from this adapter

access: public

array getList ()

getLocale (line 122)

Gets locale

access: public

Zend_Locale|null getLocale ()

getOptions (line 105)

Returns the adapters name and it's options

access: public

integer|string|array getOptions ([string|null $optionKey = null])

string|null $optionKey: String returns this option null returns all options

isAvailable (line 168)

Is the wished language avaiable ?

access: public

boolean isAvailable (string|Zend_Locale $locale)

string|Zend_Locale $locale: Language to search for, identical with locale identifier, see Zend_Locale for more information

isTranslated (line 267)

Checks if a string is translated within the source or not returns boolean

access: public

boolean isTranslated (string $messageId, [boolean $original = false], [string|Zend_Locale $locale = null])

string $messageId: Translation string
boolean $original: OPTIONAL Allow translation only for original language when true, a translation for 'en_US' would give false when it can be translated with 'en' only
string|Zend_Locale $locale: OPTIONAL Locale/Language to use, identical with locale identifier, see Zend_Locale for more information

setLocale (line 134)

Sets locale

throws: Zend_Translate_Exception
access: public

void setLocale (string|Zend_Locale $locale)

string|Zend_Locale $locale: Locale to set

setOptions (line 91)

Sets new adapter options

throws: Zend_Translate_Exception
access: public

void setOptions ([ $options = array()])

array $options: Adapter options

toString (line 309)

Returns the adapter name

abstract:
access: public

string toString ()

Redefined in descendants as:

Zend_Translate_Adapter_Array::toString() : returns the adapters name
Zend_Translate_Adapter_Csv::toString() : returns the adapters name
Zend_Translate_Adapter_Gettext::toString() : Returns the adapter name
Zend_Translate_Adapter_Qt::toString() : Returns the adapter name
Zend_Translate_Adapter_Tmx::toString() : Returns the adapter name
Zend_Translate_Adapter_Xliff::toString() : Returns the adapter name

translate (line 222)

Translates the given string returns the translation

access: public

string translate (string $messageId, [string|Zend_Locale $locale = null])

string $messageId: Translation string
string|Zend_Locale $locale: OPTIONAL Locale/Language to use, identical with locale identifier, see Zend_Locale for more information

_loadTranslationData (line 184)

Load translation data

abstract:
access: protected

void _loadTranslationData (mixed $data, string|Zend_Locale $locale, [ $options = array()])

mixed $data
string|Zend_Locale $locale
array $options

Redefined in descendants as:

Zend_Translate_Adapter_Array::_loadTranslationData() : Load translation data
Zend_Translate_Adapter_Csv::_loadTranslationData() : Load translation data
Zend_Translate_Adapter_Gettext::_loadTranslationData() : Load translation data (MO file reader)
Zend_Translate_Adapter_Qt::_loadTranslationData() : Load translation data (QT file reader)
Zend_Translate_Adapter_Tmx::_loadTranslationData() : Load translation data (TMX file reader)
Zend_Translate_Adapter_Xliff::_loadTranslationData() : Load translation data (XLIFF file reader)