oxViewConfig Class Reference

Inheritance diagram for oxViewConfig:

Inheritance graph
[legend]
Collaboration diagram for oxViewConfig:

Collaboration graph
[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.

Definition at line 8 of file oxviewconfig.php.


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 ()
 isAutoSearchOnCat ()
 getActLanguageId ()
 getActiveClassName ()
 getArtPerPageCount ()
 getNavUrlParams ()
 getNavFormParams ()
 getStockOnDefaultMessage ()
 getStockOffDefaultMessage ()
 getShopVersion ()
 getAjaxLink ()
 isMultiShop ()
 getServiceUrl ()
 __get ($sVarName)
 getViewVar ($sVarName)

Protected Attributes

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

Member Function Documentation

oxViewConfig.getHomeLink (  ) 

Returns shops home link

Returns:
string

Definition at line 36 of file oxviewconfig.php.

oxViewConfig.getActTplName (  ) 

Returns active template name (if set)

Returns:
string

Definition at line 63 of file oxviewconfig.php.

oxViewConfig.getLogoutLink (  ) 

Returns shop logout link

Returns:
string

Definition at line 78 of file oxviewconfig.php.

oxViewConfig.getHelpLink (  ) 

Returns shop help link

Returns:
string

Definition at line 93 of file oxviewconfig.php.

oxViewConfig.getActCatId (  ) 

Returns active category id

Returns:
string

Definition at line 106 of file oxviewconfig.php.

oxViewConfig.getActManufacturerId (  ) 

Returns active manufacturer id

Returns:
string

Definition at line 116 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.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.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.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.__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.getSessionId (  ) 

Returns session id

Returns:
string

Definition at line 246 of file oxviewconfig.php.

oxViewConfig.getHiddenSid (  ) 

Returns forms hidden session parameters

Returns:
string

Definition at line 260 of file oxviewconfig.php.

oxViewConfig.getSelfLink (  ) 

Returns shops self link

Returns:
string

Definition at line 274 of file oxviewconfig.php.

oxViewConfig.getSslSelfLink (  ) 

Returns shops self ssl link

Returns:
string

Definition at line 288 of file oxviewconfig.php.

oxViewConfig.getBaseDir (  ) 

Returns shops base directory path

Returns:
string

Definition at line 302 of file oxviewconfig.php.

oxViewConfig.getCoreUtilsDir (  ) 

Returns shops utility directory path

Returns:
string

Definition at line 316 of file oxviewconfig.php.

oxViewConfig.getSelfActionLink (  ) 

Returns shops action link

Returns:
string

Definition at line 330 of file oxviewconfig.php.

oxViewConfig.getCurrentHomeDir (  ) 

Returns shops home path

Returns:
string

Definition at line 344 of file oxviewconfig.php.

oxViewConfig.getBasketLink (  ) 

Returns shops basket link

Returns:
string

Definition at line 358 of file oxviewconfig.php.

oxViewConfig.getOrderLink (  ) 

Returns shops order link

Returns:
string

Definition at line 372 of file oxviewconfig.php.

oxViewConfig.getPaymentLink (  ) 

Returns shops payment link

Returns:
string

Definition at line 386 of file oxviewconfig.php.

oxViewConfig.getExeOrderLink (  ) 

Returns shops order execution link

Returns:
string

Definition at line 400 of file oxviewconfig.php.

oxViewConfig.getOrderConfirmLink (  ) 

Returns shops order confirmation link

Returns:
string

Definition at line 414 of file oxviewconfig.php.

oxViewConfig.getResourceUrl (  ) 

Returns shops resource url

Returns:
string

Definition at line 428 of file oxviewconfig.php.

oxViewConfig.getTemplateDir (  ) 

Returns shops current (related to language) templates path

Returns:
string

Definition at line 442 of file oxviewconfig.php.

oxViewConfig.getUrlTemplateDir (  ) 

Returns shops current templates url

Returns:
string

Definition at line 456 of file oxviewconfig.php.

oxViewConfig.getImageUrl (  ) 

Returns image url

Returns:
string

Definition at line 470 of file oxviewconfig.php.

oxViewConfig.getNoSslImageDir (  ) 

Returns non ssl image url

Returns:
string

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

oxViewConfig.getAdminDir (  ) 

Returns admin path

Returns:
string

Definition at line 513 of file oxviewconfig.php.

oxViewConfig.getActiveShopId (  ) 

Returns currently open shop id

Returns:
string

Definition at line 527 of file oxviewconfig.php.

oxViewConfig.isSsl (  ) 

Returns ssl mode (on/off)

Returns:
string

Definition at line 541 of file oxviewconfig.php.

oxViewConfig.getRemoteAddress (  ) 

Returns users ip address

Returns:
string

Definition at line 556 of file oxviewconfig.php.

oxViewConfig.getPopupIdent (  ) 

Returns basket popup identifier

Returns:
string

Definition at line 570 of file oxviewconfig.php.

oxViewConfig.getPopupIdentRand (  ) 

Returns random basket popup identifier

Returns:
string

Definition at line 584 of file oxviewconfig.php.

oxViewConfig.getArtPerPageForm (  ) 

Returns list view paging url

Returns:
string

Definition at line 598 of file oxviewconfig.php.

oxViewConfig.isBuyableParent (  ) 

Returns "blVariantParentBuyable" parent article config state

Returns:
string

Definition at line 612 of file oxviewconfig.php.

oxViewConfig.showBirthdayFields (  ) 

Returns config param "blShowBirthdayFields" value

Returns:
string

Definition at line 622 of file oxviewconfig.php.

oxViewConfig.showFinalStep (  ) 

Returns config param "blShowFinalStep" value

Returns:
string

Definition at line 632 of file oxviewconfig.php.

oxViewConfig.getNrOfCatArticles (  ) 

Returns config param "aNrofCatArticles" value

Returns:
string

Definition at line 642 of file oxviewconfig.php.

oxViewConfig.isAutoSearchOnCat (  ) 

Returns config param "blAutoSearchOnCat" value

Returns:
string

Definition at line 652 of file oxviewconfig.php.

oxViewConfig.getActLanguageId (  ) 

Returns session language id

Returns:
string

Definition at line 662 of file oxviewconfig.php.

oxViewConfig.getActiveClassName (  ) 

Returns name of active view class

Returns:
string

Definition at line 677 of file oxviewconfig.php.

oxViewConfig.getArtPerPageCount (  ) 

Returns max number of items shown on page

Returns:
int

Definition at line 687 of file oxviewconfig.php.

oxViewConfig.getNavUrlParams (  ) 

Returns navigation url parameters

Returns:
string

Definition at line 697 of file oxviewconfig.php.

oxViewConfig.getNavFormParams (  ) 

Returns navigation forms parameters

Returns:
string

Definition at line 724 of file oxviewconfig.php.

oxViewConfig.getStockOnDefaultMessage (  ) 

Returns config param "blStockOnDefaultMessage" value

Returns:
string

Definition at line 746 of file oxviewconfig.php.

oxViewConfig.getStockOffDefaultMessage (  ) 

Returns config param "blStockOnDefaultMessage" value

Returns:
string

Definition at line 756 of file oxviewconfig.php.

oxViewConfig.getShopVersion (  ) 

Returns shop version defined in view

Returns:
string

Definition at line 766 of file oxviewconfig.php.

oxViewConfig.getAjaxLink (  ) 

Returns AJAX request url

Returns:
string

Definition at line 776 of file oxviewconfig.php.

oxViewConfig.isMultiShop (  ) 

Returns multishop status

Returns:
bool

Definition at line 786 of file oxviewconfig.php.

oxViewConfig.getServiceUrl (  ) 

Returns service url

Returns:
string

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


Member Data Documentation

oxViewConfig.$_oShop = null [protected]

Definition at line 15 of file oxviewconfig.php.

oxViewConfig.$_aViewData = null [protected]

Definition at line 22 of file oxviewconfig.php.

oxViewConfig.$_aConfigParams = array() [protected]

Definition at line 29 of file oxviewconfig.php.


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

Generated on Tue Sep 29 16:50:47 2009 for OXID eShop CE by  doxygen 1.5.5