oxViewConfig Class Reference

Inheritance diagram for oxViewConfig:
Inheritance graph
[legend]
Collaboration diagram for oxViewConfig:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 getHomeLink ()
 getActTplName ()
 getLogoutLink ()
 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 ()

Protected Attributes

 $_oShop = null
 $_aViewData = null
 $_aConfigParams = array()

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 232 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 876 of file oxviewconfig.php.

oxViewConfig.getActCatId (  ) 

Returns active category id

Returns:
string

Definition at line 106 of file oxviewconfig.php.

oxViewConfig.getActiveClassName (  ) 

Returns name of active view class

Returns:
string

Definition at line 744 of file oxviewconfig.php.

oxViewConfig.getActiveShopId (  ) 

Returns currently open shop id

Returns:
string

Definition at line 534 of file oxviewconfig.php.

oxViewConfig.getActLanguageId (  ) 

Returns session language id

Returns:
string

Definition at line 729 of file oxviewconfig.php.

oxViewConfig.getActManufacturerId (  ) 

Returns active manufacturer id

Returns:
string

Definition at line 116 of file oxviewconfig.php.

oxViewConfig.getActTplName (  ) 

Returns active template name (if set)

Returns:
string

Definition at line 65 of file oxviewconfig.php.

oxViewConfig.getAdminDir (  ) 

Returns admin path

Returns:
string

Definition at line 520 of file oxviewconfig.php.

oxViewConfig.getAjaxLink (  ) 

Returns AJAX request url

Returns:
string

Definition at line 843 of file oxviewconfig.php.

oxViewConfig.getArtPerPageCount (  ) 

Returns max number of items shown on page

Returns:
int

Definition at line 754 of file oxviewconfig.php.

oxViewConfig.getArtPerPageForm (  ) 

Returns list view paging url

Returns:
string

Definition at line 605 of file oxviewconfig.php.

oxViewConfig.getBaseDir (  ) 

Returns shops base directory path

Returns:
string

Definition at line 309 of file oxviewconfig.php.

oxViewConfig.getBasketLink (  ) 

Returns shops basket link

Returns:
string

Definition at line 365 of file oxviewconfig.php.

oxViewConfig.getCoreUtilsDir (  ) 

Returns shops utility directory path

Returns:
string

Definition at line 323 of file oxviewconfig.php.

oxViewConfig.getCurrentHomeDir (  ) 

Returns shops home path

Returns:
string

Definition at line 351 of file oxviewconfig.php.

oxViewConfig.getExeOrderLink (  ) 

Returns shops order execution link

Returns:
string

Definition at line 407 of file oxviewconfig.php.

oxViewConfig.getHelpLink (  ) 

Returns shop help link

Returns:
string

Definition at line 94 of file oxviewconfig.php.

oxViewConfig.getHiddenSid (  ) 

Returns forms hidden session parameters

Returns:
string

Definition at line 260 of file oxviewconfig.php.

oxViewConfig.getHomeLink (  ) 

Returns shops home link

Returns:
string

Definition at line 36 of file oxviewconfig.php.

oxViewConfig.getImageUrl (  ) 

Returns image url

Returns:
string

Definition at line 477 of file oxviewconfig.php.

oxViewConfig.getLogoutLink (  ) 

Returns shop logout link

Returns:
string

Definition at line 80 of file oxviewconfig.php.

oxViewConfig.getNavFormParams (  ) 

Returns navigation forms parameters

Returns:
string

Definition at line 791 of file oxviewconfig.php.

oxViewConfig.getNavUrlParams (  ) 

Returns navigation url parameters

Returns:
string

Definition at line 764 of file oxviewconfig.php.

oxViewConfig.getNoSslImageDir (  ) 

Returns non ssl image url

Returns:
string

Definition at line 491 of file oxviewconfig.php.

oxViewConfig.getNrOfCatArticles (  ) 

Returns config param "aNrofCatArticles" value

Returns:
string

Definition at line 649 of file oxviewconfig.php.

oxViewConfig.getOrderConfirmLink (  ) 

Returns shops order confirmation link

Returns:
string

Definition at line 421 of file oxviewconfig.php.

oxViewConfig.getOrderLink (  ) 

Returns shops order link

Returns:
string

Definition at line 379 of file oxviewconfig.php.

oxViewConfig.getPaymentLink (  ) 

Returns shops payment link

Returns:
string

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

oxViewConfig.getPopupIdent (  ) 

Returns basket popup identifier

Returns:
string

Definition at line 577 of file oxviewconfig.php.

oxViewConfig.getPopupIdentRand (  ) 

Returns random basket popup identifier

Returns:
string

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

oxViewConfig.getRemoteAddress (  ) 

Returns visitor ip address

Returns:
string

Definition at line 563 of file oxviewconfig.php.

oxViewConfig.getResourceUrl (  ) 

Returns shops resource url

Returns:
string

Definition at line 435 of file oxviewconfig.php.

oxViewConfig.getSelfActionLink (  ) 

Returns shops action link

Returns:
string

Definition at line 337 of file oxviewconfig.php.

oxViewConfig.getSelfLink (  ) 

Returns shops self link

Returns:
string

Definition at line 281 of file oxviewconfig.php.

oxViewConfig.getServiceUrl (  ) 

Returns service url

Returns:
string

Definition at line 864 of file oxviewconfig.php.

oxViewConfig.getSessionId (  ) 

Returns session id

Returns:
string

Definition at line 246 of file oxviewconfig.php.

oxViewConfig.getShopVersion (  ) 

Returns shop version defined in view

Returns:
string

Definition at line 833 of file oxviewconfig.php.

oxViewConfig.getShowCompareList (  ) 

Returns config param "bl_showCompareList" value

Returns:
bool

Definition at line 669 of file oxviewconfig.php.

oxViewConfig.getShowGiftWrapping (  ) 

Returns config param "bl_showGiftWrapping" value

Returns:
bool

Definition at line 709 of file oxviewconfig.php.

oxViewConfig.getShowListmania (  ) 

Returns config param "bl_showListmania" value

Returns:
bool

Definition at line 679 of file oxviewconfig.php.

oxViewConfig.getShowOpenIdLogin (  ) 

Returns config param "bl_showOpenId" value

Returns:
bool

Definition at line 689 of file oxviewconfig.php.

oxViewConfig.getShowVouchers (  ) 

Returns config param "bl_showVouchers" value

Returns:
bool

Definition at line 699 of file oxviewconfig.php.

oxViewConfig.getShowWishlist (  ) 

Returns config param "bl_showWishlist" value

Returns:
bool

Definition at line 659 of file oxviewconfig.php.

oxViewConfig.getSslSelfLink (  ) 

Returns shops self ssl link

Returns:
string

Definition at line 295 of file oxviewconfig.php.

oxViewConfig.getStockOffDefaultMessage (  ) 

Returns config param "blStockOnDefaultMessage" value

Returns:
string

Definition at line 823 of file oxviewconfig.php.

oxViewConfig.getStockOnDefaultMessage (  ) 

Returns config param "blStockOnDefaultMessage" value

Returns:
string

Definition at line 813 of file oxviewconfig.php.

oxViewConfig.getTemplateDir (  ) 

Returns shops current (related to language) templates path

Returns:
string

Definition at line 449 of file oxviewconfig.php.

oxViewConfig.getTypeLinkParams (  ) 

Returns parameters which should be appended to url

Deprecated:
use oxViewConfig.getNavUrlParams
Returns:
string

Definition at line 128 of file oxviewconfig.php.

oxViewConfig.getTypeParams (  ) 

Returns parameters which should be appended to form

Deprecated:
use oxViewConfig.getNavFormParams
Returns:
string

Definition at line 148 of file oxviewconfig.php.

oxViewConfig.getUrlTemplateDir (  ) 

Returns shops current templates url

Returns:
string

Definition at line 463 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 188 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 888 of file oxviewconfig.php.

oxViewConfig.isAutoSearchOnCat (  ) 

Returns config param "blAutoSearchOnCat" value

Returns:
string

Definition at line 719 of file oxviewconfig.php.

oxViewConfig.isBuyableParent (  ) 

Returns "blVariantParentBuyable" parent article config state

Returns:
string

Definition at line 619 of file oxviewconfig.php.

oxViewConfig.isMultiShop (  ) 

Returns multishop status

Returns:
bool

Definition at line 853 of file oxviewconfig.php.

oxViewConfig.isSsl (  ) 

Returns ssl mode (on/off)

Returns:
string

Definition at line 548 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 172 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 214 of file oxviewconfig.php.

oxViewConfig.showBirthdayFields (  ) 

Returns config param "blShowBirthdayFields" value

Returns:
string

Definition at line 629 of file oxviewconfig.php.

oxViewConfig.showFinalStep (  ) 

Returns config param "blShowFinalStep" value

Returns:
string

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

The documentation for this class was generated from the following file:
Generated by  doxygen 1.6.2