OXID eShop CE  6.1.5
OxidEsales\EshopCommunity\Core\ViewConfig Class Reference
+ Inheritance diagram for OxidEsales\EshopCommunity\Core\ViewConfig:
+ Collaboration diagram for OxidEsales\EshopCommunity\Core\ViewConfig:

Public Member Functions

 getHomeLink ()
 
 getActContentLoadId ()
 
 getActTplName ()
 
 getActCurrency ()
 
 getLogoutLink ()
 
 getHelpPageLink ()
 
 getActCatId ()
 
 getActArticleId ()
 
 getActSearchParam ()
 
 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 ()
 
 getNrOfCatArticles ()
 
 getShowWishlist ()
 
 getShowCompareList ()
 
 getShowListmania ()
 
 getShowSuggest ()
 
 getShowVouchers ()
 
 getShowGiftWrapping ()
 
 getActLanguageId ()
 
 getActLanguageAbbr ()
 
 getActiveClassName ()
 
 getTopActiveClassName ()
 
 getArtPerPageCount ()
 
 getNavUrlParams ()
 
 getNavFormParams ()
 
 getStockOnDefaultMessage ()
 
 getStockOffDefaultMessage ()
 
 getShopVersion ()
 
 getAjaxLink ()
 
 isMultiShop ()
 
 getServiceUrl ()
 
 getRemoteAccessToken ()
 
 getActionClassName ()
 
 getTopActionClassName ()
 
 getShowBasketTimeout ()
 
 getBasketTimeLeft ()
 
 isTplBlocksDebugMode ()
 
 getPasswordLength ()
 
 getCountryList ()
 
 getModulePath ($sModule, $sFile='')
 
 getModuleUrl ($sModule, $sFile='')
 
 isModuleActive ($sModuleId, $sVersionFrom=null, $sVersionTo=null)
 
 getViewThemeParam ($sName)
 
 showSelectLists ()
 
 showSelectListsInList ()
 
 isAltImageServerConfigured ()
 
 isFunctionalityEnabled ($sParamName)
 
 getActiveTheme ()
 
 getShopLogo ()
 
 setShopLogo ($sLogo)
 
 getSessionChallengeToken ()
 
 getEdition ()
 
 getAdditionalNavigationParameters ()
 
 getAdditionalParameters ()
 
 addRequestParameters ()
 
 getDynUrlParameters ($listType)
 

Protected Member Functions

 isStartClassRequired ()
 
 _getHelpContentIdents ()
 
 getAdditionalRequestParameters ()
 

Protected Attributes

 $_oShop = null
 
 $_aViewData = null
 
 $_aConfigParams = []
 
 $_sHelpPageLink = null
 
 $_oCountryList = null
 
 $_sActiveTheme = null
 
 $_sShopLogo = null
 

Private Member Functions

 _moduleExists ($sModuleId, $aModuleVersions)
 
 _isModuleEnabled ($sModuleId)
 
 _isModuleVersionCorrect ($sModuleId, $sVersionFrom, $sVersionTo)
 

Detailed Description

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

Member Function Documentation

◆ _getHelpContentIdents()

OxidEsales\EshopCommunity\Core\ViewConfig::_getHelpContentIdents ( )
protected

Returns help content link idents

Returns
array

◆ _isModuleEnabled()

OxidEsales\EshopCommunity\Core\ViewConfig::_isModuleEnabled (   $sModuleId)
private

Checks whether module is enabled.

Parameters
string$sModuleIdModule id
Returns
bool

◆ _isModuleVersionCorrect()

OxidEsales\EshopCommunity\Core\ViewConfig::_isModuleVersionCorrect (   $sModuleId,
  $sVersionFrom,
  $sVersionTo 
)
private

Checks whether module version is between given range.

Parameters
string$sModuleIdModule id
string$sVersionFromVersion from
string$sVersionToVersion to
Returns
bool

◆ _moduleExists()

OxidEsales\EshopCommunity\Core\ViewConfig::_moduleExists (   $sModuleId,
  $aModuleVersions 
)
private

Checks if module exists.

Parameters
string$sModuleIdModule id
array$aModuleVersionsModules from oxconfig 'aModuleVersions'
Returns
bool

◆ addRequestParameters()

OxidEsales\EshopCommunity\Core\ViewConfig::addRequestParameters ( )

Hook for modules. Collects additional _GET parameters used by eShop

Returns
string

◆ getActArticleId()

OxidEsales\EshopCommunity\Core\ViewConfig::getActArticleId ( )

