languages
[ class tree: languages ] [ index: languages ] [ all elements ]
Packages:
articles
blogs
boards
calendar
events
fisheye
install
kernel
languages
liberty
newsletters
protector
recess-http
search
sharethis
Smarty
stars
tags
themes
treasury
users
wiki


Files:
Babelfish.php
BitLanguage.php
LibertyTranslations.php

subpackage functions
ajax_translate.php
edit_languages.php
get_strings.php
import.php
master_strings.php
switch_lang.php
translate_strings.php

subpackage modules
mod_switch_language_dropdown.php
mod_switch_language_links.php

Classes:
Babelfish
BitLanguage
LibertyTranslations

Class: BitLanguage

Source Location: /languages/BitLanguage.php

Class Overview

BitBase
   |
   --BitSingleton
      |
      --BitLanguage

Variables

Methods

Inherited Constants

Class: BitBase

BitBase::CACHE_STATE_ADDED
BitBase::CACHE_STATE_DELETE
BitBase::CACHE_STATE_NONE
BitBase::CACHE_STATE_STORED

Inherited Variables

Class: BitSingleton

BitSingleton::$singletons

Class: BitBase

BitBase::$dType
BitBase::$mCacheTime
BitBase::$mDb
BitBase::$mErrors
BitBase::$mInfo
BitBase::$mLogs
BitBase::$mName
BitBase::$mPreventCache
BitBase::$mSuccess

Inherited Methods

Class: BitSingleton

BitSingleton::__construct()
BitSingleton::loadSingleton()

Class: BitBase

BitBase::BitBase()
During initialisation, we assign a name which is used by the class.
BitBase::__construct()
BitBase::clearFromCache()
BitBase::expunge()
Delete content object and all related records
BitBase::load()
BitBase::__destruct()

Class Details

[line 16]


[ Top ]

Class Variables

$mLanguage =

[line 20]


Type:   mixed


[ Top ]

$mLanguageList =

[line 18]


Type:   mixed


[ Top ]


Class Methods

constructor __construct [line 25]

BitLanguage __construct( )

initiate BitLanguage



Overrides BitSingleton::__construct() (parent method not documented)

[ Top ]

method clearCache [line 674]

void clearCache( )

clearCache



Tags:

access:  public


[ Top ]

method expungeLanguage [line 134]

void expungeLanguage( string $pLangCode)

expungeLanguage remove language from database



Tags:

access:  public


Parameters:

string   $pLangCode   Language code

[ Top ]

method expungeMasterString [line 152]

TRUE expungeMasterString( string $pSourceHash)

expungeMasterString remove master string from database



Tags:

return:  on success, FALSE on failure
access:  public


Parameters:

string   $pSourceHash   MD5 hash of master string

[ Top ]

method getImportedLanguages [line 170]

array getImportedLanguages( )

getImportedLanguages get a list of languages that have been imported



Tags:

return:  of available languages
access:  public


[ Top ]

method getLanguage [line 63]

active getLanguage( )

getLanguage get acvtive language



Tags:

return:  language
access:  public


[ Top ]

method getLanguageFile [line 439]

TRUE getLanguageFile( string $pLangCode)

getLanguageFile



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

string   $pLangCode   Language code

[ Top ]

method getMasterString [line 653]

master getMasterString( string $pSourceHash)

getMasterString



Tags:

return:  string with given source hash
access:  public


Parameters:

string   $pSourceHash  

[ Top ]

method getSourceHash [line 664]

MD5 getSourceHash( string $pString)

getSourceHash



Tags:

return:  hash of string
access:  public


Parameters:

string   $pString  

[ Top ]

method getTranslatedStrings [line 404]

array getTranslatedStrings( string $pSourceHash)

getTranslatedStrings



Tags:

return:  of translated strings
access:  public


Parameters:

string   $pSourceHash   MD5 hash of master string

[ Top ]

method getTranslationString [line 421]

TRUE getTranslationString( string $pSourceHash, string $pLangCode)

getTranslationString



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

string   $pSourceHash   MD5 hash of master string
string   $pLangCode   Language code

[ Top ]

method importMasterStrings [line 350]

TRUE importMasterStrings( [boolean $pOverwrite = FALSE])

importMasterStrings



Tags:

