oxUBase Class Reference

Inheritance diagram for oxUBase:

Inheritance graph
[legend]
Collaboration diagram for oxUBase:

Collaboration graph
[legend]

List of all members.

Detailed Description

Base view class. Class is responsible for managing of components that must be loaded and executed before any regular operation.

Definition at line 18 of file oxubase.php.


Public Member Functions

 init ()
 getViewId ()
 showSorting ()
 setComponents ($aComponents=null)
 getComponents ()
 setIsOrderStep ($blIsOrderStep=null)
 getIsOrderStep ()
 setActiveCategory ($oCategory)
 getActiveCategory ()
 setIsCallForCache ($blIsCallForCache=null)
 getIsCallForCache ()
 getListType ()
 setListType ($sType)
 getCategoryId ()
 setCategoryId ($sCategoryId)
 showRightBasket ()
 setShowRightBasket ($blShowBasket)
 showLeftBasket ()
 setShowLeftBasket ($blShowBasket)
 showTopBasket ()
 setShowTopBasket ($blShowBasket)
 loadCurrency ()
 loadVendorTree ()
 loadManufacturerTree ()
 dontShowEmptyCategories ()
 isLanguageLoaded ()
 showTopCatNavigation ()
 getTopNavigationCatCnt ()
 addRssFeed ($sTitle, $sUrl, $key=null)
 prepareSortColumns ()
 getListOrderBy ()
 getListOrderDirection ()
 setMetaDescription ($sDescription)
 setMetaKeywords ($sKeywords)
 getMetaKeywords ()
 getMetaDescription ()
 getActCurrency ()
 setActCurrency ($oCur)
 getCompareItemsCnt ()
 setCompareItemsCnt ($iCount)
 getWishlistName ()
 setWishlistName ($sName)
 noIndex ()
 getContentId ()
 getContent ()
 isSortingActive ()
 getMenueList ()
 setMenueList ($aMenue)
 getNavigationParams ()
 setItemSorting ($sCnid, $sSortBy, $sSortDir=null)
 getSorting ($sCnid)
 getSortingSql ($sCnid)
 getTitleSuffix ()
 getTitlePrefix ()
 getDynUrlParams ()
 getLink ($iLang=null)
 getSimilarRecommLists ()
 showSearch ()
 getRssLinks ()
 getSortColumns ()
 getEditTags ()
 getRecommSearch ()
 getReviewUserId ()
 getPaymentList ()
 getActiveRecommList ()
 getAccessoires ()
 getCrossSelling ()
 getSimilarProducts ()
 getAlsoBoughtThiesProducts ()
 getArticleId ()
 isMoreTagsVisible ()
 getTitle ()
 getActiveLangAbbr ()
 addGlobalParams ($oShop=null)
 getAdditionalParams ()
 generatePageNavigationUrl ()
 generatePageNavigation ()
 prepareMinimumOrderPrice4View ()
 render ()
 getViewProduct ()
 setViewProduct ($oProduct)
 getViewProductList ()
 getActPage ()
 getActCategory ()
 setActCategory ($oCategory)
 getActTag ()
 getActVendor ()
 getActManufacturer ()
 setActVendor ($oVendor)
 setActManufacturer ($oManufacturer)
 getActSearch ()
 getActRecommList ()
 getCategoryTree ()
 setCategoryTree ($oCatTree)
 getVendorTree ()
 setVendorTree ($oVendorTree)
 getManufacturerTree ()
 setManufacturerTree ($oManufacturerTree)
 setSessionCategoryId ($sCategoryId)
 getSessionCategoryId ()
 getAddUrlParams ()
 getTop5ArticleList ()
 getBargainArticleList ()
 isLowOrderPrice ()
 getMinOrderPrice ()
 getNewsRealStatus ()
 getProduct ()
 getVendorlist ()
 setVendorlist ($aList)
 getManufacturerlist ()
 setManufacturerlist ($aList)
 setRootVendor ($oVendor)
 getRootVendor ()
 setRootManufacturer ($oManufacturer)
 getRootManufacturer ()
 getVendorId ()
 getManufacturerId ()
 getSearchCatTree ()
 setSearchCatTree ($aTree)
 getCatMore ()
 setCatMore ($oCat)
 isNewsSubscribed ()
 setNewsSubscribed ($blNewsSubscribed)
 showShipAddress ()
 setShowShipAddress ($blShowShipAddress)
 getDelAddress ()
 setDelAddress ($oDelAddress)
 getCatTreePath ()
 getContentByIdent ($sIdent)
 getContentCategory ()

Protected Member Functions

 _processRequest ()
 _forceNoIndex ()
 _setNrOfArtPerPage ()
 _getSeoObjectId ()
 _prepareMetaDescription ($sMeta, $iLength=1024, $blDescTag=false)
 _prepareMetaKeyword ($sKeywords)
 _removeDuplicatedWords ($aInput)
 _getSubject ()
 _getRequestParams ($blAddPageNr=true)
 _getSeoRequestParams ()
 _setListType ()
 _addPageNrParam ($sUrl, $iPage, $iLang=null)
 _loadActions ()
 _processListArticles ()
 _canRedirect ()

Protected Attributes

 $_oaComponents = array()
 $_blIsCallForCache = false
 $_blIsOrderStep = false
 $_sListType = null
 $_oActCategory = null
 $_oClickCat = null
 $_sCategoryId = null
 $_oActManufacturer = null
 $_oActVendor = null
 $_oActSearch = null
 $_blShowSorting = false
 $_blShowRightBasket = null
 $_blShowTopBasket = null
 $_blShowLeftBasket = null
 $_blLoadCurrency = null
 $_blLoadVendorTree = null
 $_blLoadManufacturerTree = null
 $_blDontShowEmptyCats = null
 $_blLoadLanguage = null
 $_blShowTopCatNav = null
 $_iTopCatNavItmCnt = null
 $_aRssLinks = null
 $_sListOrderBy = null
 $_sListOrderDir = null
 $_sMetaDescription = null
 $_sMetaKeywords = null
 $_sMetaDescriptionIdent = null
 $_sMetaKeywordsIdent = null
 $_sAdditionalParams = null
 $_oActCurrency = null
 $_blCommonAdded = false
 $_iViewIndexState = VIEW_INDEXSTATE_INDEX
 $_blForceNoIndex = false
 $_sWishlistName = null
 $_iCompItemsCnt = null
 $_sContentId = null
 $_oContent = null
 $_sViewResetID = null
 $_blActiveSorting = null
 $_aMenueList = null
 $_aComponentNames
 $_aUserComponentNames = array()
 $_oProduct = null
 $_iActPage = null
 $_aArticleList = null
 $_oVendorTree = null
 $_oManufacturerTree = null
 $_oCategoryTree = null
 $_aTop5ArticleList = null
 $_aBargainArticleList = null
 $_iLowOrderPrice = null
 $_sMinOrderPrice = null
 $_iNewsRealStatus = null
 $_aBlockRedirectParams = array( 'fnc' )
 $_aVendorlist = null
 $_oRootVendor = null
 $_sVendorId = null
 $_aManufacturerlist = null
 $_oRootManufacturer = null
 $_sManufacturerId = null
 $_aSearchCatTree = null
 $_oCatMore = null
 $_blNewsSubscribed = null
 $_blShowShipAddress = null
 $_oDelAddress = null
 $_sCatTreePath = null
 $_aContents = array()
 $_blTop5Action = false
 $_blBargainAction = false

Member Function Documentation

oxUBase._processRequest (  )  [protected]

In non admin mode checks if request was NOT processed by seo handler. If NOT, then tries to load alternative SEO url and if url is available - redirects to it. If no alternative path was found - 404 header is emitted and page is rendered

Returns:
null

Definition at line 474 of file oxubase.php.

oxUBase.init (  ) 

Calls self._processRequest(), initializes components which needs to be loaded, sets current list type, calls parent.init()

Returns:
null

Reimplemented from oxView.

Reimplemented in Content, Details, Order, Payment, Review, Rss, Search, Start, Tag, and Thankyou.

Definition at line 506 of file oxubase.php.

oxUBase.getViewId (  ) 

If current view ID is not set - forms and returns view ID according to language and currency.

Returns:
string $this->_sViewId

Reimplemented from oxView.

Reimplemented in aList, Content, and Details.

Definition at line 567 of file oxubase.php.

oxUBase.showSorting (  ) 

Template variable getter. Returns true if sorting is on

Returns:
bool

Definition at line 588 of file oxubase.php.

oxUBase.setComponents ( $  aComponents = null  ) 

Set array of component objects

Parameters:
array $aComponents array of components objects
Returns:
null

Definition at line 600 of file oxubase.php.

oxUBase.getComponents (  ) 

Get array of component objects

Returns:
array

Definition at line 610 of file oxubase.php.

oxUBase.setIsOrderStep ( $  blIsOrderStep = null  ) 

Set flag if current view is an order view

Parameters:
bool $blIsOrderStep flag if current view is an order view
Returns:
null

Definition at line 622 of file oxubase.php.

oxUBase.getIsOrderStep (  ) 

Get flag if current view is an order view

Returns:
bool

Definition at line 632 of file oxubase.php.

oxUBase.setActiveCategory ( $  oCategory  ) 

Active category setter

Parameters:
oxcategory $oCategory active category
Returns:
null

Definition at line 645 of file oxubase.php.

oxUBase.getActiveCategory (  ) 

Returns active category

Returns:
null

Reimplemented in aList, ManufacturerList, Search, Tag, and VendorList.

Definition at line 655 of file oxubase.php.

oxUBase.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

Definition at line 667 of file oxubase.php.

oxUBase.getIsCallForCache (  ) 

Get cache sign to enable/disable use of cache

Returns:
bool

Definition at line 677 of file oxubase.php.

oxUBase.getListType (  ) 

Get list type

Returns:
string list type

Reimplemented in Account.

Definition at line 687 of file oxubase.php.

oxUBase.setListType ( $  sType  ) 

List type setter

Parameters:
string $sType type of list
Returns:
null

Definition at line 702 of file oxubase.php.

oxUBase.getCategoryId (  ) 

Get category ID

Returns:
string

Definition at line 712 of file oxubase.php.

oxUBase.setCategoryId ( $  sCategoryId  ) 

Category ID setter

Parameters:
string $sCategoryId Id of category to cache
Returns:
null

Definition at line 728 of file oxubase.php.

oxUBase.showRightBasket (  ) 

Returns show right basket

Returns:
bool

Definition at line 739 of file oxubase.php.

oxUBase.setShowRightBasket ( $  blShowBasket  ) 

Returns show right basket

Parameters:
bool $blShowBasket if TRUE - right basket will be shown
Returns:
null

Definition at line 756 of file oxubase.php.

oxUBase.showLeftBasket (  ) 

Returns show left basket

Returns:
bool

Definition at line 766 of file oxubase.php.

oxUBase.setShowLeftBasket ( $  blShowBasket  ) 

