Inheritance diagram for oxViewConfig:

Collaboration diagram for oxViewConfig:

Public Member Functions
	getHomeLink ()
	getActContentLoadId ()
	getActTplName ()
	getActCurrency ()
	getLogoutLink ()
	getHelpPageLink ()
	getActCatId ()
	getActArticleId ()
	getActSearchParam ()
	getActSearchTag ()
	getActRecommendationId ()
	getActListType ()
	getActManufacturerId ()
	getContentId ()
	setViewConfigParam ($sName, $sValue)
	getViewConfigParam ($sName)
	setViewShop ($oShop, $aViewData)
	getSessionId ()
	getHiddenSid ()
	getSelfLink ()
	getSslSelfLink ()
	getBaseDir ()
	getCoreUtilsDir ()
	getSelfActionLink ()
	getCurrentHomeDir ()
	getBasketLink ()
	getOrderLink ()
	getPaymentLink ()
	getExeOrderLink ()
	getOrderConfirmLink ()
	getResourceUrl ($sFile=null)
	getTemplateDir ()
	getUrlTemplateDir ()
	getImageUrl ($sFile=null, $bSsl=null)
	getNoSslImageDir ()
	getPictureDir ()
	getAdminDir ()
	getActiveShopId ()
	isSsl ()
	getRemoteAddress ()
	getPopupIdent ()
	getPopupIdentRand ()
	getArtPerPageForm ()
	isBuyableParent ()
	showBirthdayFields ()
	showFinalStep ()
	getNrOfCatArticles ()
	getShowWishlist ()
	getShowCompareList ()
	getShowListmania ()
	getShowVouchers ()
	getShowGiftWrapping ()
	getActLanguageId ()
	getActLanguageAbbr ()
	getActiveClassName ()
	getTopActiveClassName ()
	getArtPerPageCount ()
	getNavUrlParams ()
	getNavFormParams ()
	getStockOnDefaultMessage ()
	getStockOffDefaultMessage ()
	getShopVersion ()
	getAjaxLink ()
	isMultiShop ()
	getServiceUrl ()
	getRemoteAccessToken ()
	getActionClassName ()
	getTopActionClassName ()
	getFbAppId ()
	getShowBasketTimeout ()
	getBasketTimeLeft ()
	getShowFbConnect ()
	getTsDomain ()
	getTsRatings ()
	getTsRatingUrl ()
	showTs ($sType)
	getTsId ()
	isTplBlocksDebugMode ()
	getPasswordLength ()
	getCountryList ()
	getModulePath ($sModule, $sFile= '')
	getModuleUrl ($sModule, $sFile= '')
	isModuleActive ($sModuleId, $sVersionFrom=null, $sVersionTo=null)
	getViewThemeParam ($sName)
	showSelectLists ()
	showSelectListsInList ()
	isAltImageServerConfigured ()
	isFunctionalityEnabled ($sParamName)
	getActiveTheme ()
	getShopLogo ()
	setShopLogo ($sLogo)
	getSessionChallengeToken ()
	getEdition ()
Public Member Functions inherited from oxSuperCfg
	__call ($sMethod, $aArgs)
	__construct ()
	getConfig ()
	setConfig ($oConfig)
	getSession ()
	setSession ($oSession)
	getUser ()
	setUser ($oUser)
	isAdmin ()
	setAdminMode ($blAdmin)

Protected Member Functions
	_getHelpContentIdents ()

Protected Attributes
	$_oShop = null
	$_aViewData = null
	$_aConfigParams = array()
	$_sHelpPageLink = null
	$_oCountryList = null
	$_aTrustedShopRatings = null
	$_sActiveTheme = null
	$_sShopLogo = null

Private Member Functions
	_moduleExists ($sModuleId, $aModuleVersions)
	_isModuleEnabled ($sModuleId)
	_isModuleVersionCorrect ($sModuleId, $sVersionFrom, $sVersionTo)

Additional Inherited Members
Static Protected Attributes inherited from oxSuperCfg
static	$_oConfig = null
static	$_oSession = null
static	$_oRights = null
static	$_oActUser = null
static	$_blIsAdmin = null

Detailed Description

View config data access class. Keeps most of getters needed for formatting various urls, config parameters, session information etc.

Definition at line 8 of file oxviewconfig.php.

Member Function Documentation

oxViewConfig::_getHelpContentIdents ( )

protected

Returns help content link idents

Returns: array

Definition at line 188 of file oxviewconfig.php.

oxViewConfig::_isModuleEnabled ( $sModuleId )

private

Checks whether module is enabled.

Parameters

string $sModuleId Module id

Returns: bool

Definition at line 1558 of file oxviewconfig.php.

oxViewConfig::_isModuleVersionCorrect	(	$sModuleId,
		$sVersionFrom,
		$sVersionTo
	)

private

Checks whether module version is between given range.

Parameters

string	$sModuleId	Module id
string	$sVersionFrom	Version from
string	$sVersionTo	Version to

Returns: bool

Definition at line 1578 of file oxviewconfig.php.

oxViewConfig::_moduleExists	(	$sModuleId,
		$aModuleVersions
	)

private

Checks if module exists.

Parameters

string	$sModuleId	Module id
array	$aModuleVersions	Modules from oxconfig 'aModuleVersions'

Returns: bool

Definition at line 1540 of file oxviewconfig.php.

oxViewConfig::getActArticleId ( )

Returns active article id

Returns: string

Definition at line 232 of file oxviewconfig.php.

oxViewConfig::getActCatId ( )

Returns active category id

Returns: string

Definition at line 222 of file oxviewconfig.php.

oxViewConfig::getActContentLoadId ( )

Returns active template name (if set)

Returns: string

Definition at line 109 of file oxviewconfig.php.

oxViewConfig::getActCurrency ( )

Returns active currency id

Returns: string

Definition at line 135 of file oxviewconfig.php.

oxViewConfig::getActionClassName ( )

Returns name of a view class, which will be active for an action (given a generic fnc, e.g. logout)

Returns: string

Definition at line 1080 of file oxviewconfig.php.

oxViewConfig::getActiveClassName ( )

Returns name of active view class

Returns: string

Definition at line 922 of file oxviewconfig.php.

oxViewConfig::getActiveShopId ( )

Returns currently open shop id

Returns: string

Definition at line 690 of file oxviewconfig.php.

oxViewConfig::getActiveTheme ( )

Returns active theme name

Returns: string

Definition at line 1476 of file oxviewconfig.php.

oxViewConfig::getActLanguageAbbr ( )

Returns session language id

Returns: string

Definition at line 912 of file oxviewconfig.php.

oxViewConfig::getActLanguageId ( )

Returns session language id

Returns: string

Definition at line 896 of file oxviewconfig.php.

oxViewConfig::getActListType ( )

Returns active listtype parameter

Returns: string

Definition at line 276 of file oxviewconfig.php.

oxViewConfig::getActManufacturerId ( )

Returns active manufacturer id

Returns: string

Definition at line 286 of file oxviewconfig.php.

oxViewConfig::getActRecommendationId ( )

Returns active recommendation id parameter

Deprecated:: since v5.3 (2016-06-17); Listmania will be moved to an own module.

Returns: string

Definition at line 266 of file oxviewconfig.php.

oxViewConfig::getActSearchParam ( )

Returns active search parameter

Returns: string

Definition at line 242 of file oxviewconfig.php.

oxViewConfig::getActSearchTag ( )

Returns active search tag parameter

Deprecated:: v5.3 (2016-05-04); Tags will be moved to own module.

Returns: string

Definition at line 254 of file oxviewconfig.php.

oxViewConfig::getActTplName ( )

Returns active manufacturer id

Returns: string

Definition at line 125 of file oxviewconfig.php.

oxViewConfig::getAdminDir ( )

Returns admin path

Returns: string

Definition at line 675 of file oxviewconfig.php.

oxViewConfig::getAjaxLink ( )

Returns AJAX request url

Returns: string

Definition at line 1034 of file oxviewconfig.php.

oxViewConfig::getArtPerPageCount ( )

Returns max number of items shown on page

Returns: int

Definition at line 943 of file oxviewconfig.php.

oxViewConfig::getArtPerPageForm ( )

Returns list view paging url

Returns: string

Definition at line 766 of file oxviewconfig.php.

oxViewConfig::getBaseDir ( )

Returns shops base directory path

Returns: string

Definition at line 434 of file oxviewconfig.php.

oxViewConfig::getBasketLink ( )

Returns shops basket link

Returns: string

Definition at line 500 of file oxviewconfig.php.

oxViewConfig::getBasketTimeLeft ( )

return the seconds left until basket expiration

Returns: int

Definition at line 1124 of file oxviewconfig.php.

oxViewConfig::getContentId ( )

Returns active content id

Returns: string

Definition at line 296 of file oxviewconfig.php.

oxViewConfig::getCoreUtilsDir ( )

Returns shops utility directory path

Returns: string

Definition at line 455 of file oxviewconfig.php.

oxViewConfig::getCountryList ( )

Return country list