return:  on success, FALSE on failure
access:  public


Parameters:

boolean   $pOverwrite  

[ Top ]

method importTranslationStrings [line 464]

TRUE importTranslationStrings( string $pLangCode, [boolean $pOverwrite = FALSE], [string $pTable = 'i18n_strings`'], [string $pFile = FALSE])

importTranslationStrings



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

string   $pLangCode   Language code
boolean   $pOverwrite  
string   $pTable  
string   $pFile   path to file

[ Top ]

method isImportFileAvailable [line 450]

TRUE isImportFileAvailable( string $pLangCode)

isImportFileAvailable



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

string   $pLangCode   Language code

[ Top ]

method isLanguageRTL [line 79]

void isLanguageRTL( )



[ Top ]

method listLanguages [line 194]

array listLanguages( [boolean $pListDisabled = TRUE], [boolean $pListOnlyImportable = FALSE])

listLanguages list languages



Tags:

return:  of languages
access:  public


Parameters:

boolean   $pListDisabled  
boolean   $pListOnlyImportable  

[ Top ]

method loadLanguage [line 542]

void loadLanguage( string $pLangCode)

loadLanguage



Tags:

access:  public


Parameters:

string   $pLangCode   Language code

[ Top ]

method loadMasterStrings [line 263]

all loadMasterStrings( [string $pSourceHash = NULL], [string $pFilter = NULL], [ $pLangCode = NULL])

loadMasterStrings load all master strings



Tags:

return:  master strings in $this->mStrings['master']
access:  public


Parameters:

string   $pSourceHash   MD5 hash to load
string   $pFilter   Limit strings loaded to unlimited (default), translated or untranslated
   $pLangCode  

[ Top ]

method lookupTranslation [line 619]

TRUE lookupTranslation( string $pString, string $pLangCode, [boolean $pOverrideUsage = TRUE])

lookupTranslation



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

string   $pString  
string   $pLangCode   Language code
boolean   $pOverrideUsage  

[ Top ]

method masterStringExists [line 236]

TRUE masterStringExists( array $pSourceHash)

masterStringExists check to see if a given master string already exists



Tags:

return:  if found, FALSE otherwise
access:  public


Parameters:

array   $pSourceHash   MD5 hash of string to be checked

[ Top ]

method searchMasterStrings [line 247]

TRUE searchMasterStrings( string $pQuerySource)

searchMasterStrings find master string in database



Tags:

return:  on success, FALSE on failure
access:  public


Parameters:

string   $pQuerySource   string

[ Top ]

method setLanguage [line 74]

void setLanguage( string $pLangCode)

setLanguage set active language



Tags:

access:  public


Parameters:

string   $pLangCode   Language code

[ Top ]

method storeLanguage [line 114]

TRUE storeLanguage( array $pParamHash)

storeLanguage store language in database



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

array   $pParamHash   parameters that will be stored

[ Top ]

method storeMasterString [line 301]

TRUE storeMasterString( array $pParamHash)

storeMasterString store master string



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

array   $pParamHash   data to be stored

[ Top ]

method storeTranslationString [line 382]

void storeTranslationString( string $pLangCode, string $pString, string $pSourceHash)

storeTranslationString



Tags:

access:  public


Parameters:

string   $pLangCode   Language code
string   $pString  
string   $pSourceHash   MD5 hash of master string

[ Top ]

method translate [line 561]

translation translate( string $pString)

translate



Tags:

access:  public


Parameters:

string   $pString  

[ Top ]

method verifyLanguage [line 90]

TRUE verifyLanguage( &$pParamHash, array $pParamHash)

verifyLanguage verify language hash before storing it



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

array   $pParamHash   parameters that will be stored
   &$pParamHash  

[ Top ]

method verifyMastersLoaded [line 220]

void verifyMastersLoaded( )

verifyMastersLoaded verify that master strings are loaded



Tags:

access:  public


[ Top ]

method verifyTranslationLoaded [line 524]

void verifyTranslationLoaded( string $pLangCode)

verifyTranslationLoaded



Tags:

access:  public


Parameters:

string   $pLangCode   Language code

[ Top ]

Documentation generated on Wed, 29 Jul 2015 13:55:53 +0000 by phpDocumentor 1.5.0-lsces