Returns show left basket

Parameters:
bool $blShowBasket if TRUE - left basket will be shown
Returns:
null

Definition at line 783 of file oxubase.php.

oxUBase.showTopBasket (  ) 

Returns show top basket

Returns:
bool

Definition at line 793 of file oxubase.php.

oxUBase.setShowTopBasket ( $  blShowBasket  ) 

Returns show top basket

Parameters:
bool $blShowBasket if TRUE - basket will be shown
Returns:
null

Definition at line 810 of file oxubase.php.

oxUBase.loadCurrency (  ) 

Returns currency swiching option

Returns:
bool

Definition at line 820 of file oxubase.php.

oxUBase.loadVendorTree (  ) 

Returns if show/hide vendors

Returns:
bool

Definition at line 836 of file oxubase.php.

oxUBase.loadManufacturerTree (  ) 

Returns if show/hide Manufacturers

Returns:
bool

Definition at line 852 of file oxubase.php.

oxUBase.dontShowEmptyCategories (  ) 

Returns true if empty categories are not loaded

Returns:
bool

Definition at line 868 of file oxubase.php.

oxUBase.isLanguageLoaded (  ) 

Returns if language should be loaded

Returns:
bool

Definition at line 884 of file oxubase.php.

oxUBase.showTopCatNavigation (  ) 

Returns show/hide top navigation of categories

Returns:
bool

Definition at line 900 of file oxubase.php.

oxUBase.getTopNavigationCatCnt (  ) 

Returns item count in top navigation of categories

Returns:
integer

Definition at line 916 of file oxubase.php.

oxUBase.addRssFeed ( $  sTitle,
$  sUrl,
$  key = null 
)

addRssFeed adds link to rss

Parameters:
string $sTitle feed page title
string $sUrl feed url
int $key feed number
Returns:
null

Definition at line 934 of file oxubase.php.

oxUBase.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.

Definition at line 962 of file oxubase.php.

oxUBase.getListOrderBy (  ) 

Template variable getter. Returns string after the list is ordered by

Returns:
array

Definition at line 997 of file oxubase.php.

oxUBase.getListOrderDirection (  ) 

Template variable getter. Returns list order direction

Returns:
array

Definition at line 1007 of file oxubase.php.

oxUBase.setMetaDescription ( $  sDescription  ) 

Sets the view parameter "meta_description"

Parameters:
string $sDescription prepared string for description
Returns:
null

Definition at line 1019 of file oxubase.php.

oxUBase.setMetaKeywords ( $  sKeywords  ) 

Sets the view parameter 'meta_keywords'

Parameters:
string $sKeywords prepared string for meta keywords
Returns:
null

Definition at line 1031 of file oxubase.php.

oxUBase.getMetaKeywords (  ) 

Template variable getter. Returns meta keywords

Returns:
string

Definition at line 1041 of file oxubase.php.

oxUBase.getMetaDescription (  ) 

Template variable getter. Returns meta description

Returns:
string

Definition at line 1065 of file oxubase.php.

oxUBase.getActCurrency (  ) 

Get active language

Returns:
object

Definition at line 1089 of file oxubase.php.

oxUBase.setActCurrency ( $  oCur  ) 

Active language setter

Parameters:
object $oCur corrency object
Returns:
object

Definition at line 1101 of file oxubase.php.

oxUBase.getCompareItemsCnt (  ) 

Template variable getter. Returns article list count in comparison

Returns:
integer

Reimplemented in Compare.

Definition at line 1111 of file oxubase.php.

oxUBase.setCompareItemsCnt ( $  iCount  ) 

Articlelist count in comparison setter

Parameters:
integer $iCount compare items count
Returns:
integer

Definition at line 1123 of file oxubase.php.

oxUBase.getWishlistName (  ) 

Template variable getter. Returns user name of searched wishlist

Returns:
string

Definition at line 1133 of file oxubase.php.

oxUBase.setWishlistName ( $  sName  ) 

Sets user name of searched wishlist

Parameters:
string $sName wishlist name
Returns:
null

Definition at line 1145 of file oxubase.php.

oxUBase._forceNoIndex (  )  [protected]

Forces output noindex meta data for current view

Returns:
null

Definition at line 1155 of file oxubase.php.

oxUBase.noIndex (  ) 

Marks that current view is marked as noindex, nofollow and article details links must contain nofollow tags

Returns:
int

Reimplemented in Details.

Definition at line 1166 of file oxubase.php.

oxUBase.getContentId (  ) 

Returns "impressum" content ID used by template engine. Used, when no content id specified in template

Returns:
string

Reimplemented in Content.

Definition at line 1189 of file oxubase.php.

oxUBase.getContent (  ) 

Returns "impressum" content as default content when no content id specified in template

Returns:
object

Reimplemented in Content.

Definition at line 1206 of file oxubase.php.

oxUBase.isSortingActive (  ) 

Returns if sorting is active and can be displayed

Returns:
bool

Definition at line 1223 of file oxubase.php.

oxUBase.getMenueList (  ) 

Template variable getter. Returns header menue list

Returns:
array

Definition at line 1233 of file oxubase.php.

oxUBase.setMenueList ( $  aMenue  ) 

Header menue list setter

Parameters:
array $aMenue menu list
Returns:
null

Definition at line 1245 of file oxubase.php.

oxUBase._setNrOfArtPerPage (  )  [protected]

Sets number of articles per page to config value

Returns:
null

Definition at line 1256 of file oxubase.php.

oxUBase._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, ManufacturerList, Tag, and VendorList.

Definition at line 1302 of file oxubase.php.

