Inheritance diagram for OxidEsales\EshopCommunity\Core\Config:

Collaboration diagram for OxidEsales\EshopCommunity\Core\Config:

Public Member Functions
	getConfigParam ($name, $default=null)

	setConfigParam ($name, $value)

	init ()

	reinitialize ()

	pageClose ()

	getRequestParameter ($name, $raw=false)

	getRequestEscapedParameter ($name, $defaultValue=null)

	getRequestRawParameter ($name, $defaultValue=null)

	getRequestControllerId ()

	getRequestControllerClass ()

	getUploadedFile ($paramName)

	setGlobalParameter ($name, $value)

	getGlobalParameter ($name)

	checkParamSpecialChars (&$value, $raw=null)

	setShopId ($shopId)

	getShopId ()

	setIsSsl ($isSsl=false)

	isSsl ()

	isHttpsOnly ()

	isCurrentUrl ($url)

	isCurrentProtocol ($url)

	getShopUrl ($lang=null, $admin=null)

	getSslShopUrl ($lang=null)

	getCoreUtilsUrl ()

	getCurrentShopUrl ($admin=null)

	getShopCurrentUrl ($lang=null)

	getShopHomeUrl ($lang=null, $admin=null)

	getWidgetUrl ($languageId=null, $inAdmin=null, $urlParameters=[])

	getShopSecureHomeUrl ()

	getShopCurrency ()

	getActShopCurrencyObject ()

	setActShopCurrency ($cur)

	getOutDir ($absolute=true)

	getViewsDir ($absolute=true)

	getTranslationsDir ($file, $dir, $absolute=true)

	getAppDir ($absolute=true)

	getOutUrl ($ssl=null, $admin=null, $nativeImg=false)

	getDir ($file, $dir, $admin, $lang=null, $shop=null, $theme=null, $absolute=true, $ignoreCust=false)

	getUrl ($file, $dir, $admin=null, $ssl=null, $nativeImg=false, $lang=null, $shop=null, $theme=null)

	getImagePath ($file, $admin=false)

	getImageUrl ($admin=false, $ssl=null, $nativeImg=null, $file=null)

	getImageDir ($admin=false)

	getPicturePath ($file, $admin=false, $lang=null, $shop=null, $theme=null)

	getMasterPictureDir ($admin=false)

	getMasterPicturePath ($file, $admin=false)

	getPictureUrl ($file, $admin=false, $ssl=null, $lang=null, $shopId=null, $defPic="master/nopic.jpg")

	getPictureDir ($admin)

	getTemplatePath ($templateName, $isAdmin)

	getTemplateDir ($admin=false)

	getTemplateUrl ($file=null, $admin=false, $ssl=null, $lang=null)

	getTemplateBase ($admin=false)

	getResourcePath ($file='', $admin=false)

	getModulesDir ($absolute=true)

	getResourceUrl ($file='', $admin=false, $ssl=null, $lang=null)

	getResourceDir ($admin)

	getCurrencyArray ($currency=null)

	getCurrencyObject ($name)

	isDemoShop ()

	getEdition ()

	getFullEdition ()

	getVersion ()

	getRevision ()

	getPackageInfo ()

	getMandateCount ()

	isMall ()

	detectVersion ()

	saveShopConfVar ($varType, $varName, $varVal, $shopId=null, $module='')

	getShopConfVar ($varName, $shopId=null, $module='')

	decodeValue ($type, $mOrigValue)

	getDecodeValueQuery ($fieldName="oxvarvalue")

	isProductiveMode ()

	getBaseShopId ()

	getActiveShop ()

	getActiveView ()

	getTopActiveView ()

	getActiveViewsList ()

	setActiveView ($view)

	dropLastActiveView ()

	hasActiveViewsChain ()

	getActiveViewsNames ()

	getActiveViewsIds ()

	isUtf ()

	getLogsDir ()

	isThemeOption ($name)

	getShopMainUrl ()

	getModulesWithExtendedClass ()

	parseModuleChains ($modules)

	getShopIds ()

	getShopUrlByLanguage ($lang, $ssl=false)

	getMallShopUrl ($ssl=false)

	saveSystemConfigParameter ($parameterType, $parameterName, $parameterValue)

	getSystemConfigParameter ($parameterName)

Public Attributes
const	DEFAULT_CONFIG_KEY = 'fq45QS09_fqyx09239QQ'

const	OXMODULE_THEME_PREFIX = 'theme:'

const	OXMODULE_MODULE_PREFIX = 'module:'

Protected Member Functions
	_processSeoCall ()

	loadAdditionalConfiguration ()

	initializeShop ()

	_loadVarsFromFile ()

	_setDefaults ()

	_loadCustomConfig ()

	_loadVarsFromDb ($shopID, $onlyVars=null, $module='')

	_getConfigParamsSelectSnippet ($vars)

	_setConfVarFromDb ($varName, $varType, $varVal)

	_checkSsl ()

	getShopLevelDir ($base, $absBase, $file, $dir, $admin, $lang, $shop, $theme, $absolute, $ignoreCust)

	getModuleTemplatePathCalculator ()

	_handleDbConnectionException (\OxidEsales\Eshop\Core\Exception\DatabaseException $exception)

	_handleCookieException ($ex)

	_isValidShopId ($shopId)

	calculateActiveShopId ()

	getEditionTemplate ($templateName)

	getExceptionHandler ()

Protected Attributes
	$dbHost = null

	$dbName = null

	$dbUser = null

	$dbPwd = null

	$dbType = null

	$sShopURL = null

	$sSSLShopURL = null

	$sAdminSSLURL = null

	$sShopDir = null

	$sCompileDir = null

	$iDebug = null

	$sAdminEmail = null

	$blSessionUseCookies = null

	$blNativeImages = true

	$aMultiShopTables

	$_oActShop = null

	$_aActiveViews = []

	$_aGlobalParams = []

	$_aConfigParams = []

	$_aThemeConfigParams = []

	$_iLanguageId = null

	$_iShopId = null

	$_sOutDir = 'out'

	$_sImageDir = 'img'

	$_sPictureDir = 'pictures'

	$_sMasterPictureDir = 'master'

	$_sTemplateDir = 'tpl'

	$_sResourceDir = 'src'

	$_sModulesDir = 'modules'

	$_blIsSsl = null

	$_aAbsDynImageDir = []

	$_oActCurrencyObject = null

	$_blInit = false

	$sConfigKey = self::DEFAULT_CONFIG_KEY

Private Attributes
	$_oStart = null

Detailed Description

Main shop configuration class.

@mixin \OxidEsales\EshopEnterprise\Core\Config @mixin \OxidEsales\EshopProfessional\Core\Config

Member Function Documentation

◆ _checkSsl()

OxidEsales\EshopCommunity\Core\Config::_checkSsl ( )

protected

Checks if WEB session is SSL.

◆ _getConfigParamsSelectSnippet()

OxidEsales\EshopCommunity\Core\Config::_getConfigParamsSelectSnippet ( $vars )

protected

Allow loading from some vars only from baseshop

Parameters

array $vars

Returns: string

◆ _handleCookieException()

OxidEsales\EshopCommunity\Core\Config::_handleCookieException ( $ex )

protected

Redirect to start page and display the error

Parameters

\OxidEsales\Eshop\Core\Exception\StandardException $ex message to show on exit

◆ _handleDbConnectionException()

OxidEsales\EshopCommunity\Core\Config::_handleDbConnectionException ( \OxidEsales\Eshop\Core\Exception\DatabaseException $exception )

protected

Handle database exception. At this point everything has crashed already and not much of shop business logic is left to call. So just go straight and call the ExceptionHandler.

Parameters

\OxidEsales\Eshop\Core\Exception\DatabaseException $exception

◆ _isValidShopId()

OxidEsales\EshopCommunity\Core\Config::_isValidShopId ( $shopId )

protected

Returns whether given shop id is valid.

Parameters

string $shopId

Returns: bool

◆ _loadCustomConfig()

OxidEsales\EshopCommunity\Core\Config::_loadCustomConfig ( )

protected

Loads vars from custom config file

◆ _loadVarsFromDb()

OxidEsales\EshopCommunity\Core\Config::_loadVarsFromDb	(	$shopID,
		$onlyVars = `null`,
		$module = `''`
	)

protected

Load config values from DB

Parameters

string	$shopID	shop ID to load parameters
array	$onlyVars	array of params to load (optional)
string	$module	module vars to load, empty for base options

Returns: bool

◆ _loadVarsFromFile()

OxidEsales\EshopCommunity\Core\Config::_loadVarsFromFile ( )

protected

Loads vars from default config file

◆ _processSeoCall()

OxidEsales\EshopCommunity\Core\Config::_processSeoCall ( )

protected

Parse SEO url parameters.

◆ _setConfVarFromDb()

OxidEsales\EshopCommunity\Core\Config::_setConfVarFromDb	(	$varName,
		$varType,
		$varVal
	)

protected

Sets config variable to config object, first unserializing it by given type. sShopURL and sSSLShopURL are skipped for admin or when URL values are not set

Parameters

string	$varName	variable name
string	$varType	variable type - arr, aarr, bool or str
string	$varVal	serialized by type value

Returns: null

◆ _setDefaults()

OxidEsales\EshopCommunity\Core\Config::_setDefaults ( )

protected

Set important defaults.

◆ calculateActiveShopId()

OxidEsales\EshopCommunity\Core\Config::calculateActiveShopId ( )

protected

Returns active shop id.

Returns: string

◆ checkParamSpecialChars()

OxidEsales\EshopCommunity\Core\Config::checkParamSpecialChars	(	&	$value,
			$raw = `null`
	)

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

Parameters

mixed	$value	value to process escaping
array	$raw	keys of unescaped values

Returns: mixed

◆ decodeValue()

OxidEsales\EshopCommunity\Core\Config::decodeValue	(	$type,
		$mOrigValue
	)

Decodes and returns database value

Parameters

string	$type	parameter type
mixed	$mOrigValue	parameter db value

Returns: mixed

◆ detectVersion()

OxidEsales\EshopCommunity\Core\Config::detectVersion ( )

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

◆ dropLastActiveView()

OxidEsales\EshopCommunity\Core\Config::dropLastActiveView ( )

Drop last active view object

◆ getActiveShop()

OxidEsales\EshopCommunity\Core\Config::getActiveShop ( )

Loads and returns active shop object

Returns: Shop

◆ getActiveView()

OxidEsales\EshopCommunity\Core\Config::getActiveView ( )

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

Returns: FrontendController

◆ getActiveViewsIds()

OxidEsales\EshopCommunity\Core\Config::getActiveViewsIds ( )

Get active views class id list

Returns: array

◆ getActiveViewsList()

OxidEsales\EshopCommunity\Core\Config::getActiveViewsList ( )

Returns all active views objects list.

Returns: array

◆ getActiveViewsNames()

OxidEsales\EshopCommunity\Core\Config::getActiveViewsNames ( )

Deprecated:: since v6.0 (2017-02-3). Use Config::getActiveViewsIds() instead.

NOTE: according to current logic, this returns the view ids.

Get active views names list

Returns: array

◆ getActShopCurrencyObject()

OxidEsales\EshopCommunity\Core\Config::getActShopCurrencyObject ( )

Returns active shop currency object.

Returns: object

◆ getAppDir()

OxidEsales\EshopCommunity\Core\Config::getAppDir ( $absolute = true )

Returns path to out dir

Parameters

bool $absolute mode - absolute/relative path

Returns: string

◆ getBaseShopId()

OxidEsales\EshopCommunity\Core\Config::getBaseShopId ( )

Function returns default shop ID

Returns: string

◆ getConfigParam()

OxidEsales\EshopCommunity\Core\Config::getConfigParam	(	$name,
		$default = `null`
	)

Returns config parameter value if such parameter exists

Parameters

string	$name	config parameter name
mixed	$default	default value if no config var is found default null

Returns: mixed

◆ getCoreUtilsUrl()

OxidEsales\EshopCommunity\Core\Config::getCoreUtilsUrl ( )

Returns utils dir URL

Returns: string

◆ getCurrencyArray()

OxidEsales\EshopCommunity\Core\Config::getCurrencyArray ( $currency = null )

Returns array of available currencies

Parameters

integer $currency Active currency number (default null)

Returns: array

◆ getCurrencyObject()

OxidEsales\EshopCommunity\Core\Config::getCurrencyObject ( $name )

Returns currency object.

Parameters

string $name Name of active currency

Returns: object

◆ getCurrentShopUrl()

OxidEsales\EshopCommunity\Core\Config::getCurrentShopUrl ( $admin = null )

Returns SSL or non SSL shop URL without index.php depending on Mall affecting environment is admin mode and current ssl usage status

Parameters

bool $admin if admin

Returns: string

◆ getDecodeValueQuery()

OxidEsales\EshopCommunity\Core\Config::getDecodeValueQuery ( $fieldName = "oxvarvalue" )

Returns decode query part user to decode config field value

Parameters

string $fieldName field name, default "oxvarvalue" [optional]

Returns: string

◆ getDir()

OxidEsales\EshopCommunity\Core\Config::getDir	(	$file,
		$dir,
		$admin,
		$lang = `null`,
		$shop = `null`,
		$theme = `null`,
		$absolute = `true`,
		$ignoreCust = `false`
	)

Finds and returns files or folders path in out dir

Parameters

string	$file	File name
string	$dir	Directory name
bool	$admin	Whether to force admin
int	$lang	Language id
int	$shop	Shop id
string	$theme	Theme name
bool	$absolute	mode - absolute/relative path
bool	$ignoreCust	Ignore custom theme

Returns: string

◆ getEdition()

OxidEsales\EshopCommunity\Core\Config::getEdition ( )

Returns OXID eShop edition.

Deprecated:: since v6.0.0-rc.2 (2017-08-24); Use \OxidEsales\Facts\Facts::getEdition() instead.

Returns: string

◆ getEditionTemplate()

OxidEsales\EshopCommunity\Core\Config::getEditionTemplate ( $templateName )

protected

Check and get template path by Edition if exists

Parameters

string $templateName

Returns: false|string

◆ getExceptionHandler()

OxidEsales\EshopCommunity\Core\Config::getExceptionHandler ( )

protected

Returns: \OxidEsales\Eshop\Core\Exception\ExceptionHandler

◆ getFullEdition()

OxidEsales\EshopCommunity\Core\Config::getFullEdition ( )

Returns full eShop edition name

Returns: string

◆ getGlobalParameter()

OxidEsales\EshopCommunity\Core\Config::getGlobalParameter ( $name )

Returns global parameter value

Parameters

string $name name of cached parameter

Returns: mixed

◆ getImageDir()

OxidEsales\EshopCommunity\Core\Config::getImageDir ( $admin = false )

Finds and returns image folders path

Parameters

bool $admin Whether to force admin

Returns: string

◆ getImagePath()

OxidEsales\EshopCommunity\Core\Config::getImagePath	(	$file,
		$admin = `false`
	)

Finds and returns image files or folders path

Parameters

string	$file	File name
bool	$admin	Whether to force admin

Returns: string

◆ getImageUrl()

OxidEsales\EshopCommunity\Core\Config::getImageUrl	(	$admin = `false`,
		$ssl = `null`,
		$nativeImg = `null`,
		$file = `null`
	)

