Public Member Functions | Protected Member Functions | Protected Attributes

oxViewConfig Class Reference

Inheritance diagram for oxViewConfig:
Collaboration diagram for oxViewConfig:

List of all members.

Public Member Functions

 getHomeLink ()
 getActContentLoadId ()
 getActTplName ()
 getActCurrency ()
 getLogoutLink ()
 getHelpPageLink ()
 getHelpLink ()
 getActCatId ()
 getActArticleId ()
 getActSearchParam ()
 getActSearchTag ()
 getActRecommendationId ()
 getActListType ()
 getActManufacturerId ()
 getContentId ()
 setViewConfigParam ($sName, $sValue)
 getViewConfigParam ($sName)
 setViewShop ($oShop, $aViewData)
 getSessionId ()
 getHiddenSid ()
 getSelfLink ()
 getSslSelfLink ()
 getBaseDir ()
 getCoreUtilsDir ()
 getSelfActionLink ()
 getCurrentHomeDir ()
 getBasketLink ()
 getOrderLink ()
 getPaymentLink ()
 getExeOrderLink ()
 getOrderConfirmLink ()
 getResourceUrl ($sFile=null)
 getTemplateDir ()
 getUrlTemplateDir ()
 getImageUrl ($sFile=null, $bSsl=null)
 getNoSslImageDir ()
 getPictureDir ()
 getAdminDir ()
 getActiveShopId ()
 isSsl ()
 getRemoteAddress ()
 getPopupIdent ()
 getPopupIdentRand ()
 getArtPerPageForm ()
 isBuyableParent ()
 showBirthdayFields ()
 showFinalStep ()
 getNrOfCatArticles ()
 getShowWishlist ()
 getShowCompareList ()
 getShowListmania ()
 getShowVouchers ()
 getShowGiftWrapping ()
 getActLanguageId ()
 getActLanguageAbbr ()
 getActiveClassName ()
 getTopActiveClassName ()
 getArtPerPageCount ()
 getNavUrlParams ()
 getNavFormParams ()
 getStockOnDefaultMessage ()
 getStockOffDefaultMessage ()
 getShopVersion ()
 getAjaxLink ()
 isMultiShop ()
 getServiceUrl ()
 getRemoteAccessToken ()
 getActionClassName ()
 getTopActionClassName ()
 getFbAppId ()
 getShowBasketTimeout ()
 getBasketTimeLeft ()
 getShowFbConnect ()
 getTsDomain ()
 getTsWidgetUrl ()
 getTsInfoUrl ()
 getTsRatingUrl ()
 showTs ($sType)
 getTsId ()
 isTplBlocksDebugMode ()
 getPasswordLength ()
 getCountryList ()
 getModulePath ($sModule, $sFile= '')
 getModuleUrl ($sModule, $sFile= '')
 getViewThemeParam ($sName)
 showSelectLists ()
 showSelectListsInList ()
 isAltImageServerConfigured ()
 isFunctionalityEnabled ($sParamName)
 getActiveTheme ()

Protected Member Functions

 _getHelpContentIdents ()

Protected Attributes

 $_oShop = null
 $_aViewData = null
 $_aConfigParams = array()
 $_sHelpPageLink = null
 $_oCountryList = null
 $_sActiveTheme = 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._getHelpContentIdents (  )  [protected]

Returns help content link idents

Returns:
array

Definition at line 162 of file oxviewconfig.php.

oxViewConfig.getActArticleId (  ) 

Returns active article id

Returns:
string

Definition at line 219 of file oxviewconfig.php.

oxViewConfig.getActCatId (  ) 

Returns active category id

Returns:
string

Definition at line 209 of file oxviewconfig.php.

oxViewConfig.getActContentLoadId (  ) 

Returns active template name (if set)

Returns:
string

Definition at line 93 of file oxviewconfig.php.

oxViewConfig.getActCurrency (  ) 

Returns active currency id

Returns:
string

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

oxViewConfig.getActiveClassName (  ) 

Returns name of active view class

Returns:
string

Definition at line 872 of file oxviewconfig.php.