oxUBase._prepareMetaDescription ( $  sMeta,
$  iLength = 1024,
$  blDescTag = false 
) [protected]

Returns current view meta description data

Parameters:
string $sMeta category path
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, Content, Details, ManufacturerList, Start, Tag, and VendorList.

Definition at line 1315 of file oxubase.php.

oxUBase._prepareMetaKeyword ( $  sKeywords  )  [protected]

Returns current view keywords seperated by comma

Parameters:
string $sKeywords data to use as keywords
Returns:
string of keywords seperated by comma

Reimplemented in aList, Content, Details, ManufacturerList, Start, Tag, and VendorList.

Definition at line 1360 of file oxubase.php.

oxUBase._removeDuplicatedWords ( $  aInput  )  [protected]

Removes duplicated words (not case sensitive)

Parameters:
mixed $aInput array of string or string
Returns:
string of words seperated by comma

Definition at line 1385 of file oxubase.php.

oxUBase.getNavigationParams (  ) 

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 brokent templates problems

Returns:
array

Reimplemented in Account_Recommlist, and RecommList.

Definition at line 1413 of file oxubase.php.

oxUBase.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 ManufacturerList, Search, Tag, and VendorList.

Definition at line 1441 of file oxubase.php.

oxUBase.getSorting ( $  sCnid  ) 

Returns sorting config for current item

Parameters:
string $sCnid sortable item id
Returns:
string

Reimplemented in aList, ManufacturerList, Search, Tag, and VendorList.

Definition at line 1457 of file oxubase.php.

oxUBase.getSortingSql ( $  sCnid  ) 

Returns part of SQL query with sorting params

Parameters:
string $sCnid sortable item id
Returns:
string

Definition at line 1472 of file oxubase.php.

oxUBase.getTitleSuffix (  ) 

Returns title suffix used in template

Returns:
string

Reimplemented in aList, ManufacturerList, Start, Tags, and VendorList.

Definition at line 1485 of file oxubase.php.

oxUBase.getTitlePrefix (  ) 

Returns title prefix used in template

Returns:
string

Definition at line 1496 of file oxubase.php.

oxUBase._getSubject (  )  [protected]

returns object, assosiated with current view. (the object that is shown in frontend)

Returns:
object

Reimplemented in aList, Content, and Details.

Definition at line 1507 of file oxubase.php.

oxUBase.getDynUrlParams (  ) 

returns additional url params for dynamic url building

Returns:
string

Definition at line 1517 of file oxubase.php.

oxUBase.getLink ( $  iLang = null  ) 

get link of current view

Parameters:
int $iLang requested language
Returns:
string

Definition at line 1559 of file oxubase.php.

oxUBase.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.

Definition at line 1608 of file oxubase.php.

oxUBase._getRequestParams ( $  blAddPageNr = true  )  [protected]

collects _GET parameters used by eShop and returns uri

Parameters:
bool $blAddPageNr if TRUE - page number will be added
Returns:
string

Definition at line 1619 of file oxubase.php.

oxUBase._getSeoRequestParams (  )  [protected]

collects _GET parameters used by eShop SEO and returns uri

Returns:
string

Definition at line 1697 of file oxubase.php.

oxUBase.showSearch (  ) 

Returns show category search

Returns:
bool

Definition at line 1734 of file oxubase.php.

oxUBase.getRssLinks (  ) 

Returns RSS links

Returns:
array

Definition at line 1748 of file oxubase.php.

oxUBase.getSortColumns (  ) 

Template variable getter. Returns sorting columns

Returns:
array

Reimplemented in GuestBook.

Definition at line 1758 of file oxubase.php.

oxUBase.getEditTags (  ) 

Returns if tags will be edit

Returns:
bool

Reimplemented in Details.

Definition at line 1768 of file oxubase.php.

oxUBase.getRecommSearch (  ) 

Template variable getter. Returns search string

Returns:
string

Reimplemented in RecommList.

Definition at line 1777 of file oxubase.php.

oxUBase.getReviewUserId (  ) 

Template variable getter. Returns review user id

Returns:
string

Reimplemented in Review.

Definition at line 1786 of file oxubase.php.

oxUBase.getPaymentList (  ) 

Template variable getter. Returns payment id

Returns:
string

Reimplemented in Payment.

Definition at line 1795 of file oxubase.php.

oxUBase.getActiveRecommList (  ) 

Template variable getter. Returns active recommendation lists

Returns:
string

Reimplemented in Account_Recommlist, RecommList, and Review.

Definition at line 1804 of file oxubase.php.

oxUBase.getAccessoires (  ) 

Template variable getter. Returns accessoires of article

Returns:
object

Reimplemented in Details.

Definition at line 1813 of file oxubase.php.

oxUBase.getCrossSelling (  ) 

Template variable getter. Returns crosssellings

Returns:
object

Reimplemented in Details, Review, and Suggest.

Definition at line 1822 of file oxubase.php.

oxUBase.getSimilarProducts (  ) 

Template variable getter. Returns similar article list

Returns:
object

Reimplemented in Account_Noticelist, Details, Review, and Suggest.

Definition at line 1831 of file oxubase.php.

oxUBase.getAlsoBoughtThiesProducts (  ) 

Template variable getter. Returns list of customer also bought thies products

Returns:
object

Reimplemented in Details, and Thankyou.

Definition at line 1840 of file oxubase.php.

oxUBase.getArticleId (  ) 

Return the active article id

Returns:
string | bool

Reimplemented in Account.

Definition at line 1849 of file oxubase.php.

oxUBase.isMoreTagsVisible (  ) 

Should "More tags" link be visible.

Returns:
bool

Reimplemented in Start, and Tags.

Definition at line 1858 of file oxubase.php.

oxUBase.getTitle (  ) 

Returns current view title. Default is null

Returns:
null

Reimplemented in aList, Details, ManufacturerList, Tag, and VendorList.

Definition at line 1868 of file oxubase.php.

oxUBase.getActiveLangAbbr (  ) 

Returns active lang suffix

Returns:
string

Definition at line 1877 of file oxubase.php.

oxUBase.addGlobalParams ( $  oShop = null  ) 

Sets and caches default parameters for shop object and returns it.

Template variables: isdemoversion, shop, isdemoversion, version, iShopID_TrustedShops, urlsign

Parameters:
oxShop $oShop current shop object
Returns:
object $oShop current shop object

Reimplemented from oxView.

Definition at line 1910 of file oxubase.php.

oxUBase.getAdditionalParams (  ) 

Template variable getter. Returns additional params for url

Returns:
string

Reimplemented from oxView.

Reimplemented in RecommList, and Review.

Definition at line 1974 of file oxubase.php.

oxUBase._setListType (  )  [protected]

Sets active list type if it was not set by request

Returns:
null

Definition at line 2014 of file oxubase.php.

oxUBase.generatePageNavigationUrl (  ) 

Generates URL for page navigation

Returns:
string $sUrl String with working page url.

Reimplemented in aList, ManufacturerList, Tag, and VendorList.

Definition at line 2026 of file oxubase.php.

oxUBase._addPageNrParam ( $  sUrl,
$  iPage,
$  iLang = null 
) [protected]

Adds page number parameter to url and returns modified url

Parameters:
string $sUrl url to add page number
string $iPage active page number
int $iLang language id
Returns:
string

Reimplemented in aList, ManufacturerList, Tag, and VendorList.

Definition at line 2041 of file oxubase.php.

oxUBase.generatePageNavigation (  ) 

Generates variables for page navigation

Returns:
stdClass $pageNavigation Object with pagenavigation data

Reimplemented in Tag.

Definition at line 2054 of file oxubase.php.

oxUBase.prepareMinimumOrderPrice4View (  ) 

performs setup of aViewData according to iMinOrderPrice admin setting

Returns:
null

Definition at line 2100 of file oxubase.php.

oxUBase.render (  ) 

While ordering disables navigation controls if oxConfig.blDisableNavBars is on and executes parent.render()

Returns:
null

Reimplemented from oxView.

Reimplemented in 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, ManufacturerList, MoreDetails, News, Newsletter, Order, oxStart, Payment, Pricealarm, RecommAdd, RecommList, Register, Review, Rss, Search, Start, Suggest, Tag, Tags, Thankyou, Tpl, User, VendorList, Wishlist, and Wrapping.

Definition at line 2125 of file oxubase.php.

oxUBase.getViewProduct (  ) 

Returns current view product object (if it is loaded)

Returns:
oxarticle

Definition at line 2173 of file oxubase.php.

oxUBase.setViewProduct ( $  oProduct  ) 

Sets view product

Parameters:
oxarticle $oProduct view product object
Returns:
null

Definition at line 2185 of file oxubase.php.

oxUBase.getViewProductList (  ) 

Returns view product list

Returns:
array

Definition at line 2195 of file oxubase.php.

oxUBase.getActPage (  ) 

Active page getter

Returns:
int

Definition at line 2205 of file oxubase.php.

oxUBase.getActCategory (  ) 

Returns active category set by categories component; if category is not set by component - will create category object and will try to load by id passed by request

Returns:
oxcategory

Definition at line 2221 of file oxubase.php.

oxUBase.setActCategory ( $  oCategory  ) 

Active category setter

Parameters:
oxcategory $oCategory active category
Returns:
null

Definition at line 2245 of file oxubase.php.

oxUBase.getActTag (  ) 

Active tag info object getter. Object properties:

  • sTag current tag
  • link link leading to tag article list

Returns:
oxstdclass

Definition at line 2257 of file oxubase.php.

oxUBase.getActVendor (  ) 

Returns active vendor set by categories component; if vendor is not set by component - will create vendor object and will try to load by id passed by request

Returns:
oxvendor

Definition at line 2276 of file oxubase.php.

oxUBase.getActManufacturer (  ) 

Returns active Manufacturer set by categories component; if Manufacturer is not set by component - will create Manufacturer object and will try to load by id passed by request

Returns:
oxmanufacturer

Definition at line 2305 of file oxubase.php.

oxUBase.setActVendor ( $  oVendor  ) 

Active vendor setter

Parameters:
oxvendor $oVendor active vendor
Returns:
null

Definition at line 2334 of file oxubase.php.

oxUBase.setActManufacturer ( $  oManufacturer  ) 

Active Manufacturer setter

Parameters:
oxmanufacturer $oManufacturer active Manufacturer
Returns:
null

Definition at line 2346 of file oxubase.php.

oxUBase.getActSearch (  ) 

Returns fake object which is used to mount navigation info

Returns:
oxstdclass

Definition at line 2356 of file oxubase.php.

oxUBase.getActRecommList (  ) 

Returns active recommlist object which is used to mount navigation info

Returns:
object

Definition at line 2371 of file oxubase.php.

oxUBase.getCategoryTree (  ) 

Returns category tree (if it is loaded)

Returns:
oxcategorylist

Definition at line 2391 of file oxubase.php.

oxUBase.setCategoryTree ( $  oCatTree  ) 

Category list setter

Parameters:
oxcategorylist $oCatTree category tree
Returns:
null

Definition at line 2403 of file oxubase.php.

oxUBase.getVendorTree (  ) 

Returns vendor tree (if it is loaded0

Returns:
oxvendorlist

Definition at line 2413 of file oxubase.php.

oxUBase.setVendorTree ( $  oVendorTree  ) 

Vendor tree setter

Parameters:
oxvendorlist $oVendorTree vendor tree
Returns:
null

Definition at line 2425 of file oxubase.php.

oxUBase.getManufacturerTree (  ) 

Returns Manufacturer tree (if it is loaded0

Returns:
oxManufacturerlist

Definition at line 2435 of file oxubase.php.

oxUBase.setManufacturerTree ( $  oManufacturerTree  ) 

Manufacturer tree setter

Parameters:
oxManufacturerlist $oManufacturerTree Manufacturer tree
Returns:
null

Definition at line 2447 of file oxubase.php.

oxUBase._loadActions (  )  [protected]

Loads article actions: top articles, bargain - right side and top 5 articles

Template variables:

articlebargainlist, aTop5Articles

Returns:
null

Definition at line 2460 of file oxubase.php.

oxUBase.setSessionCategoryId ( $  sCategoryId  ) 

Active category id tracker used when SEO is on to track active category and keep correct navigation

Parameters:
string $sCategoryId active category Id
Returns:
null

Definition at line 2474 of file oxubase.php.

oxUBase.getSessionCategoryId (  ) 

Active category id getter

Returns:
string

Definition at line 2484 of file oxubase.php.

oxUBase._processListArticles (  )  [protected]

Iterates through list articles and performs list view specific tasks

Returns:
null

Reimplemented in ManufacturerList, RecommList, and VendorList.

Definition at line 2494 of file oxubase.php.

oxUBase.getAddUrlParams (  ) 

Returns additional URL paramerets which must be added to list products urls

Returns:
string

Reimplemented in RecommList, Search, and Tag.

Definition at line 2509 of file oxubase.php.

oxUBase.getTop5ArticleList (  ) 

Template variable getter. Returns Top 5 article list. Parameter oxubase::$_blTop5Action must be set to true.

Returns:
array

Reimplemented in aList.

Definition at line 2519 of file oxubase.php.

oxUBase.getBargainArticleList (  ) 

Template variable getter. Returns bargain article list Parameter oxubase::$_blBargainAction must be set to true.

Returns:
array

Reimplemented in aList.

Definition at line 2546 of file oxubase.php.

oxUBase.isLowOrderPrice (  ) 

Template variable getter. Returns if order price is to low

Returns:
integer

Definition at line 2570 of file oxubase.php.

oxUBase.getMinOrderPrice (  ) 

Template variable getter. Returns min order price

Returns:
string

Definition at line 2580 of file oxubase.php.

oxUBase.getNewsRealStatus (  ) 

Template variable getter. Returns if newsletter is realy active (for user.tpl)

Returns:
integer

Definition at line 2590 of file oxubase.php.

oxUBase._canRedirect (  )  [protected]

Checks if current request parameters does not block SEO redirection process

Returns:
bool

Definition at line 2600 of file oxubase.php.

oxUBase.getProduct (  ) 

Empty active product getter

Returns:
null

Reimplemented in Details, MoreDetails, Pricealarm, Review, and Suggest.

Definition at line 2616 of file oxubase.php.

oxUBase.getVendorlist (  ) 

Template variable getter. Returns vendorlist for search

Returns:
array

Definition at line 2625 of file oxubase.php.

oxUBase.setVendorlist ( $  aList  ) 

Sets vendorlist for search

Parameters:
array $aList vendor list
Returns:
null

Definition at line 2637 of file oxubase.php.

oxUBase.getManufacturerlist (  ) 

Template variable getter. Returns Manufacturerlist for search

Returns:
array

Definition at line 2647 of file oxubase.php.

oxUBase.setManufacturerlist ( $  aList  ) 

Sets Manufacturerlist for search

Parameters:
array $aList manufacturer list
Returns:
null

Definition at line 2659 of file oxubase.php.

oxUBase.setRootVendor ( $  oVendor  ) 

Sets root vendor

Parameters:
object $oVendor vendor object
Returns:
null

Definition at line 2671 of file oxubase.php.

oxUBase.getRootVendor (  ) 

Template variable getter. Returns root vendor

Returns:
object

Definition at line 2681 of file oxubase.php.

oxUBase.setRootManufacturer ( $  oManufacturer  ) 

Sets root Manufacturer

Parameters:
object $oManufacturer manufacturer object
Returns:
null

Definition at line 2693 of file oxubase.php.

oxUBase.getRootManufacturer (  ) 

Template variable getter. Returns root Manufacturer

Returns:
object

Definition at line 2703 of file oxubase.php.

oxUBase.getVendorId (  ) 

Template variable getter. Returns vendor id

Returns:
string

Definition at line 2713 of file oxubase.php.

oxUBase.getManufacturerId (  ) 

Template variable getter. Returns Manufacturer id

Returns:
string

Definition at line 2729 of file oxubase.php.

oxUBase.getSearchCatTree (  ) 

Template variable getter. Returns category tree for search

Returns:
array

Definition at line 2745 of file oxubase.php.

oxUBase.setSearchCatTree ( $  aTree  ) 

Sets category tree for search

Parameters:
array $aTree category tree
Returns:
null

Definition at line 2757 of file oxubase.php.

oxUBase.getCatMore (  ) 

Template variable getter. Returns more category

Returns:
object

Definition at line 2767 of file oxubase.php.

oxUBase.setCatMore ( $  oCat  ) 

Sets more category

Parameters:
object $oCat category object
Returns:
null

Definition at line 2779 of file oxubase.php.

oxUBase.isNewsSubscribed (  ) 

Template variable getter. Returns if user subscribed for newsletter

Returns:
bool

Reimplemented in User.

Definition at line 2789 of file oxubase.php.

oxUBase.setNewsSubscribed ( $  blNewsSubscribed  ) 

Sets if user subscribed for newsletter

Parameters:
bool $blNewsSubscribed TRUE - news are subscribed
Returns:
null

Definition at line 2801 of file oxubase.php.

oxUBase.showShipAddress (  ) 

Template variable getter. Returns if show user shipping address

Returns:
bool

Reimplemented in User.

Definition at line 2811 of file oxubase.php.

oxUBase.setShowShipAddress ( $  blShowShipAddress  ) 

Sets if show user shipping address

Parameters:
bool $blShowShipAddress TRUE - show shipping address
Returns:
null

Reimplemented in User.

Definition at line 2823 of file oxubase.php.

oxUBase.getDelAddress (  ) 

Template variable getter. Returns shipping address

Returns:
bool

Reimplemented in Order, Register, and User.

Definition at line 2833 of file oxubase.php.

oxUBase.setDelAddress ( $  oDelAddress  ) 

Sets shipping address

Parameters:
bool $oDelAddress delivery address
Returns:
null

Reimplemented in User.

Definition at line 2845 of file oxubase.php.

oxUBase.getCatTreePath (  ) 

Template variable getter. Returns category path

Returns:
string

Reimplemented in aList, ManufacturerList, and VendorList.

Definition at line 2855 of file oxubase.php.

oxUBase.getContentByIdent ( $  sIdent  ) 

Loads and returns oxcontent object requested by its ident

Parameters:
string $sIdent content identifier
Returns:
oxcontent

Definition at line 2867 of file oxubase.php.

oxUBase.getContentCategory (  ) 

Default content category getter, returns FALSE by default

Returns:
bool

Reimplemented in Content.

Definition at line 2881 of file oxubase.php.

Member Data Documentation

oxUBase.$_oaComponents = array() [protected]

Definition at line 25 of file oxubase.php.

oxUBase.$_blIsCallForCache = false [protected]

Definition at line 32 of file oxubase.php.

oxUBase.$_blIsOrderStep = false [protected]

Reimplemented in Basket, Order, Payment, and User.

Definition at line 39 of file oxubase.php.

oxUBase.$_sListType = null [protected]

Reimplemented in Account, ManufacturerList, RecommList, Search, Tag, and VendorList.

Definition at line 46 of file oxubase.php.

oxUBase.$_oActCategory = null [protected]

Definition at line 53 of file oxubase.php.

oxUBase.$_oClickCat = null [protected]

Definition at line 59 of file oxubase.php.

oxUBase.$_sCategoryId = null [protected]

Definition at line 66 of file oxubase.php.

oxUBase.$_oActManufacturer = null [protected]

Definition at line 73 of file oxubase.php.

oxUBase.$_oActVendor = null [protected]

Definition at line 80 of file oxubase.php.

oxUBase.$_oActSearch = null [protected]

Definition at line 87 of file oxubase.php.

oxUBase.$_blShowSorting = false [protected]

Reimplemented in aList, Details, GuestBook, ManufacturerList, Search, Tag, and VendorList.

Definition at line 93 of file oxubase.php.

oxUBase.$_blShowRightBasket = null [protected]

Definition at line 99 of file oxubase.php.

oxUBase.$_blShowTopBasket = null [protected]

Definition at line 105 of file oxubase.php.

oxUBase.$_blShowLeftBasket = null [protected]

Definition at line 111 of file oxubase.php.

oxUBase.$_blLoadCurrency = null [protected]

Definition at line 117 of file oxubase.php.

oxUBase.$_blLoadVendorTree = null [protected]

Definition at line 123 of file oxubase.php.

oxUBase.$_blLoadManufacturerTree = null [protected]

Definition at line 129 of file oxubase.php.

oxUBase.$_blDontShowEmptyCats = null [protected]

Definition at line 135 of file oxubase.php.

oxUBase.$_blLoadLanguage = null [protected]

Definition at line 141 of file oxubase.php.

oxUBase.$_blShowTopCatNav = null [protected]

Definition at line 147 of file oxubase.php.

oxUBase.$_iTopCatNavItmCnt = null [protected]

Definition at line 153 of file oxubase.php.

oxUBase.$_aRssLinks = null [protected]

Definition at line 159 of file oxubase.php.

oxUBase.$_sListOrderBy = null [protected]

Definition at line 165 of file oxubase.php.

oxUBase.$_sListOrderDir = null [protected]

Definition at line 171 of file oxubase.php.

oxUBase.$_sMetaDescription = null [protected]

Definition at line 177 of file oxubase.php.

oxUBase.$_sMetaKeywords = null [protected]

Definition at line 183 of file oxubase.php.

oxUBase.$_sMetaDescriptionIdent = null [protected]

Reimplemented in Start.

Definition at line 190 of file oxubase.php.

oxUBase.$_sMetaKeywordsIdent = null [protected]

Reimplemented in Start.

Definition at line 197 of file oxubase.php.

oxUBase.$_sAdditionalParams = null [protected]

Definition at line 203 of file oxubase.php.

oxUBase.$_oActCurrency = null [protected]

Definition at line 209 of file oxubase.php.

oxUBase.$_blCommonAdded = false [protected]

Definition at line 217 of file oxubase.php.

oxUBase.$_iViewIndexState = VIEW_INDEXSTATE_INDEX [protected]

Current view search engine indexing state: VIEW_INDEXSTATE_INDEX - index without limitations VIEW_INDEXSTATE_NOINDEXNOFOLLOW - no index / no follow VIEW_INDEXSTATE_NOINDEXFOLLOW - no index / follow

Reimplemented in Account, Account_Noticelist, Account_Wishlist, Basket, Contact, ForgotPwd, GuestBook, Help, Info, ManufacturerList, MoreDetails, Newsletter, Register, Review, Search, and VendorList.

Definition at line 225 of file oxubase.php.

oxUBase.$_blForceNoIndex = false [protected]

Definition at line 233 of file oxubase.php.

oxUBase.$_sWishlistName = null [protected]

Definition at line 239 of file oxubase.php.

oxUBase.$_iCompItemsCnt = null [protected]

Reimplemented in Compare.

Definition at line 245 of file oxubase.php.

oxUBase.$_sContentId = null [protected]

Default content id

Returns:
string

Reimplemented in Content.

Definition at line 252 of file oxubase.php.

oxUBase.$_oContent = null [protected]

Default content

Returns:
oxContent

Reimplemented in Content.

Definition at line 259 of file oxubase.php.

oxUBase.$_sViewResetID = null [protected]

Definition at line 266 of file oxubase.php.

oxUBase.$_blActiveSorting = null [protected]

Definition at line 272 of file oxubase.php.

oxUBase.$_aMenueList = null [protected]

Definition at line 278 of file oxubase.php.

oxUBase.$_aComponentNames [protected]

Initial value:

 array(
                                    'oxcmp_user'       => 1, // 0 means dont init if cached
                                    'oxcmp_lang'       => 1,
                                    'oxcmp_cur'        => 1,
                                    'oxcmp_shop'       => 1,
                                    'oxcmp_categories' => 0,
                                    'oxcmp_utils'      => 1,
                                    'oxcmp_news'       => 0,
                                    'oxcmp_basket'     => 1
                                  )

Definition at line 285 of file oxubase.php.

oxUBase.$_aUserComponentNames = array() [protected]

Definition at line 301 of file oxubase.php.

oxUBase.$_oProduct = null [protected]

Definition at line 308 of file oxubase.php.

oxUBase.$_iActPage = null [protected]

Definition at line 314 of file oxubase.php.

oxUBase.$_aArticleList = null [protected]

Definition at line 320 of file oxubase.php.

oxUBase.$_oVendorTree = null [protected]

Definition at line 326 of file oxubase.php.

oxUBase.$_oManufacturerTree = null [protected]

Definition at line 332 of file oxubase.php.

oxUBase.$_oCategoryTree = null [protected]

Definition at line 338 of file oxubase.php.

oxUBase.$_aTop5ArticleList = null [protected]

Definition at line 344 of file oxubase.php.

oxUBase.$_aBargainArticleList = null [protected]

Definition at line 350 of file oxubase.php.

oxUBase.$_iLowOrderPrice = null [protected]

Definition at line 356 of file oxubase.php.

oxUBase.$_sMinOrderPrice = null [protected]

Definition at line 362 of file oxubase.php.

oxUBase.$_iNewsRealStatus = null [protected]

Definition at line 368 of file oxubase.php.

oxUBase.$_aBlockRedirectParams = array( 'fnc' ) [protected]

Url parameters which block redirection

Returns:
null

Definition at line 374 of file oxubase.php.

oxUBase.$_aVendorlist = null [protected]

Definition at line 380 of file oxubase.php.

oxUBase.$_oRootVendor = null [protected]

Definition at line 386 of file oxubase.php.

oxUBase.$_sVendorId = null [protected]

Definition at line 392 of file oxubase.php.

oxUBase.$_aManufacturerlist = null [protected]

Definition at line 398 of file oxubase.php.

oxUBase.$_oRootManufacturer = null [protected]

Definition at line 404 of file oxubase.php.

oxUBase.$_sManufacturerId = null [protected]

Definition at line 410 of file oxubase.php.

oxUBase.$_aSearchCatTree = null [protected]

Definition at line 416 of file oxubase.php.

oxUBase.$_oCatMore = null [protected]

Definition at line 422 of file oxubase.php.

oxUBase.$_blNewsSubscribed = null [protected]

Definition at line 428 of file oxubase.php.

oxUBase.$_blShowShipAddress = null [protected]

Definition at line 434 of file oxubase.php.

oxUBase.$_oDelAddress = null [protected]

Reimplemented in Account_User, and Order.

Definition at line 440 of file oxubase.php.

oxUBase.$_sCatTreePath = null [protected]

Definition at line 446 of file oxubase.php.

oxUBase.$_aContents = array() [protected]

Definition at line 452 of file oxubase.php.

oxUBase.$_blTop5Action = false [protected]

Reimplemented in Account, Compare, ForgotPwd, News, Start, Thankyou, and Wishlist.

Definition at line 458 of file oxubase.php.

oxUBase.$_blBargainAction = false [protected]

Reimplemented in Account, Compare, ForgotPwd, News, Start, Thankyou, and Wishlist.

Definition at line 464 of file oxubase.php.

The documentation for this class was generated from the following file:
Generated on Wed Apr 22 12:32:54 2009 for OXID eShop CE by  doxygen 1.5.5