PHP Class PMA\libraries\LanguageManager

Show file Open project: phpmyadmin/phpmyadmin Class Usage Examples

Public Methods

Method Description
availableLanguages ( ) : array Returns (cached) list of all available languages
availableLocales ( ) : array Returns (cached) list of all available locales
getCurrentLanguage ( ) : object Return currently active Language object
getInstance ( ) : LanguageManager Returns LanguageManager singleton
getLanguage ( string $code ) : object | false Return Language object for given code
getSelectorDisplay ( boolean $use_fieldset = false, boolean $show_doc = true ) : string Returns HTML code for the language selector
listLocaleDir ( ) : array Returns list of available locales
selectLanguage ( ) : PMA\libraries\Language Activates language based on configuration, user preferences or browser
showWarnings ( ) : void Displays warnings about invalid languages. This needs to be postponed to show messages at time when language is initialized.
sortedLanguages ( ) : array Returns (cached) list of all available languages sorted by name

Method Details

availableLanguages() public method

Returns (cached) list of all available languages
public availableLanguages ( ) : array
return array of Language objects

availableLocales() public method

Returns (cached) list of all available locales
public availableLocales ( ) : array
return array of strings

getCurrentLanguage() public method

Return currently active Language object
public getCurrentLanguage ( ) : object
return object Language object

getInstance() public static method

Returns LanguageManager singleton
public static getInstance ( ) : LanguageManager
return LanguageManager

getLanguage() public method

Return Language object for given code
public getLanguage ( string $code ) : object | false
$code string Language code
return object | false Language object or false on failure

getSelectorDisplay() public method

Returns HTML code for the language selector
public getSelectorDisplay ( boolean $use_fieldset = false, boolean $show_doc = true ) : string
$use_fieldset boolean whether to use fieldset for selection
$show_doc boolean whether to show documentation links
return string

listLocaleDir() public method

Returns list of available locales
public listLocaleDir ( ) : array
return array

selectLanguage() public method

Activates language based on configuration, user preferences or browser
public selectLanguage ( ) : PMA\libraries\Language
return PMA\libraries\Language

showWarnings() public method

Displays warnings about invalid languages. This needs to be postponed to show messages at time when language is initialized.
public showWarnings ( ) : void
return void

sortedLanguages() public method

Returns (cached) list of all available languages sorted by name
public sortedLanguages ( ) : array
return array of Language objects