oxLang Class Reference

Inheritance diagram for oxLang:

Collaboration diagram for oxLang:

List of all members.

Public Member Functions
	resetBaseLanguage ()
	getBaseLanguage ()
	getObjectTplLanguage ()
	getTplLanguage ()
	getEditLanguage ()
	getLanguageArray ($iLanguage=null, $blOnlyActive=false, $blSort=false)
	getAdminTplLanguageArray ()
	getLanguageAbbr ($iLanguage=null)
	getLanguageNames ()
	getLanguageIds ()
	registerAdditionalLangFile ($sFile)
	translateString ($sStringToTranslate, $iLang=null, $blAdminMode=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 ()
Static Public Member Functions
static	getInstance ()
Protected Member Functions
	_recodeLangArray ($aLangArray, $sCharset)
	_getLangFilesPathArray ($blAdmin, $iLang)
	_getLangFileCacheName ($blAdmin, $iLang, $aLangFiles=null)
	_getLanguageFileData ($blAdmin=false, $iLang=0, $aLangFiles=null)
	_getLanguageMap ($iLang)
	_getCacheLanguageId ($blAdmin, $iLang=null)
	_getLangTranslationArray ($iLang=null, $blAdmin=null, $aLangFiles=null)
	_readTranslateStrFromTextFile ($sStringToTranslate, $iLang=null, $blIsAdmin=null)
	_sortLanguagesCallback ($a1, $a2)
Protected Attributes
	$_sName = 'lang'
	$_iBaseLanguageId = null
	$_iTplLanguageId = null
	$_iEditLanguageId = null
	$_aLangCache = array()
	$_aAdminTplLanguageArray = null
	$_aLangAbbr = null
	$_aAdditionalLangFiles = array()
	$_aLangMap = array()
Static Private Attributes
static	$_instance = null

---

Detailed Description

Language related utility class

Definition at line 6 of file oxlang.php.

---

Member Function Documentation

oxLang._getCacheLanguageId	(	$	blAdmin,
		$	iLang = null
	)			[protected]

Returns current language cache language id

Parameters:

	bool	$blAdmin admin mode
	int	$iLang language id [optional]

Returns:

int

Definition at line 843 of file oxlang.php.

oxLang._getLangFileCacheName	(	$	blAdmin,
		$	iLang,
		$	aLangFiles = null
	)			[protected]

Returns language cache file name

Parameters:

	bool	$blAdmin admin or not
	int	$iLang current language id
	array	$aLangFiles language files to load [optional]

Returns:

string

Definition at line 742 of file oxlang.php.

oxLang._getLangFilesPathArray	(	$	blAdmin,
		$	iLang
	)			[protected]

Returns array with paths where language files are stored

Parameters:

	bool	$blAdmin admin mode
	int	$iLang active language

Returns:

array

Definition at line 643 of file oxlang.php.

oxLang._getLangTranslationArray	(	$	iLang = null,
		$	blAdmin = null,
		$	aLangFiles = null
	)			[protected]

get language array from lang translation file

Parameters:

	int	$iLang optional language
	bool	$blAdmin admin mode switch
	array	$aLangFiles language files to load [optional]

Returns:

array

Definition at line 865 of file oxlang.php.

oxLang._getLanguageFileData	(	$	blAdmin = false,
		$	iLang = 0,
		$	aLangFiles = null
	)			[protected]

Returns language cache array

Parameters:

	bool	$blAdmin admin or not [optional]
	int	$iLang current language id [optional]
	array	$aLangFiles language files to load [optional]

Returns:

array

Definition at line 761 of file oxlang.php.

oxLang._getLanguageMap

(

$

iLang

)

[protected]

Returns language map array

Parameters:

int

$iLang language index

Returns:

array

Definition at line 818 of file oxlang.php.

oxLang._readTranslateStrFromTextFile	(	$	sStringToTranslate,
		$	iLang = null,
		$	blIsAdmin = null
	)			[protected]

translates a given string

Parameters:

	string	$sStringToTranslate string that should be translated
	int	$iLang language id (optional)
	bool	$blIsAdmin admin mode switch (default null)

Deprecated:

, text files should not be used any more (2011.07.06)

Returns:

string translation

Definition at line 898 of file oxlang.php.

oxLang._recodeLangArray	(	$	aLangArray,
		$	sCharset
	)			[protected]

Goes through language array and recodes its values. Returns recoded data

Parameters:

	array	$aLangArray language data
	string	$sCharset charset which was used while making file

Returns:

array

Definition at line 626 of file oxlang.php.

oxLang._sortLanguagesCallback	(	$	a1,
		$	a2
	)			[protected]

Language sorting callback function

Parameters:

	object	$a1 first value to check
	object	$a2 second value to check

Returns:

bool

Definition at line 954 of file oxlang.php.

oxLang.detectLanguageByBrowser

(

)

Detect language by user browser settings. Returns language ID if detected, otherwise returns null.

Returns:

int

Definition at line 1042 of file oxlang.php.

oxLang.formatCurrency	(	$	dValue,
		$	oActCur = null
	)

Returns formatted number, according to active currency formatting standards.

Parameters:

	double	$dValue Plain price
	object	$oActCur Object of active currency

Returns:

string

Definition at line 500 of file oxlang.php.

oxLang.formatVat	(	$	dValue,
		$	oActCur = null
	)

Returns formatted vat value, according to formatting standards.

Parameters:

	double	$dValue Plain price
	object	$oActCur Object of active currency

Returns:

string

Definition at line 516 of file oxlang.php.

oxLang.getAdminTplLanguageArray

(

)

Returns languages array containing possible admin template translations

Returns:

array

Definition at line 315 of file oxlang.php.

oxLang.getBaseLanguage

(

)

Returns active shop language id

Returns:

string

Definition at line 119 of file oxlang.php.

oxLang.getEditLanguage

(

)

Returns editing object working language id

Returns:

string

Definition at line 222 of file oxlang.php.

oxLang.getFormLang

(

)

Returns form hidden language parameter

Returns:

string

Definition at line 974 of file oxlang.php.

static oxLang.getInstance

(

)

[static]

resturns a single instance of this class

Returns:

oxLang

Definition at line 84 of file oxlang.php.

oxLang.getLanguageAbbr

(

$

iLanguage = null

)

Returns selected language abbervation

Parameters:

int

$iLanguage language id [optional]

Returns:

string

Definition at line 367 of file oxlang.php.

oxLang.getLanguageArray	(	$	iLanguage = null,
		$	blOnlyActive = false,
		$	blSort = false
	)

Returns array of available languages.

Parameters:

	integer	$iLanguage Number if current language (default null)
	bool	$blOnlyActive load only current language or all
	bool	$blSort enable sorting or not

Returns:

array

Definition at line 258 of file oxlang.php.

oxLang.getLanguageIds

(

)

Returns available language IDs (abbervations)

Returns:

array

Definition at line 410 of file oxlang.php.

oxLang.getLanguageNames

(

)

getLanguageNames returns array of language names e.g. array('Deutch', 'English')

public

Returns:

array

Definition at line 394 of file oxlang.php.

oxLang.getLanguageTag

(

$

iLanguage = null

)

According to user configuration forms and return language prefix.

Parameters:

integer

$iLanguage User selected language (default null)

Returns:

string

Definition at line 537 of file oxlang.php.

oxLang.getMultiLangTables

(

)

Returns all multi language tables

Returns:

array

Definition at line 1064 of file oxlang.php.

oxLang.getName

(

)

Returns language id param name

Returns:

string

Definition at line 964 of file oxlang.php.

oxLang.getObjectTplLanguage

(

)

Returns language id used to load objects according to current template language

Returns:

int

Definition at line 188 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

Returns:

string

Definition at line 208 of file oxlang.php.

oxLang.getUrlLang

(

$

iLang = null

)

Returns url language parameter

Parameters:

int

$iLang lanugage id [optional]

Returns:

string

Definition at line 990 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

Parameters:

	string	$sUrl url to process
	int	$iLang language id [optional]

See also:

oxUtilsUrl.processUrl

Returns:

string

Definition at line 1012 of file oxlang.php.

oxLang.registerAdditionalLangFile

(

$

sFile

)

register additional language files to be loaded for this session

Parameters:

string

$sFile file name

Returns:

null

Deprecated:

since 2012-01-24 marked in version 4.5.7

Definition at line 437 of file oxlang.php.

oxLang.resetBaseLanguage

(

)

resetBaseLanguage resets base language id cache

public

Returns:

void

Definition at line 109 of file oxlang.php.

oxLang.setBaseLanguage

(

$

iLang = null

)

Set base shop language

Parameters:

int

$iLang Language id

Returns:

null

Definition at line 578 of file oxlang.php.

oxLang.setTplLanguage

(

$

iLang = null

)

Validates and sets templates language id

Parameters:

int

$iLang Language id

Returns:

null

Definition at line 600 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.

Parameters:

	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

Exceptions:

oxLanguageException

in debug mode

Returns:

string

Definition at line 459 of file oxlang.php.

oxLang.validateLanguage

(

$

iLang = null

)

Validate language id. If not valid id, returns default value

Parameters:

int

$iLang Language id

Returns:

int

Definition at line 555 of file oxlang.php.

---

Member Data Documentation

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.$_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.

---

The documentation for this class was generated from the following file:

• core/oxlang.php