oxViewConfig Class Reference

Inheritance diagram for oxViewConfig:

[legend]

Collaboration diagram for oxViewConfig:

[legend]

List of all members.

---

Detailed Description

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

Public Member Functions
	getHomeLink ()
	getActTplName ()
	getLogoutLink ()
	getHelpLink ()
	getActCatId ()
	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 ()
	isAutoSearchOnCat ()
	getActLanguageId ()
	getActiveClassName ()
	getArtPerPageCount ()
	getNavUrlParams ()
	getNavFormParams ()
	getStockOnDefaultMessage ()
	getStockOffDefaultMessage ()
	getShopVersion ()
	getAjaxLink ()
	isMultiShop ()
	isAutoSave ()
	getServiceUrl ()
	__get ($sVarName)
Protected Attributes
	$_oShop = null
	$_aViewData = null
	$_aConfigParams = array()

---

Member Function Documentation

oxViewConfig.getHomeLink

(

)

Returns shops home link

Returns:

string

oxViewConfig.getActTplName

(

)

Returns active template name (if set)

Returns:

string

oxViewConfig.getLogoutLink

(

)

Returns shop logout link

Returns:

string

oxViewConfig.getHelpLink

(

)

Returns shop help link

Returns:

string

oxViewConfig.getActCatId

(

)

Returns active category id

Returns:

string

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

oxViewConfig.getViewConfigParam

(

$

sName

)

Returns current view config parameter

Parameters:

string

$sName name of parameter to get

Returns:

mixed

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

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

oxViewConfig.getSessionId

(

)

Returns session id

Returns:

string

oxViewConfig.getHiddenSid

(

)

Returns forms hidden session parameters

Returns:

string

oxViewConfig.getSelfLink

(

)

Returns shops self link

Returns:

string

oxViewConfig.getSslSelfLink

(

)

Returns shops self ssl link

Returns:

string

oxViewConfig.getBaseDir

(

)

Returns shops base directory path

Returns:

string

oxViewConfig.getCoreUtilsDir

(

)

Returns shops utility directory path

Returns:

string

oxViewConfig.getSelfActionLink

(

)

Returns shops action link

Returns:

string

oxViewConfig.getCurrentHomeDir

(

)

Returns shops home path

Returns:

string

oxViewConfig.getBasketLink

(

)

Returns shops basket link

Returns:

string

oxViewConfig.getOrderLink

(

)

Returns shops order link

Returns:

string

oxViewConfig.getPaymentLink

(

)

Returns shops payment link

Returns:

string

oxViewConfig.getExeOrderLink

(

)

Returns shops order execution link

Returns:

string

oxViewConfig.getOrderConfirmLink

(

)

Returns shops order confirmation link

Returns:

string

oxViewConfig.getResourceUrl

(

)

Returns shops resource url

Returns:

string

oxViewConfig.getTemplateDir

(

)

Returns shops current (related to language) templates path

Returns:

string

oxViewConfig.getUrlTemplateDir

(

)

Returns shops current templates url

Returns:

string

oxViewConfig.getImageUrl

(

)

Returns image url

Returns:

string

oxViewConfig.getNoSslImageDir

(

)

Returns non ssl image url

Returns:

string

oxViewConfig.getPictureDir

(

)

Returns dynamic (language related) image url

Returns:

string

oxViewConfig.getAdminDir

(

)

Returns admin path

Returns:

string

oxViewConfig.getActiveShopId

(

)

Returns currently open shop id

Returns:

string

oxViewConfig.isSsl

(

)

Returns ssl mode (on/off)

Returns:

string

oxViewConfig.getRemoteAddress

(

)

Returns users ip address

Returns:

string

oxViewConfig.getPopupIdent

(

)

Returns basket popup identifier

Returns:

string

oxViewConfig.getPopupIdentRand

(

)

Returns random basket popup identifier

Returns:

string

oxViewConfig.getArtPerPageForm

(

)

Returns list view paging url

Returns:

string

oxViewConfig.isBuyableParent

(

)

Returns "blVariantParentBuyable" parent article config state

Returns:

string

oxViewConfig.showBirthdayFields

(

)

Returns config param "blShowBirthdayFields" value

Returns:

string

oxViewConfig.showFinalStep

(

)

Returns config param "blShowFinalStep" value

Returns:

string

oxViewConfig.getNrOfCatArticles

(

)

Returns config param "aNrofCatArticles" value

Returns:

string

oxViewConfig.isAutoSearchOnCat

(

)

Returns config param "blAutoSearchOnCat" value

Returns:

string

oxViewConfig.getActLanguageId

(

)

Returns session language id

Returns:

string

oxViewConfig.getActiveClassName

(

)

Returns name of active view class

Returns:

string

oxViewConfig.getArtPerPageCount

(

)

Returns max number of items shown on page

Returns:

int

oxViewConfig.getNavUrlParams

(

)

Returns navigation url parameters

Returns:

string

oxViewConfig.getNavFormParams

(

)

Returns navigation forms parameters

Returns:

string

oxViewConfig.getStockOnDefaultMessage

(

)

Returns config param "blStockOnDefaultMessage" value

Returns:

string

oxViewConfig.getStockOffDefaultMessage

(

)

Returns config param "blStockOnDefaultMessage" value

Returns:

string

oxViewConfig.getShopVersion

(

)

Returns shop version defined in view

Returns:

string

oxViewConfig.getAjaxLink

(

)

Returns AJAX request url

Returns:

string

oxViewConfig.isMultiShop

(

)

Returns multishop status

Returns:

bool

oxViewConfig.isAutoSave

(

)

Returns autosave config option

Returns:

bool

oxViewConfig.getServiceUrl

(

)

Returns service url

Returns:

string

oxViewConfig.__get

(

$

sVarName

)

Returns view config variable value if possible

Returns:

mixed

---

Member Data Documentation

oxViewConfig.$_oShop = null [protected]

oxViewConfig.$_aViewData = null [protected]

oxViewConfig.$_aConfigParams = array() [protected]

---

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

• views/oxviewconfig.php