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)
 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)
 getCanonicalUrl ()
 getSimilarRecommLists ()
 showSearch ()
 getRssLinks ()
 getSortColumns ()
 getEditTags ()
 getRecommSearch ()
 getReviewUserId ()
 getPaymentList ()
 getActiveRecommList ()
 getAccessoires ()
 getCrossSelling ()
 getSimilarProducts ()
 getAlsoBoughtThiesProducts ()
 getAlsoBoughtTheseProducts ()
 getArticleId ()
 isMoreTagsVisible ()
 getTitle ()
 getActiveLangAbbr ()
 addGlobalParams ($oShop=null)
 getAdditionalParams ()
 generatePageNavigationUrl ()
 generatePageNavigation ()
 prepareMinimumOrderPrice4View ()
 render ()
 getViewProduct ()
 setViewProduct ($oProduct)
 getViewProductList ()
 getActPage ()
 getActTag ()
 getActVendor ()
 getActManufacturer ()
 setActVendor ($oVendor)
 setActManufacturer ($oManufacturer)
 getActSearch ()
 getActRecommList ()
 getCategoryTree ()
 setCategoryTree ($oCatTree)
 getVendorTree ()
 setVendorTree ($oVendorTree)
 getManufacturerTree ()
 setManufacturerTree ($oManufacturerTree)
 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)
 getCatTreePath ()
 getContentByIdent ($sIdent)
 getContentCategory ()

Protected Member Functions

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

Protected Attributes

 $_oaComponents = array()
 $_blIsCallForCache = false
 $_blIsOrderStep = false
 $_sListType = null
 $_oActCategory = 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
 $_blLowOrderPrice = 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 470 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, Tag, and Thankyou.

Definition at line 502 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 560 of file oxubase.php.

oxUBase.showSorting (  ) 

Template variable getter. Returns true if sorting is on

Returns:
bool

Definition at line 581 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 593 of file oxubase.php.

oxUBase.getComponents (  ) 

Get array of component objects

Returns:
array

Definition at line 603 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 615 of file oxubase.php.

oxUBase.getIsOrderStep (  ) 

Get flag if current view is an order view

Returns:
bool

Definition at line 625 of file oxubase.php.

oxUBase.setActiveCategory ( $  oCategory  ) 

Active category setter

Parameters:
oxcategory $oCategory active category
Returns:
null

Definition at line 638 of file oxubase.php.

oxUBase.getActiveCategory (  ) 

Returns active category

Returns:
null

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

Definition at line 648 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 660 of file oxubase.php.

oxUBase.getIsCallForCache (  ) 

Get cache sign to enable/disable use of cache

Returns:
bool

Definition at line 670 of file oxubase.php.

oxUBase.getListType (  ) 

Get list type

Returns:
string list type

Reimplemented in Account.

Definition at line 680 of file oxubase.php.

oxUBase.setListType ( $  sType  ) 

List type setter

Parameters:
string $sType type of list
Returns:
null

Definition at line 699 of file oxubase.php.

oxUBase.showRightBasket (  ) 

Returns show right basket

Returns:
bool

Definition at line 710 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 727 of file oxubase.php.

oxUBase.showLeftBasket (  ) 

Returns show left basket

Returns:
bool

Definition at line 737 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 754 of file oxubase.php.

oxUBase.showTopBasket (  ) 

Returns show top basket

Returns:
bool

Definition at line 764 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 781 of file oxubase.php.

oxUBase.loadCurrency (  ) 

Returns currency swiching option

Returns:
bool

Definition at line 791 of file oxubase.php.

oxUBase.loadVendorTree (  ) 

Returns if show/hide vendors

Returns:
bool

Definition at line 807 of file oxubase.php.

oxUBase.loadManufacturerTree (  ) 

Returns if show/hide Manufacturers

Returns:
bool

Definition at line 823 of file oxubase.php.

oxUBase.dontShowEmptyCategories (  ) 

Returns true if empty categories are not loaded

Returns:
bool

Definition at line 839 of file oxubase.php.

oxUBase.isLanguageLoaded (  ) 

Returns if language should be loaded

Returns:
bool

Definition at line 855 of file oxubase.php.

oxUBase.showTopCatNavigation (  ) 

Returns show/hide top navigation of categories

Returns:
bool

Definition at line 871 of file oxubase.php.

oxUBase.getTopNavigationCatCnt (  ) 

Returns item count in top navigation of categories

Returns:
integer

Definition at line 887 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 905 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 933 of file oxubase.php.

oxUBase.getListOrderBy (  ) 

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

Returns:
array

Definition at line 968 of file oxubase.php.

oxUBase.getListOrderDirection (  ) 

Template variable getter. Returns list order direction

Returns:
array

Definition at line 978 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 990 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 1002 of file oxubase.php.

oxUBase.getMetaKeywords (  ) 

Template variable getter. Returns meta keywords

Returns:
string

Definition at line 1012 of file oxubase.php.

oxUBase.getMetaDescription (  ) 

Template variable getter. Returns meta description

Returns:
string

Reimplemented in aList.

Definition at line 1040 of file oxubase.php.

oxUBase.getActCurrency (  ) 

Get active language

Returns:
object

Definition at line 1066 of file oxubase.php.

oxUBase.setActCurrency ( $  oCur  ) 

Active language setter

Parameters:
object $oCur corrency object
Returns:
object

Definition at line 1078 of file oxubase.php.

oxUBase.getCompareItemsCnt (  ) 

Template variable getter. Returns article list count in comparison

Returns:
integer

Reimplemented in Compare.

Definition at line 1088 of file oxubase.php.

oxUBase.setCompareItemsCnt ( $  iCount  ) 

Articlelist count in comparison setter

Parameters:
integer $iCount compare items count
Returns:
integer

Definition at line 1100 of file oxubase.php.

oxUBase.getWishlistName (  ) 

Template variable getter. Returns user name of searched wishlist

Returns:
string

Definition at line 1110 of file oxubase.php.

oxUBase.setWishlistName ( $  sName  ) 

Sets user name of searched wishlist

Parameters:
string $sName wishlist name
Returns:
null

Definition at line 1122 of file oxubase.php.

oxUBase._forceNoIndex (  )  [protected]

Forces output noindex meta data for current view

Returns:
null

Definition at line 1132 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 1143 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 1166 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 1183 of file oxubase.php.

oxUBase.isSortingActive (  ) 

Returns if sorting is active and can be displayed

Returns:
bool

Definition at line 1200 of file oxubase.php.

oxUBase.getMenueList (  ) 

Template variable getter. Returns header menue list

Returns:
array

Definition at line 1210 of file oxubase.php.

oxUBase.setMenueList ( $  aMenue  ) 

Header menue list setter

Parameters:
array $aMenue menu list
Returns:
null

Definition at line 1222 of file oxubase.php.

oxUBase._setNrOfArtPerPage (  )  [protected]

Sets number of articles per page to config value

Returns:
null

Definition at line 1233 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 1277 of file oxubase.php.

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

Returns current view meta description data

Parameters:
string $sMeta category path
int $iLength max length of result, -1 for no truncation
bool $blRemoveDuplicatedWords if true - performs additional dublicate cleaning
Returns:
string $sString converted string

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

Definition at line 1290 of file oxubase.php.

oxUBase._prepareMetaKeyword ( $  sKeywords,
$  blRemoveDuplicatedWords = true 
) [protected]

Returns current view keywords seperated by comma

Parameters:
string $sKeywords data to use as keywords
bool $blRemoveDuplicatedWords if true - performs additional dublicate cleaning
Returns:
string of keywords seperated by comma

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

Definition at line 1336 of file oxubase.php.

oxUBase._removeDuplicatedWords ( $  aInput,
$  aSkipTags = array() 
) [protected]

Removes duplicated words (not case sensitive)

Parameters:
mixed $aInput array of string or string
array $aSkipTags in admin defined strings
Returns:
string of words seperated by comma

Definition at line 1368 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, Account_Recommlist, and RecommList.

Definition at line 1405 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 1433 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 1449 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 1464 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 1477 of file oxubase.php.

oxUBase.getTitlePrefix (  ) 

Returns title prefix used in template

Returns:
string

Definition at line 1488 of file oxubase.php.

oxUBase._getSubject ( $  iLang  )  [protected]

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

Parameters:
int $iLang language id
Returns:
object

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

Definition at line 1501 of file oxubase.php.

oxUBase.getDynUrlParams (  ) 

returns additional url params for dynamic url building

Returns:
string

Reimplemented in Review.

Definition at line 1511 of file oxubase.php.

oxUBase.getLink ( $  iLang = null  ) 

get link of current view

Parameters:
int $iLang requested language
Returns:
string

Reimplemented in RecommList, and Suggest.

Definition at line 1553 of file oxubase.php.

oxUBase.getCanonicalUrl (  ) 

Returns view object canonical url

Returns:
string

Reimplemented in aList, Details, Start, and Tag.

Definition at line 1603 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 1613 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 1624 of file oxubase.php.

oxUBase._getSeoRequestParams (  )  [protected]

collects _GET parameters used by eShop SEO and returns uri

Returns:
string

Definition at line 1702 of file oxubase.php.

oxUBase.showSearch (  ) 

Returns show category search

Returns:
bool

Definition at line 1739 of file oxubase.php.

oxUBase.getRssLinks (  ) 

Returns RSS links

Returns:
array

Definition at line 1753 of file oxubase.php.

oxUBase.getSortColumns (  ) 

Template variable getter. Returns sorting columns

Returns:
array

Reimplemented in GuestBook.

Definition at line 1763 of file oxubase.php.

oxUBase.getEditTags (  ) 

Returns if tags will be edit

Returns:
bool

Reimplemented in Details.

Definition at line 1773 of file oxubase.php.

oxUBase.getRecommSearch (  ) 

Template variable getter. Returns search string

Returns:
string

Reimplemented in RecommList.

Definition at line 1782 of file oxubase.php.

oxUBase.getReviewUserId (  ) 

Template variable getter. Returns review user id

Returns:
string

Reimplemented in Review.

Definition at line 1791 of file oxubase.php.

oxUBase.getPaymentList (  ) 

Template variable getter. Returns payment id

Returns:
string

Reimplemented in Payment.

Definition at line 1800 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 1809 of file oxubase.php.

oxUBase.getAccessoires (  ) 

Template variable getter. Returns accessoires of article

Returns:
object

Reimplemented in Details.

Definition at line 1818 of file oxubase.php.

oxUBase.getCrossSelling (  ) 

Template variable getter. Returns crosssellings

Returns:
object

Reimplemented in Details, Review, and Suggest.

Definition at line 1827 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 1836 of file oxubase.php.

oxUBase.getAlsoBoughtThiesProducts (  ) 

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

Deprecated:
use thankyou.getAlsoBoughtTheseProducts()
Returns:
object

Reimplemented in Details, and Thankyou.

Definition at line 1847 of file oxubase.php.

oxUBase.getAlsoBoughtTheseProducts (  ) 

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

Returns:
object

Reimplemented in Details, and Thankyou.

Definition at line 1856 of file oxubase.php.

oxUBase.getArticleId (  ) 

Return the active article id

Returns:
string | bool

Reimplemented in Account.

Definition at line 1865 of file oxubase.php.

oxUBase.isMoreTagsVisible (  ) 

Should "More tags" link be visible.

Returns:
bool

Reimplemented in Start, and Tags.

Definition at line 1874 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 1884 of file oxubase.php.

oxUBase.getActiveLangAbbr (  ) 

Returns active lang suffix

Returns:
string

Definition at line 1893 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 1926 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 1990 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 2030 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 2045 of file oxubase.php.

oxUBase.generatePageNavigation (  ) 

Generates variables for page navigation

Returns:
stdClass $pageNavigation Object with pagenavigation data

Definition at line 2058 of file oxubase.php.

oxUBase.prepareMinimumOrderPrice4View (  ) 

performs setup of aViewData according to iMinOrderPrice admin setting

Deprecated:
Returns:
null

Definition at line 2106 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 2131 of file oxubase.php.

oxUBase.getViewProduct (  ) 

Returns current view product object (if it is loaded)

Returns:
oxarticle

Definition at line 2176 of file oxubase.php.

oxUBase.setViewProduct ( $  oProduct  ) 

Sets view product

Parameters:
oxarticle $oProduct view product object
Returns:
null

Definition at line 2188 of file oxubase.php.

oxUBase.getViewProductList (  ) 

Returns view product list

