oxViewConfig Class Reference
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.__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.__get |
( |
$ |
sVarName |
) |
|
Returns view config variable value if possible
- Parameters:
-
| string | $sVarName name of variable to return |
- Returns:
- mixed
Definition at line 876 of file oxviewconfig.php.
oxViewConfig.getActCatId |
( |
|
) |
|
oxViewConfig.getActiveClassName |
( |
|
) |
|
Returns name of active view class
- Returns:
- string
Definition at line 744 of file oxviewconfig.php.
oxViewConfig.getActiveShopId |
( |
|
) |
|
oxViewConfig.getActLanguageId |
( |
|
) |
|
oxViewConfig.getActManufacturerId |
( |
|
) |
|
oxViewConfig.getActTplName |
( |
|
) |
|
Returns active template name (if set)
- Returns:
- string
Definition at line 65 of file oxviewconfig.php.
oxViewConfig.getAdminDir |
( |
|
) |
|
oxViewConfig.getAjaxLink |
( |
|
) |
|
oxViewConfig.getArtPerPageCount |
( |
|
) |
|
Returns max number of items shown on page
- Returns:
- int
Definition at line 754 of file oxviewconfig.php.
oxViewConfig.getArtPerPageForm |
( |
|
) |
|
oxViewConfig.getBaseDir |
( |
|
) |
|
Returns shops base directory path
- Returns:
- string
Definition at line 309 of file oxviewconfig.php.
oxViewConfig.getBasketLink |
( |
|
) |
|
oxViewConfig.getCoreUtilsDir |
( |
|
) |
|
Returns shops utility directory path
- Returns:
- string
Definition at line 323 of file oxviewconfig.php.
oxViewConfig.getCurrentHomeDir |
( |
|
) |
|
oxViewConfig.getExeOrderLink |
( |
|
) |
|
Returns shops order execution link
- Returns:
- string
Definition at line 407 of file oxviewconfig.php.
oxViewConfig.getHelpLink |
( |
|
) |
|
oxViewConfig.getHiddenSid |
( |
|
) |
|
Returns forms hidden session parameters
- Returns:
- string
Definition at line 260 of file oxviewconfig.php.
oxViewConfig.getHomeLink |
( |
|
) |
|
oxViewConfig.getImageUrl |
( |
|
) |
|
oxViewConfig.getLogoutLink |
( |
|
) |
|
oxViewConfig.getNavFormParams |
( |
|
) |
|
Returns navigation forms parameters
- Returns:
- string
Definition at line 791 of file oxviewconfig.php.
oxViewConfig.getNavUrlParams |
( |
|
) |
|
Returns navigation url parameters
- Returns:
- string
Definition at line 764 of file oxviewconfig.php.
oxViewConfig.getNoSslImageDir |
( |
|
) |
|
oxViewConfig.getNrOfCatArticles |
( |
|
) |
|
Returns config param "aNrofCatArticles" value
- Returns:
- string
Definition at line 649 of file oxviewconfig.php.
oxViewConfig.getOrderConfirmLink |
( |
|
) |
|
Returns shops order confirmation link
- Returns:
- string
Definition at line 421 of file oxviewconfig.php.
oxViewConfig.getOrderLink |
( |
|
) |
|
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 506 of file oxviewconfig.php.
oxViewConfig.getPopupIdent |
( |
|
) |
|
Returns basket popup identifier
- Returns:
- string
Definition at line 577 of file oxviewconfig.php.
oxViewConfig.getPopupIdentRand |
( |
|
) |
|
Returns random basket popup identifier
- Returns:
- string
Definition at line 591 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 1058 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 833 of file oxviewconfig.php.
oxViewConfig.getShowCompareList |
( |
|
) |
|
Returns config param "bl_showCompareList" value
- Returns:
- bool
Definition at line 669 of file oxviewconfig.php.
oxViewConfig.getShowGiftWrapping |
( |
|
) |
|
Returns config param "bl_showGiftWrapping" value
- Returns:
- bool
Definition at line 709 of file oxviewconfig.php.
oxViewConfig.getShowListmania |
( |
|
) |
|
Returns config param "bl_showListmania" value
- Returns:
- bool
Definition at line 679 of file oxviewconfig.php.
oxViewConfig.getShowOpenIdLogin |
( |
|
) |
|
Returns config param "bl_showOpenId" value
- Returns:
- bool
Definition at line 689 of file oxviewconfig.php.
oxViewConfig.getShowVouchers |
( |
|
) |
|
Returns config param "bl_showVouchers" value
- Returns:
- bool
Definition at line 699 of file oxviewconfig.php.
oxViewConfig.getShowWishlist |
( |
|
) |
|
Returns config param "bl_showWishlist" value
- Returns:
- bool
Definition at line 659 of file oxviewconfig.php.
oxViewConfig.getSslSelfLink |
( |
|
) |
|
oxViewConfig.getStockOffDefaultMessage |
( |
|
) |
|
Returns config param "blStockOnDefaultMessage" value
- Returns:
- string
Definition at line 823 of file oxviewconfig.php.
oxViewConfig.getStockOnDefaultMessage |
( |
|
) |
|
Returns config param "blStockOnDefaultMessage" value
- Returns:
- string
Definition at line 813 of file oxviewconfig.php.
oxViewConfig.getTemplateDir |
( |
|
) |
|
Returns shops current (related to language) templates path
- Returns:
- string
Definition at line 449 of file oxviewconfig.php.
oxViewConfig.getTypeLinkParams |
( |
|
) |
|
oxViewConfig.getTypeParams |
( |
|
) |
|
oxViewConfig.getUrlTemplateDir |
( |
|
) |
|
Returns shops current templates url
- Returns:
- string
Definition at line 463 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.getViewVar |
( |
$ |
sVarName |
) |
|
Returns view config variable value if possible
- Parameters:
-
| string | $sVarName name of variable to return |
- Returns:
- mixed
Definition at line 888 of file oxviewconfig.php.
oxViewConfig.isAutoSearchOnCat |
( |
|
) |
|
Returns config param "blAutoSearchOnCat" value
- Returns:
- string
Definition at line 719 of file oxviewconfig.php.
oxViewConfig.isBuyableParent |
( |
|
) |
|
Returns "blVariantParentBuyable" parent article config state
- Returns:
- string
Definition at line 619 of file oxviewconfig.php.
oxViewConfig.isMultiShop |
( |
|
) |
|
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.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.showBirthdayFields |
( |
|
) |
|
Returns config param "blShowBirthdayFields" value
- Returns:
- string
Definition at line 629 of file oxviewconfig.php.
oxViewConfig.showFinalStep |
( |
|
) |
|
Returns config param "blShowFinalStep" value
- Returns:
- string
Definition at line 639 of file oxviewconfig.php.
Member Data Documentation
oxViewConfig.$_aConfigParams = array() [protected] |
oxViewConfig.$_aViewData = null [protected] |
oxViewConfig.$_oShop = null [protected] |
The documentation for this class was generated from the following file: