oxViewConfig Class Reference

Inheritance diagram for oxViewConfig:

Collaboration diagram for oxViewConfig:

List of all members.

Public Member Functions
	getHomeLink ()
	getActContentLoadId ()
	getActTplName ()
	getActCurrency ()
	getLogoutLink ()
	getHelpPageLink ()
	getHelpLink ()
	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 ()
	getTsWidgetUrl ()
	getTsInfoUrl ()
	getTsRatings ()
	getTsRatingUrl ()
	showTs ($sType)
	getTsId ()
	isTplBlocksDebugMode ()
	getPasswordLength ()
	getCountryList ()
	getModulePath ($sModule, $sFile= '')
	getModuleUrl ($sModule, $sFile= '')
	getViewThemeParam ($sName)
	showSelectLists ()
	showSelectListsInList ()
	isAltImageServerConfigured ()
	isFunctionalityEnabled ($sParamName)
	getActiveTheme ()
	getShopLogo ()
	setShopLogo ($sLogo)
	getSessionChallengeToken ()
Protected Member Functions
	_getHelpContentIdents ()
Protected Attributes
	$_oShop = null
	$_aViewData = null
	$_aConfigParams = array()
	$_sHelpPageLink = null
	$_oCountryList = null
	$_aTrustedShopRatings = null
	$_sActiveTheme = null
	$_sShopLogo = 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 175 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 106 of file oxviewconfig.php.

oxViewConfig.getActCurrency

(

)

Returns active currency id

Returns:

string

Definition at line 131 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 1044 of file oxviewconfig.php.

oxViewConfig.getActiveClassName

(

)

Returns name of active view class

Returns:

string

Definition at line 889 of file oxviewconfig.php.

oxViewConfig.getActiveShopId

(

)

Returns currently open shop id

Returns:

string

Definition at line 670 of file oxviewconfig.php.

oxViewConfig.getActiveTheme

(

)

Returns active theme name

Returns:

string

Definition at line 1438 of file oxviewconfig.php.

oxViewConfig.getActLanguageAbbr

(

)

Returns session language id

Returns:

string

Definition at line 879 of file oxviewconfig.php.

oxViewConfig.getActLanguageId

(

)

Returns session language id

Returns:

string

Definition at line 864 of file oxviewconfig.php.

oxViewConfig.getActListType

(

)

Returns active listtype parameter

Returns:

string

Definition at line 272 of file oxviewconfig.php.

oxViewConfig.getActManufacturerId

(

)

Returns active manufacturer id

Returns:

string

Definition at line 282 of file oxviewconfig.php.

oxViewConfig.getActRecommendationId

(

)

Returns active recommendation id parameter

Returns:

string

Definition at line 262 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

Returns:

string

Definition at line 252 of file oxviewconfig.php.

oxViewConfig.getActTplName

(

)

Returns active manufacturer id

Returns:

string

Definition at line 121 of file oxviewconfig.php.

oxViewConfig.getAdminDir

(

)

Returns admin path

Returns:

string

Definition at line 656 of file oxviewconfig.php.

oxViewConfig.getAjaxLink

(

)

Returns AJAX request url

Returns:

string

Definition at line 999 of file oxviewconfig.php.

oxViewConfig.getArtPerPageCount

(

)

Returns max number of items shown on page

Returns:

int

Definition at line 910 of file oxviewconfig.php.

oxViewConfig.getArtPerPageForm

(

)

Returns list view paging url

Returns:

string

Definition at line 741 of file oxviewconfig.php.

oxViewConfig.getBaseDir

(

)

Returns shops base directory path

Returns:

string

Definition at line 430 of file oxviewconfig.php.

oxViewConfig.getBasketLink

(

)

Returns shops basket link

Returns:

string

Definition at line 492 of file oxviewconfig.php.

oxViewConfig.getBasketTimeLeft

(

)

return the seconds left until basket expiration

Returns:

int

Definition at line 1086 of file oxviewconfig.php.

oxViewConfig.getContentId

(

)

Returns active content id

Returns:

string

Definition at line 292 of file oxviewconfig.php.

oxViewConfig.getCoreUtilsDir

(

)

Returns shops utility directory path

Returns:

string

Definition at line 450 of file oxviewconfig.php.

oxViewConfig.getCountryList

(

)

Return country list

Returns:

oxcountrylist

Definition at line 1306 of file oxviewconfig.php.

oxViewConfig.getCurrentHomeDir

(

)

Returns shops home path

Returns:

string

Definition at line 478 of file oxviewconfig.php.

oxViewConfig.getExeOrderLink

(

)

Returns shops order execution link

Returns:

string

Definition at line 534 of file oxviewconfig.php.

oxViewConfig.getFbAppId

(

)

Returns facebook application key value

Returns:

string

Definition at line 1065 of file oxviewconfig.php.

oxViewConfig.getHelpLink

(

)

Returns dynamic shop help link

Returns:

string

Definition at line 210 of file oxviewconfig.php.

oxViewConfig.getHelpPageLink

(

)

Returns shop help link

Returns:

string

Definition at line 186 of file oxviewconfig.php.

oxViewConfig.getHiddenSid

(

)

Returns forms hidden session parameters

Returns:

string

Definition at line 376 of file oxviewconfig.php.

oxViewConfig.getHomeLink

(

)

Returns shops home link

Returns:

string

Definition at line 70 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 611 of file oxviewconfig.php.

oxViewConfig.getLogoutLink

(

)

Returns shop logout link

Returns:

string

Definition at line 141 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 1327 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 1357 of file oxviewconfig.php.

oxViewConfig.getNavFormParams

(

)

Returns navigation forms parameters

Returns:

string

Definition at line 947 of file oxviewconfig.php.

oxViewConfig.getNavUrlParams

(

)

Returns navigation url parameters

Returns:

string

Definition at line 920 of file oxviewconfig.php.

oxViewConfig.getNoSslImageDir

(

)

Returns non ssl image url

Returns:

string

Definition at line 627 of file oxviewconfig.php.

oxViewConfig.getNrOfCatArticles

(

)

Returns config param "aNrofCatArticles" value

Returns:

string

Definition at line 787 of file oxviewconfig.php.

oxViewConfig.getOrderConfirmLink

(

)

Returns shops order confirmation link

Returns:

string

Definition at line 548 of file oxviewconfig.php.

oxViewConfig.getOrderLink

(

)

Returns shops order link

Returns:

string

Definition at line 506 of file oxviewconfig.php.

oxViewConfig.getPasswordLength

(

)

min length of password

Returns:

int

Definition at line 1288 of file oxviewconfig.php.

oxViewConfig.getPaymentLink

(

)

Returns shops payment link

Returns:

string

Definition at line 520 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 642 of file oxviewconfig.php.

oxViewConfig.getPopupIdent

(

)

Returns basket popup identifier

Returns:

string

Definition at line 713 of file oxviewconfig.php.

oxViewConfig.getPopupIdentRand

(

)

Returns random basket popup identifier

Returns:

string

Definition at line 727 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 1031 of file oxviewconfig.php.

oxViewConfig.getRemoteAddress

(

)

Returns visitor ip address

Returns:

string

Definition at line 699 of file oxviewconfig.php.

oxViewConfig.getResourceUrl

(

$

sFile = null

)

Returns shops resource url

Parameters:

string

$sFile resource file name

Returns:

string

Definition at line 564 of file oxviewconfig.php.

oxViewConfig.getSelfActionLink

(

)

Returns shops action link

Returns:

string

Definition at line 464 of file oxviewconfig.php.

oxViewConfig.getSelfLink

(

)

Returns shops self link

Returns:

string

Definition at line 397 of file oxviewconfig.php.

oxViewConfig.getServiceUrl

(

)

Returns service url

Returns:

string

Definition at line 1020 of file oxviewconfig.php.

oxViewConfig.getSessionChallengeToken

(

)

retrieve session challenge token from session

Returns:

string

Definition at line 1485 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 1452 of file oxviewconfig.php.

oxViewConfig.getShopVersion

(

)

Returns shop version defined in view

Returns:

string

Definition at line 989 of file oxviewconfig.php.

oxViewConfig.getShowBasketTimeout

(

)

should basket timeout counter be shown?

Returns:

bool

Definition at line 1075 of file oxviewconfig.php.

oxViewConfig.getShowCompareList

(

)

Returns config param "bl_showCompareList" value

Returns:

bool

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

Returns:

bool

Definition at line 1100 of file oxviewconfig.php.

oxViewConfig.getShowGiftWrapping

(

)

Returns config param "bl_showGiftWrapping" value

Returns:

bool

Definition at line 854 of file oxviewconfig.php.

oxViewConfig.getShowListmania

(

)

Returns config param "bl_showListmania" value

Returns:

bool

Definition at line 834 of file oxviewconfig.php.

oxViewConfig.getShowVouchers

(

)

Returns config param "bl_showVouchers" value

Returns:

bool

Definition at line 844 of file oxviewconfig.php.

oxViewConfig.getShowWishlist

(

)

Returns config param "bl_showWishlist" value

Returns:

bool

Definition at line 806 of file oxviewconfig.php.

oxViewConfig.getSslSelfLink

(

)

Returns shops self ssl link

Returns:

string

Definition at line 411 of file oxviewconfig.php.

oxViewConfig.getStockOffDefaultMessage

(

)

Returns config param "blStockOnDefaultMessage" value

Returns:

string