Returns active article id

Returns
string

◆ getActCatId()

OxidEsales\EshopCommunity\Core\ViewConfig::getActCatId ( )

Returns active category id

Returns
string

◆ getActContentLoadId()

OxidEsales\EshopCommunity\Core\ViewConfig::getActContentLoadId ( )

Returns active template name (if set)

Returns
string

◆ getActCurrency()

OxidEsales\EshopCommunity\Core\ViewConfig::getActCurrency ( )

Returns active currency id

Returns
string

◆ getActionClassName()

OxidEsales\EshopCommunity\Core\ViewConfig::getActionClassName ( )

Returns name of a view class, which will be active for an action (given a generic fnc, e.g. logout)

Returns
string

◆ getActiveClassName()

OxidEsales\EshopCommunity\Core\ViewConfig::getActiveClassName ( )

Returns name of active view class

Returns
string

◆ getActiveShopId()

OxidEsales\EshopCommunity\Core\ViewConfig::getActiveShopId ( )

Returns currently open shop id

Returns
string

◆ getActiveTheme()

OxidEsales\EshopCommunity\Core\ViewConfig::getActiveTheme ( )

Returns active theme name

Returns
string

◆ getActLanguageAbbr()

OxidEsales\EshopCommunity\Core\ViewConfig::getActLanguageAbbr ( )

Returns session language id

Returns
string

◆ getActLanguageId()

OxidEsales\EshopCommunity\Core\ViewConfig::getActLanguageId ( )

Returns session language id

Returns
string

◆ getActListType()

OxidEsales\EshopCommunity\Core\ViewConfig::getActListType ( )

Returns active listtype parameter

Returns
string

◆ getActManufacturerId()

OxidEsales\EshopCommunity\Core\ViewConfig::getActManufacturerId ( )

Returns active manufacturer id

Returns
string

◆ getActRecommendationId()

OxidEsales\EshopCommunity\Core\ViewConfig::getActRecommendationId ( )

Returns active recommendation id parameter

Deprecated:
since v5.3 (2016-06-17); Listmania will be moved to an own module.
Returns
string

◆ getActSearchParam()

OxidEsales\EshopCommunity\Core\ViewConfig::getActSearchParam ( )

Returns active search parameter

Returns
string

◆ getActTplName()

OxidEsales\EshopCommunity\Core\ViewConfig::getActTplName ( )

Returns active manufacturer id

Returns
string

◆ getAdditionalNavigationParameters()

OxidEsales\EshopCommunity\Core\ViewConfig::getAdditionalNavigationParameters ( )

Hook for modules. Returns array of params => values which are used in hidden forms and as additional url params. NOTICE: this method SHOULD return raw (non encoded into entities) parameters, because values are processed by htmlentities() to avoid security and broken templates problems

Returns
array

◆ getAdditionalParameters()

OxidEsales\EshopCommunity\Core\ViewConfig::getAdditionalParameters ( )

Hook for modules. Template variable getter. Returns additional params for url

Returns
string

◆ getAdditionalRequestParameters()

OxidEsales\EshopCommunity\Core\ViewConfig::getAdditionalRequestParameters ( )
protected

If any hidden parameters needed for sending with request

Returns
string

◆ getAdminDir()

OxidEsales\EshopCommunity\Core\ViewConfig::getAdminDir ( )

Returns admin path

Returns
string

◆ getAjaxLink()

OxidEsales\EshopCommunity\Core\ViewConfig::getAjaxLink ( )

Returns AJAX request url

Returns
string

◆ getArtPerPageCount()

OxidEsales\EshopCommunity\Core\ViewConfig::getArtPerPageCount ( )

Returns max number of items shown on page

Returns
int

◆ getArtPerPageForm()

OxidEsales\EshopCommunity\Core\ViewConfig::getArtPerPageForm ( )

Returns list view paging url

Returns
string

◆ getBaseDir()

OxidEsales\EshopCommunity\Core\ViewConfig::getBaseDir ( )

Returns shops base directory path

Returns
string

◆ getBasketLink()

OxidEsales\EshopCommunity\Core\ViewConfig::getBasketLink ( )

Returns shops basket link

Returns
string

◆ getBasketTimeLeft()

OxidEsales\EshopCommunity\Core\ViewConfig::getBasketTimeLeft ( )

return the seconds left until basket expiration

Returns
int

◆ getContentId()

OxidEsales\EshopCommunity\Core\ViewConfig::getContentId ( )