Finds and returns image folder url

Parameters

bool	$admin	Whether to force admin
bool	$ssl	Whether to force ssl
bool	$nativeImg	Whether to force native image dirs
string	$file	Image file name

Returns: string

◆ getLogsDir()

OxidEsales\EshopCommunity\Core\Config::getLogsDir ( )

Returns log files storage path

Returns: string

◆ getMallShopUrl()

OxidEsales\EshopCommunity\Core\Config::getMallShopUrl ( $ssl = false )

Function returns mall shop url.

Parameters

bool $ssl

Returns: null|string

◆ getMandateCount()

OxidEsales\EshopCommunity\Core\Config::getMandateCount ( )

Counts OXID mandates

Returns: int

◆ getMasterPictureDir()

OxidEsales\EshopCommunity\Core\Config::getMasterPictureDir ( $admin = false )

Finds and returns master pictures folder path

Parameters

bool $admin Whether to force admin

Returns: string

◆ getMasterPicturePath()

OxidEsales\EshopCommunity\Core\Config::getMasterPicturePath	(	$file,
		$admin = `false`
	)

Finds and returns master picture path

Parameters

string	$file	File name
bool	$admin	Whether to force admin

Returns: string

◆ getModulesDir()

OxidEsales\EshopCommunity\Core\Config::getModulesDir ( $absolute = true )

Returns path to modules dir

Parameters

bool $absolute mode - absolute/relative path

Returns: string

◆ getModulesWithExtendedClass()

OxidEsales\EshopCommunity\Core\Config::getModulesWithExtendedClass ( )

Get parsed modules

Returns: array

◆ getModuleTemplatePathCalculator()

OxidEsales\EshopCommunity\Core\Config::getModuleTemplatePathCalculator ( )

protected

Get module template calculator object

Returns: ModuleTemplatePathCalculator

◆ getOutDir()

OxidEsales\EshopCommunity\Core\Config::getOutDir ( $absolute = true )

Returns path to out dir

Parameters

bool $absolute mode - absolute/relative path

Returns: string

◆ getOutUrl()

OxidEsales\EshopCommunity\Core\Config::getOutUrl	(	$ssl = `null`,
		$admin = `null`,
		$nativeImg = `false`
	)

Returns url to out dir

Parameters

bool	$ssl	Whether to force ssl
bool	$admin	Whether to force admin
bool	$nativeImg	Whether to force native image dirs

Returns: string

◆ getPackageInfo()

OxidEsales\EshopCommunity\Core\Config::getPackageInfo ( )

Returns build package info file content.

Returns: bool|string

◆ getPictureDir()

OxidEsales\EshopCommunity\Core\Config::getPictureDir ( $admin )

Finds and returns product pictures folders path

Parameters

bool $admin Whether to force admin

Returns: string

◆ getPicturePath()

OxidEsales\EshopCommunity\Core\Config::getPicturePath	(	$file,
		$admin = `false`,
		$lang = `null`,
		$shop = `null`,
		$theme = `null`
	)

Finds and returns product pictures files or folders path

Parameters

string	$file	File name
bool	$admin	Whether to force admin
int	$lang	Language
int	$shop	Shop id
string	$theme	theme name

Returns: string

◆ getPictureUrl()

OxidEsales\EshopCommunity\Core\Config::getPictureUrl	(	$file,
		$admin = `false`,
		$ssl = `null`,
		$lang = `null`,
		$shopId = `null`,
		$defPic = `"master/nopic.jpg"`
	)

Finds and returns product picture file or folder url

Parameters

string	$file	File name
bool	$admin	Whether to force admin
bool	$ssl	Whether to force ssl
int	$lang	Language
int	$shopId	Shop id
string	$defPic	Default (nopic) image path ["0/nopic.jpg"]

Returns: string

◆ getRequestControllerClass()

OxidEsales\EshopCommunity\Core\Config::getRequestControllerClass ( )

Use this function to get the controller class hidden behind the request's 'cl' parameter.

Returns: mixed

◆ getRequestControllerId()

OxidEsales\EshopCommunity\Core\Config::getRequestControllerId ( )

Get request 'cl' parameter which is the controller id.

Returns: string|null

◆ getRequestEscapedParameter()

OxidEsales\EshopCommunity\Core\Config::getRequestEscapedParameter	(	$name,
		$defaultValue = `null`
	)

Returns escaped value of parameter stored in POST,GET.

Parameters

string	$name	Name of parameter.
string	$defaultValue	Default value if no value provided.

Deprecated:: on 6.0.0 (2016-05-16); use OxidEsales\Eshop\Core\Request::getRequestEscapedParameter()

Returns: mixed

◆ getRequestParameter()

OxidEsales\EshopCommunity\Core\Config::getRequestParameter	(	$name,
		$raw = `false`
	)

Returns value of parameter stored in POST,GET. For security reasons performed Config->checkParamSpecialChars(). use $raw very carefully if you want to get unescaped parameter.

Parameters

string	$name	Name of parameter.
bool	$raw	Get unescaped parameter.

Deprecated:: on b-dev (2015-06-10); Use Request::getRequestEscapedParameter().

Returns: mixed

◆ getRequestRawParameter()

OxidEsales\EshopCommunity\Core\Config::getRequestRawParameter	(	$name,
		$defaultValue = `null`
	)

Returns raw value of parameter stored in POST,GET.

Parameters

string	$name	Name of parameter.
string	$defaultValue	Default value if no value provided.

Deprecated:: on 6.0.0 (2016-05-16); use OxidEsales\Eshop\Core\Request::getRequestEscapedParameter()

Returns: mixed

◆ getResourceDir()

OxidEsales\EshopCommunity\Core\Config::getResourceDir ( $admin )

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

Parameters

bool $admin Whether to force admin

Returns: string

◆ getResourcePath()

OxidEsales\EshopCommunity\Core\Config::getResourcePath	(	$file = `''`,
		$admin = `false`
	)

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

Parameters

string	$file	File name
bool	$admin	Whether to force admin

Returns: string

◆ getResourceUrl()

OxidEsales\EshopCommunity\Core\Config::getResourceUrl	(	$file = `''`,
		$admin = `false`,
		$ssl = `null`,
		$lang = `null`
	)

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

Parameters

string	$file	File name
bool	$admin	Whether to force admin
bool	$ssl	Whether to force ssl
int	$lang	Language id

Returns: string

◆ getRevision()

OxidEsales\EshopCommunity\Core\Config::getRevision ( )

Returns build revision number or false on read error.

Deprecated:: since v6.0.0 (2017-12-04); This functionality will be removed completely

Returns: bool|string

◆ getShopConfVar()

OxidEsales\EshopCommunity\Core\Config::getShopConfVar	(	$varName,
		$shopId = `null`,
		$module = `''`
	)

Retrieves shop configuration parameters from DB.

Parameters

string	$varName	Variable name
string	$shopId	Shop ID
string	$module	module identifier

Returns: object - raw configuration value in DB

◆ getShopCurrency()

OxidEsales\EshopCommunity\Core\Config::getShopCurrency ( )

Returns active shop currency.

Returns: string

◆ getShopCurrentUrl()

OxidEsales\EshopCommunity\Core\Config::getShopCurrentUrl ( $lang = null )

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

Parameters

int $lang language (optional)

Returns: string

◆ getShopHomeUrl()

OxidEsales\EshopCommunity\Core\Config::getShopHomeUrl	(	$lang = `null`,
		$admin = `null`
	)

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

Parameters

int	$lang	language
bool	$admin	if admin

Returns: string

◆ getShopId()

OxidEsales\EshopCommunity\Core\Config::getShopId ( )

Returns active shop ID.

Returns: int

◆ getShopIds()

OxidEsales\EshopCommunity\Core\Config::getShopIds ( )

Return active shop ids

Returns: array

◆ getShopLevelDir()

OxidEsales\EshopCommunity\Core\Config::getShopLevelDir	(	$base,
		$absBase,
		$file,
		$dir,
		$admin,
		$lang,
		$shop,
		$theme,
		$absolute,
		$ignoreCust
	)

protected

Parameters

string	$base
string	$absBase
string	$file
string	$dir
bool	$admin
int	$lang
int	$shop
string	$theme
bool	$absolute
bool	$ignoreCust

Returns: bool|string

◆ getShopMainUrl()

OxidEsales\EshopCommunity\Core\Config::getShopMainUrl ( )

Returns SSL or non SSL shop main URL without index.php

Returns: string

◆ getShopSecureHomeUrl()

OxidEsales\EshopCommunity\Core\Config::getShopSecureHomeUrl ( )

Returns shop SSL URL with index.php and sid.

Returns: string

◆ getShopUrl()

OxidEsales\EshopCommunity\Core\Config::getShopUrl	(	$lang = `null`,
		$admin = `null`
	)

Returns config sShopURL or sMallShopURL if secondary shop

Parameters

int	$lang	language
bool	$admin	if set true, function returns shop url without checking language/subshops for different url.

Returns: string

◆ getShopUrlByLanguage()

OxidEsales\EshopCommunity\Core\Config::getShopUrlByLanguage	(	$lang,
		$ssl = `false`
	)

Function returns shop url by given language. #680 per language another URL

Parameters

integer	$lang	Language id.
bool	$ssl	Whether to use ssl.

Returns: null|string

◆ getSslShopUrl()

OxidEsales\EshopCommunity\Core\Config::getSslShopUrl ( $lang = null )

Returns config sSSLShopURL or sMallSSLShopURL if secondary shop

Parameters

int $lang language (default is null)

Returns: string

◆ getSystemConfigParameter()

OxidEsales\EshopCommunity\Core\Config::getSystemConfigParameter ( $parameterName )

Retrieves system configuration parameters, which is the same for sub-shops.

Parameters

string $parameterName Variable name

Returns: mixed

◆ getTemplateBase()

OxidEsales\EshopCommunity\Core\Config::getTemplateBase ( $admin = false )

Finds and returns base template folder url

Parameters

bool $admin Whether to force admin

Returns: string

◆ getTemplateDir()

OxidEsales\EshopCommunity\Core\Config::getTemplateDir ( $admin = false )

Finds and returns templates folders path

Parameters

bool $admin Whether to force admin

Returns: string

◆ getTemplatePath()

OxidEsales\EshopCommunity\Core\Config::getTemplatePath	(	$templateName,
		$isAdmin
	)

Calculates and returns full path to template.

Parameters

string	$templateName	Template name
bool	$isAdmin	Whether to force admin

Returns: string

◆ getTemplateUrl()

OxidEsales\EshopCommunity\Core\Config::getTemplateUrl	(	$file = `null`,
		$admin = `false`,
		$ssl = `null`,
		$lang = `null`
	)

Finds and returns template file or folder url

Parameters

string	$file	File name
bool	$admin	Whether to force admin
bool	$ssl	Whether to force ssl
int	$lang	Language id

Returns: string

◆ getTopActiveView()

OxidEsales\EshopCommunity\Core\Config::getTopActiveView ( )

Returns top active view object from views chain.

Returns: FrontendController

◆ getTranslationsDir()

OxidEsales\EshopCommunity\Core\Config::getTranslationsDir	(	$file,
		$dir,
		$absolute = `true`
	)

Returns path to translations dir

Parameters

string	$file	File name
string	$dir	Directory name
bool	$absolute	mode - absolute/relative path

Returns: string

◆ getUploadedFile()

OxidEsales\EshopCommunity\Core\Config::getUploadedFile ( $paramName )

Returns uploaded file parameter

Parameters

string $paramName param name

Returns: null

◆ getUrl()

OxidEsales\EshopCommunity\Core\Config::getUrl	(	$file,
		$dir,
		$admin = `null`,
		$ssl = `null`,
		$nativeImg = `false`,
		$lang = `null`,
		$shop = `null`,
		$theme = `null`
	)

Finds and returns file or folder url in out dir

Parameters

string	$file	File name
string	$dir	Directory name
bool	$admin	Whether to force admin
bool	$ssl	Whether to force ssl
bool	$nativeImg	Whether to force native image dirs
int	$lang	Language id
int	$shop	Shop id
string	$theme	Theme name

Returns: string

◆ getVersion()

OxidEsales\EshopCommunity\Core\Config::getVersion ( )

Returns shops version number (eg. '4.4.2')

Deprecated:: since v6.0.0-rc.2 (2017-08-23); Use OxidEsales\Eshop\Core\ShopVersion::getVersion() instead.

Returns: string

◆ getViewsDir()

OxidEsales\EshopCommunity\Core\Config::getViewsDir ( $absolute = true )

Returns path to out dir

Parameters

bool $absolute mode - absolute/relative path

Returns: string

◆ getWidgetUrl()

OxidEsales\EshopCommunity\Core\Config::getWidgetUrl	(	$languageId = `null`,
		$inAdmin = `null`,
		$urlParameters = `[]`
	)

Returns widget start non SSL URL including widget.php and sid.

Parameters

int	$languageId	language
bool	$inAdmin	if admin
array	$urlParameters	parameters which should be added to URL.

Returns: string

◆ hasActiveViewsChain()

OxidEsales\EshopCommunity\Core\Config::hasActiveViewsChain ( )

Check if there is more than one active view

Returns: null

◆ init()

OxidEsales\EshopCommunity\Core\Config::init ( )

Starts session manager

Exceptions

oxConnectionException

Returns: null

◆ initializeShop()

OxidEsales\EshopCommunity\Core\Config::initializeShop ( )

protected

Initializes main shop tasks - processing of SEO calls, starting of session.

◆ isCurrentProtocol()

OxidEsales\EshopCommunity\Core\Config::isCurrentProtocol ( $url )

Compares current protocol to supplied url string

Parameters

string $url URL

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

◆ isCurrentUrl()

OxidEsales\EshopCommunity\Core\Config::isCurrentUrl ( $url )

Compares current URL to supplied string

Parameters

string $url URL

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

◆ isDemoShop()

OxidEsales\EshopCommunity\Core\Config::isDemoShop ( )

Checks if the shop is in demo mode.

Returns: bool

◆ isHttpsOnly()

OxidEsales\EshopCommunity\Core\Config::isHttpsOnly ( )

Checks if shop runs in https only mode https only mode means there is no http url but only a https url

Returns: bool

◆ isMall()

OxidEsales\EshopCommunity\Core\Config::isMall ( )

Checks if shop is MALL. Returns true on success.

Returns: bool

◆ isProductiveMode()

OxidEsales\EshopCommunity\Core\Config::isProductiveMode ( )

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

Returns: bool

◆ isSsl()

OxidEsales\EshopCommunity\Core\Config::isSsl ( )

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

Returns: bool

◆ isThemeOption()

OxidEsales\EshopCommunity\Core\Config::isThemeOption ( $name )

Returns true if option is theme option

Parameters

string $name option name

Returns: bool

◆ isUtf()

OxidEsales\EshopCommunity\Core\Config::isUtf ( )

Returns true if current installation works in utf-8 mode, or false if not.

Deprecated:: since 6.0 (2016-12-07) As the shop installation is utf-8, this method will be removed.

CAUTION: if you use this deprecated feature, you have to be sure, that there is a iUtfMode in your config.inc.php, otherwise the result of this method is always true.

