oxViewConfig Class Reference

Inheritance diagram for oxViewConfig:

Collaboration diagram for oxViewConfig:

List of all members.

Public Member Functions
	getHomeLink ()
	getActTplName ()
	getLogoutLink ()
	getHelpPageLink ()
	getHelpLink ()
	getActCatId ()
	getActArticleId ()
	getActSearchParam ()
	getActSearchTag ()
	getActListType ()
	getActManufacturerId ()
	setViewConfigParam ($sName, $sValue)
	getViewConfigParam ($sName)
	setViewShop ($oShop, $aViewData)
	getSessionId ()
	getHiddenSid ()
	getSelfLink ()
	getSslSelfLink ()
	getBaseDir ()
	getCoreUtilsDir ()
	getSelfActionLink ()
	getCurrentHomeDir ()
	getBasketLink ()
	getOrderLink ()
	getPaymentLink ()
	getExeOrderLink ()
	getOrderConfirmLink ()
	getResourceUrl ()
	getTemplateDir ()
	getUrlTemplateDir ()
	getImageUrl ()
	getNoSslImageDir ()
	getPictureDir ()
	getAdminDir ()
	getActiveShopId ()
	isSsl ()
	getRemoteAddress ()
	getPopupIdent ()
	getPopupIdentRand ()
	getArtPerPageForm ()
	isBuyableParent ()
	showBirthdayFields ()
	showFinalStep ()
	getNrOfCatArticles ()
	getShowWishlist ()
	getShowCompareList ()
	getShowListmania ()
	getShowVouchers ()
	getShowGiftWrapping ()
	isAutoSearchOnCat ()
	getActLanguageId ()
	getActiveClassName ()
	getArtPerPageCount ()
	getNavUrlParams ()
	getNavFormParams ()
	getStockOnDefaultMessage ()
	getStockOffDefaultMessage ()
	getShopVersion ()
	getAjaxLink ()
	isMultiShop ()
	getServiceUrl ()
	getRemoteAccessToken ()
	getActionClassName ()
	getFbAppId ()
	getShowBasketTimeout ()
	getBasketTimeLeft ()
	getShowFbConnect ()
	getTsDomain ()
	getTsWidgetUrl ()
	getTsInfoUrl ()
	getTsRatingUrl ()
	showTs ($sType)
	getTsId ()
	isTplBlocksDebugMode ()
	getPasswordLength ()
	getCountryList ()
	getModulePath ($sModule, $sFile= '')
	getModuleUrl ($sModule, $sFile= '')
	getViewThemeParam ($sName)
	showSelectLists ()
	showSelectListsInList ()
Protected Attributes
	$_oShop = null
	$_aViewData = null
	$_aConfigParams = array()
	$_sHelpPageLink = null
	$_oCountryList = 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.getActArticleId

(

)

Returns active article id

Returns:

string

Definition at line 180 of file oxviewconfig.php.

oxViewConfig.getActCatId

(

)

Returns active category id

Returns:

string

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

oxViewConfig.getActiveClassName

(

)

Returns name of active view class

Returns:

string

Definition at line 794 of file oxviewconfig.php.

oxViewConfig.getActiveShopId

(

)

Returns currently open shop id

Returns:

string

Definition at line 577 of file oxviewconfig.php.

oxViewConfig.getActLanguageId

(

)

Returns session language id

Returns:

string

Definition at line 779 of file oxviewconfig.php.

oxViewConfig.getActListType

(

)

Returns active listtype parameter

Returns:

string

Definition at line 210 of file oxviewconfig.php.

oxViewConfig.getActManufacturerId

(

)

Returns active manufacturer id

Returns:

string

Definition at line 220 of file oxviewconfig.php.

oxViewConfig.getActSearchParam

(

)

Returns active search parameter

Returns:

string

Definition at line 190 of file oxviewconfig.php.

oxViewConfig.getActSearchTag

(

)

Returns active search tag parameter

Returns:

string

Definition at line 200 of file oxviewconfig.php.

oxViewConfig.getActTplName

(

)

Returns active template name (if set)

Returns:

string

Definition at line 86 of file oxviewconfig.php.

oxViewConfig.getAdminDir

(

)

Returns admin path

Returns:

string

Definition at line 563 of file oxviewconfig.php.

oxViewConfig.getAjaxLink

(

)

Returns AJAX request url

Returns:

string

Definition at line 893 of file oxviewconfig.php.

oxViewConfig.getArtPerPageCount

(

)

Returns max number of items shown on page

Returns:

int

Definition at line 804 of file oxviewconfig.php.

oxViewConfig.getArtPerPageForm

(

)

Returns list view paging url

