Public Member Functions | |
resetBaseLanguage () | |
getBaseLanguage () | |
getObjectTplLanguage () | |
getTplLanguage () | |
getEditLanguage () | |
getLanguageArray ($iLanguage=null, $blOnlyActive=false, $blSort=false) | |
getAdminTplLanguageArray () | |
getLanguageAbbr ($iLanguage=null) | |
getLanguageNames () | |
getLanguageIds () | |
translateString ($sStringToTranslate, $iLang=null, $blAdminMode=null) | |
getSimilarByKey ($sKey, $iLang=null, $blAdmin=null) | |
formatCurrency ($dValue, $oActCur=null) | |
formatVat ($dValue, $oActCur=null) | |
getLanguageTag ($iLanguage=null) | |
validateLanguage ($iLang=null) | |
setBaseLanguage ($iLang=null) | |
setTplLanguage ($iLang=null) | |
getName () | |
getFormLang () | |
getUrlLang ($iLang=null) | |
processUrl ($sUrl, $iLang=null) | |
detectLanguageByBrowser () | |
getMultiLangTables () | |
getSeoReplaceChars ($iLang) | |
Static Public Member Functions | |
static | getInstance () |
Protected Member Functions | |
_collectSimilar ($aData, $sKey, $aCollection=array()) | |
_recodeLangArray ($aLangArray, $sCharset, $blRecodeKeys=false) | |
_getLangFilesPathArray ($iLang) | |
_getAdminLangFilesPathArray ($iLang) | |
_appendLangFile ($aLangFiles, $sFullPath, $sFilePattern="lang") | |
_appendCustomLangFiles ($aLangFiles, $sLang, $blForAdmin=false) | |
_appendModuleLangFiles ($aLangFiles, $aModulePaths, $sLang, $blForAdmin=false) | |
_getLangFileCacheName ($blAdmin, $iLang, $aLangFiles=null) | |
_getLanguageFileData ($blAdmin=false, $iLang=0, $aLangFiles=null) | |
_getLanguageMap ($iLang, $blAdmin=null) | |
_getCacheLanguageId ($blAdmin, $iLang=null) | |
_getLangTranslationArray ($iLang=null, $blAdmin=null, $aLangFiles=null) | |
_sortLanguagesCallback ($a1, $a2) | |
_getActiveModuleInfo () | |
_getDisabledModuleInfo () | |
Protected Attributes | |
$_sName = 'lang' | |
$_iBaseLanguageId = null | |
$_iTplLanguageId = null | |
$_iEditLanguageId = null | |
$_aLangCache = array() | |
$_aAdminTplLanguageArray = null | |
$_aLangAbbr = null | |
$_aAdditionalLangFiles = array() | |
$_aLangMap = array() | |
$_aActiveModuleInfo = null | |
$_aDisabledModuleInfo = null | |
Static Private Attributes | |
static | $_instance = null |
Language related utility class
Definition at line 6 of file oxlang.php.
oxLang._appendCustomLangFiles | ( | $ | aLangFiles, | |
$ | sLang, | |||
$ | blForAdmin = false | |||
) | [protected] |
Appends Custom language files cust_lang.php
array | $aLangFiles existing language files | |
string | $sLang language abbreviation | |
bool | $blForAdmin add files for admin |
Definition at line 796 of file oxlang.php.
oxLang._appendLangFile | ( | $ | aLangFiles, | |
$ | sFullPath, | |||
$ | sFilePattern = "lang" | |||
) | [protected] |
Appends lang or options files if exists, exept custom lang files
array | $aLangFiles existing language files | |
string | $sFullPath path to language files to append | |
string | $sFilePattern file pattern to search for, default is "lang" |
Definition at line 774 of file oxlang.php.
oxLang._appendModuleLangFiles | ( | $ | aLangFiles, | |
$ | aModulePaths, | |||
$ | sLang, | |||
$ | blForAdmin = false | |||
) | [protected] |
Appends module lang or options files if exists
array | $aLangFiles existing language files | |
array | $aModulePaths module language file paths | |
string | $sLang language abbreviation | |
bool | $blForAdmin add files for admin |
Definition at line 827 of file oxlang.php.
oxLang._collectSimilar | ( | $ | aData, | |
$ | sKey, | |||
$ | aCollection = array() | |||
) | [protected] |
Iterates through given array ($aData) and collects data if array key is similar as searchable key ($sKey*). If you pass $aCollection, it will be appended with found items
array | $aData array to search in | |
string | $sKey key to look for (looking for similar with strpos) | |
array | $aCollection array to append found items [optional] |
Definition at line 476 of file oxlang.php.
oxLang._getActiveModuleInfo | ( | ) | [protected] |
oxLang._getAdminLangFilesPathArray | ( | $ | iLang | ) | [protected] |
Returns array with paths where admin language files are stored
int | $iLang active language |
Definition at line 734 of file oxlang.php.
oxLang._getCacheLanguageId | ( | $ | blAdmin, | |
$ | iLang = null | |||
) | [protected] |
Returns current language cache language id
bool | $blAdmin admin mode | |
int | $iLang language id [optional] |
Definition at line 986 of file oxlang.php.
oxLang._getDisabledModuleInfo | ( | ) | [protected] |
oxLang._getLangFileCacheName | ( | $ | blAdmin, | |
$ | iLang, | |||
$ | aLangFiles = null | |||
) | [protected] |
Returns language cache file name
bool | $blAdmin admin or not | |
int | $iLang current language id | |
array | $aLangFiles language files to load [optional] |
Definition at line 864 of file oxlang.php.
oxLang._getLangFilesPathArray | ( | $ | iLang | ) | [protected] |
Returns array with paths where frontend language files are stored
int | $iLang active language |
Definition at line 682 of file oxlang.php.
oxLang._getLangTranslationArray | ( | $ | iLang = null , |
|
$ | blAdmin = null , |
|||
$ | aLangFiles = null | |||
) | [protected] |
get language array from lang translation file
int | $iLang optional language | |
bool | $blAdmin admin mode switch | |
array | $aLangFiles language files to load [optional] |
Definition at line 1008 of file oxlang.php.
oxLang._getLanguageFileData | ( | $ | blAdmin = false , |
|
$ | iLang = 0 , |
|||
$ | aLangFiles = null | |||
) | [protected] |
Returns language cache array
bool | $blAdmin admin or not [optional] | |
int | $iLang current language id [optional] | |
array | $aLangFiles language files to load [optional] |
Definition at line 883 of file oxlang.php.
oxLang._getLanguageMap | ( | $ | iLang, | |
$ | blAdmin = null | |||
) | [protected] |
Returns language map array
int | $iLang language index | |
bool | $blAdmin admin mode [default NULL] |
Definition at line 959 of file oxlang.php.
oxLang._recodeLangArray | ( | $ | aLangArray, | |
$ | sCharset, | |||
$ | blRecodeKeys = false | |||
) | [protected] |
Goes through language array and recodes its values. Returns recoded data
array | $aLangArray language data | |
string | $sCharset charset which was used while making file | |
bool | $blRecodeKeys leave keys untouched or recode it |
Definition at line 659 of file oxlang.php.
oxLang._sortLanguagesCallback | ( | $ | a1, | |
$ | a2 | |||
) | [protected] |
Language sorting callback function
object | $a1 first value to check | |
object | $a2 second value to check |
Definition at line 1038 of file oxlang.php.
oxLang.detectLanguageByBrowser | ( | ) |
Detect language by user browser settings. Returns language ID if detected, otherwise returns null.
Definition at line 1126 of file oxlang.php.
oxLang.formatCurrency | ( | $ | dValue, | |
$ | oActCur = null | |||
) |
Returns formatted number, according to active currency formatting standards.
double | $dValue Plain price | |
object | $oActCur Object of active currency |
Definition at line 531 of file oxlang.php.
oxLang.formatVat | ( | $ | dValue, | |
$ | oActCur = null | |||
) |
Returns formatted vat value, according to formatting standards.
double | $dValue Plain price | |
object | $oActCur Object of active currency |
Definition at line 548 of file oxlang.php.
oxLang.getAdminTplLanguageArray | ( | ) |
Returns languages array containing possible admin template translations
Definition at line 314 of file oxlang.php.
oxLang.getBaseLanguage | ( | ) |
oxLang.getEditLanguage | ( | ) |
Returns editing object working language id
Definition at line 222 of file oxlang.php.
oxLang.getFormLang | ( | ) |
static oxLang.getInstance | ( | ) | [static] |
resturns a single instance of this class
Definition at line 99 of file oxlang.php.
oxLang.getLanguageAbbr | ( | $ | iLanguage = null |
) |
Returns selected language abbervation
int | $iLanguage language id [optional] |
Definition at line 367 of file oxlang.php.
oxLang.getLanguageArray | ( | $ | iLanguage = null , |
|
$ | blOnlyActive = false , |
|||
$ | blSort = false | |||
) |
Returns array of available languages.
integer | $iLanguage Number if current language (default null) | |
bool | $blOnlyActive load only current language or all | |
bool | $blSort enable sorting or not |
Definition at line 259 of file oxlang.php.
oxLang.getLanguageIds | ( | ) |
Returns available language IDs (abbervations)
Definition at line 410 of file oxlang.php.
oxLang.getLanguageNames | ( | ) |
getLanguageNames returns array of language names e.g. array('Deutch', 'English')
public
Definition at line 394 of file oxlang.php.
oxLang.getLanguageTag | ( | $ | iLanguage = null |
) |
According to user configuration forms and return language prefix.
integer | $iLanguage User selected language (default null) |
Definition at line 569 of file oxlang.php.
oxLang.getMultiLangTables | ( | ) |
oxLang.getName | ( | ) |
oxLang.getObjectTplLanguage | ( | ) |
Returns language id used to load objects according to current template language
Definition at line 188 of file oxlang.php.
oxLang.getSeoReplaceChars | ( | $ | iLang | ) |
Get SEO spec. chars replacement list for current language
int | $iLang language ID |
Definition at line 1176 of file oxlang.php.
oxLang.getSimilarByKey | ( | $ | sKey, | |
$ | iLang = null , |
|||
$ | blAdmin = null | |||
) |
Returns array( "MY_TRANSLATION_KEY" => "MY_TRANSLATION_VALUE", ... ) by given filter "MY_TRANSLATION_" from language files
string | $sKey key to look | |
int | $iLang language files to search [optional] | |
bool | $blAdmin admin/non admin mode [optional] |
Definition at line 497 of file oxlang.php.
oxLang.getTplLanguage | ( | ) |
Returns active shop templates language id If it is not an admin area, template language id is same as base shop language id
Definition at line 208 of file oxlang.php.
oxLang.getUrlLang | ( | $ | iLang = null |
) |
Returns url language parameter
int | $iLang lanugage id [optional] |
Definition at line 1074 of file oxlang.php.
oxLang.processUrl | ( | $ | sUrl, | |
$ | iLang = null | |||
) |
Is needed appends url with language parameter Direct usage of this method to retrieve end url result is discouraged - instead see oxUtilsUrl.processUrl
string | $sUrl url to process | |
int | $iLang language id [optional] |
Definition at line 1096 of file oxlang.php.
oxLang.resetBaseLanguage | ( | ) |
resetBaseLanguage resets base language id cache
public
Definition at line 110 of file oxlang.php.
oxLang.setBaseLanguage | ( | $ | iLang = null |
) |
Set base shop language
int | $iLang Language id |
Definition at line 610 of file oxlang.php.
oxLang.setTplLanguage | ( | $ | iLang = null |
) |
Validates and sets templates language id
int | $iLang Language id |
Definition at line 632 of file oxlang.php.
oxLang.translateString | ( | $ | sStringToTranslate, | |
$ | iLang = null , |
|||
$ | blAdminMode = null | |||
) |
Searches for translation string in file and on success returns translation, otherwise returns initial string.
string | $sStringToTranslate Initial string | |
int | $iLang optional language number | |
bool | $blAdminMode on special case you can force mode, to load language constant from admin/shops language file |
oxLanguageException | in debug mode |
Definition at line 441 of file oxlang.php.
oxLang.validateLanguage | ( | $ | iLang = null |
) |
Validate language id. If not valid id, returns default value
int | $iLang Language id |
Definition at line 587 of file oxlang.php.
oxLang.$_aActiveModuleInfo = null [protected] |
Definition at line 83 of file oxlang.php.
oxLang.$_aAdditionalLangFiles = array() [protected] |
Definition at line 69 of file oxlang.php.
oxLang.$_aAdminTplLanguageArray = null [protected] |
Definition at line 55 of file oxlang.php.
oxLang.$_aDisabledModuleInfo = null [protected] |
Definition at line 90 of file oxlang.php.
oxLang.$_aLangAbbr = null [protected] |
Definition at line 62 of file oxlang.php.
oxLang.$_aLangCache = array() [protected] |
Definition at line 48 of file oxlang.php.
oxLang.$_aLangMap = array() [protected] |
Definition at line 76 of file oxlang.php.
oxLang.$_iBaseLanguageId = null [protected] |
Definition at line 27 of file oxlang.php.
oxLang.$_iEditLanguageId = null [protected] |
Definition at line 41 of file oxlang.php.
oxLang.$_instance = null [static, private] |
Definition at line 13 of file oxlang.php.
oxLang.$_iTplLanguageId = null [protected] |
Definition at line 34 of file oxlang.php.
oxLang.$_sName = 'lang' [protected] |
Definition at line 20 of file oxlang.php.