Definition at line 10 of file oxconfig.php.
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 () | |
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 () | |
getRevision () | |
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 |
oxConfig.getConfigParam | ( | $ | sName | ) |
Returns config parameter value if such parameter exists
string | $sName config parameter name |
Definition at line 273 of file oxconfig.php.
oxConfig.setConfigParam | ( | $ | sName, | |
$ | sValue | |||
) |
Stores config parameter value in cofig
string | $sName config parameter name | |
string | $sValue config parameter value |
Definition at line 290 of file oxconfig.php.
oxConfig.init | ( | ) |
static oxConfig.getInstance | ( | ) | [static] |
Returns singleton oxConfig object instance or create new if needed
Definition at line 417 of file oxconfig.php.
oxConfig._loadVarsFromDb | ( | $ | sShopID, | |
$ | aOnlyVars = null | |||
) | [protected] |
Load config values from DB
string | $sShopID shop ID to load parameters | |
array | $aOnlyVars array of params to load (optional) |
Definition at line 443 of file oxconfig.php.
oxConfig.pageClose | ( | ) |
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.
string | $sName Name of parameter | |
bool | $blRaw Get unescaped parameter |
Definition at line 523 of file oxconfig.php.
oxConfig.getUploadedFile | ( | $ | sParamName | ) |
Returns uploaded file parameter
array | $sParamName param name |
Definition at line 564 of file oxconfig.php.
oxConfig.setGlobalParameter | ( | $ | sName, | |
$ | sValue | |||
) |
Sets global parameter value
string | $sName name of parameter | |
mixed | $sValue value to store |
Definition at line 577 of file oxconfig.php.
oxConfig.getGlobalParameter | ( | $ | sName | ) |
Returns global parameter value
string | $sName name of cached parameter |
Definition at line 589 of file oxconfig.php.
static oxConfig.checkSpecialChars | ( | &$ | sValue, | |
$ | aRaw = null | |||
) | [static] |
Checks if passed parameter has special chars and replaces them. Returns checked value.
mixed | &$sValue value to process escaping | |
array | $aRaw keys of unescaped values |
Definition at line 607 of file oxconfig.php.
oxConfig.getShopId | ( | ) |
oxConfig.setShopId | ( | $ | sShopId | ) |
Active Shop id setter
string | $sShopId shop id |
Definition at line 657 of file oxconfig.php.
oxConfig.isSsl | ( | ) |
Checks if WEB session is SSL. Returns true if yes.
Definition at line 669 of file oxconfig.php.
oxConfig.isCurrentUrl | ( | $ | sURL | ) |
Compares current URL to supplied string
string | $sURL URL |
Definition at line 701 of file oxconfig.php.
oxConfig.getShopUrl | ( | $ | iLang = null |
) |
Returns config sShopURL or sMallShopURL if secondary shop
int | $iLang language |
Definition at line 728 of file oxconfig.php.
oxConfig.getSslShopUrl | ( | $ | iLang = null |
) |
Returns config sSSLShopURL or sMallSSLShopURL if secondary shop
int | $iLang language (default is null) |
Definition at line 757 of file oxconfig.php.
oxConfig.getCoreUtilsUrl | ( | ) |
oxConfig.getCurrentShopUrl | ( | ) |
Returns SSL or non SSL shop URL without index.php depending on Mall
Definition at line 801 of file oxconfig.php.
oxConfig.getShopCurrentUrl | ( | $ | iLang = null |
) |
Returns SSL or not SSL shop URL with index.php and sid
int | $iLang language (optional) |
Definition at line 816 of file oxconfig.php.
oxConfig.getShopHomeUrl | ( | ) |
Returns shop non SSL URL including index.php and sid.
Definition at line 832 of file oxconfig.php.
oxConfig.getShopSecureHomeUrl | ( | ) |
Returns shop SSL URL with index.php and sid.
Definition at line 842 of file oxconfig.php.
oxConfig.getShopCurrency | ( | ) |
oxConfig.getActShopCurrencyObject | ( | ) |
oxConfig.setActShopCurrency | ( | $ | iCur | ) |
Sets the actual currency
int | $iCur 0 = EUR, 1 = GBP, 2 = CHF |
Definition at line 892 of file oxconfig.php.
oxConfig.getNoSslImageDir | ( | $ | blAdmin = false |
) |
Returns image dir URL (no SSL).
bool | $blAdmin mode - admin/non-admin (default is false) |
Definition at line 911 of file oxconfig.php.
oxConfig.getAbsAdminImageDir | ( | ) |
Returns absolute path to admin images.
Definition at line 923 of file oxconfig.php.
oxConfig.getOutDir | ( | $ | blAbsolute = true |
) |
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).
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 |
bool | $blAbsolute mode - absolute/relative path |
Definition at line 1003 of file oxconfig.php.
oxConfig.getOutUrl | ( | $ | blSSL = null , |
|
$ | blNativeImg = false , |
|||
$ | blAdmin = null | |||
) |
Returns url to out dir
bool | $blSSL Whether to force ssl | |
bool | $blNativeImg Whether to force native image dirs | |
bool | $blAdmin Whether to force admin |
Definition at line 1021 of file oxconfig.php.
oxConfig.getDir | ( | $ | sFile, | |
$ | sDir, | |||
$ | blAdmin, | |||
$ | iLang = null , |
|||
$ | iShop = null , |
|||
$ | sTheme = null , |
|||
$ | blAbsolute = true | |||
) |
Finds and returns files or folders path in out dir
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 |
Definition at line 1048 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
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 |
Definition at line 1143 of file oxconfig.php.
oxConfig.getImagePath | ( | $ | sFile, | |
$ | blAdmin = false | |||
) |
Finds and returns image files or folders path
string | $sFile File name | |
bool | $blAdmin Whether to force admin |
Definition at line 1161 of file oxconfig.php.
oxConfig.getImageUrl | ( | $ | blAdmin = false , |
|
$ | blSSL = null , |
|||
$ | blNativeImg = null | |||
) |
Finds and returns image folder url
bool | $blAdmin Whether to force admin | |
bool | $blSSL Whether to force ssl | |
bool | $blNativeImg Whether to force native image dirs |
Definition at line 1175 of file oxconfig.php.
oxConfig.getImageDir | ( | $ | blAdmin = false |
) |
Finds and returns image folders path
bool | $blAdmin Whether to force admin |
Definition at line 1188 of file oxconfig.php.
oxConfig.getPicturePath | ( | $ | sFile, | |
$ | blAdmin = false | |||
) |
Finds and returns product pictures files or folders path
string | $sFile File name | |
bool | $blAdmin Whether to force admin |
Definition at line 1201 of file oxconfig.php.
oxConfig.getPictureUrl | ( | $ | sFile, | |
$ | blAdmin = false , |
|||
$ | blSSL = null , |
|||
$ | iLang = null , |
|||
$ | iShopId = null | |||
) |
Finds and returns product picture file or folder url
string | $sFile File name | |
bool | $blAdmin Whether to force admin | |
bool | $blSSL Whether to force ssl | |
int | $iLang Language | |
int | $iShopId Shop id |
Definition at line 1217 of file oxconfig.php.
oxConfig.getPictureDir | ( | $ | blAdmin | ) |
Finds and returns product pictures folders path
bool | $blAdmin Whether to force admin |
Definition at line 1245 of file oxconfig.php.
oxConfig.getTemplatePath | ( | $ | sFile, | |
$ | blAdmin | |||
) |
Finds and returns templates files or folders path
string | $sFile File name | |
bool | $blAdmin Whether to force admin |
Definition at line 1258 of file oxconfig.php.
oxConfig.getTemplateDir | ( | $ | blAdmin = false |
) |
Finds and returns templates folders path
bool | $blAdmin Whether to force admin |
Definition at line 1270 of file oxconfig.php.
oxConfig.getTemplateUrl | ( | $ | sFile = null , |
|
$ | blAdmin = false , |
|||
$ | blSSL = null , |
|||
$ | iLang = null | |||
) |
Finds and returns template file or folder url
string | $sFile File name | |
bool | $blAdmin Whether to force admin | |
bool | $blSSL Whether to force ssl | |
int | $iLang Language id |
Definition at line 1285 of file oxconfig.php.
oxConfig.getTemplateBase | ( | $ | blAdmin = false |
) |
Finds and returns base template folder url
bool | $blAdmin Whether to force admin |
Definition at line 1297 of file oxconfig.php.
oxConfig.getResourcePath | ( | $ | sFile, | |
$ | blAdmin = false | |||
) |
Finds and returns resouce (css, js, etc..) files or folders path
string | $sFile File name | |
bool | $blAdmin Whether to force admin |
Definition at line 1311 of file oxconfig.php.
oxConfig.getResourceUrl | ( | $ | sFile, | |
$ | blAdmin = false , |
|||
$ | blSSL = null , |
|||
$ | iLang = null | |||
) |
Finds and returns resouce (css, js, etc..) file or folder url
string | $sFile File name | |
bool | $blAdmin Whether to force admin | |
bool | $blSSL Whether to force ssl | |
int | $iLang Language id |
Definition at line 1326 of file oxconfig.php.
oxConfig.getResourceDir | ( | $ | blAdmin | ) |
Finds and returns resouce (css, js, etc..) folders path
bool | $blAdmin Whether to force admin |
Definition at line 1338 of file oxconfig.php.
oxConfig.getLanguagePath | ( | $ | sFile, | |
$ | blAdmin, | |||
$ | iLang = null | |||
) |
Finds and returns language files or folders path
string | $sFile File name | |
bool | $blAdmin Whether to force admin | |
int | $iLang Language id |
Definition at line 1352 of file oxconfig.php.
oxConfig.getLanguageDir | ( | $ | blAdmin | ) |
Finds and returns language folders path
bool | $blAdmin Whether to force admin |
Definition at line 1364 of file oxconfig.php.
oxConfig.getAbsImageDir | ( | ) |
Returns absolute path to images.
Definition at line 1376 of file oxconfig.php.
oxConfig.getDynImageDir | ( | $ | sOverrideShopId = null , |
|
$ | blNoSsl = null | |||
) |
Returns url to Dyn images.
string | $sOverrideShopId Shop ID (default null) | |
bool | $blNoSsl SSL status (default null) |
Definition at line 1391 of file oxconfig.php.
oxConfig.getAbsDynImageDir | ( | $ | sOverrideShopId = null |
) |
Returns absolute path to Dyn images.
string | $sOverrideShopId Shop ID (default null) |
Definition at line 1447 of file oxconfig.php.
oxConfig.getTemplateFile | ( | $ | sTemplate, | |
$ | blAdmin = false | |||
) |
Returns shop template file path.
string | $sTemplate name of template file | |
bool | $blAdmin mode - admin/non-admin (default is false) |
Definition at line 1476 of file oxconfig.php.
oxConfig.getBaseTemplateDir | ( | $ | blAdmin = false |
) |
Returns path to template files. Eg. 'http://localhost/oxid/out/1/html/0/templates/'
bool | $blAdmin mode - admin/non-admin (default is false) |
Definition at line 1490 of file oxconfig.php.
oxConfig.getBaseTplDir | ( | $ | blAdmin = false |
) |
Returns base path to template files. (eg. 'out/1/')
bool | $blAdmin mode - admin/non-admin (default is false) |
Definition at line 1515 of file oxconfig.php.
oxConfig.getCurrencyArray | ( | $ | iCurrency = null |
) |
Returns array of available currencies
integer | $iCurrency Active currency number (default null) |
Definition at line 1528 of file oxconfig.php.
oxConfig.getCurrencyObject | ( | $ | sName | ) |
Returns currency object.
string | $sName Name of active currency |
Definition at line 1590 of file oxconfig.php.
oxConfig.isDemoShop | ( | ) |
oxConfig.getEdition | ( | ) |
oxConfig.getFullEdition | ( | ) |
oxConfig.getVersion | ( | ) |
Returns shops version number (eg. '4.0.0.0')
Definition at line 1643 of file oxconfig.php.
oxConfig.getRevision | ( | ) |
Returns build revision number or false on read error.
Definition at line 1654 of file oxconfig.php.
oxConfig.isMall | ( | ) |
Checks if shop is MALL. Returns true on success.
Definition at line 1676 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
Definition at line 1691 of file oxconfig.php.
oxConfig.saveShopConfVar | ( | $ | sVarType, | |
$ | sVarName, | |||
$ | sVarVal, | |||
$ | sShopId = null | |||
) |
Updates or adds new shop configuration parameters to DB.
string | $sVarType Variable Type | |
string | $sVarName Variable name | |
string | $sVarVal Variable value | |
string | $sShopId Shop ID, default is current shop |
Definition at line 1707 of file oxconfig.php.
oxConfig.getShopConfVar | ( | $ | sVarName, | |
$ | sShopId = null | |||
) |
Retrieves shop configuration parameters from DB.
string | $sVarName Variable name | |
string | $sShopId Shop ID |
Definition at line 1736 of file oxconfig.php.
oxConfig.isProductiveMode | ( | ) |
Returns true if current active shop is in productive mode or false if not
Definition at line 1769 of file oxconfig.php.
oxConfig.getBaseShopId | ( | ) |
oxConfig.getActiveShop | ( | ) |
oxConfig.getActiveView | ( | ) |
Returns active view object. If this object was not defined - returns oxview object
Definition at line 1816 of file oxconfig.php.
oxConfig.setActiveView | ( | $ | oView | ) |
View object setter
object | $oView view object |
Definition at line 1833 of file oxconfig.php.
oxConfig.$dbHost = null [protected] |
Definition at line 20 of file oxconfig.php.
oxConfig.$dbName = null [protected] |
Definition at line 27 of file oxconfig.php.
oxConfig.$dbUser = null [protected] |
Definition at line 34 of file oxconfig.php.
oxConfig.$dbPwd = null [protected] |
Definition at line 41 of file oxconfig.php.
oxConfig.$dbType = null [protected] |
Definition at line 48 of file oxconfig.php.
oxConfig.$sShopURL = null [protected] |
Definition at line 55 of file oxconfig.php.
oxConfig.$sSSLShopURL = null [protected] |
Definition at line 62 of file oxconfig.php.
oxConfig.$sAdminSSLURL = null [protected] |
Definition at line 69 of file oxconfig.php.
oxConfig.$sShopDir = null [protected] |
Definition at line 76 of file oxconfig.php.
oxConfig.$sCompileDir = null [protected] |
Definition at line 83 of file oxconfig.php.
oxConfig.$iDebug = 0 [protected] |
Definition at line 99 of file oxconfig.php.
oxConfig.$sAdminEmail = null [protected] |
Definition at line 106 of file oxconfig.php.
oxConfig.$blSessionUseCookies = null [protected] |
Definition at line 113 of file oxconfig.php.
oxConfig.$blSessionEnforceCookies = null [protected] |
Definition at line 120 of file oxconfig.php.
oxConfig.$blNativeImages = true [protected] |
Definition at line 138 of file oxconfig.php.
oxConfig.$aMultiShopTables [protected] |
Initial value:
array( 'oxarticles', 'oxdiscount', 'oxcategories', 'oxattribute', 'oxlinks', 'oxvoucherseries', 'oxnews', 'oxselectlist', 'oxwrapping', 'oxdeliveryset', 'oxdelivery', 'oxvendor', 'oxobject2category')
Definition at line 145 of file oxconfig.php.
oxConfig.$_instance = null [static, private] |
Definition at line 155 of file oxconfig.php.
oxConfig.$_oStart = null [private] |
Definition at line 162 of file oxconfig.php.
oxConfig.$_oActShop = null [protected] |
Definition at line 170 of file oxconfig.php.
oxConfig.$_oActView = null [protected] |
Definition at line 179 of file oxconfig.php.
oxConfig.$_aGlobalParams = array() [protected] |
Definition at line 186 of file oxconfig.php.
oxConfig.$_aConfigParams = array() [protected] |
Definition at line 193 of file oxconfig.php.
oxConfig.$_iLanguageId = null [protected] |
Definition at line 200 of file oxconfig.php.
oxConfig.$_iShopId = null [protected] |
Definition at line 207 of file oxconfig.php.
oxConfig.$_sOutDir = 'out' [protected] |
Definition at line 215 of file oxconfig.php.
oxConfig.$_sImageDir = 'img' [protected] |
Definition at line 222 of file oxconfig.php.
oxConfig.$_sPictureDir = 'pictures' [protected] |
Definition at line 229 of file oxconfig.php.
oxConfig.$_sTemplateDir = 'tpl' [protected] |
Definition at line 236 of file oxconfig.php.
oxConfig.$_sResourceDir = 'src' [protected] |
Definition at line 243 of file oxconfig.php.
oxConfig.$_blIsSsl = null [protected] |
Definition at line 250 of file oxconfig.php.
oxConfig.$_aAbsDynImageDir = array() [protected] |
Definition at line 257 of file oxconfig.php.
oxConfig.$_oActCurrencyObject = null [protected] |
Definition at line 264 of file oxconfig.php.