oxConfig Class Reference

Inheritance diagram for oxConfig:

[legend]

Collaboration diagram for oxConfig:

[legend]

List of all members.

Detailed Description

Main shop configuration class.


Public Member Functions
	getConfigParam ($sName)
	setConfigParam ($sName, $sValue)
	init ()
	pageClose ()
	getUploadedFile ($sParamName)
	setGlobalParameter ($sName, $sValue)
	getGlobalParameter ($sName)
	getShopId ()
	setShopId ($sShopId)
	isSsl ()
	isCurrentUrl ($sURL)
	getShopUrl ($iLang=null)
	getSslShopUrl ($iLang=null)
	getCoreUtilsUrl ()
	getCurrentShopUrl ()
	getShopCurrentUrl ($iLang=null)
	getShopHomeUrl ()
	getShopSecureHomeUrl ()
	getShopCurrency ()
	getActShopCurrencyObject ()
	setActShopCurrency ($iCur)
	getNoSslImageDir ($blAdmin=false)
	getAbsAdminImageDir ()
	formatOutDir ($sFile, $iLang=null, $blAdmin=false, $blNoThemes=false, $iShop=null)
	getOutDir ($blAbsolute=true)
	getOutUrl ($blSSL=null, $blNativeImg=false, $blAdmin=null)
	getDir ($sFile, $sDir, $blAdmin, $iLang=null, $iShop=null, $sTheme=null, $blAbsolute=true)
	getUrl ($sFile, $sDir, $blAdmin=null, $blSSL=null, $blNativeImg=false, $iLang=null, $iShop=null, $sTheme=null)
	getImagePath ($sFile, $blAdmin=false)
	getImageUrl ($blAdmin=false, $blSSL=null, $blNativeImg=null)
	getImageDir ($blAdmin=false)
	getPicturePath ($sFile, $blAdmin=false)
	getPictureUrl ($sFile, $blAdmin=false, $blSSL=null, $iLang=null, $iShopId=null)
	getPictureDir ($blAdmin)
	getTemplatePath ($sFile, $blAdmin)
	getTemplateDir ($blAdmin=false)
	getTemplateUrl ($sFile=null, $blAdmin=false, $blSSL=null, $iLang=null)
	getTemplateBase ($blAdmin=false)
	getResourcePath ($sFile, $blAdmin=false)
	getResourceUrl ($sFile, $blAdmin=false, $blSSL=null, $iLang=null)
	getResourceDir ($blAdmin)
	getLanguagePath ($sFile, $blAdmin, $iLang=null)
	getLanguageDir ($blAdmin)
	getAbsImageDir ()
	getDynImageDir ($sOverrideShopId=null, $blNoSsl=null)
	getAbsDynImageDir ($sOverrideShopId=null)
	getTemplateFile ($sTemplate, $blAdmin=false)
	getBaseTemplateDir ($blAdmin=false)
	getBaseTplDir ($blAdmin=false)
	getCurrencyArray ($iCurrency=null)
	getCurrencyObject ($sName)
	isDemoShop ()
	getEdition ()
	getFullEdition ()
	getVersion ()
	isMall ()
	detectVersion ()
	saveShopConfVar ($sVarType, $sVarName, $sVarVal, $sShopId=null)
	getShopConfVar ($sVarName, $sShopId=null)
	isProductiveMode ()
	getBaseShopId ()
	getActiveShop ()
	getActiveView ()
	setActiveView ($oView)
Static Public Member Functions
static	getInstance ()
static	getParameter ($sName, $blRaw=false)
static	checkSpecialChars (&$sValue, $aRaw=null)
Protected Member Functions
	_loadVarsFromDb ($sShopID, $aOnlyVars=null)
Protected Attributes
	$dbHost = null
	$dbName = null
	$dbUser = null
	$dbPwd = null
	$dbType = null
	$sShopURL = null
	$sSSLShopURL = null
	$sAdminSSLURL = null
	$sShopDir = null
	$sCompileDir = null
	$iDebug = 0
	$sAdminEmail = null
	$blSessionUseCookies = null
	$blSessionEnforceCookies = null
	$blNativeImages = true
	$aMultiShopTables
	$_oActShop = null
	$_oActView = null
	$_aGlobalParams = array()
	$_aConfigParams = array()
	$_iLanguageId = null
	$_iShopId = null
	$_sOutDir = 'out'
	$_sImageDir = 'img'
	$_sPictureDir = 'pictures'
	$_sTemplateDir = 'tpl'
	$_sResourceDir = 'src'
	$_blIsSsl = null
	$_aAbsDynImageDir = array()
	$_oActCurrencyObject = null