Returns: oxcountrylist

Definition at line 1313 of file oxviewconfig.php.

oxViewConfig::getCurrentHomeDir ( )

Returns shops home path

Returns: string

Definition at line 485 of file oxviewconfig.php.

oxViewConfig::getEdition ( )

Return shop edition (EE|CE|PE)

Returns: string

Definition at line 1600 of file oxviewconfig.php.

oxViewConfig::getExeOrderLink ( )

Returns shops order execution link

Returns: string

Definition at line 545 of file oxviewconfig.php.

oxViewConfig::getFbAppId ( )

Returns facebook application key value

Deprecated:: since v5.3 (2016-05-20); Facebook will be extracted into module.

Returns: string

Definition at line 1103 of file oxviewconfig.php.

oxViewConfig::getHelpPageLink ( )

Returns shop help link

Returns: string

Definition at line 200 of file oxviewconfig.php.

oxViewConfig::getHiddenSid ( )

Returns forms hidden session parameters

Returns: string

Definition at line 377 of file oxviewconfig.php.

oxViewConfig::getHomeLink ( )

Returns shops home link

Returns: string

Definition at line 72 of file oxviewconfig.php.

oxViewConfig::getImageUrl	(	$sFile = `null`,
		$bSsl = `null`
	)

Returns image url

Parameters

string	$sFile	Image file name
bool	$bSsl	Whether to force SSL

Returns: string

Definition at line 627 of file oxviewconfig.php.

oxViewConfig::getLogoutLink ( )

Returns shop logout link

Returns: string

Definition at line 145 of file oxviewconfig.php.

oxViewConfig::getModulePath	(	$sModule,
		$sFile = `''`
	)

return path to the requested module file

Parameters

string	$sModule	module name (directory name in modules dir)
string	$sFile	file name to lookup

Exceptions

oxFileException

Returns: string

Definition at line 1335 of file oxviewconfig.php.

oxViewConfig::getModuleUrl	(	$sModule,
		$sFile = `''`
	)

return url to the requested module file

Parameters

string	$sModule	module name (directory name in modules dir)
string	$sFile	file name to lookup

Exceptions

oxFileException

Returns: string

Definition at line 1366 of file oxviewconfig.php.

oxViewConfig::getNavFormParams ( )

Returns navigation forms parameters

Returns: string

Definition at line 980 of file oxviewconfig.php.

oxViewConfig::getNavUrlParams ( )

Returns navigation url parameters

Returns: string

Definition at line 953 of file oxviewconfig.php.

oxViewConfig::getNoSslImageDir ( )

Returns non ssl image url

Returns: string

Definition at line 644 of file oxviewconfig.php.

oxViewConfig::getNrOfCatArticles ( )

Returns config param "aNrofCatArticles" value

Returns: array

Definition at line 813 of file oxviewconfig.php.

oxViewConfig::getOrderConfirmLink ( )

Returns shops order confirmation link

Returns: string

Definition at line 560 of file oxviewconfig.php.

oxViewConfig::getOrderLink ( )

Returns shops order link

Returns: string

Definition at line 515 of file oxviewconfig.php.

oxViewConfig::getPasswordLength ( )

min length of password

Returns: int

Definition at line 1295 of file oxviewconfig.php.

oxViewConfig::getPaymentLink ( )

Returns shops payment link

Returns: string

Definition at line 530 of file oxviewconfig.php.

oxViewConfig::getPictureDir ( )

Returns dynamic (language related) image url Left for compatibility reasons for a while. Will be removed in future

Returns: string

Definition at line 660 of file oxviewconfig.php.

oxViewConfig::getPopupIdent ( )

Returns basket popup identifier

Returns: string

Definition at line 736 of file oxviewconfig.php.

oxViewConfig::getPopupIdentRand ( )

Returns random basket popup identifier

Returns: string

Definition at line 751 of file oxviewconfig.php.

oxViewConfig::getRemoteAccessToken ( )

Returns session Remote Access token. Later you can pass the token over rtoken URL param when you want to access the shop, for example, from different client.

Returns: string

Definition at line 1067 of file oxviewconfig.php.

oxViewConfig::getRemoteAddress ( )

Returns visitor ip address

Returns: string

Definition at line 721 of file oxviewconfig.php.

oxViewConfig::getResourceUrl ( $sFile = null )

Returns shops resource url

Parameters

string $sFile resource file name

Returns: string

Definition at line 577 of file oxviewconfig.php.

oxViewConfig::getSelfActionLink ( )

Returns shops action link

Returns: string

Definition at line 470 of file oxviewconfig.php.

oxViewConfig::getSelfLink ( )

Returns shops self link

Returns: string

Definition at line 399 of file oxviewconfig.php.

oxViewConfig::getServiceUrl ( )

Returns service url

Returns: string

Definition at line 1056 of file oxviewconfig.php.

oxViewConfig::getSessionChallengeToken ( )

retrieve session challenge token from session

Returns: string

Definition at line 1521 of file oxviewconfig.php.

oxViewConfig::getSessionId ( )

Returns session id

Deprecated:: v5.1.0 Use conditional sid getter oxView::getSidForWidget() for widgets instead

Returns: string

Definition at line 362 of file oxviewconfig.php.

oxViewConfig::getShopLogo ( )

Returns shop logo image file name from config option

Returns: string

Definition at line 1491 of file oxviewconfig.php.

oxViewConfig::getShopVersion ( )

Returns shop version defined in view

Returns: string

Definition at line 1024 of file oxviewconfig.php.

oxViewConfig::getShowBasketTimeout ( )

should basket timeout counter be shown?

Returns: bool

Definition at line 1113 of file oxviewconfig.php.

oxViewConfig::getShowCompareList ( )

Returns config param "bl_showCompareList" value

Returns: bool

Definition at line 845 of file oxviewconfig.php.

oxViewConfig::getShowFbConnect ( )

Checks if Facebook connect is on. If yes, also checks if Facebook application id and secure key are entered in config table.

Deprecated:: since v5.3 (2016-05-20); Facebook will be extracted into module.

Returns: bool

Definition at line 1141 of file oxviewconfig.php.

oxViewConfig::getShowGiftWrapping ( )

Returns config param "bl_showGiftWrapping" value

Returns: bool

Definition at line 886 of file oxviewconfig.php.

oxViewConfig::getShowListmania ( )

Returns config param "bl_showListmania" value

Deprecated:: since v5.3 (2016-06-17); Listmania will be moved to an own module.

Returns: bool

Definition at line 866 of file oxviewconfig.php.

oxViewConfig::getShowVouchers ( )

Returns config param "bl_showVouchers" value

Returns: bool

Definition at line 876 of file oxviewconfig.php.

oxViewConfig::getShowWishlist ( )

Returns config param "bl_showWishlist" value

Returns: bool

Definition at line 835 of file oxviewconfig.php.

oxViewConfig::getSslSelfLink ( )

Returns shops self ssl link

Returns: string

Definition at line 414 of file oxviewconfig.php.

oxViewConfig::getStockOffDefaultMessage ( )

Returns config param "blStockOnDefaultMessage" value

Returns: string

Definition at line 1014 of file oxviewconfig.php.

oxViewConfig::getStockOnDefaultMessage ( )

Returns config param "blStockOnDefaultMessage" value

Returns: string

Definition at line 1004 of file oxviewconfig.php.

oxViewConfig::getTemplateDir ( )

Returns shops current (related to language) templates path

Returns: string

Definition at line 594 of file oxviewconfig.php.

oxViewConfig::getTopActionClassName ( )

Returns name of a class of top view in the chain (given a generic fnc, e.g. logout)

Returns: string

Definition at line 1091 of file oxviewconfig.php.

oxViewConfig::getTopActiveClassName ( )

Returns name of a class of top view in the chain (given a generic fnc, e.g. logout)

Returns: string

Definition at line 933 of file oxviewconfig.php.

oxViewConfig::getTsDomain ( )

Returns Trusted shops domain name (includes "http://")

Deprecated:: since 5.3.0 (2016.04.28); Use Trusted Shops Module instead.

Returns: string

Definition at line 1161 of file oxviewconfig.php.

oxViewConfig::getTsId ( )

Returns Trusted Shops id

Deprecated:: since 5.3.0 (2016.04.19); Use Trusted Shops Module instead.

Returns: string

Definition at line 1262 of file oxviewconfig.php.

oxViewConfig::getTsRatings ( )

Gets Trusted shops ratings from Trusted shops

Deprecated:: since 5.3.0 (2016.04.19); Use Trusted Shops Module instead.

Returns: array

Definition at line 1179 of file oxviewconfig.php.

oxViewConfig::getTsRatingUrl ( )

Trusted Shops ratings url

Deprecated:: since 5.3.0 (2016.04.19); Use Trusted Shops Module instead.

Returns: string | bool

Definition at line 1202 of file oxviewconfig.php.

oxViewConfig::getUrlTemplateDir ( )

Returns shops current templates url

Returns: string

Definition at line 609 of file oxviewconfig.php.

