oxViewConfig Class Reference

Inheritance diagram for oxViewConfig:

Collaboration diagram for oxViewConfig:

List of all members.

Public Member Functions
	getHomeLink ()
	getActTplName ()
	getLogoutLink ()
	getHelpPageLink ()
	getHelpLink ()
	getActCatId ()
	getActManufacturerId ()
	getTypeLinkParams ()
	getTypeParams ()
	setViewConfigParam ($sName, $sValue)
	getViewConfigParam ($sName)
	setViewShop ($oShop, $aViewData)
	__call ($sMethodName, $sParams)
	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 ()
	getShowOpenIdLogin ()
	getShowVouchers ()
	getShowGiftWrapping ()
	isAutoSearchOnCat ()
	getActLanguageId ()
	getActiveClassName ()
	getArtPerPageCount ()
	getNavUrlParams ()
	getNavFormParams ()
	getStockOnDefaultMessage ()
	getStockOffDefaultMessage ()
	getShopVersion ()
	getAjaxLink ()
	isMultiShop ()
	getServiceUrl ()
	__get ($sVarName)
	getViewVar ($sVarName)
	getRemoteAccessToken ()
	getActionClassName ()
	getFbAppId ()
	getShowBasketTimeout ()
	getBasketTimeLeft ()
	getShowFbConnect ()
	getTsDomain ()
	getTsWidgetUrl ()
	getTsInfoUrl ()
	getTsRatingUrl ()
	showTs ($sType)
	getTsId ()
Protected Attributes
	$_oShop = null
	$_aViewData = null
	$_aConfigParams = array()
	$_sHelpPageLink = 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.__call	(	$	sMethodName,
		$	sParams
	)

This magic function is used for easier view config parameter handling. It allows to access config parameters by calling:

$oViewConf->_name_of_param_ (deprecated) $oViewConf->getNameOfParam() (preferred)

Parameters:

	string	$sMethodName name os method
	mixed	$sParams method parameters

Returns:

mixed

Reimplemented from oxSuperCfg.

Definition at line 275 of file oxviewconfig.php.

oxViewConfig.__get

(

$

sVarName

)

Returns view config variable value if possible

Parameters:

string

$sVarName name of variable to return

Returns:

mixed

Definition at line 919 of file oxviewconfig.php.

oxViewConfig.getActCatId

(

)

Returns active category id

Returns:

string

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

oxViewConfig.getActiveClassName

(

)

Returns name of active view class

Returns:

string

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

oxViewConfig.getActManufacturerId

(

)

Returns active manufacturer id

Returns:

string

Definition at line 159 of file oxviewconfig.php.

oxViewConfig.getActTplName

(

)

Returns active template name (if set)

Returns:

string

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

oxViewConfig.getArtPerPageCount

(

)

Returns max number of items shown on page

Returns:

int

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

oxViewConfig.getCoreUtilsDir

(

)

Returns shops utility directory path

Returns:

string

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

oxViewConfig.getHelpLink

(

)

Returns dynamic shop help link

Returns:

string

Definition at line 137 of file oxviewconfig.php.

oxViewConfig.getHelpPageLink

(

)

Returns shop help link

Returns:

string

Definition at line 108 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 43 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 94 of file oxviewconfig.php.

oxViewConfig.getNavFormParams

(

)

Returns navigation forms parameters

Returns:

string

Definition at line 834 of file oxviewconfig.php.

oxViewConfig.getNavUrlParams

(

)

Returns navigation url parameters

Returns:

string

Definition at line 807 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.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 1101 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 907 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 876 of file oxviewconfig.php.

oxViewConfig.getShowBasketTimeout

(

)

should basket timeout counter be shown?

Returns:

bool

Definition at line 1135 of file oxviewconfig.php.

oxViewConfig.getShowCompareList

(

)

Returns config param "bl_showCompareList" value

Returns:

bool

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

oxViewConfig.getShowGiftWrapping

(

)

Returns config param "bl_showGiftWrapping" value

Returns:

bool

Definition at line 752 of file oxviewconfig.php.

oxViewConfig.getShowListmania

(

)

Returns config param "bl_showListmania" value

Returns:

bool

Definition at line 722 of file oxviewconfig.php.

oxViewConfig.getShowOpenIdLogin

(

)

Returns config param "bl_showOpenId" value

Returns:

bool

Definition at line 732 of file oxviewconfig.php.

oxViewConfig.getShowVouchers

(

)

Returns config param "bl_showVouchers" value

Returns:

bool

Definition at line 742 of file oxviewconfig.php.

oxViewConfig.getShowWishlist

(

)

Returns config param "bl_showWishlist" value

Returns:

bool

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

oxViewConfig.getStockOnDefaultMessage

(

)

Returns config param "blStockOnDefaultMessage" value

Returns:

string

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

oxViewConfig.getTsId

(

)

Returns Trusted Shops id

Returns:

string

Definition at line 1292 of file oxviewconfig.php.

oxViewConfig.getTsInfoUrl

(

)

Trusted Shops widget info url

Returns:

string | bool

Definition at line 1219 of file oxviewconfig.php.

oxViewConfig.getTsRatingUrl

(

)

Trusted Shops ratings url

Returns:

string | bool

Definition at line 1242 of file oxviewconfig.php.

oxViewConfig.getTsWidgetUrl

(

)

Returns Trusted Shops Widget image url

Returns:

string

Definition at line 1193 of file oxviewconfig.php.

oxViewConfig.getTypeLinkParams

(

)

Returns parameters which should be appended to url

Deprecated:

use oxViewConfig.getNavUrlParams

Returns:

string

Definition at line 171 of file oxviewconfig.php.

oxViewConfig.getTypeParams

(

)

Returns parameters which should be appended to form

Deprecated:

use oxViewConfig.getNavFormParams

Returns:

string

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

oxViewConfig.getViewVar

(

$

sVarName

)

Returns view config variable value if possible

Parameters:

string

$sVarName name of variable to return

Returns:

mixed

Definition at line 931 of file oxviewconfig.php.

oxViewConfig.isAutoSearchOnCat

(

)

Returns config param "blAutoSearchOnCat" value

Returns:

string

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

oxViewConfig.isSsl

(

)

Returns ssl mode (on/off)

Returns:

string

Definition at line 591 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 215 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 257 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.showTs

(

$

sType

)

Returns true if Trusted Shops feature is On

Parameters:

string

$sType type of element to check

Returns:

bool

Definition at line 1267 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.$_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