Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Attributes

oxConfig Class Reference

Inheritance diagram for oxConfig:
Collaboration diagram for oxConfig:

List of all members.

Public Member Functions

 getConfigParam ($sName)
 setConfigParam ($sName, $sValue)
 init ()
 pageClose ()
 getRequestParameter ($sName, $blRaw=false)
 getUploadedFile ($sParamName)
 setGlobalParameter ($sName, $sValue)
 getGlobalParameter ($sName)
 checkParamSpecialChars (&$sValue, $aRaw=null)
 setShopId ($sShopId)
 getShopId ()
 setIsSsl ($blIsSsl=false)
 isSsl ()
 isCurrentUrl ($sURL)
 isCurrentProtocol ($sURL)
 getShopUrl ($iLang=null, $blAdmin=null)
 getSslShopUrl ($iLang=null)
 getCoreUtilsUrl ()
 getCurrentShopUrl ($blAdmin=null)
 getShopCurrentUrl ($iLang=null)
 getShopHomeUrl ($iLang=null, $blAdmin=null)
 getWidgetUrl ($iLang=null, $blAdmin=null)
 getShopSecureHomeUrl ()
 getShopCurrency ()
 getActShopCurrencyObject ()
 setActShopCurrency ($iCur)
 getOutDir ($blAbsolute=true)
 getViewsDir ($blAbsolute=true)
 getTranslationsDir ($sFile, $sDir, $blAbsolute=true)
 getAppDir ($blAbsolute=true)
 getOutUrl ($blSSL=null, $blAdmin=null, $blNativeImg=false)
 getDir ($sFile, $sDir, $blAdmin, $iLang=null, $iShop=null, $sTheme=null, $blAbsolute=true, $blIgnoreCust=false)
 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, $sFile=null)
 getImageDir ($blAdmin=false)
 getPicturePath ($sFile, $blAdmin=false, $iLang=null, $iShop=null, $sTheme=null)
 getMasterPictureDir ($blAdmin=false)
 getMasterPicturePath ($sFile, $blAdmin=false)
 getPictureUrl ($sFile, $blAdmin=false, $blSSL=null, $iLang=null, $iShopId=null, $sDefPic="master/nopic.jpg")
 getPictureDir ($blAdmin)
 getTemplatePath ($sFile, $blAdmin)
 getTemplateDir ($blAdmin=false)
 getTemplateUrl ($sFile=null, $blAdmin=false, $blSSL=null, $iLang=null)
 getTemplateBase ($blAdmin=false)
 getResourcePath ($sFile= '', $blAdmin=false)
 getModulesDir ($blAbsolute=true)
 getResourceUrl ($sFile= '', $blAdmin=false, $blSSL=null, $iLang=null)
 getResourceDir ($blAdmin)
 getCurrencyArray ($iCurrency=null)
 getCurrencyObject ($sName)
 isDemoShop ()
 getEdition ()
 getFullEdition ()
 getVersion ()
 getRevision ()
 getPackageInfo ()
 getMandateCount ()
 isMall ()
 detectVersion ()
 saveShopConfVar ($sVarType, $sVarName, $sVarVal, $sShopId=null, $sModule= '')
 getShopConfVar ($sVarName, $sShopId=null, $sModule= '')
 decodeValue ($sType, $mOrigValue)
 getDecodeValueQuery ($sFieldName="oxvarvalue")
 isProductiveMode ()
 getBaseShopId ()
 getActiveShop ()
 getActiveView ()
 getTopActiveView ()
 getActiveViewsList ()
 setActiveView ($oView)
 dropLastActiveView ()
 hasActiveViewsChain ()
 getActiveViewsNames ()
 isUtf ()
 getLogsDir ()
 isThemeOption ($sName)
 getShopMainUrl ()
 getAllModules ()
 getModulesWithExtendedClass ()
 parseModuleChains ($aModules)
 getShopIds ()
 getShopUrlByLanguage ($iLang, $blSSL=false)
 getMallShopUrl ($blSSL=false)
 saveSystemConfigParameter ($sParameterType, $sParameterName, $sParameterValue)
 getSystemConfigParameter ($sParameterName)

