oxConfig Class Reference

Inheritance diagram for oxConfig:

Inheritance graph
[legend]
Collaboration diagram for oxConfig:

Collaboration graph
[legend]

List of all members.


Detailed Description

Main shop configuration class.

Definition at line 9 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, $blAdmin=null)
 getSslShopUrl ($iLang=null)
 getCoreUtilsUrl ()
 getCurrentShopUrl ()
 getShopCurrentUrl ($iLang=null)
 getShopHomeUrl ($iLang=null, $blAdmin=null)
 getShopSecureHomeUrl ()
 getShopCurrency ()
 getActShopCurrencyObject ()
 setActShopCurrency ($iCur)
 getNoSslImageDir ($blAdmin=false)
 getAbsAdminImageDir ()
 getOutDir ($blAbsolute=true)
 getOutUrl ($blSSL=null, $blAdmin=null, $blNativeImg=false)
 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)
 isUtf ()
 getLogsDir ()

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

Definition at line 265 of file oxconfig.php.

oxConfig.setConfigParam ( sName,
sValue 
)

Stores config parameter value in cofig

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

Definition at line 282 of file oxconfig.php.

oxConfig.init (  ) 

Starts session manager

Returns:
null

Definition at line 296 of file oxconfig.php.

static oxConfig.getInstance (  )  [static]

Returns singleton oxConfig object instance or create new if needed

Returns:
oxConfig

Definition at line 405 of file oxconfig.php.

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

Definition at line 431 of file oxconfig.php.

oxConfig.pageClose (  ) 

Unsets all session data.

Returns:
null

Definition at line 487 of file oxconfig.php.

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

Definition at line 505 of file oxconfig.php.

oxConfig.getUploadedFile ( sParamName  ) 

Returns uploaded file parameter

Parameters:
array $sParamName param name
Returns:
null

Definition at line 546 of file oxconfig.php.

oxConfig.setGlobalParameter ( sName,
sValue 
)

Sets global parameter value

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

Definition at line 559 of file oxconfig.php.

oxConfig.getGlobalParameter ( sName  ) 

Returns global parameter value

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

Definition at line 571 of file oxconfig.php.

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

Definition at line 589 of file oxconfig.php.

oxConfig.getShopId (  ) 

Returns active shop ID.

Returns:
int

Definition at line 622 of file oxconfig.php.

oxConfig.setShopId ( sShopId  ) 

Active Shop id setter

Parameters:
string $sShopId shop id
Returns:
null

Definition at line 642 of file oxconfig.php.

oxConfig.isSsl (  ) 

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

Returns:
bool

Definition at line 654 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 683 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 admin
Returns:
string

Definition at line 715 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 747 of file oxconfig.php.

oxConfig.getCoreUtilsUrl (  ) 

Returns utils dir URL

Returns:
string

Definition at line 781 of file oxconfig.php.

oxConfig.getCurrentShopUrl (  ) 

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

Returns:
string

Definition at line 791 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 806 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 825 of file oxconfig.php.

oxConfig.getShopSecureHomeUrl (  ) 

Returns shop SSL URL with index.php and sid.

Returns:
string

Definition at line 835 of file oxconfig.php.

oxConfig.getShopCurrency (  ) 

Returns active shop currency.

Returns:
string

Definition at line 845 of file oxconfig.php.

oxConfig.getActShopCurrencyObject (  ) 

Returns active shop currency object.

Returns:
object

Definition at line 855 of file oxconfig.php.

oxConfig.setActShopCurrency ( iCur  ) 

Sets the actual currency

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

Definition at line 885 of file oxconfig.php.

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

Definition at line 904 of file oxconfig.php.

oxConfig.getAbsAdminImageDir (  ) 

Returns absolute path to admin images.

Deprecated:
use getImageDir
Returns:
string

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

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 Returns path to out dir
Parameters:
bool $blAbsolute mode - absolute/relative path
Returns:
string

Definition at line 996 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 1014 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

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

Definition at line 1041 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 1142 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 1160 of file oxconfig.php.

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

Definition at line 1174 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 1187 of file oxconfig.php.

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

Definition at line 1200 of file oxconfig.php.

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
int $iLang Language
int $iShopId Shop id
Returns:
string

Definition at line 1216 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 1251 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 1264 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 1276 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 1291 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 1303 of file oxconfig.php.

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

Definition at line 1317 of file oxconfig.php.

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

Definition at line 1332 of file oxconfig.php.

oxConfig.getResourceDir ( blAdmin  ) 

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

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

Definition at line 1345 of file oxconfig.php.

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

Definition at line 1359 of file oxconfig.php.

oxConfig.getLanguageDir ( blAdmin  ) 

Finds and returns language folders path

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

Definition at line 1371 of file oxconfig.php.

oxConfig.getAbsImageDir (  ) 

Returns absolute path to images.

Deprecated:
use getImageDir
Returns:
string

Definition at line 1383 of file oxconfig.php.

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

Definition at line 1398 of file oxconfig.php.

oxConfig.getAbsDynImageDir ( sOverrideShopId = null  ) 

Returns absolute path to Dyn images.

Parameters:
string $sOverrideShopId Shop ID (default null)
Deprecated:
Returns:
string

Definition at line 1454 of file oxconfig.php.

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

Definition at line 1483 of file oxconfig.php.

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

Definition at line 1497 of file oxconfig.php.

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

Definition at line 1522 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 1535 of file oxconfig.php.

oxConfig.getCurrencyObject ( sName  ) 

Returns currency object.

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

Definition at line 1598 of file oxconfig.php.

oxConfig.isDemoShop (  ) 

Checks if the shop is in demo mode.

Returns:
bool

Definition at line 1613 of file oxconfig.php.

oxConfig.getEdition (  ) 

Returns OXID eShop edition

Returns:
string

Definition at line 1623 of file oxconfig.php.

oxConfig.getFullEdition (  ) 

Returns full eShop edition name

Returns:
string

Definition at line 1635 of file oxconfig.php.

oxConfig.getVersion (  ) 

Returns shops version number (eg. '4.0.0.0')

Returns:
unknown

Definition at line 1653 of file oxconfig.php.

oxConfig.getRevision (  ) 

Returns build revision number or false on read error.

Returns:
int

Definition at line 1664 of file oxconfig.php.

oxConfig.isMall (  ) 

Checks if shop is MALL. Returns true on success.

Returns:
bool

Definition at line 1686 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 1701 of file oxconfig.php.

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

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

Definition at line 1718 of file oxconfig.php.

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

Definition at line 1773 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 1808 of file oxconfig.php.

oxConfig.getBaseShopId (  ) 

Function returns default shop ID

Returns:
string

Definition at line 1829 of file oxconfig.php.

oxConfig.getActiveShop (  ) 

Loads and returns active shop object

Returns:
oxshop

Definition at line 1840 of file oxconfig.php.

oxConfig.getActiveView (  ) 

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

Returns:
oxview

Definition at line 1857 of file oxconfig.php.

oxConfig.setActiveView ( oView  ) 

View object setter

Parameters:
object $oView view object
Returns:
null

Definition at line 1874 of file oxconfig.php.

oxConfig.isUtf (  ) 

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

Returns:
bool

Definition at line 1884 of file oxconfig.php.

oxConfig.getLogsDir (  ) 

Returns log files storage path

Returns:
string

Definition at line 1894 of file oxconfig.php.


Member Data Documentation

oxConfig.$dbHost = null [protected]

Definition at line 19 of file oxconfig.php.

oxConfig.$dbName = null [protected]

Definition at line 26 of file oxconfig.php.

oxConfig.$dbUser = null [protected]

Definition at line 33 of file oxconfig.php.

oxConfig.$dbPwd = null [protected]

Definition at line 40 of file oxconfig.php.

oxConfig.$dbType = null [protected]

Definition at line 47 of file oxconfig.php.

oxConfig.$sShopURL = null [protected]

Definition at line 54 of file oxconfig.php.

oxConfig.$sSSLShopURL = null [protected]

Definition at line 61 of file oxconfig.php.

oxConfig.$sAdminSSLURL = null [protected]

Definition at line 68 of file oxconfig.php.

oxConfig.$sShopDir = null [protected]

Definition at line 75 of file oxconfig.php.

oxConfig.$sCompileDir = null [protected]

Definition at line 82 of file oxconfig.php.

oxConfig.$iDebug = 0 [protected]

Definition at line 98 of file oxconfig.php.

oxConfig.$sAdminEmail = null [protected]

Definition at line 105 of file oxconfig.php.

oxConfig.$blSessionUseCookies = null [protected]

Definition at line 112 of file oxconfig.php.

oxConfig.$blNativeImages = true [protected]

Definition at line 130 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 137 of file oxconfig.php.

oxConfig.$_instance = null [static, private]

Definition at line 147 of file oxconfig.php.

oxConfig.$_oStart = null [private]

Definition at line 154 of file oxconfig.php.

oxConfig.$_oActShop = null [protected]

Definition at line 162 of file oxconfig.php.

oxConfig.$_oActView = null [protected]

Definition at line 171 of file oxconfig.php.

oxConfig.$_aGlobalParams = array() [protected]

Definition at line 178 of file oxconfig.php.

oxConfig.$_aConfigParams = array() [protected]

Definition at line 185 of file oxconfig.php.

oxConfig.$_iLanguageId = null [protected]

Definition at line 192 of file oxconfig.php.

oxConfig.$_iShopId = null [protected]

Definition at line 199 of file oxconfig.php.

oxConfig.$_sOutDir = 'out' [protected]

Definition at line 207 of file oxconfig.php.

oxConfig.$_sImageDir = 'img' [protected]

Definition at line 214 of file oxconfig.php.

oxConfig.$_sPictureDir = 'pictures' [protected]

Definition at line 221 of file oxconfig.php.

oxConfig.$_sTemplateDir = 'tpl' [protected]

Definition at line 228 of file oxconfig.php.

oxConfig.$_sResourceDir = 'src' [protected]

Definition at line 235 of file oxconfig.php.

oxConfig.$_blIsSsl = null [protected]

Definition at line 242 of file oxconfig.php.

oxConfig.$_aAbsDynImageDir = array() [protected]

Definition at line 249 of file oxconfig.php.

oxConfig.$_oActCurrencyObject = null [protected]

Definition at line 256 of file oxconfig.php.


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

Generated on Mon Oct 26 20:10:01 2009 for OXID eShop CE by  doxygen 1.5.5