Definition at line 979 of file oxviewconfig.php.

oxViewConfig.getStockOnDefaultMessage

(

)

Returns config param "blStockOnDefaultMessage" value

Returns:

string

Definition at line 969 of file oxviewconfig.php.

oxViewConfig.getTemplateDir

(

)

Returns shops current (related to language) templates path

Returns:

string

Definition at line 580 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 1055 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 900 of file oxviewconfig.php.

oxViewConfig.getTsDomain

(

)

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

Returns:

string

Definition at line 1118 of file oxviewconfig.php.

oxViewConfig.getTsId

(

)

Returns Trusted Shops id

Returns:

string

Definition at line 1255 of file oxviewconfig.php.

oxViewConfig.getTsInfoUrl

(

)

Trusted Shops widget info url

Deprecated:

since v4.7.6/5.0.6 (2013-07-09); new Trusted Shops badge added

Returns:

string | bool

Definition at line 1163 of file oxviewconfig.php.

oxViewConfig.getTsRatings

(

)

Gets Trusted shops ratings from Trusted shops

Returns:

array

Definition at line 1186 of file oxviewconfig.php.

oxViewConfig.getTsRatingUrl

(

)

Trusted Shops ratings url

Returns:

string | bool

Definition at line 1205 of file oxviewconfig.php.

oxViewConfig.getTsWidgetUrl

(

)

Returns Trusted Shops Widget image url

Deprecated:

since v4.7.6/5.0.6 (2013-07-09); new Trusted Shops badge added

Returns:

string

Definition at line 1135 of file oxviewconfig.php.

oxViewConfig.getUrlTemplateDir

(

)

Returns shops current templates url

Returns:

string

Definition at line 594 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 323 of file oxviewconfig.php.

oxViewConfig.getViewThemeParam

(

$

sName

)

return param value

Parameters:

string

$sName param name

Returns:

mix

Definition at line 1374 of file oxviewconfig.php.

oxViewConfig.isAltImageServerConfigured

(

)

Checks if alternative image server is configured.

Returns:

bool

Definition at line 1413 of file oxviewconfig.php.

oxViewConfig.isBuyableParent

(

)

Returns "blVariantParentBuyable" parent article config state

Returns:

string

Definition at line 755 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 1428 of file oxviewconfig.php.

oxViewConfig.isMultiShop

(

)

Returns multishop status

Returns:

bool

Definition at line 1009 of file oxviewconfig.php.

oxViewConfig.isSsl

(

)

Returns ssl mode (on/off)

Returns:

string

Definition at line 684 of file oxviewconfig.php.

oxViewConfig.isTplBlocksDebugMode

(

)

true if blocks javascript code be enabled in templates

Returns:

bool

Definition at line 1278 of file oxviewconfig.php.

oxViewConfig.setShopLogo

(

$

sLogo

)

Sets shop logo

Parameters:

string

$sLogo shop logo image file name

Returns:

null

Definition at line 1475 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

Returns:

mixed

Definition at line 307 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

Returns:

null

Definition at line 349 of file oxviewconfig.php.

oxViewConfig.showBirthdayFields

(

)

Returns config param "blShowBirthdayFields" value

Returns:

string

Definition at line 765 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 777 of file oxviewconfig.php.

oxViewConfig.showSelectLists

(

)

Returns true if selection lists must be displayed in details page

Returns:

bool

Definition at line 1391 of file oxviewconfig.php.

oxViewConfig.showSelectListsInList

(

)

Returns true if selection lists must be displayed in details page

Returns:

bool

Definition at line 1401 of file oxviewconfig.php.

oxViewConfig.showTs

(

$

sType

)

Returns true if Trusted Shops feature is On

Parameters:

string

$sType type of element to check

Returns:

bool

Definition at line 1230 of file oxviewconfig.php.

---

Member Data Documentation

oxViewConfig.$_aConfigParams = array() [protected]

Definition at line 29 of file oxviewconfig.php.

oxViewConfig.$_aTrustedShopRatings = null [protected]

Definition at line 50 of file oxviewconfig.php.

oxViewConfig.$_aViewData = null [protected]

Definition at line 22 of file oxviewconfig.php.

oxViewConfig.$_oCountryList = null [protected]

Definition at line 43 of file oxviewconfig.php.

oxViewConfig.$_oShop = null [protected]

Definition at line 15 of file oxviewconfig.php.

oxViewConfig.$_sActiveTheme = null [protected]

Definition at line 57 of file oxviewconfig.php.

oxViewConfig.$_sHelpPageLink = null [protected]

Help page link

Returns:

string

Definition at line 36 of file oxviewconfig.php.

oxViewConfig.$_sShopLogo = null [protected]

Definition at line 63 of file oxviewconfig.php.

---

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

• core/oxviewconfig.php