oxView Class Reference
Detailed Description
Base view class. Collects and passes data to template engine, sets some global configuration parameters.Member Function Documentation
| oxView.init | ( | ) |
Initiates all components stored, executes oxview.addGlobalParams.
- Returns:
- null
Reimplemented in Adminlinks_list, Article_list, Attribute_list, Category_list, Delivery_list, deliveryset_list, Discount_list, gui, News_list, oxAdminList, oxAdminView, Selectlist_list, Shop_list, User_list, Vendor_list, Wrapping_list, Content, Details, moreDetails, order, oxcmp_categories, oxcmp_cur, oxcmp_lang, oxcmp_user, oxUBase, Payment, Review, rss, search, Start, Suggest, Tag, and Thankyou.
| oxView.showSorting | ( | ) |
Template variable getter. Returns true if sorting is on
- Returns:
- bool
| oxView.getViewId | ( | ) |
If current view ID is not set - forms and returns view ID according to language and currency.
- Returns:
- string $this->_sViewId
Reimplemented in dyn_affiliwelt, dyn_econda, dyn_etracker, dyn_interface, dyn_ipayment, dyn_trusted, DynExportBase, dynscreen, Login, oxAdminView, aList, Content, and Details.
| oxView.getViewResetId | ( | ) |
If current reset ID is not set - forms and returns view ID according to category and usergroup ....
- Returns:
- string
Reimplemented in Details.
| oxView.render | ( | ) |
If this object is not a component (oxview._blIsComponent = false) goes through oxview._oaComponents list, executes oxview.list render method and passes it's data to template engine. Returns an array of parameters used by template engine.
- Returns:
- string current view template file name
Reimplemented in Actions_main, AdminGuestbook_list, Adminguestbook_main, Adminlinks_main, Article_attribute, Article_crossselling, Article_extend, Article_list, Article_main, Article_overview, Article_pictures, Article_review, Article_Seo, Article_stock, Article_userdef, Article_variant, Attribute_category, Attribute_main, Category_list, Category_main, Category_order, Category_pictures, Category_Seo, Category_Text, Category_update, Content_list, Content_main, Country_list, Country_main, Delivery_articles, Delivery_main, Delivery_users, deliveryset_main, Deliveryset_payment, DeliverySet_users, Discount_articles, Discount_main, Discount_users, dyn_adbutler, dyn_affili24, dyn_affilinet, dyn_affiliwelt, dyn_econda, dyn_etracker, dyn_ipayment, dyn_superclix, dyn_trusted, DynExportBase, dynscreen_list, efire_downloader, EFire_List, genExport_main, gui, List_Order, List_Review, List_User, Login, Main, Navigation, News_main, News_Text, Newsletter_main, Newsletter_plain, Newsletter_preview, Newsletter_selection, Newsletter_send, Object_Seo, Order_address, Order_article, Order_list, Order_main, Order_overview, Order_package, Order_remark, oxAdminDetails, oxAdminList, oxAdminView, oxChangeView, Payment_country, Payment_main, Payment_overview, pricealarm_list, pricealarm_mail, pricealarm_main, pricealarm_send, Selectlist_main, Shop, Shop_config, Shop_list, Shop_main, Shop_seo, Shop_system, Statistic_main, Statistic_service, Systeminfo, Tools, tools_main, User_address, User_article, User_extend, User_main, User_overview, User_payment, User_remark, Usergroup_list, Usergroup_main, Vendor_main, Vendor_Seo, Voucherserie_export, Voucherserie_groups, voucherserie_main, Wrapping_list, Wrapping_main, account, account_newsletter, account_noticelist, account_order, account_password, account_recommlist, account_user, account_wishlist, aList, Basket, Compare, Contact, Content, Details, ForgotPwd, GuestBook, Help, Info, Links, moreDetails, News, Newsletter, order, oxcmp_basket, oxcmp_categories, oxcmp_cur, oxcmp_lang, oxcmp_news, oxcmp_shop, oxcmp_user, oxcmp_utils, oxStart, oxUBase, Payment, Pricealarm, RecommAdd, RecommList, Review, rss, search, Start, Suggest, Tag, Tags, Thankyou, Tpl, User, vendorlist, wishlist, and Wrapping.
| oxView.addGlobalParams | ( | $ | oShop = null |
) |
Sets and caches default parameters for shop object and returns it.
Template variables: isdemoversion, shop, isdemoversion, version, iShopID_TrustedShops, iShopID_etracker, urlsign
- Parameters:
-
oxShop $oShop current shop object
- Returns:
- object $oShop current shop object
Reimplemented in oxAdminView.
| oxView.addRssFeed | ( | $ | sTitle, | |
| $ | sUrl, | |||
| $ | key = null | |||
| ) |
| oxView.addTplParam | ( | $ | sPara, | |
| $ | sValue | |||
| ) |
Sets value to parameter used by template engine.
- Parameters:
-
string $sPara name of parameter to pass string $sValue value of parameter
- Returns:
- null
| oxView.prepareSortColumns | ( | ) |
Retrieves from session or gets new sorting parameters for search and category lists. Sets new sorting parameters (reverse or new column sort) to session.
Template variables: showsorting, listorderby, listorder, allsortcolumns
Session variables: listorderby, listorder
- Returns:
- null
Reimplemented in GuestBook.
| oxView._setAdditionalParams | ( | ) | [protected] |
Sets additional parameters: cl, searchparam, searchcnid, searchvendor, cnid.
Template variables: additionalparams
- Returns:
- null
| oxView.getViewConfig | ( | ) |
Returns view config object
- Returns:
- oxviewconfig
| oxView._setNrOfArtPerPage | ( | ) | [protected] |
Sets number of articles per page to config value
- Returns:
- null
| oxView._getSeoObjectId | ( | ) | [protected] |
Override this function to return object it which is used to identify its seo meta info
- Returns:
- null
Reimplemented in aList, Content, Details, Tag, and vendorlist.
| oxView.setMetaDescription | ( | $ | aInput, | |
| $ | iLength = 1024, |
|||
| $ | blDescTag = false | |||
| ) |
Sets the view parameter "meta_description"
- Parameters:
-
mixed $aInput array of strings or string int $iLength max length of result, -1 for no truncation bool $blDescTag if true - performs additional dublicate cleaning
- Returns:
- null
Reimplemented in Start.
| oxView._prepareMetaDescription | ( | $ | aInput, | |
| $ | iLength = 1024, |
|||
| $ | blDescTag = false | |||
| ) | [protected] |
Metatags - description and keywords - generator for search engines. Uses string passed by parameters, cleans HTML tags, string dublicates, special chars. Also removes strings defined in $myConfig->aSkipTags (Admin area).
- Parameters:
-
mixed $aInput array of strings or string int $iLength max length of result, -1 for no truncation bool $blDescTag if true - performs additional dublicate cleaning
- Returns:
- string $sString converted string
Reimplemented in aList, Tag, and vendorlist.
| oxView.setMetaKeywords | ( | $ | aInput | ) |
Sets the view parameter 'meta_keywords'
- Parameters:
-
mixed $aInput array of strings or string
- Returns:
- null
Reimplemented in Start.
| oxView._prepareMetaKeyword | ( | $ | aInput | ) | [protected] |
creates a stirng of keyword filtered by the function prepareMetaDescription and without any duplicates additional the admin defined strings are removed
- Parameters:
-
mixed $aInput array of strings or string
- Returns:
- string of keywords seperated by comma
Reimplemented in aList, Tag, and vendorlist.
| oxView._removeDuplicatedWords | ( | $ | aInput | ) | [protected] |
Removes duplicated words (not case sensitive)
- Parameters:
-
mixed $aInput array of string or string
- Returns:
- string of words seperated by comma
| oxView._setNavigationParams | ( | ) | [protected] |
Formats url/form navigation parameters
- Returns:
- array navigation strings for url and form
| oxView._getNavigationParams | ( | ) | [protected] |
Returns array of params => values which are used in hidden forms and as additional url params
- Returns:
- array
Reimplemented in RecommList.
| oxView.getListType | ( | ) |
| oxView.setListType | ( | $ | sType | ) |
List type setter
- Parameters:
-
string $sType type of list
- Returns:
- null
| oxView.getCategoryId | ( | ) |
Get category ID
- Returns:
- string $sListType
| oxView.setCategoryId | ( | $ | sCategoryId | ) |
| oxView.getTemplateName | ( | ) |
| oxView.setClassName | ( | $ | sClassName | ) |
Current view class name setter.
- Parameters:
-
string $sClassName current view class name
- Returns:
- null
| oxView.getClassName | ( | ) |
Returns class name of current class
- Returns:
- string
| oxView.setFncName | ( | $ | sFncName | ) |
Set current view action function name
- Parameters:
-
string $sFncName action function name
- Returns:
- null
| oxView.getFncName | ( | ) |
Returns name of current action function
- Returns:
- string
| oxView.setComponents | ( | $ | aComponents = null |
) |
Set array of component objects
- Parameters:
-
array $aComponents array of components objects
- Returns:
- null
| oxView.getComponents | ( | ) |
Get array of component objects
- Returns:
- array
| oxView.setViewData | ( | $ | aViewData = null |
) |
Set array of data that is passed to template engine - array( "varName" => "varValue")
- Parameters:
-
array $aViewData array of data that is passed to template engine
- Returns:
- null
| oxView.getViewData | ( | ) |
Get view data
- Returns:
- array
| oxView.getViewDataElement | ( | $ | sParamId = null |
) |
Get view data single array element
- Parameters:
-
string $sParamId view data array key
- Returns:
- mixed
| oxView.setClassLocation | ( | $ | sClassLocation = null |
) |
Set location of a executed class file
- Parameters:
-
string $sClassLocation location of a executed class file
- Returns:
- null
| oxView.getClassLocation | ( | ) |
Get location of a executed class file
- Returns:
- string
| oxView.setThisAction | ( | $ | sThisAction = null |
) |
Set name of running class method
- Parameters:
-
string $sThisAction name of running class method
- Returns:
- null
| oxView.getThisAction | ( | ) |
Get name of running class method
- Returns:
- string
| oxView.setParent | ( | $ | oParent = null |
) |
Set parent object. If this is a component we will have our parent view here.
- Parameters:
-
object $oParent parent object
- Returns:
- null
| oxView.getParent | ( | ) |
Get parent object
- Returns:
- null
| oxView.setIsOrderStep | ( | $ | blIsOrderStep = null |
) |
| oxView.getIsOrderStep | ( | ) |
| oxView.setIsComponent | ( | $ | blIsComponent = null |
) |
Set flag if this object is a component or not
- Parameters:
-
bool $blIsComponent flag if this object is a component
- Returns:
- null
| oxView.getIsComponent | ( | ) |
Get flag if this objcet is a component
- Returns:
- bool
| oxView.setItemSorting | ( | $ | sCnid, | |
| $ | sSortBy, | |||
| $ | sSortDir = null | |||
| ) |
Sets sorting item config
- Parameters:
-
string $sCnid sortable item id string $sSortBy sort field string $sSortDir sort direction (optional)
- Returns:
- null
Reimplemented in search, Tag, and vendorlist.
| oxView.getSorting | ( | $ | sCnid | ) |
Returns sorting config for current item
- Parameters:
-
string $sCnid sortable item id
- Returns:
- string
Reimplemented in aList, search, Tag, and vendorlist.
| oxView.getSortingSql | ( | $ | sCnid | ) |
Returns part of SQL query with sorting params
- Parameters:
-
string $sCnid sortable item id
- Returns:
- string
| oxView.setIsCallForCache | ( | $ | blIsCallForCache = null |
) |
Set cache sign to enable/disable use of cache
- Parameters:
-
bool $blIsCallForCache cache sign to enable/disable use of cache
- Returns:
- null
| oxView.getIsCallForCache | ( | ) |
Get cache sign to enable/disable use of cache
- Returns:
- bool
| oxView.executeFunction | ( | $ | sFunction | ) |
Executes method (creates class and then executes). Returns executed function result.
- Parameters:
-
string $sFunction name of function to execute
- Exceptions:
-
oxSystemComponentException system component exception
- Returns:
- mixed
| oxView._executeNewAction | ( | $ | sNewAction | ) | [protected] |
Formats header for new controller action
Input example: "[component_name@]view_name[/function_name]?param1=val1¶m2=val2" Parameters in [] are optional.
- Parameters:
-
string $sNewAction new action params
- Returns:
- string
| oxView.getAdditionalParams | ( | ) |
Template variable getter. Returns additional params for url
- Returns:
- string
| oxView.noIndex | ( | ) |
Marks that current view is marked as noindex, nofollow and article details links must contain nofollow tags
- Returns:
- int
Reimplemented in Details.
| oxView.getTitleSuffix | ( | ) |
Returns title suffix used in template
- Returns:
- string
Reimplemented in aList, Start, Tags, and vendorlist.
| oxView.getTitlePrefix | ( | ) |
Returns title prefix used in template
- Returns:
- string
| oxView.getSubject | ( | ) | [protected] |
| oxView.getDynUrlParams | ( | ) |
returns additional url params for dynamic url building
- Returns:
- string
| oxView.getLink | ( | $ | iLang = null |
) |
get link of current view
- Parameters:
-
int $iLang requested language
- Returns:
- string
Reimplemented in oxUBase.
| oxView.getSimilarRecommLists | ( | ) |
Returns similar recommendation list So far this method is implemented in Details (details.php) view.
- Returns:
- null
Reimplemented in account_noticelist, account_wishlist, aList, Basket, Compare, Details, RecommList, and search.
| oxView._getRequestParams | ( | $ | blAddPageNr = true |
) | [protected] |
collects _GET parameters used by eShop and returns uri
- Parameters:
-
bool $blAddPageNr
- Returns:
- string
| oxView._getSeoRequestParams | ( | ) | [protected] |
collects _GET parameters used by eShop SEO and returns uri
- Returns:
- string
| oxView.showRightBasket | ( | ) |
Returns show right basket
- Returns:
- bool
| oxView.setShowRightBasket | ( | $ | blShowBasket | ) |
Returns show right basket
- Parameters:
-
bool $blShowBasket
- Returns:
- null
| oxView.showLeftBasket | ( | ) |
Returns show left basket
- Returns:
- bool
| oxView.setShowLeftBasket | ( | $ | blShowBasket | ) |
Returns show left basket
- Parameters:
-
bool $blShowBasket
- Returns:
- null
| oxView.showTopBasket | ( | ) |
Returns show top basket
- Returns:
- bool
| oxView.setShowTopBasket | ( | $ | blShowBasket | ) |
Returns show top basket
- Parameters:
-
bool $blShowBasket
- Returns:
- null
| oxView.loadCurrency | ( | ) |
Returns currency swiching option
- Returns:
- bool
| oxView.loadVendorTree | ( | ) |
Returns if show/hide vendors
- Returns:
- bool
| oxView.dontShowEmptyCategories | ( | ) |
Returns true if empty categories are not loaded
- Returns:
- bool
| oxView.getTrustedShopId | ( | ) |
Returns shop id in trusted shops
- Returns:
- string
| oxView.getEtrackerShopId | ( | ) |
Returns shop id in etracker
- Returns:
- string
| oxView.isLanguageLoaded | ( | ) |
Returns if language should be loaded
- Returns:
- bool
| oxView.showTopCatNavigation | ( | ) |
Returns show/hide top navigation of categories
- Returns:
- bool
| oxView.getTopNavigationCatCnt | ( | ) |
Returns item count in top navigation of categories
- Returns:
- integer
| oxView.getCharSet | ( | ) |
Returns active charset
- Returns:
- string
| oxView.getShopVersion | ( | ) |
Returns shop version
- Returns:
- string
| oxView.getShopEdition | ( | ) |
Returns shop edition
- Returns:
- string
| oxView.getShopFullEdition | ( | ) |
Returns shop full edition
- Returns:
- string
| oxView.isDemoVersion | ( | ) |
Returns if current shop is demoshop
- Returns:
- string
| oxView.getRssLinks | ( | ) |
Returns RSS links
- Returns:
- array
| oxView.isSortingActive | ( | ) |
Returns if sorting is active and can be displayed
- Returns:
- bool
| oxView.getSortColumns | ( | ) |
| oxView.getListOrderBy | ( | ) |
Template variable getter. Returns string after the list is ordered by
- Returns:
- array
| oxView.getListOrderDirection | ( | ) |
| oxView.getMetaDescription | ( | ) |
Template variable getter. Returns meta description
- Returns:
- string
| oxView.getMetaKeywords | ( | ) |
Template variable getter. Returns meta keywords
- Returns:
- string
| oxView.getActCurrency | ( | ) |
Get active language
- Returns:
- object
| oxView.setActCurrency | ( | $ | oCur | ) |
Active language setter
- Parameters:
-
object $oCur
- Returns:
- object
| oxView.getCompareItemsCnt | ( | ) |
Template variable getter. Returns article list count in comparison
- Returns:
- integer
Reimplemented in Compare.
| oxView.setCompareItemsCnt | ( | $ | iCount | ) |
Articlelist count in comparison setter
- Parameters:
-
integer $iCount
- Returns:
- integer
| oxView.getWishlistName | ( | ) |
| oxView.setWishlistName | ( | $ | sName | ) |
| oxView.getMenueList | ( | ) |
Template variable getter. Returns header menue list
- Returns:
- array
| oxView.setMenueList | ( | $ | aMenue | ) |
Header menue list setter
- Parameters:
-
array $aMenue
- Returns:
- null
| oxView.getEditTags | ( | ) |
| oxView.getRecommSearch | ( | ) |
| oxView.getReviewUserId | ( | ) |
| oxView.getPaymentList | ( | ) |
| oxView.getActiveRecommList | ( | ) |
Template variable getter. Returns active recommendation lists
- Returns:
- string
Reimplemented in account_recommlist, RecommList, and Review.
| oxView.getAccessoires | ( | ) |
| oxView.getCrossSelling | ( | ) |
| oxView.getSimilarProducts | ( | ) |
Template variable getter. Returns similar article list
- Returns:
- object
Reimplemented in account_noticelist, Details, Review, and Suggest.
| oxView.getAlsoBoughtThiesProducts | ( | ) |
| oxView.getArticleId | ( | ) |
| oxView.setActiveCategory | ( | $ | oCategory | ) |
Active category setter
- Parameters:
-
oxcategory $oCategory active category
- Returns:
- null
| oxView.getActiveCategory | ( | ) |
Active category setter
- Parameters:
-
oxcategory $oCategory active category
- Returns:
- null
Reimplemented in aList, search, Tag, and vendorlist.
| oxView.isMoreTagsVisible | ( | ) |
| oxView.getTitle | ( | ) |
Returns current view title. Default is null
- Returns:
- null
Reimplemented in aList, Details, Tag, and vendorlist.
| oxView.showNewsletter | ( | ) |
Template variable getter. Returns if newsletter can be displayed (for _right.tpl)
- Returns:
- integer
| oxView.setShowNewsletter | ( | $ | blShow | ) |
Sets if to show newsletter
- Parameters:
-
bool $blShow
- Returns:
- null
| oxView.getShopLogo | ( | ) |
Template variable getter. Returns shop logo
- Returns:
- string
| oxView.setShopLogo | ( | $ | sLogo | ) |
Sets shop logo
- Parameters:
-
string $sLogo
- Returns:
- null
Member Data Documentation
oxView.$_oaComponents = array() [protected] |
oxView.$_aViewData = array() [protected] |
oxView.$_sClassLocation = null [protected] |
oxView.$_sThisAction = null [protected] |
oxView.$_oParent = null [protected] |
Reimplemented in Details.
oxView.$_blIsComponent = false [protected] |
Reimplemented in oxcmp_basket, oxcmp_categories, oxcmp_cur, oxcmp_lang, oxcmp_news, oxcmp_shop, oxcmp_user, and oxcmp_utils.
oxView.$_oActCategory = null [protected] |
oxView.$_oActVendor = null [protected] |
oxView.$_oActSearch = null [protected] |
oxView.$_sThisTemplate = null [protected] |
Reimplemented in Actions, Actions_list, Admin_Content, Admin_guestbook, Admin_links, Admin_News, Admin_newsletter, Admin_Order, Admin_Payment, admin_pricealarm, Admin_Start, Admin_User, Admin_Wrapping, AdminGuestbook_list, Adminlinks_list, Article, Attribute, Attribute_list, Category, Country, Delivery, Delivery_list, DeliverySet, deliveryset_list, Discount, Discount_list, DynExportBase, dynscreen, dynscreen_local, Efire, efire_downloader, genExport_do, genExport_main, News_list, Newsletter_list, oxAdminView, oxChangeView, Payment_list, Selectlist, Selectlist_list, Shop_config, Shop_Performance, Shop_system, Statistic, Statistic_list, Tools_list, User_list, Usergroup, Vendor, Vendor_list, VoucherSerie, VoucherSerie_list, account, account_newsletter, account_noticelist, account_order, account_password, account_recommlist, account_user, account_wishlist, aList, Basket, Compare, Contact, Content, Details, ForgotPwd, GuestBook, Help, Links, moreDetails, News, Newsletter, order, Payment, Pricealarm, RecommAdd, RecommList, Review, rss, search, Start, Suggest, Tags, Thankyou, User, wishlist, and Wrapping.
oxView.$_aComponentNames = array() [protected] |
Reimplemented in oxUBase.
oxView.$_blIsCallForCache = false [protected] |
oxView.$_sViewId = null [protected] |
oxView.$_sListType = null [protected] |
Reimplemented in Article_list, Category_list, Content_list, Delivery_list, deliveryset_list, Discount_list, News_list, oxAdminList, User_list, account, RecommList, search, Tag, and vendorlist.
oxView.$_sCategoryId = null [protected] |
oxView.$_sClass = null [protected] |
oxView.$_sFnc = null [protected] |
oxView.$_blExecuted = false [static, protected] |
oxView.$_oClickCat = null [protected] |
oxView.$_sAdditionalParams = null [protected] |
oxView.$_blShowSorting = false [protected] |
oxView.$_blShowRightBasket = null [protected] |
oxView.$_blShowLeftBasket = null [protected] |
oxView.$_blShowTopBasket = null [protected] |
oxView.$_blLoadCurrency = null [protected] |
oxView.$_blLoadVendorTree = null [protected] |
oxView.$_blDontShowEmptyCats = null [protected] |
oxView.$_sTrustedShopId = null [protected] |
oxView.$_sEtrackerShopId = null [protected] |
oxView.$_blLoadLanguage = null [protected] |
oxView.$_blShowTopCatNav = null [protected] |
oxView.$_iTopCatNavItmCnt = null [protected] |
oxView.$_sCharSet = null [protected] |
oxView.$_sVersion = null [protected] |
oxView.$_blDemoVersion = null [protected] |
oxView.$_aRssLinks = null [protected] |
oxView.$_blActiveSorting = null [protected] |
oxView.$_sListOrderBy = null [protected] |
oxView.$_sListOrderDir = null [protected] |
oxView.$_sMetaDescription = null [protected] |
oxView.$_sMetaKeywords = null [protected] |
oxView.$_oActCurrency = null [protected] |
oxView.$_iCompItemsCnt = null [protected] |
Reimplemented in Compare.
oxView.$_sWishlistName = null [protected] |
oxView.$_aMenueList = null [protected] |
oxView.$_iViewIndexState = 0 [protected] |
Current view search engine indexing state: 0 - index without limitations 1 - no index / no follow 2 - no index / follow
Reimplemented in account, account_noticelist, account_wishlist, Basket, Contact, ForgotPwd, GuestBook, Help, Info, moreDetails, Newsletter, Review, search, and vendorlist.
oxView.$_iNewsStatus = null [protected] |
oxView.$_sShopLogo = null [protected] |
The documentation for this class was generated from the following file:
- views/oxview.php