Private Attributes
	$_oStart = null
Static Private Attributes
static	$_instance = null

Member Function Documentation

oxConfig.getConfigParam ( $ sName )

Returns config parameter value if such parameter exists

Parameters:

string

$sName config parameter name

Returns:: mixed

oxConfig.setConfigParam	(	$	sName,
		$	sValue
	)

Stores config parameter value in cofig

Parameters:

	string	$sName config parameter name
	string	$sValue config parameter value

Returns:: null

oxConfig.init ( )

Starts session manager

Returns:: null

static oxConfig.getInstance ( ) [static]

Returns singleton oxConfig object instance or create new if needed

Returns:: oxConfig

oxConfig._loadVarsFromDb	(	$	sShopID,
		$	aOnlyVars = `null`
	)			`[protected]`

Load config values from DB

Parameters:

	string	$sShopID shop ID to load parameters
	array	$aOnlyVars array of params to load (optional)

Returns:: null

oxConfig.pageClose ( )

Unsets all session data.

Returns:: null

static oxConfig.getParameter	(	$	sName,
		$	blRaw = `false`
	)			`[static]`

Returns value of parameter stored in POST,GET. This method returns parameter stored in session as well, but this functionality is deprecated and will be removed in future

For security reasons performed oxconfig.checkSpecialChars(). use $blRaw very carefully if you want to get unescaped parameter.

Parameters:

	string	$sName Name of parameter
	bool	$blRaw Get unescaped parameter

Returns:: mixed

oxConfig.getUploadedFile ( $ sParamName )

Returns uploaded file parameter

Parameters:

array

$sParamName

oxConfig.setGlobalParameter	(	$	sName,
		$	sValue
	)

Sets global parameter value

Parameters:

	string	$sName name of parameter
	mixed	$sValue value to store

Returns:: null

oxConfig.getGlobalParameter ( $ sName )

Returns global parameter value

Parameters:

string

$sName name of cached parameter

Returns:: mixed

static oxConfig.checkSpecialChars	(	&$	sValue,
		$	aRaw = `null`
	)			`[static]`

Checks if passed parameter has special chars and replaces them. Returns checked value.

Parameters:

	mixed	&$sValue value to process escaping
	array	$aRaw keys of unescaped values

Returns:: mixed

oxConfig.getShopId ( )

Returns active shop ID.

Returns:: int

oxConfig.setShopId ( $ sShopId )

Active Shop id setter

Parameters:

string

$sShopId shop id

Returns:: null

oxConfig.isSsl ( )

Checks if WEB session is SSL. Returns true if yes.

Returns:: bool

oxConfig.isCurrentUrl ( $ sURL )

Compares current URL to supplied string

Parameters:

string

$sURL URL

Returns:: bool true if $sURL is equal to current page URL

oxConfig.getShopUrl ( $ iLang = null )

Returns config sShopURL or sMallShopURL if secondary shop

Parameters:

int

$iLang language

Returns:: string

oxConfig.getSslShopUrl ( $ iLang = null )

Returns config sSSLShopURL or sMallSSLShopURL if secondary shop

Parameters:

int

$iLang language (default is null)

Returns:: string

oxConfig.getCoreUtilsUrl ( )

Returns utils dir URL

Returns:: string

oxConfig.getCurrentShopUrl ( )

Returns SSL or non SSL shop URL without index.php depending on Mall

Returns:: string

oxConfig.getShopCurrentUrl ( $ iLang = null )

Returns SSL or not SSL shop URL with index.php and sid

Parameters:

int

$iLang language (optional)

Returns:: string

oxConfig.getShopHomeUrl ( )

Returns shop non SSL URL including index.php and sid.

Returns:: string

oxConfig.getShopSecureHomeUrl ( )

Returns shop SSL URL with index.php and sid.

Returns:: string

oxConfig.getShopCurrency ( )

Returns active shop currency.

Returns:: string

oxConfig.getActShopCurrencyObject ( )