oxViewConfig.getActiveShopId (  ) 

Returns currently open shop id

Returns:
string

Definition at line 655 of file oxviewconfig.php.

oxViewConfig.getActiveTheme (  ) 

Returns active theme name

Returns:
string

Definition at line 1398 of file oxviewconfig.php.

oxViewConfig.getActLanguageAbbr (  ) 

Returns session language id

Returns:
string

Definition at line 862 of file oxviewconfig.php.

oxViewConfig.getActLanguageId (  ) 

Returns session language id

Returns:
string

Definition at line 847 of file oxviewconfig.php.

oxViewConfig.getActListType (  ) 

Returns active listtype parameter

Returns:
string

Definition at line 259 of file oxviewconfig.php.

oxViewConfig.getActManufacturerId (  ) 

Returns active manufacturer id

Returns:
string

Definition at line 269 of file oxviewconfig.php.

oxViewConfig.getActRecommendationId (  ) 

Returns active recommendation id parameter

Returns:
string

Definition at line 249 of file oxviewconfig.php.

oxViewConfig.getActSearchParam (  ) 

Returns active search parameter

Returns:
string

Definition at line 229 of file oxviewconfig.php.

oxViewConfig.getActSearchTag (  ) 

Returns active search tag parameter

Returns:
string

Definition at line 239 of file oxviewconfig.php.

oxViewConfig.getActTplName (  ) 

Returns active manufacturer id

Returns:
string

Definition at line 108 of file oxviewconfig.php.

oxViewConfig.getAdminDir (  ) 

Returns admin path

Returns:
string

Definition at line 641 of file oxviewconfig.php.

oxViewConfig.getAjaxLink (  ) 

Returns AJAX request url

Returns:
string

Definition at line 982 of file oxviewconfig.php.

oxViewConfig.getArtPerPageCount (  ) 

Returns max number of items shown on page

Returns:
int

Definition at line 893 of file oxviewconfig.php.

oxViewConfig.getArtPerPageForm (  ) 

Returns list view paging url

Returns:
string

Definition at line 726 of file oxviewconfig.php.

oxViewConfig.getBaseDir (  ) 

Returns shops base directory path

Returns:
string

Definition at line 415 of file oxviewconfig.php.

oxViewConfig.getBasketLink (  ) 

Returns shops basket link

Returns:
string

Definition at line 477 of file oxviewconfig.php.

oxViewConfig.getBasketTimeLeft (  ) 

return the seconds left until basket expiration

Returns:
int

Definition at line 1069 of file oxviewconfig.php.

oxViewConfig.getContentId (  ) 

Returns active content id

Returns:
string

Definition at line 279 of file oxviewconfig.php.

oxViewConfig.getCoreUtilsDir (  ) 

Returns shops utility directory path

Returns:
string

Definition at line 435 of file oxviewconfig.php.

oxViewConfig.getCountryList (  ) 

Return country list

Returns:
oxcountrylist

Definition at line 1266 of file oxviewconfig.php.

oxViewConfig.getCurrentHomeDir (  ) 

Returns shops home path

Returns:
string

Definition at line 463 of file oxviewconfig.php.

oxViewConfig.getExeOrderLink (  ) 

Returns shops order execution link

Returns:
string

Definition at line 519 of file oxviewconfig.php.

oxViewConfig.getFbAppId (  ) 

Returns facebook application key value

Returns:
string

Definition at line 1048 of file oxviewconfig.php.

oxViewConfig.getHelpLink (  ) 

Returns dynamic shop help link

Returns:
string

Definition at line 197 of file oxviewconfig.php.

oxViewConfig.getHelpPageLink (  ) 

Returns shop help link

Returns:
string

Definition at line 173 of file oxviewconfig.php.

oxViewConfig.getHiddenSid (  ) 

Returns forms hidden session parameters

Returns:
string

Definition at line 361 of file oxviewconfig.php.

oxViewConfig.getHomeLink (  ) 

Returns shops home link

Returns:
string

Definition at line 57 of file oxviewconfig.php.