Returns active content id

Returns
string

◆ getCoreUtilsDir()

OxidEsales\EshopCommunity\Core\ViewConfig::getCoreUtilsDir ( )

Returns shops utility directory path

Returns
string

◆ getCountryList()

OxidEsales\EshopCommunity\Core\ViewConfig::getCountryList ( )

Return country list

Returns
oxcountrylist

◆ getCurrentHomeDir()

OxidEsales\EshopCommunity\Core\ViewConfig::getCurrentHomeDir ( )

Returns shops home path

Returns
string

◆ getDynUrlParameters()

OxidEsales\EshopCommunity\Core\ViewConfig::getDynUrlParameters (   $listType)

Hook for modules. returns additional url params for dynamic url building

Parameters
string$listType
Returns
string

◆ getEdition()

OxidEsales\EshopCommunity\Core\ViewConfig::getEdition ( )

Return shop edition (EE|CE|PE)

Returns
string

◆ getExeOrderLink()

OxidEsales\EshopCommunity\Core\ViewConfig::getExeOrderLink ( )

Returns shops order execution link

Returns
string

◆ getHelpPageLink()

OxidEsales\EshopCommunity\Core\ViewConfig::getHelpPageLink ( )

Returns shop help link

Returns
string

◆ getHiddenSid()

OxidEsales\EshopCommunity\Core\ViewConfig::getHiddenSid ( )

Returns forms hidden session parameters

Returns
string

◆ getHomeLink()

OxidEsales\EshopCommunity\Core\ViewConfig::getHomeLink ( )

Returns shops home link

Returns
string

◆ getImageUrl()

OxidEsales\EshopCommunity\Core\ViewConfig::getImageUrl (   $sFile = null,
  $bSsl = null 
)

Returns image url

Parameters
string$sFileImage file name
bool$bSslWhether to force SSL
Returns
string

◆ getLogoutLink()

OxidEsales\EshopCommunity\Core\ViewConfig::getLogoutLink ( )

Returns shop logout link

Returns
string

◆ getModulePath()

OxidEsales\EshopCommunity\Core\ViewConfig::getModulePath (   $sModule,
  $sFile = '' 
)

return path to the requested module file

Parameters
string$sModulemodule name (directory name in modules dir)
string$sFilefile name to lookup
Exceptions

◆ getModuleUrl()

OxidEsales\EshopCommunity\Core\ViewConfig::getModuleUrl (   $sModule,
  $sFile = '' 
)

return url to the requested module file

Parameters
string$sModulemodule name (directory name in modules dir)
string$sFilefile name to lookup
Exceptions

◆ getNavFormParams()

OxidEsales\EshopCommunity\Core\ViewConfig::getNavFormParams ( )

Returns navigation forms parameters

Returns
string

◆ getNavUrlParams()

OxidEsales\EshopCommunity\Core\ViewConfig::getNavUrlParams ( )

Returns navigation url parameters

Returns
string

◆ getNoSslImageDir()

OxidEsales\EshopCommunity\Core\ViewConfig::getNoSslImageDir ( )

Returns non ssl image url

Returns
string

◆ getNrOfCatArticles()

OxidEsales\EshopCommunity\Core\ViewConfig::getNrOfCatArticles ( )

Returns config param "aNrofCatArticles" value

Returns
array

◆ getOrderConfirmLink()

OxidEsales\EshopCommunity\Core\ViewConfig::getOrderConfirmLink ( )

Returns shops order confirmation link

Returns
string

◆ getOrderLink()

OxidEsales\EshopCommunity\Core\ViewConfig::getOrderLink ( )

Returns shops order link

Returns
string

◆ getPasswordLength()

OxidEsales\EshopCommunity\Core\ViewConfig::getPasswordLength ( )

min length of password

Returns
int

◆ getPaymentLink()

OxidEsales\EshopCommunity\Core\ViewConfig::getPaymentLink ( )

Returns shops payment link

Returns
string

◆ getPictureDir()

OxidEsales\EshopCommunity\Core\ViewConfig::getPictureDir ( )

Returns url to pictures directory.

Returns
string

◆ getPopupIdent()

OxidEsales\EshopCommunity\Core\ViewConfig::getPopupIdent ( )

Returns basket popup identifier

Returns
string

◆ getPopupIdentRand()

OxidEsales\EshopCommunity\Core\ViewConfig::getPopupIdentRand ( )

Returns random basket popup identifier

Returns
string