Public Attributes

const OXMODULE_THEME_PREFIX = 'theme:'
const OXMODULE_MODULE_PREFIX = 'module:'

Protected Member Functions

 _processSeoCall ()
 _loadVarsFromFile ()
 _setDefaults ()
 _loadCustomConfig ()
 _loadVarsFromDb ($sShopID, $aOnlyVars=null, $sModule= '')
 _getConfigParamsSelectSnippet ($aVars)
 _setConfVarFromDb ($sVarName, $sVarType, $sVarVal)
 _checkSsl ()
 _handleDbConnectionException ($oEx)
 _handleCookieException ($oEx)

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 = array()
 $_aGlobalParams = array()
 $_aConfigParams = array()
 $_aThemeConfigParams = array()
 $_iLanguageId = null
 $_iShopId = null
 $_sOutDir = 'out'
 $_sImageDir = 'img'
 $_sPictureDir = 'pictures'
 $_sMasterPictureDir = 'master'
 $_sTemplateDir = 'tpl'
 $_sResourceDir = 'src'
 $_sModulesDir = 'modules'
 $_blIsSsl = null
 $_aAbsDynImageDir = array()
 $_oActCurrencyObject = null
 $_blInit = false

Private Attributes

 $_oStart = null

Detailed Description

Main shop configuration class.

Definition at line 10 of file oxconfig.php.

Member Function Documentation

oxConfig._checkSsl (  )  [protected]

Checks if WEB session is SSL.

Definition at line 782 of file oxconfig.php.

oxConfig._getConfigParamsSelectSnippet ( $  aVars  )  [protected]

Allow loading from some vars only from baseshop

Parameters:
array $aVars
Returns:
string

Definition at line 546 of file oxconfig.php.

oxConfig._handleCookieException ( $  oEx  )  [protected]

Redirect to start page and display the error

Parameters:
oxException $oEx message to show on exit

Definition at line 2206 of file oxconfig.php.

oxConfig._handleDbConnectionException ( $  oEx  )  [protected]

Shows exception message if debug mode is enabled, redirects otherwise.

Parameters:
oxException $oEx message to show on exit
Returns:
bool

Definition at line 2187 of file oxconfig.php.

oxConfig._loadCustomConfig (  )  [protected]

Loads vars from custom config file

Definition at line 492 of file oxconfig.php.

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

Load config values from DB

Parameters:
string $sShopID shop ID to load parameters
array $aOnlyVars array of params to load (optional)
string $sModule module vars to load, empty for base options
Returns:
bool

Definition at line 509 of file oxconfig.php.

oxConfig._loadVarsFromFile (  )  [protected]

Loads vars from default config file

Definition at line 423 of file oxconfig.php.

oxConfig._processSeoCall (  )  [protected]

Parse SEO url parameters.

Definition at line 337 of file oxconfig.php.

oxConfig._setConfVarFromDb ( $  sVarName,
$  sVarType,
$  sVarVal 
) [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 $sVarName variable name
string $sVarType variable type - arr, aarr, bool or str
string $sVarVal serialized by type value
Returns:
null

Definition at line 569 of file oxconfig.php.

oxConfig._setDefaults (  )  [protected]

Set important defaults.

Definition at line 442 of file oxconfig.php.

oxConfig.checkParamSpecialChars ( &$  sValue,
$  aRaw = null 
)

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

Definition at line 702 of file oxconfig.php.

oxConfig.decodeValue ( $  sType,
$  mOrigValue 
)

Decodes and returns database value

Parameters:
string $sType parameter type
mixed $mOrigValue parameter db value
Returns:
mixed

Definition at line 1873 of file oxconfig.php.

oxConfig.detectVersion (  ) 

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

Returns:
int

Definition at line 1761 of file oxconfig.php.

oxConfig.dropLastActiveView (  ) 

Drop last active view object

Definition at line 2005 of file oxconfig.php.

oxConfig.getActiveShop (  ) 

Loads and returns active shop object

Returns:
oxShop

Definition at line 1936 of file oxconfig.php.

oxConfig.getActiveView (  ) 

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

Returns:
oxView

Definition at line 1955 of file oxconfig.php.

oxConfig.getActiveViewsList (  ) 

Returns all active views objects list.

Returns:
array

Definition at line 1987 of file oxconfig.php.

oxConfig.getActiveViewsNames (  ) 

Get active views names list

Returns:
array

Definition at line 2025 of file oxconfig.php.

oxConfig.getActShopCurrencyObject (  ) 

Returns active shop currency object.

Returns:
object

Definition at line 1036 of file oxconfig.php.

oxConfig.getAllModules (  ) 

Get parsed modules

Deprecated:
since v5.1.2 (2013-12-10); Naming changed use function getModulesWithExtendedClass().
Returns:
array

Definition at line 2087 of file oxconfig.php.

oxConfig.getAppDir ( $  blAbsolute = true  ) 

Returns path to out dir

Parameters:
bool $blAbsolute mode - absolute/relative path
Returns:
string

Definition at line 1128 of file oxconfig.php.

oxConfig.getBaseShopId (  ) 

Function returns default shop ID

Returns:
string

Definition at line 1925 of file oxconfig.php.

oxConfig.getConfigParam ( $  sName  ) 

Returns config parameter value if such parameter exists

Parameters:
string $sName config parameter name
Returns:
mixed

Definition at line 297 of file oxconfig.php.

oxConfig.getCoreUtilsUrl (  ) 

Returns utils dir URL

Returns:
string

Definition at line 923 of file oxconfig.php.

oxConfig.getCurrencyArray ( $  iCurrency = null  ) 

Returns array of available currencies

Parameters:
integer $iCurrency Active currency number (default null)
Returns:
array

Definition at line 1565 of file oxconfig.php.

oxConfig.getCurrencyObject ( $  sName  ) 

Returns currency object.

Parameters:
string $sName Name of active currency
Returns:
object

Definition at line 1629 of file oxconfig.php.

oxConfig.getCurrentShopUrl ( $  blAdmin = 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 $blAdmin if admin
Returns:
string

Definition at line 936 of file oxconfig.php.

oxConfig.getDecodeValueQuery ( $  sFieldName = "oxvarvalue"  ) 

Returns decode query part user to decode config field value

Parameters:
string $sFieldName field name, default "oxvarvalue" [optional]
Returns:
string

Definition at line 1896 of file oxconfig.php.

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

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
bool $blIgnoreCust Ignore custom theme
Returns:
string

Definition at line 1181 of file oxconfig.php.

oxConfig.getEdition (  ) 

Returns OXID eShop edition

Returns:
string

Definition at line 1656 of file oxconfig.php.

oxConfig.getFullEdition (  ) 

Returns full eShop edition name

Returns:
string

Definition at line 1668 of file oxconfig.php.

oxConfig.getGlobalParameter ( $  sName  ) 

Returns global parameter value

Parameters:
string $sName name of cached parameter
Returns:
mixed

Definition at line 684 of file oxconfig.php.

oxConfig.getImageDir ( $  blAdmin = false  ) 

Finds and returns image folders path

Parameters:
bool $blAdmin Whether to force admin
Returns:
string

Definition at line 1339 of file oxconfig.php.

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

Definition at line 1310 of file oxconfig.php.

oxConfig.getImageUrl ( $  blAdmin = false,
$  blSSL = null,
$  blNativeImg = null,
$  sFile = 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
string $sFile Image file name
Returns:
string

Definition at line 1325 of file oxconfig.php.

oxConfig.getLogsDir (  ) 

Returns log files storage path

Returns:
string

Definition at line 2053 of file oxconfig.php.

oxConfig.getMallShopUrl ( $  blSSL = false  ) 

Function returns mall shop url.

Parameters:
bool $blSSL
Returns:
null|string

Definition at line 2167 of file oxconfig.php.

oxConfig.getMandateCount (  ) 

Counts OXID mandates

Returns:
int

Definition at line 1733 of file oxconfig.php.

oxConfig.getMasterPictureDir ( $  blAdmin = false  ) 

Finds and returns master pictures folder path

Parameters:
bool $blAdmin Whether to force admin
Returns:
string

Definition at line 1367 of file oxconfig.php.

oxConfig.getMasterPicturePath ( $  sFile,
$  blAdmin = false 
)

Finds and returns master picture path

Parameters:
string $sFile File name
bool $blAdmin Whether to force admin
Returns:
string

Definition at line 1380 of file oxconfig.php.

oxConfig.getModulesDir ( $  blAbsolute = true  ) 

Returns path to modules dir

Parameters:
bool $blAbsolute mode - absolute/relative path
Returns:
string

Definition at line 1520 of file oxconfig.php.

oxConfig.getModulesWithExtendedClass (  ) 

Get parsed modules

Returns:
array

Definition at line 2097 of file oxconfig.php.

oxConfig.getOutDir ( $  blAbsolute = true  ) 

Returns path to out dir

Parameters:
bool $blAbsolute mode - absolute/relative path
Returns:
string

Definition at line 1076 of file oxconfig.php.

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

Returns url to out dir

Parameters:
bool $blSSL Whether to force ssl
bool $blAdmin Whether to force admin
bool $blNativeImg Whether to force native image dirs
Returns:
string

Definition at line 1146 of file oxconfig.php.

oxConfig.getPackageInfo (  ) 

Returns build package info file content.

Returns:
bool|string

Definition at line 1715 of file oxconfig.php.

oxConfig.getPictureDir ( $  blAdmin  ) 

Finds and returns product pictures folders path

Parameters:
bool $blAdmin Whether to force admin
Returns:
string

Definition at line 1421 of file oxconfig.php.

oxConfig.getPicturePath ( $  sFile,
$  blAdmin = false,
$  iLang = null,
$  iShop = null,
$  sTheme = null 
)

Finds and returns product pictures files or folders path

Parameters:
string $sFile File name
bool $blAdmin Whether to force admin
int $iLang Language
int $iShop Shop id
string $sTheme theme name
Returns:
string

Definition at line 1355 of file oxconfig.php.

oxConfig.getPictureUrl ( $  sFile,
$  blAdmin = false,
$  blSSL = null,
$  iLang = null,
$  iShopId = null,
$  sDefPic = "master/nopic.jpg" 
)

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
int $iLang Language
int $iShopId Shop id
string $sDefPic Default (nopic) image path ["0/nopic.jpg"]
Returns:
string

Definition at line 1397 of file oxconfig.php.

oxConfig.getRequestParameter ( $  sName,
$  blRaw = false 
)

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

Parameters:
string $sName Name of parameter
bool $blRaw Get unescaped parameter
Returns:
mixed

Definition at line 617 of file oxconfig.php.

oxConfig.getResourceDir ( $  blAdmin  ) 

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

Parameters:
bool $blAdmin Whether to force admin
Returns:
string

Definition at line 1553 of file oxconfig.php.

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

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

Parameters:
string $sFile File name
bool $blAdmin Whether to force admin
Returns:
string

Definition at line 1508 of file oxconfig.php.

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

Finds and returns resource (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

Definition at line 1539 of file oxconfig.php.

oxConfig.getRevision (  ) 

Returns build revision number or false on read error.

Returns:
int

Definition at line 1698 of file oxconfig.php.

oxConfig.getShopConfVar ( $  sVarName,
$  sShopId = null,
$  sModule = '' 
)

Retrieves shop configuration parameters from DB.

Parameters:
string $sVarName Variable name
string $sShopId Shop ID
string $sModule module identifier
Returns:
object - raw configuration value in DB

Definition at line 1839 of file oxconfig.php.

oxConfig.getShopCurrency (  ) 

Returns active shop currency.

Returns:
string

Definition at line 1019 of file oxconfig.php.

oxConfig.getShopCurrentUrl ( $  iLang = null  ) 

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

Parameters:
int $iLang language (optional)
Returns:
string

Definition at line 965 of file oxconfig.php.

oxConfig.getShopHomeUrl ( $  iLang = null,
$  blAdmin = null 
)

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

Parameters:
int $iLang language
bool $blAdmin if admin
Returns:
string

Definition at line 984 of file oxconfig.php.

oxConfig.getShopId (  ) 

Returns active shop ID.

Returns:
int

Definition at line 752 of file oxconfig.php.

oxConfig.getShopIds (  ) 

Return active shop ids

Returns:
array

Definition at line 2132 of file oxconfig.php.

oxConfig.getShopMainUrl (  ) 

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

Returns:
string

Definition at line 2075 of file oxconfig.php.

oxConfig.getShopSecureHomeUrl (  ) 

Returns shop SSL URL with index.php and sid.

Returns:
string

Definition at line 1009 of file oxconfig.php.

oxConfig.getShopUrl ( $  iLang = null,
$  blAdmin = null 
)

Returns config sShopURL or sMallShopURL if secondary shop

Parameters:
int $iLang language
bool $blAdmin if set true, function returns shop url without checking language/subshops for different url.
Returns:
string

Definition at line 864 of file oxconfig.php.

oxConfig.getShopUrlByLanguage ( $  iLang,
$  blSSL = false 
)

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

Parameters:
integer $iLang Language id.
bool $blSSL Whether to use ssl.
Returns:
null|string

Definition at line 2146 of file oxconfig.php.

oxConfig.getSslShopUrl ( $  iLang = null  ) 

Returns config sSSLShopURL or sMallSSLShopURL if secondary shop

Parameters:
int $iLang language (default is null)
Returns:
string

Definition at line 890 of file oxconfig.php.

oxConfig.getSystemConfigParameter ( $  sParameterName  ) 

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

Parameters:
string $sParameterName Variable name
Returns:
mixed

Definition at line 2237 of file oxconfig.php.

oxConfig.getTemplateBase ( $  blAdmin = false  ) 

Finds and returns base template folder url

Parameters:
bool $blAdmin Whether to force admin
Returns:
string

Definition at line 1494 of file oxconfig.php.

oxConfig.getTemplateDir ( $  blAdmin = false  ) 

Finds and returns templates folders path

Parameters:
bool $blAdmin Whether to force admin
Returns:
string

Definition at line 1467 of file oxconfig.php.

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

Definition at line 1434 of file oxconfig.php.

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

Definition at line 1482 of file oxconfig.php.

oxConfig.getTopActiveView (  ) 

Returns top active view object from views chain.

Returns:
oxView

Definition at line 1973 of file oxconfig.php.

oxConfig.getTranslationsDir ( $  sFile,
$  sDir,
$  blAbsolute = true 
)

Returns path to translations dir

Parameters:
string $sFile File name
string $sDir Directory name
bool $blAbsolute mode - absolute/relative path
Returns:
string

Definition at line 1110 of file oxconfig.php.

oxConfig.getUploadedFile ( $  sParamName  ) 

Returns uploaded file parameter

Parameters:
array $sParamName param name
Returns:
null

Definition at line 661 of file oxconfig.php.

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
Returns:
string

Definition at line 1291 of file oxconfig.php.

oxConfig.getVersion (  ) 

Returns shops version number (eg. '4.4.2')

Returns:
string

Definition at line 1686 of file oxconfig.php.

oxConfig.getViewsDir ( $  blAbsolute = true  ) 

Returns path to out dir

Parameters:
bool $blAbsolute mode - absolute/relative path
Returns:
string

Definition at line 1092 of file oxconfig.php.

oxConfig.getWidgetUrl ( $  iLang = null,
$  blAdmin = null 
)

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

Parameters:
int $iLang language
bool $blAdmin if admin
Returns:
string

Definition at line 997 of file oxconfig.php.

oxConfig.hasActiveViewsChain (  ) 

Check if there is more than one active view

Returns:
null

Definition at line 2015 of file oxconfig.php.

oxConfig.init (  ) 

Starts session manager

Exceptions:
oxConnectionException 
Returns:
null

Definition at line 352 of file oxconfig.php.

oxConfig.isCurrentProtocol ( $  sURL  ) 

Compares current protocol to supplied url string

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

Definition at line 846 of file oxconfig.php.

oxConfig.isCurrentUrl ( $  sURL  ) 

Compares current URL to supplied string

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

Definition at line 829 of file oxconfig.php.

oxConfig.isDemoShop (  ) 

Checks if the shop is in demo mode.

Returns:
bool

Definition at line 1644 of file oxconfig.php.

oxConfig.isMall (  ) 

Checks if shop is MALL. Returns true on success.

Returns:
bool

Definition at line 1746 of file oxconfig.php.

oxConfig.isProductiveMode (  ) 

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

Returns:
bool

Definition at line 1906 of file oxconfig.php.

oxConfig.isSsl (  ) 

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

Returns:
bool

Definition at line 813 of file oxconfig.php.

oxConfig.isThemeOption ( $  sName  ) 

Returns true if option is theme option

Parameters:
string $sName option name
Returns:
bool

Definition at line 2065 of file oxconfig.php.

oxConfig.isUtf (  ) 

Returns true if current installation works in UTF8 mode, or false if not

Returns:
bool

Definition at line 2043 of file oxconfig.php.

oxConfig.pageClose (  ) 

Unsets all session data.

Returns:
null

Definition at line 596 of file oxconfig.php.

oxConfig.parseModuleChains ( $  aModules  ) 

Parse array of module chains to nested array

Parameters:
array $aModules Module array (config format)
Returns:
array

Definition at line 2109 of file oxconfig.php.

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

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 $sVarType Variable Type
string $sVarName Variable name
mixed $sVarVal Variable value (can be string, integer or array)
string $sShopId Shop ID, default is current shop
string $sModule Module name (empty for base options)

Definition at line 1777 of file oxconfig.php.

oxConfig.saveSystemConfigParameter ( $  sParameterType,
$  sParameterName,
$  sParameterValue 
)

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

Parameters:
string $sParameterType Type
string $sParameterName Name
mixed $sParameterValue Value (can be string, integer or array)

Definition at line 2225 of file oxconfig.php.

oxConfig.setActiveView ( $  oView  ) 

View object setter

Parameters:
object $oView view object

Definition at line 1997 of file oxconfig.php.

oxConfig.setActShopCurrency ( $  iCur  ) 

Sets the actual currency

Parameters:
int $iCur 0 = EUR, 1 = GBP, 2 = CHF

Definition at line 1060 of file oxconfig.php.

oxConfig.setConfigParam ( $  sName,
$  sValue 
)

Stores config parameter value in config

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

Definition at line 325 of file oxconfig.php.

oxConfig.setGlobalParameter ( $  sName,
$  sValue 
)

Sets global parameter value

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

Definition at line 672 of file oxconfig.php.

oxConfig.setIsSsl ( $  blIsSsl = false  ) 

Set is shop url

Parameters:
bool $blIsSsl - state bool value

Definition at line 774 of file oxconfig.php.

oxConfig.setShopId ( $  sShopId  ) 

Active Shop id setter

Parameters:
string $sShopId shop id
Returns:
null

Definition at line 740 of file oxconfig.php.

Member Data Documentation

oxConfig.$_aAbsDynImageDir = array() [protected]

Definition at line 258 of file oxconfig.php.

oxConfig.$_aActiveViews = array() [protected]

Definition at line 159 of file oxconfig.php.

oxConfig.$_aConfigParams = array() [protected]

Definition at line 173 of file oxconfig.php.

oxConfig.$_aGlobalParams = array() [protected]

Definition at line 166 of file oxconfig.php.

oxConfig.$_aThemeConfigParams = array() [protected]

Definition at line 180 of file oxconfig.php.

oxConfig.$_blInit = false [protected]

Definition at line 274 of file oxconfig.php.

oxConfig.$_blIsSsl = null [protected]

Definition at line 251 of file oxconfig.php.

oxConfig.$_iLanguageId = null [protected]

Definition at line 187 of file oxconfig.php.

oxConfig.$_iShopId = null [protected]

Definition at line 194 of file oxconfig.php.

oxConfig.$_oActCurrencyObject = null [protected]

Definition at line 265 of file oxconfig.php.

oxConfig.$_oActShop = null [protected]

Definition at line 150 of file oxconfig.php.

oxConfig.$_oStart = null [private]

Definition at line 142 of file oxconfig.php.

oxConfig.$_sImageDir = 'img' [protected]

Definition at line 209 of file oxconfig.php.

oxConfig.$_sMasterPictureDir = 'master' [protected]

Definition at line 223 of file oxconfig.php.

oxConfig.$_sModulesDir = 'modules' [protected]

Definition at line 244 of file oxconfig.php.

oxConfig.$_sOutDir = 'out' [protected]

Definition at line 202 of file oxconfig.php.

oxConfig.$_sPictureDir = 'pictures' [protected]

Definition at line 216 of file oxconfig.php.

oxConfig.$_sResourceDir = 'src' [protected]

Definition at line 237 of file oxconfig.php.

oxConfig.$_sTemplateDir = 'tpl' [protected]

Definition at line 230 of file oxconfig.php.

oxConfig.$aMultiShopTables [protected]
Initial value:
 array('oxarticles', 'oxdiscount', 'oxcategories', 'oxattribute',
                                        'oxlinks', 'oxvoucherseries', 'oxmanufacturers',
                                        'oxnews', 'oxselectlist', 'oxwrapping',
                                        'oxdeliveryset', 'oxdelivery', 'oxvendor', 'oxobject2category')

Definition at line 132 of file oxconfig.php.

oxConfig.$blNativeImages = true [protected]

Definition at line 125 of file oxconfig.php.

oxConfig.$blSessionUseCookies = null [protected]

Definition at line 114 of file oxconfig.php.

oxConfig.$dbHost = null [protected]

Definition at line 21 of file oxconfig.php.

oxConfig.$dbName = null [protected]

Definition at line 28 of file oxconfig.php.

oxConfig.$dbPwd = null [protected]

Definition at line 42 of file oxconfig.php.

oxConfig.$dbType = null [protected]

Definition at line 49 of file oxconfig.php.

oxConfig.$dbUser = null [protected]

Definition at line 35 of file oxconfig.php.

oxConfig.$iDebug = null [protected]

Definition at line 100 of file oxconfig.php.

oxConfig.$sAdminEmail = null [protected]

Definition at line 107 of file oxconfig.php.

oxConfig.$sAdminSSLURL = null [protected]

Definition at line 70 of file oxconfig.php.

oxConfig.$sCompileDir = null [protected]

Definition at line 84 of file oxconfig.php.

oxConfig.$sShopDir = null [protected]

Definition at line 77 of file oxconfig.php.

oxConfig.$sShopURL = null [protected]

Definition at line 56 of file oxconfig.php.

oxConfig.$sSSLShopURL = null [protected]

Definition at line 63 of file oxconfig.php.

const oxConfig.OXMODULE_MODULE_PREFIX = 'module:'

Definition at line 288 of file oxconfig.php.

const oxConfig.OXMODULE_THEME_PREFIX = 'theme:'

Definition at line 281 of file oxconfig.php.

The documentation for this class was generated from the following file:
Generated by  doxygen 1.7.1