oxViewConfig::getViewConfigParam ( $sName )

Returns current view config parameter

Parameters

string $sName name of parameter to get

Returns: mixed

Definition at line 325 of file oxviewconfig.php.

oxViewConfig::getViewThemeParam ( $sName )

return param value

Parameters

string $sName param name

Returns: mixed

Definition at line 1412 of file oxviewconfig.php.

oxViewConfig::isAltImageServerConfigured ( )

Checks if alternative image server is configured.

Returns: bool

Definition at line 1451 of file oxviewconfig.php.

oxViewConfig::isBuyableParent ( )

Returns "blVariantParentBuyable" parent article config state

Returns: string

Definition at line 781 of file oxviewconfig.php.

oxViewConfig::isFunctionalityEnabled ( $sParamName )

Get config parameter for view to check if functionality is turned on or off.

Parameters

string $sParamName config parameter name.

Returns: bool

Definition at line 1466 of file oxviewconfig.php.

oxViewConfig::isModuleActive	(	$sModuleId,
		$sVersionFrom = `null`,
		$sVersionTo = `null`
	)

Check if module is active. If versionFrom or|and versionTo is defined - also checks module versions.

Parameters

string	$sModuleId	module id.
string	$sVersionFrom	module from version.
string	$sVersionTo	module to version.

Returns: bool

Definition at line 1387 of file oxviewconfig.php.

oxViewConfig::isMultiShop ( )

Returns multishop status

Returns: bool

Definition at line 1044 of file oxviewconfig.php.

oxViewConfig::isSsl ( )

Returns ssl mode (on/off)

Returns: string

Definition at line 705 of file oxviewconfig.php.

oxViewConfig::isTplBlocksDebugMode ( )

true if blocks javascript code be enabled in templates

Returns: bool

Definition at line 1285 of file oxviewconfig.php.

oxViewConfig::setShopLogo ( $sLogo )

Sets shop logo

Parameters

string $sLogo shop logo image file name

Definition at line 1511 of file oxviewconfig.php.

oxViewConfig::setViewConfigParam	(	$sName,
		$sValue
	)

Sets view config parameter, which can be accessed in templates in two ways:

$oViewConf->getViewConfigParam( $sName )

Parameters

string	$sName	name of parameter
mixed	$sValue	parameter value

Definition at line 309 of file oxviewconfig.php.

oxViewConfig::setViewShop	(	$oShop,
		$aViewData
	)

Sets shop object and view data to view config. This is needed mostly for old templates

Parameters

oxshop	$oShop	shop object
array	$aViewData	view data array

Definition at line 349 of file oxviewconfig.php.

oxViewConfig::showBirthdayFields ( )

Returns config param "blShowBirthdayFields" value

Returns: string

Definition at line 791 of file oxviewconfig.php.

oxViewConfig::showFinalStep ( )

Returns config param "blShowFinalStep" value

Deprecated:: since 2012-11-19. Option blShowFinalStep is removed

Returns: bool

Definition at line 803 of file oxviewconfig.php.

oxViewConfig::showSelectLists ( )

Returns true if selection lists must be displayed in details page

Returns: bool

Definition at line 1429 of file oxviewconfig.php.

oxViewConfig::showSelectListsInList ( )

Returns true if selection lists must be displayed in details page

Returns: bool

Definition at line 1439 of file oxviewconfig.php.

oxViewConfig::showTs ( $sType )

Returns true if Trusted Shops feature is On

Deprecated:: since 5.3.0 (2016.04.19); Use Trusted Shops Module instead.

Parameters

string $sType type of element to check

Returns: bool

Definition at line 1234 of file oxviewconfig.php.

Member Data Documentation

oxViewConfig::$_aConfigParams = array()

protected

Definition at line 30 of file oxviewconfig.php.

oxViewConfig::$_aTrustedShopRatings = null

protected

Definition at line 51 of file oxviewconfig.php.

oxViewConfig::$_aViewData = null

protected

Definition at line 23 of file oxviewconfig.php.

oxViewConfig::$_oCountryList = null

protected

Definition at line 44 of file oxviewconfig.php.

oxViewConfig::$_oShop = null

protected

Definition at line 16 of file oxviewconfig.php.

oxViewConfig::$_sActiveTheme = null

protected

Definition at line 58 of file oxviewconfig.php.

oxViewConfig::$_sHelpPageLink = null

protected

Help page link

Returns: string

Definition at line 37 of file oxviewconfig.php.

oxViewConfig::$_sShopLogo = null

protected

Definition at line 65 of file oxviewconfig.php.

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

core/oxviewconfig.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation