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.
Member Function Documentation
oxViewConfig.getActArticleId |
( |
|
) |
|
oxViewConfig.getActCatId |
( |
|
) |
|
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 949 of file oxviewconfig.php.
oxViewConfig.getActiveClassName |
( |
|
) |
|
Returns name of active view class
- Returns:
- string
Definition at line 804 of file oxviewconfig.php.
oxViewConfig.getActiveShopId |
( |
|
) |
|
oxViewConfig.getActLanguageId |
( |
|
) |
|
oxViewConfig.getActListType |
( |
|
) |
|
Returns active listtype parameter
- Returns:
- string
Definition at line 210 of file oxviewconfig.php.
oxViewConfig.getActManufacturerId |
( |
|
) |
|
oxViewConfig.getActSearchParam |
( |
|
) |
|
Returns active search parameter
- Returns:
- string
Definition at line 190 of file oxviewconfig.php.
oxViewConfig.getActSearchTag |
( |
|
) |
|
Returns active search tag parameter
- Returns:
- string
Definition at line 200 of file oxviewconfig.php.
oxViewConfig.getActTplName |
( |
|
) |
|
Returns active template name (if set)
- Returns:
- string
Definition at line 86 of file oxviewconfig.php.
oxViewConfig.getAdminDir |
( |
|
) |
|
oxViewConfig.getAjaxLink |
( |
|
) |
|
oxViewConfig.getArtPerPageCount |
( |
|
) |
|
Returns max number of items shown on page
- Returns:
- int
Definition at line 814 of file oxviewconfig.php.
oxViewConfig.getArtPerPageForm |
( |
|
) |
|
oxViewConfig.getBaseDir |
( |
|
) |
|
Returns shops base directory path
- Returns:
- string
Definition at line 352 of file oxviewconfig.php.
oxViewConfig.getBasketLink |
( |
|
) |
|
oxViewConfig.getBasketTimeLeft |
( |
|
) |
|
return the seconds left until basket expiration
- Returns:
- int
Definition at line 980 of file oxviewconfig.php.
oxViewConfig.getCoreUtilsDir |
( |
|
) |
|
Returns shops utility directory path
- Returns:
- string
Definition at line 372 of file oxviewconfig.php.
oxViewConfig.getCountryList |
( |
|
) |
|
oxViewConfig.getCurrentHomeDir |
( |
|
) |
|
oxViewConfig.getExeOrderLink |
( |
|
) |
|
Returns shops order execution link
- Returns:
- string
Definition at line 456 of file oxviewconfig.php.
oxViewConfig.getFbAppId |
( |
|
) |
|
Returns facebook application key value
- Returns:
- string
Definition at line 959 of file oxviewconfig.php.
oxViewConfig.getHelpLink |
( |
|
) |
|
oxViewConfig.getHelpPageLink |
( |
|
) |
|
oxViewConfig.getHiddenSid |
( |
|
) |
|
Returns forms hidden session parameters
- Returns:
- string
Definition at line 303 of file oxviewconfig.php.
oxViewConfig.getHomeLink |
( |
|
) |
|
oxViewConfig.getImageUrl |
( |
$ |
sFile = null |
) |
|
Returns image url
- Parameters:
-
| string | $sFile Image file name |
- Returns:
- string
Definition at line 528 of file oxviewconfig.php.
oxViewConfig.getLogoutLink |
( |
|
) |
|
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:
-
- Returns:
- string
Definition at line 1198 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:
-
- Returns:
- string
Definition at line 1222 of file oxviewconfig.php.
oxViewConfig.getNavFormParams |
( |
|
) |
|
Returns navigation forms parameters
- Returns:
- string
Definition at line 851 of file oxviewconfig.php.
oxViewConfig.getNavUrlParams |
( |
|
) |
|
Returns navigation url parameters
- Returns:
- string
Definition at line 824 of file oxviewconfig.php.
oxViewConfig.getNoSslImageDir |
( |
|
) |
|
oxViewConfig.getNrOfCatArticles |
( |
|
) |
|
Returns config param "aNrofCatArticles" value
- Returns:
- string
Definition at line 702 of file oxviewconfig.php.
oxViewConfig.getOrderConfirmLink |
( |
|
) |
|
Returns shops order confirmation link
- Returns:
- string
Definition at line 470 of file oxviewconfig.php.
oxViewConfig.getOrderLink |
( |
|
) |
|
oxViewConfig.getPasswordLength |
( |
|
) |
|
oxViewConfig.getPaymentLink |
( |
|
) |
|
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 559 of file oxviewconfig.php.
oxViewConfig.getPopupIdent |
( |
|
) |
|
Returns basket popup identifier
- Returns:
- string
Definition at line 630 of file oxviewconfig.php.
oxViewConfig.getPopupIdentRand |
( |
|
) |
|
Returns random basket popup identifier
- Returns:
- string
Definition at line 644 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 935 of file oxviewconfig.php.
oxViewConfig.getRemoteAddress |
( |
|
) |
|
oxViewConfig.getResourceUrl |
( |
|
) |
|
oxViewConfig.getSelfActionLink |
( |
|
) |
|
oxViewConfig.getSelfLink |
( |
|
) |
|
oxViewConfig.getServiceUrl |
( |
|
) |
|
oxViewConfig.getSessionId |
( |
|
) |
|
oxViewConfig.getShopVersion |
( |
|
) |
|
Returns shop version defined in view
- Returns:
- string
Definition at line 893 of file oxviewconfig.php.
oxViewConfig.getShowBasketTimeout |
( |
|
) |
|
should basket timeout counter be shown?
- Returns:
- bool
Definition at line 969 of file oxviewconfig.php.
oxViewConfig.getShowCompareList |
( |
|
) |
|
Returns config param "bl_showCompareList" value
- Returns:
- bool
Definition at line 731 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 994 of file oxviewconfig.php.
oxViewConfig.getShowGiftWrapping |
( |
|
) |
|
Returns config param "bl_showGiftWrapping" value
- Returns:
- bool
Definition at line 769 of file oxviewconfig.php.
oxViewConfig.getShowListmania |
( |
|
) |
|
Returns config param "bl_showListmania" value
- Returns:
- bool
Definition at line 749 of file oxviewconfig.php.
oxViewConfig.getShowVouchers |
( |
|
) |
|
Returns config param "bl_showVouchers" value
- Returns:
- bool
Definition at line 759 of file oxviewconfig.php.
oxViewConfig.getShowWishlist |
( |
|
) |
|
Returns config param "bl_showWishlist" value
- Returns:
- bool
Definition at line 721 of file oxviewconfig.php.
oxViewConfig.getSslSelfLink |
( |
|
) |
|
oxViewConfig.getStockOffDefaultMessage |
( |
|
) |
|
Returns config param "blStockOnDefaultMessage" value
- Returns:
- string
Definition at line 883 of file oxviewconfig.php.
oxViewConfig.getStockOnDefaultMessage |
( |
|
) |
|
Returns config param "blStockOnDefaultMessage" value
- Returns:
- string
Definition at line 873 of file oxviewconfig.php.
oxViewConfig.getTemplateDir |
( |
|
) |
|
Returns shops current (related to language) templates path
- Returns:
- string
Definition at line 498 of file oxviewconfig.php.
oxViewConfig.getTsDomain |
( |
|
) |
|
Returns Trusted shops domain name (includes "http://")
- Returns:
- string
Definition at line 1012 of file oxviewconfig.php.
oxViewConfig.getTsInfoUrl |
( |
|
) |
|
Trusted Shops widget info url
- Returns:
- string | bool
Definition at line 1053 of file oxviewconfig.php.
oxViewConfig.getTsRatingUrl |
( |
|
) |
|
oxViewConfig.getTsWidgetUrl |
( |
|
) |
|
Returns Trusted Shops Widget image url
- Returns:
- string
Definition at line 1027 of file oxviewconfig.php.
oxViewConfig.getUrlTemplateDir |
( |
|
) |
|
Returns shops current templates url
- Returns:
- string
Definition at line 512 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 252 of file oxviewconfig.php.
oxViewConfig.getViewThemeParam |
( |
$ |
sName |
) |
|
oxViewConfig.isAutoSearchOnCat |
( |
|
) |
|
Returns config param "blAutoSearchOnCat" value
- Returns:
- string
Definition at line 779 of file oxviewconfig.php.
oxViewConfig.isBuyableParent |
( |
|
) |
|
Returns "blVariantParentBuyable" parent article config state
- Returns:
- string
Definition at line 672 of file oxviewconfig.php.
oxViewConfig.isMultiShop |
( |
|
) |
|
oxViewConfig.isTplBlocksDebugMode |
( |
|
) |
|
true if blocks javascript code be enabled in templates
- Returns:
- bool
Definition at line 1149 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 236 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 278 of file oxviewconfig.php.
oxViewConfig.showBirthdayFields |
( |
|
) |
|
Returns config param "blShowBirthdayFields" value
- Returns:
- string
Definition at line 682 of file oxviewconfig.php.
oxViewConfig.showFinalStep |
( |
|
) |
|
Returns config param "blShowFinalStep" value
- Returns:
- string
Definition at line 692 of file oxviewconfig.php.
oxViewConfig.showSelectLists |
( |
|
) |
|
Returns true if selection lists must be displayed in details page
- Returns:
- bool
Definition at line 1256 of file oxviewconfig.php.
oxViewConfig.showSelectListsInList |
( |
|
) |
|
Returns true if selection lists must be displayed in details page
- Returns:
- bool
Definition at line 1266 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 1101 of file oxviewconfig.php.
Member Data Documentation
oxViewConfig.$_aConfigParams = array() [protected] |
oxViewConfig.$_aViewData = null [protected] |
oxViewConfig.$_oCountryList = null [protected] |
oxViewConfig.$_oShop = null [protected] |
oxViewConfig.$_sHelpPageLink = null [protected] |
The documentation for this class was generated from the following file: