Docs For Class SGL_Translation3

SGL_Translation3_Driver

Description

abstract:

Located in /SGL/Translation3/Driver.php (line 6)

Direct descendents

Class	Description
SGL_Translation3_Driver_Array

Variable Summary

mixed $defaultLangCode

mixed $defaultLangCodeCharset

mixed $dictionary

mixed $langCode

mixed $langCodeCharset

mixed $_aDictionaries

mixed $_aLanguages

mixed $_aOptions

Method Summary

static void extractCharset ( $langCodeCharset)

static void getDefaultCharset ()

static boolean isAllowedLangCodeCharset (string $langCodeCharset)

static mixed resolveLanguageFromBrowser ()

static mixed resolveLanguageFromDomain ()

static array _removeMetaData (array $aTranslations, [boolean $removeAll = false])

SGL_Translation3_Driver __construct ([ $aOptions = array()])

object Specific addTranslations (string $dictionary, string $langCode, [ $aTranslations = array()])

void clearCache ()

void getAvailableLanguages ()

void getDefaultLangCode ()

void getDictionary (string $dictionary, [ $langCode = null], string $langCodeCharset)

void getLangCode ([ $langCodeCharset = null])

void getLangCodeCharset ([ $langCode = null])

void init ()

void langCodeToLangCodeCharset ( $langCode)

void loadDefaultDictionaries ()

void loadDictionary (string $dictionary, [ $langCode = null], [ $aOptions = array()], string $langCodeCharset)

void save ([ $dictionary = null], [ $langCode = null])

void setAvailableLanguages ()

void setDefaultLangCode ()

void setDictionary ( $dictionary)

void setLangCode ([ $langCode = null])

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

string toString ()

string translate (string $langCode, string $key)

void update ([ $aStrings = array()], $dictionary, [ $langCode = null])

string _resolveLangCode ()

Variables

mixed $defaultLangCode (line 35)

The framework default langCode

access: public

mixed $defaultLangCodeCharset (line 20)

The default language code charset

access: public

mixed $dictionary (line 40)

Current dictionary

access: public

mixed $langCode (line 30)

The current language code, eg, en

access: public

mixed $langCodeCharset (line 25)

The current language code charset, eg, en-utf-8

access: public

mixed $_aDictionaries = array() (line 46)

A hash of translation arrays ie default (module), cms(module), navigation, categories

keyed by langCode, ie zh-TW

access: protected

mixed $_aLanguages = array() (line 15)

Supported languages

access: protected

mixed $_aOptions = array(
'clear' => false,
'loadDefault' => true
) (line 8)

access: protected

Methods

static extractCharset (line 350)

todo: make work with langCode
access: public

void extractCharset ( $langCodeCharset)

$langCodeCharset

static getDefaultCharset (line 360)

access: public

void getDefaultCharset ()

static isAllowedLangCodeCharset (line 374)

Is a language allowed ?

access: public

boolean isAllowedLangCodeCharset (string $langCodeCharset)

string $langCodeCharset: language id, e.g. en-utf-8, fr-utf-8, ...

static resolveLanguageFromBrowser (line 386)

Resolve language from browser settings.

return: language or false on failure
access: public

mixed resolveLanguageFromBrowser ()

static resolveLanguageFromDomain (line 416)

Resolve language from domain name.

return: language or false on failure
access: public

mixed resolveLanguageFromDomain ()

static _removeMetaData (line 269)

Remove meta data from translation array.

access: protected

array _removeMetaData (array $aTranslations, [boolean $removeAll = false])

array $aTranslations
boolean $removeAll

Constructor __construct (line 48)

access: public

SGL_Translation3_Driver __construct ([ $aOptions = array()])

array $aOptions

Redefined in descendants as:

SGL_Translation3_Driver_Array::__construct()

addTranslations (line 251)

Adds an array of key => value translations.

return: SGL_Translation3_Driver instance (this method is chainable)
access: public

object Specific addTranslations (string $dictionary, string $langCode, [ $aTranslations = array()])

string $dictionary
string $langCode
array $aTranslations

clearCache (line 457)

abstract:
access: public

void clearCache ()

Redefined in descendants as:

SGL_Translation3_Driver_Array::clearCache() : Does nothing, this Driver is already using files

getAvailableLanguages (line 300)

access: public

void getAvailableLanguages ()

getDefaultLangCode (line 110)

access: public

void getDefaultLangCode ()

getDictionary (line 442)

Fetches a dictionary

abstract:
access: public

void getDictionary (string $dictionary, [ $langCode = null], string $langCodeCharset)

string $dictionary: Dictionary you want to load
string $langCodeCharset: Language you want the dictionary in, let null value to use automaticaly discovered language
$langCode

Redefined in descendants as:

SGL_Translation3_Driver_Array::getDictionary() : Fetches a dictionary

getLangCode (line 72)

Returns language langCode i.e. fr for fr-utf-8

todo: make more similar to langCodeToLangCodeCharset()
access: public

void getLangCode ([ $langCodeCharset = null])

$langCodeCharset

getLangCodeCharset (line 100)

access: public

void getLangCodeCharset ([ $langCode = null])

$langCode

init (line 59)

Initializea the Translate Driver, setting available languages, the default language and the current language.

access: private

void init ()

langCodeToLangCodeCharset (line 184)

access: public

void langCodeToLangCodeCharset ( $langCode)

$langCode

loadDefaultDictionaries (line 201)

Loading default dictionaries following SGL process.

Additionaly you can add default dictionaries to be loaded in the Translation module's conf.ini file

access: public

void loadDefaultDictionaries ()

loadDictionary (line 153)

Fetches a dictionary and loads it into _aDictionaries array + $GLOBALS['_SGL']['TRANSLATION'] for BC.

access: public

void loadDictionary (string $dictionary, [ $langCode = null], [ $aOptions = array()], string $langCodeCharset)

string $dictionary: Dictionary you want to load
string $langCodeCharset: Language you want the dictionary in leave as null for automaticaly discovered language
array $aOptions: Run ime options to overwrite default options When passing aOption 'clear' => true, the translation array will be cleared before adding new translation strings
$langCode

save (line 455)

Saves current dictionary translations

abstract:
access: public

void save ([ $dictionary = null], [ $langCode = null])

$dictionary
$langCode

Redefined in descendants as:

SGL_Translation3_Driver_Array::save() : Saves current dictionary translations.

setAvailableLanguages (line 466)

abstract:
access: public

void setAvailableLanguages ()

Redefined in descendants as:

SGL_Translation3_Driver_Array::setAvailableLanguages()

setDefaultLangCode (line 93)

access: public

void setDefaultLangCode ()

setDictionary (line 137)

Sets current dictionary.

access: public

void setDictionary ( $dictionary)

$dictionary

setLangCode (line 119)

Sets current language code.

access: public

void setLangCode ([ $langCode = null])

$langCode

setOptions (line 86)

access: public

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

array $aOptions

toString (line 464)

Returns the driver name

abstract:
access: public

string toString ()

Redefined in descendants as:

SGL_Translation3_Driver_Array::toString() : Returns the driver name.

translate (line 293)

Enter description here...

todo: is this used?
access: public

string translate (string $langCode, string $key)

string $langCode
string $key

update (line 448)

Updates a string in dictionary given its key

abstract:
access: public

void update ([ $aStrings = array()], $dictionary, [ $langCode = null])

array $aStrings
$dictionary
$langCode

Redefined in descendants as:

SGL_Translation3_Driver_Array::update() : Updates a string in a dictionary given its key.

_resolveLangCode (line 312)

Resolve current language.

access: public

string _resolveLangCode ()

Documentation generated on Tue, 23 Feb 2010 18:14:29 +0000 by phpDocumentor 1.4.3