◆ getRemoteAccessToken()

OxidEsales\EshopCommunity\Core\ViewConfig::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

◆ getRemoteAddress()

OxidEsales\EshopCommunity\Core\ViewConfig::getRemoteAddress ( )

Returns visitor ip address

Returns
string

◆ getResourceUrl()

OxidEsales\EshopCommunity\Core\ViewConfig::getResourceUrl (   $sFile = null)

Returns shops resource url

Parameters
string$sFileresource file name
Returns
string

◆ getSelfActionLink()

OxidEsales\EshopCommunity\Core\ViewConfig::getSelfActionLink ( )

Returns shops action link

Returns
string

◆ getSelfLink()

OxidEsales\EshopCommunity\Core\ViewConfig::getSelfLink ( )

Returns shops self link

Returns
string

◆ getServiceUrl()

OxidEsales\EshopCommunity\Core\ViewConfig::getServiceUrl ( )

Returns service url

Returns
string

◆ getSessionChallengeToken()

OxidEsales\EshopCommunity\Core\ViewConfig::getSessionChallengeToken ( )

retrieve session challenge token from session

Returns
string

◆ getSessionId()

OxidEsales\EshopCommunity\Core\ViewConfig::getSessionId ( )

Returns session id

Deprecated:
v5.1.0 Use conditional sid getter \OxidEsales\Eshop\Core\Controller\BaseController::getSidForWidget() for widgets instead
Returns
string

◆ getShopLogo()

OxidEsales\EshopCommunity\Core\ViewConfig::getShopLogo ( )

Returns shop logo image file name from config option

Returns
string

◆ getShopVersion()

OxidEsales\EshopCommunity\Core\ViewConfig::getShopVersion ( )

Returns shop version defined in view

Returns
string

◆ getShowBasketTimeout()

OxidEsales\EshopCommunity\Core\ViewConfig::getShowBasketTimeout ( )

should basket timeout counter be shown?

Returns
bool

◆ getShowCompareList()

OxidEsales\EshopCommunity\Core\ViewConfig::getShowCompareList ( )

Returns config param "bl_showCompareList" value

Returns
bool

◆ getShowGiftWrapping()

OxidEsales\EshopCommunity\Core\ViewConfig::getShowGiftWrapping ( )

Returns config param "bl_showGiftWrapping" value

Returns
bool

◆ getShowListmania()

OxidEsales\EshopCommunity\Core\ViewConfig::getShowListmania ( )

Returns config param "bl_showListmania" value

Deprecated:
since v5.3 (2016-06-17); Listmania will be moved to an own module.
Returns
bool

◆ getShowSuggest()

OxidEsales\EshopCommunity\Core\ViewConfig::getShowSuggest ( )

Returns config param "blAllowSuggestArticle" value.

Deprecated:
since v6.2.0 (2017-02-15); Recommendations feature will be moved to an own module.
Returns
bool

◆ getShowVouchers()

OxidEsales\EshopCommunity\Core\ViewConfig::getShowVouchers ( )

Returns config param "bl_showVouchers" value

Returns
bool

◆ getShowWishlist()

OxidEsales\EshopCommunity\Core\ViewConfig::getShowWishlist ( )

Returns config param "bl_showWishlist" value

Returns
bool

◆ getSslSelfLink()

OxidEsales\EshopCommunity\Core\ViewConfig::getSslSelfLink ( )

Returns shops self ssl link

Returns
string

◆ getStockOffDefaultMessage()

OxidEsales\EshopCommunity\Core\ViewConfig::getStockOffDefaultMessage ( )

Returns config param "blStockOnDefaultMessage" value

Returns
string

◆ getStockOnDefaultMessage()

OxidEsales\EshopCommunity\Core\ViewConfig::getStockOnDefaultMessage ( )

Returns config param "blStockOnDefaultMessage" value

Returns
string

◆ getTemplateDir()

OxidEsales\EshopCommunity\Core\ViewConfig::getTemplateDir ( )

Returns shops current (related to language) templates path

Returns
string

◆ getTopActionClassName()

OxidEsales\EshopCommunity\Core\ViewConfig::getTopActionClassName ( )

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

Returns
string

◆ getTopActiveClassName()

OxidEsales\EshopCommunity\Core\ViewConfig::getTopActiveClassName ( )

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

Returns
string

◆ getUrlTemplateDir()

OxidEsales\EshopCommunity\Core\ViewConfig::getUrlTemplateDir ( )

Returns shops current templates url