oxViewConfig.getImageUrl ( sFile = null,
bSsl = null 
)

Returns image url

Parameters:
string $sFile Image file name
bool $bSsl Whether to force SSL
Returns:
string

Definition at line 596 of file oxviewconfig.php.

oxViewConfig.getLogoutLink (  ) 

Returns shop logout link

Returns:
string

Definition at line 128 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 1287 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 1317 of file oxviewconfig.php.

oxViewConfig.getNavFormParams (  ) 

Returns navigation forms parameters

Returns:
string

Definition at line 930 of file oxviewconfig.php.

oxViewConfig.getNavUrlParams (  ) 

Returns navigation url parameters

Returns:
string

Definition at line 903 of file oxviewconfig.php.

oxViewConfig.getNoSslImageDir (  ) 

Returns non ssl image url

Returns:
string

Definition at line 612 of file oxviewconfig.php.

oxViewConfig.getNrOfCatArticles (  ) 

Returns config param "aNrofCatArticles" value

Returns:
string

Definition at line 770 of file oxviewconfig.php.

oxViewConfig.getOrderConfirmLink (  ) 

Returns shops order confirmation link

Returns:
string

Definition at line 533 of file oxviewconfig.php.

oxViewConfig.getOrderLink (  ) 

Returns shops order link

Returns:
string

Definition at line 491 of file oxviewconfig.php.

oxViewConfig.getPasswordLength (  ) 

min length of password

Returns:
int

Definition at line 1248 of file oxviewconfig.php.

oxViewConfig.getPaymentLink (  ) 

Returns shops payment link

Returns:
string

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

oxViewConfig.getPopupIdent (  ) 

Returns basket popup identifier

Returns:
string

Definition at line 698 of file oxviewconfig.php.

oxViewConfig.getPopupIdentRand (  ) 

Returns random basket popup identifier

Returns:
string

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

oxViewConfig.getRemoteAddress (  ) 

Returns visitor ip address

Returns:
string

Definition at line 684 of file oxviewconfig.php.

oxViewConfig.getResourceUrl ( sFile = null  ) 

Returns shops resource url

Parameters:
string $sFile resource file name
Returns:
string

Definition at line 549 of file oxviewconfig.php.

oxViewConfig.getSelfActionLink (  ) 

Returns shops action link

Returns:
string

Definition at line 449 of file oxviewconfig.php.

oxViewConfig.getSelfLink (  ) 

Returns shops self link

Returns:
string

Definition at line 382 of file oxviewconfig.php.

oxViewConfig.getServiceUrl (  ) 

Returns service url

Returns:
string

Definition at line 1003 of file oxviewconfig.php.

oxViewConfig.getSessionId (  ) 

Returns session id

Returns:
string

Definition at line 347 of file oxviewconfig.php.

oxViewConfig.getShopVersion (  ) 

Returns shop version defined in view

Returns:
string

Definition at line 972 of file oxviewconfig.php.

oxViewConfig.getShowBasketTimeout (  ) 

should basket timeout counter be shown?

Returns:
bool

Definition at line 1058 of file oxviewconfig.php.

oxViewConfig.getShowCompareList (  ) 

Returns config param "bl_showCompareList" value

Returns:
bool

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

oxViewConfig.getShowGiftWrapping (  ) 

Returns config param "bl_showGiftWrapping" value

Returns:
bool

Definition at line 837 of file oxviewconfig.php.

oxViewConfig.getShowListmania (  ) 

Returns config param "bl_showListmania" value

Returns:
bool

Definition at line 817 of file oxviewconfig.php.

oxViewConfig.getShowVouchers (  ) 

Returns config param "bl_showVouchers" value

Returns:
bool

Definition at line 827 of file oxviewconfig.php.

oxViewConfig.getShowWishlist (  ) 

Returns config param "bl_showWishlist" value

Returns:
bool

Definition at line 789 of file oxviewconfig.php.

oxViewConfig.getSslSelfLink (  ) 

Returns shops self ssl link

Returns:
string

Definition at line 396 of file oxviewconfig.php.

oxViewConfig.getStockOffDefaultMessage (  ) 

Returns config param "blStockOnDefaultMessage" value

Returns:
string

Definition at line 962 of file oxviewconfig.php.

oxViewConfig.getStockOnDefaultMessage (  ) 

Returns config param "blStockOnDefaultMessage" value

Returns:
string

Definition at line 952 of file oxviewconfig.php.

oxViewConfig.getTemplateDir (  ) 

Returns shops current (related to language) templates path

Returns:
string

Definition at line 565 of file oxviewconfig.php.

oxViewConfig.getTopActionClassName (  ) 

Returns name of a class of top view in the chain (given a generic fnc, e.g. logout)

Returns:
string

Definition at line 1038 of file oxviewconfig.php.

oxViewConfig.getTopActiveClassName (  ) 

Returns name of a class of top view in the chain (given a generic fnc, e.g. logout)

Returns:
string

Definition at line 883 of file oxviewconfig.php.

oxViewConfig.getTsDomain (  ) 

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

Returns:
string

Definition at line 1101 of file oxviewconfig.php.

oxViewConfig.getTsId (  ) 

Returns Trusted Shops id

Returns:
string

Definition at line 1215 of file oxviewconfig.php.

oxViewConfig.getTsInfoUrl (  ) 

Trusted Shops widget info url

Returns:
string | bool

Definition at line 1142 of file oxviewconfig.php.

oxViewConfig.getTsRatingUrl (  ) 

Trusted Shops ratings url

Returns:
string | bool

Definition at line 1165 of file oxviewconfig.php.

oxViewConfig.getTsWidgetUrl (  ) 

Returns Trusted Shops Widget image url

Returns:
string

Definition at line 1116 of file oxviewconfig.php.

oxViewConfig.getUrlTemplateDir (  ) 

Returns shops current templates url

Returns:
string

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

oxViewConfig.getViewThemeParam ( sName  ) 

return param value

Parameters:
string $sName param name
Returns:
mix

Definition at line 1334 of file oxviewconfig.php.

oxViewConfig.isAltImageServerConfigured (  ) 

Checks if alternative image server is configured.

Returns:
bool

Definition at line 1373 of file oxviewconfig.php.

oxViewConfig.isBuyableParent (  ) 

Returns "blVariantParentBuyable" parent article config state

Returns:
string

Definition at line 740 of file oxviewconfig.php.

oxViewConfig.isFunctionalityEnabled ( sParamName  ) 

Get config parameter for view to check if functionality is turned on or off.

Parameters:
string $sParamName config parameter name.
Returns:
bool

Definition at line 1388 of file oxviewconfig.php.

oxViewConfig.isMultiShop (  ) 

Returns multishop status

Returns:
bool

Definition at line 992 of file oxviewconfig.php.

oxViewConfig.isSsl (  ) 

Returns ssl mode (on/off)

Returns:
string

Definition at line 669 of file oxviewconfig.php.

oxViewConfig.isTplBlocksDebugMode (  ) 

true if blocks javascript code be enabled in templates

Returns:
bool

Definition at line 1238 of file oxviewconfig.php.

oxViewConfig.setViewConfigParam ( sName,
sValue 
)

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

$oViewConf->getViewConfigParam( $sName )

Parameters:
string $sName name of parameter
mixed $sValue parameter value
Returns:
mixed

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

oxViewConfig.showBirthdayFields (  ) 

Returns config param "blShowBirthdayFields" value

Returns:
string

Definition at line 750 of file oxviewconfig.php.

oxViewConfig.showFinalStep (  ) 

Returns config param "blShowFinalStep" value

Returns:
string

Definition at line 760 of file oxviewconfig.php.

oxViewConfig.showSelectLists (  ) 

Returns true if selection lists must be displayed in details page

Returns:
bool

Definition at line 1351 of file oxviewconfig.php.

oxViewConfig.showSelectListsInList (  ) 

Returns true if selection lists must be displayed in details page

Returns:
bool

Definition at line 1361 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 1190 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.$_sActiveTheme = null [protected]

Definition at line 50 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: