OXID eShop CE
6.1.5
|
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) | |
View config data access class. Keeps most of getters needed for formatting various urls, config parameters, session information etc.
|
protected |
Returns help content link idents
|
private |
|
private |
Checks whether module version is between given range.
string | $sModuleId | Module id |
string | $sVersionFrom | Version from |
string | $sVersionTo | Version to |
|
private |
Checks if module exists.
string | $sModuleId | Module id |
array | $aModuleVersions | Modules from oxconfig 'aModuleVersions' |
OxidEsales\EshopCommunity\Core\ViewConfig::addRequestParameters | ( | ) |
Hook for modules. Collects additional _GET parameters used by eShop
OxidEsales\EshopCommunity\Core\ViewConfig::getActArticleId | ( | ) |
Returns active article id
OxidEsales\EshopCommunity\Core\ViewConfig::getActCatId | ( | ) |
Returns active category id
OxidEsales\EshopCommunity\Core\ViewConfig::getActContentLoadId | ( | ) |
Returns active template name (if set)
OxidEsales\EshopCommunity\Core\ViewConfig::getActCurrency | ( | ) |
Returns active currency id
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)
OxidEsales\EshopCommunity\Core\ViewConfig::getActiveClassName | ( | ) |
Returns name of active view class
OxidEsales\EshopCommunity\Core\ViewConfig::getActiveShopId | ( | ) |
Returns currently open shop id
OxidEsales\EshopCommunity\Core\ViewConfig::getActiveTheme | ( | ) |
Returns active theme name
OxidEsales\EshopCommunity\Core\ViewConfig::getActLanguageAbbr | ( | ) |
Returns session language id
OxidEsales\EshopCommunity\Core\ViewConfig::getActLanguageId | ( | ) |
Returns session language id
OxidEsales\EshopCommunity\Core\ViewConfig::getActListType | ( | ) |
Returns active listtype parameter
OxidEsales\EshopCommunity\Core\ViewConfig::getActManufacturerId | ( | ) |
Returns active manufacturer id
OxidEsales\EshopCommunity\Core\ViewConfig::getActRecommendationId | ( | ) |
Returns active recommendation id parameter
OxidEsales\EshopCommunity\Core\ViewConfig::getActSearchParam | ( | ) |
Returns active search parameter
OxidEsales\EshopCommunity\Core\ViewConfig::getActTplName | ( | ) |
Returns active manufacturer id
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
OxidEsales\EshopCommunity\Core\ViewConfig::getAdditionalParameters | ( | ) |
Hook for modules. Template variable getter. Returns additional params for url
|
protected |
If any hidden parameters needed for sending with request
OxidEsales\EshopCommunity\Core\ViewConfig::getAdminDir | ( | ) |
Returns admin path
OxidEsales\EshopCommunity\Core\ViewConfig::getAjaxLink | ( | ) |
Returns AJAX request url
OxidEsales\EshopCommunity\Core\ViewConfig::getArtPerPageCount | ( | ) |
Returns max number of items shown on page
OxidEsales\EshopCommunity\Core\ViewConfig::getArtPerPageForm | ( | ) |
Returns list view paging url
OxidEsales\EshopCommunity\Core\ViewConfig::getBaseDir | ( | ) |
Returns shops base directory path
OxidEsales\EshopCommunity\Core\ViewConfig::getBasketLink | ( | ) |
Returns shops basket link
OxidEsales\EshopCommunity\Core\ViewConfig::getBasketTimeLeft | ( | ) |
return the seconds left until basket expiration
OxidEsales\EshopCommunity\Core\ViewConfig::getContentId | ( | ) |
Returns active content id
OxidEsales\EshopCommunity\Core\ViewConfig::getCoreUtilsDir | ( | ) |
Returns shops utility directory path
OxidEsales\EshopCommunity\Core\ViewConfig::getCountryList | ( | ) |
Return country list
OxidEsales\EshopCommunity\Core\ViewConfig::getCurrentHomeDir | ( | ) |
Returns shops home path
OxidEsales\EshopCommunity\Core\ViewConfig::getDynUrlParameters | ( | $listType | ) |
Hook for modules. returns additional url params for dynamic url building
string | $listType |
OxidEsales\EshopCommunity\Core\ViewConfig::getEdition | ( | ) |
Return shop edition (EE|CE|PE)
OxidEsales\EshopCommunity\Core\ViewConfig::getExeOrderLink | ( | ) |
Returns shops order execution link
OxidEsales\EshopCommunity\Core\ViewConfig::getHelpPageLink | ( | ) |
Returns shop help link
OxidEsales\EshopCommunity\Core\ViewConfig::getHiddenSid | ( | ) |
Returns forms hidden session parameters
OxidEsales\EshopCommunity\Core\ViewConfig::getHomeLink | ( | ) |
Returns shops home link
OxidEsales\EshopCommunity\Core\ViewConfig::getImageUrl | ( | $sFile = null , |
|
$bSsl = null |
|||
) |
Returns image url
string | $sFile | Image file name |
bool | $bSsl | Whether to force SSL |
OxidEsales\EshopCommunity\Core\ViewConfig::getLogoutLink | ( | ) |
Returns shop logout link
OxidEsales\EshopCommunity\Core\ViewConfig::getModulePath | ( | $sModule, | |
$sFile = '' |
|||
) |
return path to the requested module file
string | $sModule | module name (directory name in modules dir) |
string | $sFile | file name to lookup |
OxidEsales\EshopCommunity\Core\ViewConfig::getModuleUrl | ( | $sModule, | |
$sFile = '' |
|||
) |
return url to the requested module file
string | $sModule | module name (directory name in modules dir) |
string | $sFile | file name to lookup |
OxidEsales\EshopCommunity\Core\ViewConfig::getNavFormParams | ( | ) |
Returns navigation forms parameters
OxidEsales\EshopCommunity\Core\ViewConfig::getNavUrlParams | ( | ) |
Returns navigation url parameters
OxidEsales\EshopCommunity\Core\ViewConfig::getNoSslImageDir | ( | ) |
Returns non ssl image url
OxidEsales\EshopCommunity\Core\ViewConfig::getNrOfCatArticles | ( | ) |
Returns config param "aNrofCatArticles" value
OxidEsales\EshopCommunity\Core\ViewConfig::getOrderConfirmLink | ( | ) |
Returns shops order confirmation link
OxidEsales\EshopCommunity\Core\ViewConfig::getOrderLink | ( | ) |
Returns shops order link
OxidEsales\EshopCommunity\Core\ViewConfig::getPasswordLength | ( | ) |
min length of password
OxidEsales\EshopCommunity\Core\ViewConfig::getPaymentLink | ( | ) |
Returns shops payment link
OxidEsales\EshopCommunity\Core\ViewConfig::getPictureDir | ( | ) |
Returns url to pictures directory.
OxidEsales\EshopCommunity\Core\ViewConfig::getPopupIdent | ( | ) |
Returns basket popup identifier
OxidEsales\EshopCommunity\Core\ViewConfig::getPopupIdentRand | ( | ) |
Returns random basket popup identifier
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.
OxidEsales\EshopCommunity\Core\ViewConfig::getRemoteAddress | ( | ) |
Returns visitor ip address
OxidEsales\EshopCommunity\Core\ViewConfig::getResourceUrl | ( | $sFile = null | ) |
Returns shops resource url
string | $sFile | resource file name |
OxidEsales\EshopCommunity\Core\ViewConfig::getSelfActionLink | ( | ) |
Returns shops action link
OxidEsales\EshopCommunity\Core\ViewConfig::getSelfLink | ( | ) |
Returns shops self link
OxidEsales\EshopCommunity\Core\ViewConfig::getServiceUrl | ( | ) |
Returns service url
OxidEsales\EshopCommunity\Core\ViewConfig::getSessionChallengeToken | ( | ) |
retrieve session challenge token from session
OxidEsales\EshopCommunity\Core\ViewConfig::getSessionId | ( | ) |
Returns session id
OxidEsales\EshopCommunity\Core\ViewConfig::getShopLogo | ( | ) |
Returns shop logo image file name from config option
OxidEsales\EshopCommunity\Core\ViewConfig::getShopVersion | ( | ) |
Returns shop version defined in view
OxidEsales\EshopCommunity\Core\ViewConfig::getShowBasketTimeout | ( | ) |
should basket timeout counter be shown?
OxidEsales\EshopCommunity\Core\ViewConfig::getShowCompareList | ( | ) |
Returns config param "bl_showCompareList" value
OxidEsales\EshopCommunity\Core\ViewConfig::getShowGiftWrapping | ( | ) |
Returns config param "bl_showGiftWrapping" value
OxidEsales\EshopCommunity\Core\ViewConfig::getShowListmania | ( | ) |
Returns config param "bl_showListmania" value
OxidEsales\EshopCommunity\Core\ViewConfig::getShowSuggest | ( | ) |
Returns config param "blAllowSuggestArticle" value.
OxidEsales\EshopCommunity\Core\ViewConfig::getShowVouchers | ( | ) |
Returns config param "bl_showVouchers" value
OxidEsales\EshopCommunity\Core\ViewConfig::getShowWishlist | ( | ) |
Returns config param "bl_showWishlist" value
OxidEsales\EshopCommunity\Core\ViewConfig::getSslSelfLink | ( | ) |
Returns shops self ssl link
OxidEsales\EshopCommunity\Core\ViewConfig::getStockOffDefaultMessage | ( | ) |
Returns config param "blStockOnDefaultMessage" value
OxidEsales\EshopCommunity\Core\ViewConfig::getStockOnDefaultMessage | ( | ) |
Returns config param "blStockOnDefaultMessage" value
OxidEsales\EshopCommunity\Core\ViewConfig::getTemplateDir | ( | ) |
Returns shops current (related to language) templates path
OxidEsales\EshopCommunity\Core\ViewConfig::getTopActionClassName | ( | ) |
Returns name of a class of top view in the chain (given a generic fnc, e.g. logout)
OxidEsales\EshopCommunity\Core\ViewConfig::getTopActiveClassName | ( | ) |
Returns name of a class of top view in the chain (given a generic fnc, e.g. logout)
OxidEsales\EshopCommunity\Core\ViewConfig::getUrlTemplateDir | ( | ) |
Returns shops current templates url
OxidEsales\EshopCommunity\Core\ViewConfig::getViewConfigParam | ( | $sName | ) |
Returns current view config parameter
string | $sName | name of parameter to get |
OxidEsales\EshopCommunity\Core\ViewConfig::getViewThemeParam | ( | $sName | ) |
return param value
string | $sName | param name |
OxidEsales\EshopCommunity\Core\ViewConfig::isAltImageServerConfigured | ( | ) |
Checks if alternative image server is configured.
OxidEsales\EshopCommunity\Core\ViewConfig::isBuyableParent | ( | ) |
Returns "blVariantParentBuyable" parent article config state
OxidEsales\EshopCommunity\Core\ViewConfig::isFunctionalityEnabled | ( | $sParamName | ) |
Get config parameter for view to check if functionality is turned on or off.
string | $sParamName | config parameter name. |
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.
string | $sModuleId | module id. |
string | $sVersionFrom | module from version. |
string | $sVersionTo | module to version. |
OxidEsales\EshopCommunity\Core\ViewConfig::isMultiShop | ( | ) |
Returns multishop status
OxidEsales\EshopCommunity\Core\ViewConfig::isSsl | ( | ) |
Returns ssl mode (on/off)
|
protected |
Check if some shop selection page must be shown
OxidEsales\EshopCommunity\Core\ViewConfig::isTplBlocksDebugMode | ( | ) |
true if blocks javascript code be enabled in templates
OxidEsales\EshopCommunity\Core\ViewConfig::setShopLogo | ( | $sLogo | ) |
Sets shop logo
string | $sLogo | shop logo image file name |
OxidEsales\EshopCommunity\Core\ViewConfig::setViewConfigParam | ( | $sName, | |
$sValue | |||
) |
Sets view config parameter, which can be accessed in templates in two ways:
$oViewConf->getViewConfigParam( $sName )
string | $sName | name of parameter |
mixed | $sValue | parameter value |
OxidEsales\EshopCommunity\Core\ViewConfig::setViewShop | ( | $oShop, | |
$aViewData | |||
) |
Sets shop object and view data to view config. This is needed mostly for old templates
\OxidEsales\Eshop\Application\Model\Shop | $oShop | shop object |
array | $aViewData | view data array |
OxidEsales\EshopCommunity\Core\ViewConfig::showBirthdayFields | ( | ) |
Returns config param "blShowBirthdayFields" value
OxidEsales\EshopCommunity\Core\ViewConfig::showSelectLists | ( | ) |
Returns true if selection lists must be displayed in details page
OxidEsales\EshopCommunity\Core\ViewConfig::showSelectListsInList | ( | ) |
Returns true if selection lists must be displayed in details page
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Help page link
|
protected |