Returns active shop currency object.

Returns:: object

oxConfig.setActShopCurrency ( $ iCur )

Sets the actual currency

Parameters:

int

$iCur 0 = EUR, 1 = GBP, 2 = CHF

Returns:: null

oxConfig.getNoSslImageDir ( $ blAdmin = false )

Returns image dir URL (no SSL).

Parameters:

bool

$blAdmin mode - admin/non-admin (default is false)

Deprecated:: use getImageUrl

Returns:: string

oxConfig.getAbsAdminImageDir ( )

Returns absolute path to admin images.

Deprecated:: use getImageDir

Returns:: string

oxConfig.formatOutDir	(	$	sFile,
		$	iLang = `null`,
		$	blAdmin = `false`,
		$	blNoThemes = `false`,
		$	iShop = `null`
	)

Formats output directory depending on given parameters. Resources could be language dependant or multilanguage, to be located in theme dir or in default oxbaseshop, 1 or admin dirs. formatOutDir tries to locate resource $sFile in one of these dirs and return that dir. Example result could be /out/basic/1/de/lang.txt when you are looking for "/de/lang.txt" resource ($sFile).

Parameters:

	string	$sFile Resource name - image, template file or dir name (generally from out dir).
	int	$iLang Custom language
	bool	$blAdmin Whether to force admin dirs
	bool	$blNoThemes Whether to force the theme dir.
	string	$iShop

Deprecated:: use getDir

Returns:: string

oxConfig.getOutDir ( $ blAbsolute = true )

Returns path to out dir

Parameters:

bool

$blAbsolute mode - absolute/relative path

Returns:: string

oxConfig.getOutUrl	(	$	blSSL = `null`,
		$	blNativeImg = `false`,
		$	blAdmin = `null`
	)

Returns url to out dir

Parameters:

	bool	$blSSL Whether to force ssl
	bool	$blNativeImg Whether to force native image dirs
	bool	$blAdmin Whether to force admin

Returns:: string

oxConfig.getDir	(	$	sFile,
		$	sDir,
		$	blAdmin,
		$	iLang = `null`,
		$	iShop = `null`,
		$	sTheme = `null`,
		$	blAbsolute = `true`
	)

Finds and returns files or folders path in out dir

Parameters:

	string	$sFile File name
	string	$sDir Directory name
	bool	$blAdmin Whether to force admin
	int	$iLang Language id
	int	$iShop Shop id
	string	$sTheme Theme name
	bool	$blAbsolute mode - absolute/relative path

Returns:: string

oxConfig.getUrl	(	$	sFile,
		$	sDir,
		$	blAdmin = `null`,
		$	blSSL = `null`,
		$	blNativeImg = `false`,
		$	iLang = `null`,
		$	iShop = `null`,
		$	sTheme = `null`
	)

Finds and returns file or folder url in out dir

Parameters:

	string	$sFile File name
	string	$sDir Directory name
	bool	$blAdmin Whether to force admin
	bool	$blSSL Whether to force ssl
	bool	$blNativeImg Whether to force native image dirs
	int	$iLang Language id
	int	$iShop Shop id
	string	$sTheme Theme name
	bool	$blAbsolute mode - absolute/relative path

Returns:: string

oxConfig.getImagePath	(	$	sFile,
		$	blAdmin = `false`
	)

Finds and returns image files or folders path

Parameters:

	string	$sFile File name
	bool	$blAdmin Whether to force admin

Returns:: string

oxConfig.getImageUrl	(	$	blAdmin = `false`,
		$	blSSL = `null`,
		$	blNativeImg = `null`
	)

Finds and returns image folder url

Parameters:

	bool	$blAdmin Whether to force admin
	bool	$blSSL Whether to force ssl
	bool	$blNativeImg Whether to force native image dirs

Returns:: string

oxConfig.getImageDir ( $ blAdmin = false )

Finds and returns image folders path

Parameters:

bool

$blAdmin Whether to force admin

Returns:: string

oxConfig.getPicturePath	(	$	sFile,
		$	blAdmin = `false`
	)

Finds and returns product pictures files or folders path

Parameters:

	string	$sFile File name
	bool	$blAdmin Whether to force admin

Returns:: string

oxConfig.getPictureUrl	(	$	sFile,
		$	blAdmin = `false`,
		$	blSSL = `null`,
		$	iLang = `null`,
		$	iShopId = `null`
	)

Finds and returns product picture file or folder url

Parameters:

	string	$sFile File name
	bool	$blAdmin Whether to force admin
	bool	$blSSL Whether to force ssl
	bool	$blNativeImg Whether to force native image dirs

Returns:: string

oxConfig.getPictureDir ( $ blAdmin )

Finds and returns product pictures folders path

Parameters:

bool

$blAdmin Whether to force admin

Returns:: string

oxConfig.getTemplatePath	(	$	sFile,
		$	blAdmin
	)

Finds and returns templates files or folders path

Parameters:

	string	$sFile File name
	bool	$blAdmin Whether to force admin

Returns:: string

oxConfig.getTemplateDir ( $ blAdmin = false )

Finds and returns templates folders path

Parameters:

bool

$blAdmin Whether to force admin

Returns:: string

oxConfig.getTemplateUrl	(	$	sFile = `null`,
		$	blAdmin = `false`,
		$	blSSL = `null`,
		$	iLang = `null`
	)

Finds and returns template file or folder url

Parameters:

	string	$sFile File name
	bool	$blAdmin Whether to force admin
	bool	$blSSL Whether to force ssl
	int	$iLang Language id

Returns:: string

oxConfig.getTemplateBase ( $ blAdmin = false )

Finds and returns base template folder url

Parameters:

bool

$blAdmin Whether to force admin

Returns:: string

oxConfig.getResourcePath	(	$	sFile,
		$	blAdmin = `false`
	)

Finds and returns resouce (css, js, etc..) files or folders path

Parameters:

	string	$sFile File name
	bool	$blAdmin Whether to force admin

Returns:: string

oxConfig.getResourceUrl	(	$	sFile,
		$	blAdmin = `false`,
		$	blSSL = `null`,
		$	iLang = `null`
	)

Finds and returns resouce (css, js, etc..) file or folder url

Parameters:

	string	$sFile File name
	bool	$blAdmin Whether to force admin
	bool	$blSSL Whether to force ssl
	int	$iLang Language id

Returns:: string

oxConfig.getResourceDir ( $ blAdmin )

Finds and returns resouce (css, js, etc..) folders path

Parameters:

	string	$sFile File name
	bool	$blAdmin Whether to force admin

Returns:: string

oxConfig.getLanguagePath	(	$	sFile,
		$	blAdmin,
		$	iLang = `null`
	)

Finds and returns language files or folders path

Parameters:

	string	$sFile File name
	bool	$blAdmin Whether to force admin
	int	$iLang Language id

Returns:: string

oxConfig.getLanguageDir ( $ blAdmin )

Finds and returns language folders path

Parameters:

bool

$blAdmin Whether to force admin

Returns:: string

oxConfig.getAbsImageDir ( )

Returns absolute path to images.

Deprecated:: use getImageDir

Returns:: string

oxConfig.getDynImageDir	(	$	sOverrideShopId = `null`,
		$	blNoSsl = `null`
	)

Returns url to Dyn images.

Parameters:

	string	$sOverrideShopId Shop ID (default null)
	bool	$blNoSsl SSL status (default null)

Deprecated:

Returns:: string

oxConfig.getAbsDynImageDir ( $ sOverrideShopId = null )

Returns absolute path to Dyn images.

Parameters:

string

$sOverrideShopId Shop ID (default null)

Deprecated:

Returns:: string

oxConfig.getTemplateFile	(	$	sTemplate,
		$	blAdmin = `false`
	)

Returns shop template file path.

Parameters:

	string	$sTemplate name of template file
	bool	$blAdmin mode - admin/non-admin (default is false)

Deprecated:

Returns:: string

oxConfig.getBaseTemplateDir ( $ blAdmin = false )

Returns path to template files. Eg. 'http://localhost/oxid/out/1/html/0/templates/'

Parameters:

bool

$blAdmin mode - admin/non-admin (default is false)

Deprecated:: use getResourceUrl

Returns:: string

oxConfig.getBaseTplDir ( $ blAdmin = false )

Returns base path to template files. (eg. 'out/1/')

Parameters:

bool

$blAdmin mode - admin/non-admin (default is false)

Deprecated:

Returns:: string

oxConfig.getCurrencyArray ( $ iCurrency = null )

Returns array of available currencies

Parameters:

integer

$iCurrency Active currency number (default null)

Returns:: array

oxConfig.getCurrencyObject ( $ sName )

Returns currency object.

Parameters:

string

$sName Name of active currency

Returns:: object

oxConfig.isDemoShop ( )

Checks if the shop is in demo mode.

Returns:: bool

oxConfig.getEdition ( )

Returns OXID eShop edition

Returns:: string

oxConfig.getFullEdition ( )

Returns full eShop edition name

Returns:: string

oxConfig.getVersion ( )

Returns shops version number (eg. '4.0.0.0')

Returns:: unknown

oxConfig.isMall ( )

Checks if shop is MALL. Returns true on success.

Returns:: bool

oxConfig.detectVersion ( )

Checks version of shop, returns: 0 - version is bellow 2.2 1 - Demo or unlicensed 2 - Pro 3 - Enterprise

Returns:: int

oxConfig.saveShopConfVar	(	$	sVarType,
		$	sVarName,
		$	sVarVal,
		$	sShopId = `null`
	)

Updates or adds new shop configuration parameters to DB.

Parameters:

	string	$sVarType Variable Type
	string	$sVarName Variable name
	string	$sVarVal Variable value
	string	$sShopId Shop ID, default is current shop

Returns:: null

oxConfig.getShopConfVar	(	$	sVarName,
		$	sShopId = `null`
	)

Retrieves shop configuration parameters from DB.

Parameters:

	string	$sVarName Variable name
	string	$sShopId Shop ID

Returns:: object - raw configuration value in DB

oxConfig.isProductiveMode ( )

Returns true if current active shop is in productive mode or false if not

Returns:: bool

oxConfig.getBaseShopId ( )

Function returns default shop ID

Returns:: string

oxConfig.getActiveShop ( )

Loads and returns active shop object

Returns:: oxshop

oxConfig.getActiveView ( )

Returns active view object. If this object was not defined - returns oxview object

Returns:: oxview

oxConfig.setActiveView ( $ oView )

View object setter

Parameters:

object

$oView view object

Returns:: null

Member Data Documentation

oxConfig.$dbHost = null [protected]

oxConfig.$dbName = null [protected]

oxConfig.$dbUser = null [protected]

oxConfig.$dbPwd = null [protected]

oxConfig.$dbType = null [protected]

oxConfig.$sShopURL = null [protected]

oxConfig.$sSSLShopURL = null [protected]

oxConfig.$sAdminSSLURL = null [protected]

oxConfig.$sShopDir = null [protected]

oxConfig.$sCompileDir = null [protected]

oxConfig.$iDebug = 0 [protected]

oxConfig.$sAdminEmail = null [protected]

oxConfig.$blSessionUseCookies = null [protected]

oxConfig.$blSessionEnforceCookies = null [protected]

oxConfig.$blNativeImages = true [protected]

oxConfig.$aMultiShopTables [protected]

Initial value:

 array( 'oxarticles', 'oxdiscount', 'oxcategories', 'oxattribute',
                                         'oxlinks', 'oxvoucherseries',
                                         'oxnews', 'oxselectlist', 'oxwrapping',
                                         'oxdeliveryset', 'oxdelivery', 'oxvendor', 'oxobject2category')

oxConfig.$_instance = null [static, private]

oxConfig.$_oStart = null [private]

oxConfig.$_oActShop = null [protected]

oxConfig.$_oActView = null [protected]

oxConfig.$_aGlobalParams = array() [protected]

oxConfig.$_aConfigParams = array() [protected]

oxConfig.$_iLanguageId = null [protected]

oxConfig.$_iShopId = null [protected]

oxConfig.$_sOutDir = 'out' [protected]

oxConfig.$_sImageDir = 'img' [protected]

oxConfig.$_sPictureDir = 'pictures' [protected]

oxConfig.$_sTemplateDir = 'tpl' [protected]

oxConfig.$_sResourceDir = 'src' [protected]

oxConfig.$_blIsSsl = null [protected]

oxConfig.$_aAbsDynImageDir = array() [protected]

oxConfig.$_oActCurrencyObject = null [protected]

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

core/oxconfig.php

oxConfig Class Reference

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Member Function Documentation

Member Data Documentation