Returns: bool

◆ loadAdditionalConfiguration()

OxidEsales\EshopCommunity\Core\Config::loadAdditionalConfiguration ( )

protected

Load any additional configuration on Config::init.

◆ pageClose()

OxidEsales\EshopCommunity\Core\Config::pageClose ( )

Unsets all session data.

Returns: null

◆ parseModuleChains()

OxidEsales\EshopCommunity\Core\Config::parseModuleChains ( $modules )

Parse array of module chains to nested array

Deprecated:: on 6.0.0 (2017-03-09); use OxidEsales\Eshop\Core\ModuleList::parseModuleChains() instead.

Parameters

array $modules Module array (config format)

Returns: array

◆ reinitialize()

OxidEsales\EshopCommunity\Core\Config::reinitialize ( )

Reloads all configuration.

◆ saveShopConfVar()

OxidEsales\EshopCommunity\Core\Config::saveShopConfVar	(	$varType,
		$varName,
		$varVal,
		$shopId = `null`,
		$module = `''`
	)

Updates or adds new shop configuration parameters to DB. Arrays must be passed not serialized, serialized values are supported just for backward compatibility.

Parameters

string	$varType	Variable Type
string	$varName	Variable name
mixed	$varVal	Variable value (can be string, integer or array)
string	$shopId	Shop ID, default is current shop
string	$module	Module name (empty for base options)

◆ saveSystemConfigParameter()

OxidEsales\EshopCommunity\Core\Config::saveSystemConfigParameter	(	$parameterType,
		$parameterName,
		$parameterValue
	)

Save system configuration parameters, which is the same for sub-shops.

Parameters

string	$parameterType	Type
string	$parameterName	Name
mixed	$parameterValue	Value (can be string, integer or array)

◆ setActiveView()

OxidEsales\EshopCommunity\Core\Config::setActiveView ( $view )

View object setter

Parameters

object $view view object

◆ setActShopCurrency()

OxidEsales\EshopCommunity\Core\Config::setActShopCurrency ( $cur )

Sets the actual currency

Parameters

int $cur 0 = EUR, 1 = GBP, 2 = CHF

◆ setConfigParam()

OxidEsales\EshopCommunity\Core\Config::setConfigParam	(	$name,
		$value
	)

Stores config parameter value in config

Parameters

string	$name	config parameter name
string	$value	config parameter value

◆ setGlobalParameter()

OxidEsales\EshopCommunity\Core\Config::setGlobalParameter	(	$name,
		$value
	)

Sets global parameter value

Parameters

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

◆ setIsSsl()

OxidEsales\EshopCommunity\Core\Config::setIsSsl ( $isSsl = false )

Set is shop url

Parameters

bool $isSsl - state bool value

◆ setShopId()

OxidEsales\EshopCommunity\Core\Config::setShopId ( $shopId )

Active Shop id setter

Parameters

string $shopId shop id

Member Data Documentation

◆ $_aAbsDynImageDir

OxidEsales\EshopCommunity\Core\Config::$_aAbsDynImageDir = []

protected

◆ $_aActiveViews

OxidEsales\EshopCommunity\Core\Config::$_aActiveViews = []

protected

◆ $_aConfigParams

OxidEsales\EshopCommunity\Core\Config::$_aConfigParams = []

protected

◆ $_aGlobalParams

OxidEsales\EshopCommunity\Core\Config::$_aGlobalParams = []

protected

◆ $_aThemeConfigParams

OxidEsales\EshopCommunity\Core\Config::$_aThemeConfigParams = []

protected

◆ $_blInit

OxidEsales\EshopCommunity\Core\Config::$_blInit = false

protected

◆ $_blIsSsl

OxidEsales\EshopCommunity\Core\Config::$_blIsSsl = null

protected

◆ $_iLanguageId

OxidEsales\EshopCommunity\Core\Config::$_iLanguageId = null

protected

◆ $_iShopId

OxidEsales\EshopCommunity\Core\Config::$_iShopId = null

protected

◆ $_oActCurrencyObject

OxidEsales\EshopCommunity\Core\Config::$_oActCurrencyObject = null

protected

◆ $_oActShop

OxidEsales\EshopCommunity\Core\Config::$_oActShop = null

protected

◆ $_oStart

OxidEsales\EshopCommunity\Core\Config::$_oStart = null

private

◆ $_sImageDir

OxidEsales\EshopCommunity\Core\Config::$_sImageDir = 'img'

protected

◆ $_sMasterPictureDir

OxidEsales\EshopCommunity\Core\Config::$_sMasterPictureDir = 'master'

protected

◆ $_sModulesDir

OxidEsales\EshopCommunity\Core\Config::$_sModulesDir = 'modules'

protected

◆ $_sOutDir

OxidEsales\EshopCommunity\Core\Config::$_sOutDir = 'out'

protected

◆ $_sPictureDir

OxidEsales\EshopCommunity\Core\Config::$_sPictureDir = 'pictures'

protected

◆ $_sResourceDir

OxidEsales\EshopCommunity\Core\Config::$_sResourceDir = 'src'

protected

◆ $_sTemplateDir

OxidEsales\EshopCommunity\Core\Config::$_sTemplateDir = 'tpl'

protected

◆ $aMultiShopTables

OxidEsales\EshopCommunity\Core\Config::$aMultiShopTables

protected

Initial value:

= ['oxarticles', 'oxdiscount', 'oxcategories', 'oxattribute',
                                        'oxlinks', 'oxvoucherseries', 'oxmanufacturers',
                                        
                                        'oxnews',
                                        
                                        'oxselectlist', 'oxwrapping',
                                        'oxdeliveryset', 'oxdelivery', 'oxvendor', 'oxobject2category']

◆ $blNativeImages

OxidEsales\EshopCommunity\Core\Config::$blNativeImages = true

protected

◆ $blSessionUseCookies

OxidEsales\EshopCommunity\Core\Config::$blSessionUseCookies = null

protected

◆ $dbHost

OxidEsales\EshopCommunity\Core\Config::$dbHost = null

protected

◆ $dbName

OxidEsales\EshopCommunity\Core\Config::$dbName = null

protected

◆ $dbPwd

OxidEsales\EshopCommunity\Core\Config::$dbPwd = null

protected

◆ $dbType

OxidEsales\EshopCommunity\Core\Config::$dbType = null

protected

◆ $dbUser

OxidEsales\EshopCommunity\Core\Config::$dbUser = null

protected

◆ $iDebug

OxidEsales\EshopCommunity\Core\Config::$iDebug = null

protected

◆ $sAdminEmail

OxidEsales\EshopCommunity\Core\Config::$sAdminEmail = null

protected

◆ $sAdminSSLURL

OxidEsales\EshopCommunity\Core\Config::$sAdminSSLURL = null

protected

◆ $sCompileDir

OxidEsales\EshopCommunity\Core\Config::$sCompileDir = null

protected

◆ $sConfigKey

OxidEsales\EshopCommunity\Core\Config::$sConfigKey = self::DEFAULT_CONFIG_KEY

protected

◆ $sShopDir

OxidEsales\EshopCommunity\Core\Config::$sShopDir = null

protected

◆ $sShopURL

OxidEsales\EshopCommunity\Core\Config::$sShopURL = null

protected

◆ $sSSLShopURL

OxidEsales\EshopCommunity\Core\Config::$sSSLShopURL = null

protected

◆ DEFAULT_CONFIG_KEY

const OxidEsales\EshopCommunity\Core\Config::DEFAULT_CONFIG_KEY = 'fq45QS09_fqyx09239QQ'

◆ OXMODULE_MODULE_PREFIX

const OxidEsales\EshopCommunity\Core\Config::OXMODULE_MODULE_PREFIX = 'module:'

◆ OXMODULE_THEME_PREFIX

const OxidEsales\EshopCommunity\Core\Config::OXMODULE_THEME_PREFIX = 'theme:'

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

/oxideshop-ce/source/Core/Config.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Function Documentation

◆ _checkSsl()

◆ _getConfigParamsSelectSnippet()

◆ _handleCookieException()

◆ _handleDbConnectionException()

◆ _isValidShopId()

◆ _loadCustomConfig()

◆ _loadVarsFromDb()

◆ _loadVarsFromFile()

◆ _processSeoCall()

◆ _setConfVarFromDb()

◆ _setDefaults()

◆ calculateActiveShopId()

◆ checkParamSpecialChars()

◆ decodeValue()

◆ detectVersion()

◆ dropLastActiveView()

◆ getActiveShop()

◆ getActiveView()

◆ getActiveViewsIds()

◆ getActiveViewsList()

◆ getActiveViewsNames()

◆ getActShopCurrencyObject()

◆ getAppDir()

◆ getBaseShopId()

◆ getConfigParam()

◆ getCoreUtilsUrl()

◆ getCurrencyArray()

◆ getCurrencyObject()

◆ getCurrentShopUrl()

◆ getDecodeValueQuery()

◆ getDir()

◆ getEdition()

◆ getEditionTemplate()

◆ getExceptionHandler()

◆ getFullEdition()

◆ getGlobalParameter()

◆ getImageDir()

◆ getImagePath()

◆ getImageUrl()

◆ getLogsDir()

◆ getMallShopUrl()

◆ getMandateCount()

◆ getMasterPictureDir()

◆ getMasterPicturePath()

◆ getModulesDir()

◆ getModulesWithExtendedClass()

◆ getModuleTemplatePathCalculator()

◆ getOutDir()

◆ getOutUrl()

◆ getPackageInfo()

◆ getPictureDir()

◆ getPicturePath()

◆ getPictureUrl()

◆ getRequestControllerClass()

◆ getRequestControllerId()

◆ getRequestEscapedParameter()

◆ getRequestParameter()

◆ getRequestRawParameter()

◆ getResourceDir()

◆ getResourcePath()

◆ getResourceUrl()

◆ getRevision()

◆ getShopConfVar()

◆ getShopCurrency()

◆ getShopCurrentUrl()

◆ getShopHomeUrl()

◆ getShopId()

◆ getShopIds()

◆ getShopLevelDir()

◆ getShopMainUrl()

◆ getShopSecureHomeUrl()

◆ getShopUrl()

◆ getShopUrlByLanguage()