Returns:

string

Definition at line 648 of file oxviewconfig.php.

oxViewConfig.getBaseDir

(

)

Returns shops base directory path

Returns:

string

Definition at line 352 of file oxviewconfig.php.

oxViewConfig.getBasketLink

(

)

Returns shops basket link

Returns:

string

Definition at line 408 of file oxviewconfig.php.

oxViewConfig.getBasketTimeLeft

(

)

return the seconds left until basket expiration

Returns:

int

Definition at line 970 of file oxviewconfig.php.

oxViewConfig.getCoreUtilsDir

(

)

Returns shops utility directory path

Returns:

string

Definition at line 366 of file oxviewconfig.php.

oxViewConfig.getCountryList

(

)

Return country list

Returns:

oxcountrylist

Definition at line 1167 of file oxviewconfig.php.

oxViewConfig.getCurrentHomeDir

(

)

Returns shops home path

Returns:

string

Definition at line 394 of file oxviewconfig.php.

oxViewConfig.getExeOrderLink

(

)

Returns shops order execution link

Returns:

string

Definition at line 450 of file oxviewconfig.php.

oxViewConfig.getFbAppId

(

)

Returns facebook application key value

Returns:

string

Definition at line 949 of file oxviewconfig.php.

oxViewConfig.getHelpLink

(

)

Returns dynamic shop help link

Returns:

string

Definition at line 158 of file oxviewconfig.php.

oxViewConfig.getHelpPageLink

(

)

Returns shop help link

Returns:

string

Definition at line 129 of file oxviewconfig.php.

oxViewConfig.getHiddenSid

(

)

Returns forms hidden session parameters

Returns:

string

Definition at line 303 of file oxviewconfig.php.

oxViewConfig.getHomeLink

(

)

Returns shops home link

Returns:

string

Definition at line 50 of file oxviewconfig.php.

oxViewConfig.getImageUrl

(

)

Returns image url

Returns:

string

Definition at line 520 of file oxviewconfig.php.

oxViewConfig.getLogoutLink

(

)

Returns shop logout link

Returns:

string

Definition at line 101 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 1188 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 1212 of file oxviewconfig.php.

oxViewConfig.getNavFormParams

(

)

Returns navigation forms parameters

Returns:

string

Definition at line 841 of file oxviewconfig.php.

oxViewConfig.getNavUrlParams

(

)

Returns navigation url parameters

Returns:

string

Definition at line 814 of file oxviewconfig.php.

oxViewConfig.getNoSslImageDir

(

)

Returns non ssl image url

Returns:

string

Definition at line 534 of file oxviewconfig.php.

oxViewConfig.getNrOfCatArticles

(

)

Returns config param "aNrofCatArticles" value

Returns:

string

Definition at line 692 of file oxviewconfig.php.

oxViewConfig.getOrderConfirmLink

(

)

Returns shops order confirmation link

Returns:

string

Definition at line 464 of file oxviewconfig.php.

oxViewConfig.getOrderLink

(

)

Returns shops order link

Returns:

string

Definition at line 422 of file oxviewconfig.php.

oxViewConfig.getPasswordLength

(

)

min length of password

Returns:

int

Definition at line 1149 of file oxviewconfig.php.

oxViewConfig.getPaymentLink

(

)

Returns shops payment link

Returns:

string

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

oxViewConfig.getPopupIdent

(

)

Returns basket popup identifier

Returns:

string

Definition at line 620 of file oxviewconfig.php.

oxViewConfig.getPopupIdentRand

(

)

Returns random basket popup identifier

Returns:

string

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

oxViewConfig.getRemoteAddress

(

)

Returns visitor ip address

Returns:

string

Definition at line 606 of file oxviewconfig.php.

oxViewConfig.getResourceUrl

(

)

Returns shops resource url

Returns:

string

Definition at line 478 of file oxviewconfig.php.

oxViewConfig.getSelfActionLink

(

)

Returns shops action link

Returns:

string

Definition at line 380 of file oxviewconfig.php.

oxViewConfig.getSelfLink

(

)

Returns shops self link

Returns:

string

Definition at line 324 of file oxviewconfig.php.

oxViewConfig.getServiceUrl

(

)

Returns service url

Returns:

string

Definition at line 914 of file oxviewconfig.php.

oxViewConfig.getSessionId

(

)

Returns session id

Returns:

string

Definition at line 289 of file oxviewconfig.php.

oxViewConfig.getShopVersion

(

)

Returns shop version defined in view

Returns:

string

Definition at line 883 of file oxviewconfig.php.

oxViewConfig.getShowBasketTimeout

(

)

should basket timeout counter be shown?

Returns:

bool

Definition at line 959 of file oxviewconfig.php.

oxViewConfig.getShowCompareList

(

)

Returns config param "bl_showCompareList" value

Returns:

bool

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

oxViewConfig.getShowGiftWrapping

(

)

Returns config param "bl_showGiftWrapping" value

Returns:

bool

Definition at line 759 of file oxviewconfig.php.

oxViewConfig.getShowListmania

(

)

Returns config param "bl_showListmania" value

Returns:

bool

Definition at line 739 of file oxviewconfig.php.

oxViewConfig.getShowVouchers

(

)

Returns config param "bl_showVouchers" value

Returns:

bool

Definition at line 749 of file oxviewconfig.php.

oxViewConfig.getShowWishlist

(

)

Returns config param "bl_showWishlist" value

Returns:

bool

Definition at line 711 of file oxviewconfig.php.

oxViewConfig.getSslSelfLink

(

)

Returns shops self ssl link

Returns:

string

Definition at line 338 of file oxviewconfig.php.

oxViewConfig.getStockOffDefaultMessage

(

)

Returns config param "blStockOnDefaultMessage" value

Returns:

string

Definition at line 873 of file oxviewconfig.php.

oxViewConfig.getStockOnDefaultMessage

(

)

Returns config param "blStockOnDefaultMessage" value

Returns:

string

Definition at line 863 of file oxviewconfig.php.

oxViewConfig.getTemplateDir

(

)

Returns shops current (related to language) templates path

Returns:

string

Definition at line 492 of file oxviewconfig.php.

oxViewConfig.getTsDomain

(

)

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

Returns:

string

Definition at line 1002 of file oxviewconfig.php.

oxViewConfig.getTsId

(

)

Returns Trusted Shops id

Returns:

string

Definition at line 1116 of file oxviewconfig.php.

oxViewConfig.getTsInfoUrl

(

)

Trusted Shops widget info url

Returns:

string | bool

Definition at line 1043 of file oxviewconfig.php.

oxViewConfig.getTsRatingUrl

(

)

Trusted Shops ratings url

Returns:

string | bool

Definition at line 1066 of file oxviewconfig.php.

oxViewConfig.getTsWidgetUrl

(

)

Returns Trusted Shops Widget image url

Returns:

string

Definition at line 1017 of file oxviewconfig.php.

oxViewConfig.getUrlTemplateDir

(

)

Returns shops current templates url

Returns:

string

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

oxViewConfig.getViewThemeParam

(

$

sName

)

return param value

Parameters:

string

$sName param name

Returns:

mix

Definition at line 1229 of file oxviewconfig.php.

oxViewConfig.isAutoSearchOnCat

(

)

Returns config param "blAutoSearchOnCat" value

Returns:

string

Definition at line 769 of file oxviewconfig.php.

oxViewConfig.isBuyableParent

(

)

Returns "blVariantParentBuyable" parent article config state

Returns:

string

Definition at line 662 of file oxviewconfig.php.

oxViewConfig.isMultiShop

(

)

Returns multishop status

Returns:

bool

Definition at line 903 of file oxviewconfig.php.

oxViewConfig.isSsl

(

)

Returns ssl mode (on/off)

Returns:

string

Definition at line 591 of file oxviewconfig.php.

oxViewConfig.isTplBlocksDebugMode

(

)

true if blocks javascript code be enabled in templates

Returns:

bool

Definition at line 1139 of file oxviewconfig.php.

oxViewConfig.setViewConfigParam	(	$	sName,
		$	sValue
	)

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

$oViewConf->__name_of_parameter__ (deprecated) $oViewConf->getNameOfParameter()

Parameters:

	string	$sName name of parameter
	mixed	$sValue parameter value

Returns:

mixed

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

oxViewConfig.showBirthdayFields

(

)

Returns config param "blShowBirthdayFields" value

Returns:

string

Definition at line 672 of file oxviewconfig.php.

oxViewConfig.showFinalStep

(

)

Returns config param "blShowFinalStep" value

Returns:

string

Definition at line 682 of file oxviewconfig.php.

oxViewConfig.showSelectLists

(

)

Returns true if selection lists must be displayed in details page

Returns:

bool

Definition at line 1246 of file oxviewconfig.php.

oxViewConfig.showSelectListsInList

(

)

Returns true if selection lists must be displayed in details page

Returns:

bool

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

---

Member Data Documentation

oxViewConfig.$_aConfigParams = array() [protected]

Definition at line 29 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.$_sHelpPageLink = null [protected]

Help page link

Returns:

string

Definition at line 36 of file oxviewconfig.php.

---

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

• views/oxviewconfig.php