Returns
string

◆ getViewConfigParam()

OxidEsales\EshopCommunity\Core\ViewConfig::getViewConfigParam (   $sName)

Returns current view config parameter

Parameters
string$sNamename of parameter to get
Returns
mixed

◆ getViewThemeParam()

OxidEsales\EshopCommunity\Core\ViewConfig::getViewThemeParam (   $sName)

return param value

Parameters
string$sNameparam name
Returns
mixed

◆ isAltImageServerConfigured()

OxidEsales\EshopCommunity\Core\ViewConfig::isAltImageServerConfigured ( )

Checks if alternative image server is configured.

Returns
bool

◆ isBuyableParent()

OxidEsales\EshopCommunity\Core\ViewConfig::isBuyableParent ( )

Returns "blVariantParentBuyable" parent article config state

Returns
string

◆ isFunctionalityEnabled()

OxidEsales\EshopCommunity\Core\ViewConfig::isFunctionalityEnabled (   $sParamName)

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

Parameters
string$sParamNameconfig parameter name.
Returns
bool

◆ isModuleActive()

OxidEsales\EshopCommunity\Core\ViewConfig::isModuleActive (   $sModuleId,
  $sVersionFrom = null,
  $sVersionTo = null 
)

Check if module is active. If versionFrom or|and versionTo is defined - also checks module versions.

Parameters
string$sModuleIdmodule id.
string$sVersionFrommodule from version.
string$sVersionTomodule to version.
Returns
bool

◆ isMultiShop()

OxidEsales\EshopCommunity\Core\ViewConfig::isMultiShop ( )

Returns multishop status

Returns
bool

◆ isSsl()

OxidEsales\EshopCommunity\Core\ViewConfig::isSsl ( )

Returns ssl mode (on/off)

Returns
string

◆ isStartClassRequired()

OxidEsales\EshopCommunity\Core\ViewConfig::isStartClassRequired ( )
protected

Check if some shop selection page must be shown

Returns
bool

◆ isTplBlocksDebugMode()

OxidEsales\EshopCommunity\Core\ViewConfig::isTplBlocksDebugMode ( )

true if blocks javascript code be enabled in templates

Returns
bool

◆ setShopLogo()

OxidEsales\EshopCommunity\Core\ViewConfig::setShopLogo (   $sLogo)

Sets shop logo

Parameters
string$sLogoshop logo image file name

◆ setViewConfigParam()

OxidEsales\EshopCommunity\Core\ViewConfig::setViewConfigParam (   $sName,
  $sValue 
)

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

$oViewConf->getViewConfigParam( $sName )

Parameters
string$sNamename of parameter
mixed$sValueparameter value

◆ setViewShop()

OxidEsales\EshopCommunity\Core\ViewConfig::setViewShop (   $oShop,
  $aViewData 
)

Sets shop object and view data to view config. This is needed mostly for old templates

Parameters
\OxidEsales\Eshop\Application\Model\Shop$oShopshop object
array$aViewDataview data array

◆ showBirthdayFields()

OxidEsales\EshopCommunity\Core\ViewConfig::showBirthdayFields ( )

Returns config param "blShowBirthdayFields" value

Returns
string

◆ showSelectLists()

OxidEsales\EshopCommunity\Core\ViewConfig::showSelectLists ( )

Returns true if selection lists must be displayed in details page

Returns
bool

◆ showSelectListsInList()

OxidEsales\EshopCommunity\Core\ViewConfig::showSelectListsInList ( )

Returns true if selection lists must be displayed in details page

Returns
bool

Member Data Documentation

◆ $_aConfigParams

OxidEsales\EshopCommunity\Core\ViewConfig::$_aConfigParams = []
protected

◆ $_aViewData

OxidEsales\EshopCommunity\Core\ViewConfig::$_aViewData = null
protected

◆ $_oCountryList

OxidEsales\EshopCommunity\Core\ViewConfig::$_oCountryList = null
protected

◆ $_oShop

OxidEsales\EshopCommunity\Core\ViewConfig::$_oShop = null
protected

◆ $_sActiveTheme

OxidEsales\EshopCommunity\Core\ViewConfig::$_sActiveTheme = null
protected

◆ $_sHelpPageLink

OxidEsales\EshopCommunity\Core\ViewConfig::$_sHelpPageLink = null
protected

Help page link

Returns
string

◆ $_sShopLogo

OxidEsales\EshopCommunity\Core\ViewConfig::$_sShopLogo = null
protected

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