Returns:
array

Definition at line 2198 of file oxubase.php.

oxUBase.getActPage (  ) 

Active page getter

Returns:
int

Definition at line 2208 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 2224 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 2248 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 2273 of file oxubase.php.

oxUBase.setActVendor ( $  oVendor  ) 

Active vendor setter

Parameters:
oxvendor $oVendor active vendor
Returns:
null

Definition at line 2298 of file oxubase.php.

oxUBase.setActManufacturer ( $  oManufacturer  ) 

Active Manufacturer setter

Parameters:
oxmanufacturer $oManufacturer active Manufacturer
Returns:
null

Definition at line 2310 of file oxubase.php.

oxUBase.getActSearch (  ) 

Returns fake object which is used to mount navigation info

Returns:
oxstdclass

Definition at line 2320 of file oxubase.php.

oxUBase.getActRecommList (  ) 

Returns active recommlist object which is used to mount navigation info

Returns:
object

Definition at line 2335 of file oxubase.php.

oxUBase.getCategoryTree (  ) 

Returns category tree (if it is loaded)

Returns:
oxcategorylist

Definition at line 2355 of file oxubase.php.

oxUBase.setCategoryTree ( $  oCatTree  ) 

Category list setter

Parameters:
oxcategorylist $oCatTree category tree
Returns:
null

Definition at line 2367 of file oxubase.php.

oxUBase.getVendorTree (  ) 

Returns vendor tree (if it is loaded0

Returns:
oxvendorlist

Definition at line 2377 of file oxubase.php.

oxUBase.setVendorTree ( $  oVendorTree  ) 

Vendor tree setter

Parameters:
oxvendorlist $oVendorTree vendor tree
Returns:
null

Definition at line 2389 of file oxubase.php.

oxUBase.getManufacturerTree (  ) 

Returns Manufacturer tree (if it is loaded0

Returns:
oxManufacturerlist

Definition at line 2399 of file oxubase.php.

oxUBase.setManufacturerTree ( $  oManufacturerTree  ) 

Manufacturer tree setter

Parameters:
oxManufacturerlist $oManufacturerTree Manufacturer tree
Returns:
null

Definition at line 2411 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 2424 of file oxubase.php.

oxUBase._processListArticles (  )  [protected]

Iterates through list articles and performs list view specific tasks

Returns:
null

Reimplemented in aList, and RecommList.

Definition at line 2435 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 2450 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 2460 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 2485 of file oxubase.php.

oxUBase.isLowOrderPrice (  ) 

Template variable getter. Returns if order price is lower than minimum order price setup (config param "iMinOrderPrice")

Returns:
bool

Definition at line 2508 of file oxubase.php.

oxUBase.getMinOrderPrice (  ) 

Template variable getter. Returns formatted min order price value

Returns:
string

Definition at line 2522 of file oxubase.php.

oxUBase.getNewsRealStatus (  ) 

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

Returns:
integer

Definition at line 2536 of file oxubase.php.

oxUBase._canRedirect (  )  [protected]

Checks if current request parameters does not block SEO redirection process

Returns:
bool

Definition at line 2546 of file oxubase.php.

oxUBase.getProduct (  ) 

Empty active product getter

Returns:
null

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

Definition at line 2562 of file oxubase.php.

oxUBase.getVendorlist (  ) 

Template variable getter. Returns vendorlist for search

Returns:
array

Definition at line 2571 of file oxubase.php.

oxUBase.setVendorlist ( $  aList  ) 

Sets vendorlist for search

Parameters:
array $aList vendor list
Returns:
null

Definition at line 2583 of file oxubase.php.

oxUBase.getManufacturerlist (  ) 

Template variable getter. Returns Manufacturerlist for search

Returns:
array

Definition at line 2593 of file oxubase.php.

oxUBase.setManufacturerlist ( $  aList  ) 

Sets Manufacturerlist for search

Parameters:
array $aList manufacturer list
Returns:
null

Definition at line 2605 of file oxubase.php.

oxUBase.setRootVendor ( $  oVendor  ) 

Sets root vendor

Parameters:
object $oVendor vendor object
Returns:
null

Definition at line 2617 of file oxubase.php.

oxUBase.getRootVendor (  ) 

Template variable getter. Returns root vendor

Returns:
object

Definition at line 2627 of file oxubase.php.

oxUBase.setRootManufacturer ( $  oManufacturer  ) 

Sets root Manufacturer

Parameters:
object $oManufacturer manufacturer object
Returns:
null

Definition at line 2639 of file oxubase.php.

oxUBase.getRootManufacturer (  ) 

Template variable getter. Returns root Manufacturer

Returns:
object

Definition at line 2649 of file oxubase.php.

oxUBase.getVendorId (  ) 

Template variable getter. Returns vendor id

Returns:
string

Definition at line 2659 of file oxubase.php.

oxUBase.getManufacturerId (  ) 

Template variable getter. Returns Manufacturer id

Returns:
string

Definition at line 2675 of file oxubase.php.

oxUBase.getSearchCatTree (  ) 

Template variable getter. Returns category tree for search

Returns:
array

Definition at line 2691 of file oxubase.php.

oxUBase.setSearchCatTree ( $  aTree  ) 

Sets category tree for search

Parameters:
array $aTree category tree
Returns:
null

Definition at line 2703 of file oxubase.php.

oxUBase.getCatMore (  ) 

Template variable getter. Returns more category

Returns:
object

Definition at line 2713 of file oxubase.php.

oxUBase.setCatMore ( $  oCat  ) 

Sets more category

Parameters:
object $oCat category object
Returns:
null

Definition at line 2725 of file oxubase.php.

oxUBase.getCatTreePath (  ) 

Template variable getter. Returns category path

Returns:
string

Reimplemented in aList, ManufacturerList, and VendorList.

Definition at line 2735 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 2747 of file oxubase.php.

oxUBase.getContentCategory (  ) 

Default content category getter, returns FALSE by default

Returns:
bool

Reimplemented in Content.

Definition at line 2761 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, Register, 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.$_oActManufacturer = null [protected]

Definition at line 60 of file oxubase.php.

oxUBase.$_oActVendor = null [protected]

Definition at line 67 of file oxubase.php.

oxUBase.$_oActSearch = null [protected]

Definition at line 74 of file oxubase.php.

oxUBase.$_blShowSorting = false [protected]

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

Definition at line 80 of file oxubase.php.

oxUBase.$_blShowRightBasket = null [protected]

Definition at line 86 of file oxubase.php.

oxUBase.$_blShowTopBasket = null [protected]

Definition at line 92 of file oxubase.php.

oxUBase.$_blShowLeftBasket = null [protected]

Definition at line 98 of file oxubase.php.

oxUBase.$_blLoadCurrency = null [protected]

Definition at line 104 of file oxubase.php.

oxUBase.$_blLoadVendorTree = null [protected]

Definition at line 110 of file oxubase.php.

oxUBase.$_blLoadManufacturerTree = null [protected]

Definition at line 116 of file oxubase.php.

oxUBase.$_blDontShowEmptyCats = null [protected]

Definition at line 122 of file oxubase.php.

oxUBase.$_blLoadLanguage = null [protected]

Definition at line 128 of file oxubase.php.

oxUBase.$_blShowTopCatNav = null [protected]

Definition at line 134 of file oxubase.php.

oxUBase.$_iTopCatNavItmCnt = null [protected]

Definition at line 140 of file oxubase.php.

oxUBase.$_aRssLinks = null [protected]

Definition at line 146 of file oxubase.php.

oxUBase.$_sListOrderBy = null [protected]

Definition at line 152 of file oxubase.php.

oxUBase.$_sListOrderDir = null [protected]

Definition at line 158 of file oxubase.php.

oxUBase.$_sMetaDescription = null [protected]

Definition at line 164 of file oxubase.php.

oxUBase.$_sMetaKeywords = null [protected]

Definition at line 170 of file oxubase.php.

oxUBase.$_sMetaDescriptionIdent = null [protected]

Reimplemented in Start.

Definition at line 177 of file oxubase.php.

oxUBase.$_sMetaKeywordsIdent = null [protected]

Reimplemented in Start.

Definition at line 184 of file oxubase.php.

oxUBase.$_sAdditionalParams = null [protected]

Definition at line 190 of file oxubase.php.

oxUBase.$_oActCurrency = null [protected]

Definition at line 196 of file oxubase.php.

oxUBase.$_blCommonAdded = false [protected]

Definition at line 204 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, Tag, and VendorList.

Definition at line 212 of file oxubase.php.

oxUBase.$_blForceNoIndex = false [protected]

Definition at line 220 of file oxubase.php.

oxUBase.$_sWishlistName = null [protected]

Definition at line 226 of file oxubase.php.

oxUBase.$_iCompItemsCnt = null [protected]

Reimplemented in Compare.

Definition at line 232 of file oxubase.php.

oxUBase.$_sContentId = null [protected]

Default content id

Returns:
string

Reimplemented in Content.

Definition at line 239 of file oxubase.php.

oxUBase.$_oContent = null [protected]

Default content

Returns:
oxContent

Reimplemented in Content.

Definition at line 246 of file oxubase.php.

oxUBase.$_sViewResetID = null [protected]

Definition at line 253 of file oxubase.php.

oxUBase.$_blActiveSorting = null [protected]

Definition at line 259 of file oxubase.php.

oxUBase.$_aMenueList = null [protected]

Definition at line 265 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 272 of file oxubase.php.

oxUBase.$_aUserComponentNames = array() [protected]

Definition at line 288 of file oxubase.php.

oxUBase.$_oProduct = null [protected]

Definition at line 295 of file oxubase.php.

oxUBase.$_iActPage = null [protected]

Definition at line 301 of file oxubase.php.

oxUBase.$_aArticleList = null [protected]

Definition at line 307 of file oxubase.php.

oxUBase.$_oVendorTree = null [protected]

Definition at line 313 of file oxubase.php.

oxUBase.$_oManufacturerTree = null [protected]

Definition at line 319 of file oxubase.php.

oxUBase.$_oCategoryTree = null [protected]

Definition at line 325 of file oxubase.php.

oxUBase.$_aTop5ArticleList = null [protected]

Definition at line 331 of file oxubase.php.

oxUBase.$_aBargainArticleList = null [protected]

Definition at line 337 of file oxubase.php.

oxUBase.$_blLowOrderPrice = null [protected]

Definition at line 343 of file oxubase.php.

oxUBase.$_iLowOrderPrice = null [protected]

Definition at line 352 of file oxubase.php.

oxUBase.$_sMinOrderPrice = null [protected]

Definition at line 358 of file oxubase.php.

oxUBase.$_iNewsRealStatus = null [protected]

Definition at line 364 of file oxubase.php.

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

Url parameters which block redirection

Returns:
null

Definition at line 370 of file oxubase.php.

oxUBase.$_aVendorlist = null [protected]

Definition at line 376 of file oxubase.php.

oxUBase.$_oRootVendor = null [protected]

Definition at line 382 of file oxubase.php.

oxUBase.$_sVendorId = null [protected]

Definition at line 388 of file oxubase.php.

oxUBase.$_aManufacturerlist = null [protected]

Definition at line 394 of file oxubase.php.

oxUBase.$_oRootManufacturer = null [protected]

Definition at line 400 of file oxubase.php.

oxUBase.$_sManufacturerId = null [protected]

Definition at line 406 of file oxubase.php.

oxUBase.$_aSearchCatTree = null [protected]

Definition at line 412 of file oxubase.php.

oxUBase.$_oCatMore = null [protected]

Definition at line 418 of file oxubase.php.

oxUBase.$_blNewsSubscribed = null [protected]

Definition at line 424 of file oxubase.php.

oxUBase.$_blShowShipAddress = null [protected]

Definition at line 430 of file oxubase.php.

oxUBase.$_oDelAddress = null [protected]

Reimplemented in Account_User, and Order.

Definition at line 436 of file oxubase.php.

oxUBase.$_sCatTreePath = null [protected]

Definition at line 442 of file oxubase.php.

oxUBase.$_aContents = array() [protected]

Definition at line 448 of file oxubase.php.

oxUBase.$_blTop5Action = false [protected]

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

Definition at line 454 of file oxubase.php.

oxUBase.$_blBargainAction = false [protected]

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

Definition at line 460 of file oxubase.php.

The documentation for this class was generated from the following file:
Generated on Mon Oct 26 20:11:42 2009 for OXID eShop CE by  doxygen 1.5.5