Public Member Functions | Protected Member Functions | Protected Attributes

oxUBase Class Reference

Inheritance diagram for oxUBase:
Collaboration diagram for oxUBase:

List of all members.

Public Member Functions

 isActive ($sName)
 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 ()
 getMustFillFields ()
 isFieldRequired ($sField)
 getFormId ()
 canAcceptFormData ()
 getPromoFinishedList ()
 getPromoCurrentList ()
 getPromoFutureList ()
 getShowPromotionList ()

Protected Member Functions

 _processRequest ()
 _getMetaSeoParam ()
 _getMetaFromSeo ($sDataType)
 _getMetaFromContent ($sMetaIdent)
 _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 ()
 _canRedirect ()

Protected Attributes

 $_oaComponents = array()
 $_blIsCallForCache = false
 $_blIsOrderStep = false
 $_sListType = null
 $_oActCategory = null
 $_oActManufacturer = null
 $_oActVendor = null
 $_oActiveRecommList = 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
 $_aMustFillFields = null

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.

Member Function Documentation

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, RecommList, Tag, and VendorList.

Definition at line 2108 of file oxubase.php.

oxUBase._canRedirect (  )  [protected]

Checks if current request parameters does not block SEO redirection process

Returns:
bool

Definition at line 2590 of file oxubase.php.

oxUBase._forceNoIndex (  )  [protected]

Forces output noindex meta data for current view

Returns:
null

Definition at line 1198 of file oxubase.php.

oxUBase._getMetaFromContent ( $  sMetaIdent  )  [protected]

Fetches meta data (description or keywords) from content table

Parameters:
string $sMetaIdent meta content ident
Returns:
string

Definition at line 1070 of file oxubase.php.

oxUBase._getMetaFromSeo ( $  sDataType  )  [protected]

Fetches meta data (description or keywords) from seo table

Parameters:
string $sDataType data type "oxkeywords" or "oxdescription"
Returns:
string

Definition at line 1051 of file oxubase.php.

oxUBase._getMetaSeoParam (  )  [protected]

Returns seo parameter to filter meta data by it e.g. article meta data for active category

Deprecated:
not used any more
Returns:
null

Definition at line 1040 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 1678 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 1343 of file oxubase.php.

oxUBase._getSeoRequestParams (  )  [protected]

collects _GET parameters used by eShop SEO and returns uri

Returns:
string

Definition at line 1756 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 1567 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 2483 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 1356 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 1402 of file oxubase.php.

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 495 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 1434 of file oxubase.php.

oxUBase._setNrOfArtPerPage (  )  [protected]

Sets number of articles per page to config value

Returns:
null

Definition at line 1299 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 1990 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 930 of file oxubase.php.

oxUBase.canAcceptFormData (  ) 

Checks if session session form id matches with form id

Returns:
bool

Definition at line 2867 of file oxubase.php.

oxUBase.dontShowEmptyCategories (  ) 

Returns true if empty categories are not loaded

Returns:
bool

Definition at line 864 of file oxubase.php.

oxUBase.generatePageNavigation (  ) 

Generates variables for page navigation

Returns:
stdClass $pageNavigation Object with pagenavigation data

Definition at line 2121 of file oxubase.php.

oxUBase.generatePageNavigationUrl (  ) 

Generates URL for page navigation

Returns:
string $sUrl String with working page url.

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

Definition at line 2094 of file oxubase.php.

oxUBase.getAccessoires (  ) 

Template variable getter. Returns accessoires of article

Returns:
object

Reimplemented in Details.

Definition at line 1882 of file oxubase.php.

oxUBase.getActCurrency (  ) 

Get active language

Returns:
object

Definition at line 1132 of file oxubase.php.

oxUBase.getActiveCategory (  ) 

Returns active category

Returns:
null

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

Definition at line 673 of file oxubase.php.

oxUBase.getActiveLangAbbr (  ) 

Returns active lang suffix

Returns:
string

Definition at line 1957 of file oxubase.php.

oxUBase.getActiveRecommList (  ) 

Template variable getter. Returns active recommendation lists

Returns:
string

Reimplemented in Account_Recommlist, and Review.

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

oxUBase.getActPage (  ) 

Active page getter

Returns:
int

Definition at line 2275 of file oxubase.php.

oxUBase.getActRecommList (  ) 

Returns active recommlist object which is used to mount navigation info

Deprecated:
dublicated, use oxUBase.getActiveRecommList()
Returns:
object

Definition at line 2404 of file oxubase.php.

oxUBase.getActSearch (  ) 

Returns fake object which is used to mount navigation info

Returns:
oxstdclass

Definition at line 2387 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 2291 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 2315 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 2054 of file oxubase.php.

oxUBase.getAddUrlParams (  ) 

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

Returns:
string

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

Definition at line 2494 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 1920 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 1911 of file oxubase.php.

oxUBase.getArticleId (  ) 

Return the active article id

Returns:
string | bool

Reimplemented in Account.

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

oxUBase.getCanonicalUrl (  ) 

Returns view object canonical url

Returns:
string

Reimplemented in aList, Details, Start, and Tag.

Definition at line 1657 of file oxubase.php.

oxUBase.getCategoryTree (  ) 

Returns category tree (if it is loaded)

Returns:
oxcategorylist

Definition at line 2414 of file oxubase.php.

oxUBase.getCatMore (  ) 

Template variable getter. Returns more category

Returns:
object

Definition at line 2757 of file oxubase.php.

oxUBase.getCatTreePath (  ) 

Template variable getter. Returns category path

Returns:
string

Reimplemented in aList, ManufacturerList, and VendorList.

Definition at line 2779 of file oxubase.php.

oxUBase.getCompareItemsCnt (  ) 

Template variable getter. Returns article list count in comparison

Returns:
integer

Reimplemented in Compare.

Definition at line 1154 of file oxubase.php.

oxUBase.getComponents (  ) 

Get array of component objects

Returns:
array

Definition at line 628 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 1249 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 2791 of file oxubase.php.

oxUBase.getContentCategory (  ) 

Default content category getter, returns FALSE by default

Returns:
bool

Reimplemented in Content.

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

oxUBase.getCrossSelling (  ) 

Template variable getter. Returns crosssellings

Returns:
object

Reimplemented in Details, and Suggest.

Definition at line 1891 of file oxubase.php.

oxUBase.getDynUrlParams (  ) 

returns additional url params for dynamic url building

Returns:
string

Reimplemented in Review.

Definition at line 1577 of file oxubase.php.

oxUBase.getEditTags (  ) 

Returns if tags will be edit

Returns:
bool

Reimplemented in Details.

Definition at line 1827 of file oxubase.php.

oxUBase.getFormId (  ) 

Form id getter. This id used to prevent double guestbook, review entry submit

Returns:
string

Definition at line 2852 of file oxubase.php.

oxUBase.getIsCallForCache (  ) 

Get cache sign to enable/disable use of cache

Returns:
bool

Definition at line 695 of file oxubase.php.

oxUBase.getIsOrderStep (  ) 

Get flag if current view is an order view

Returns:
bool

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

oxUBase.getListOrderBy (  ) 

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

Returns:
array

Definition at line 993 of file oxubase.php.

oxUBase.getListOrderDirection (  ) 

Template variable getter. Returns list order direction

Returns:
array

Definition at line 1003 of file oxubase.php.

oxUBase.getListType (  ) 

Get list type

Returns:
string list type

Reimplemented in Account.

Definition at line 705 of file oxubase.php.

oxUBase.getManufacturerId (  ) 

Template variable getter. Returns Manufacturer id

Returns:
string

Definition at line 2719 of file oxubase.php.

oxUBase.getManufacturerlist (  ) 

Template variable getter. Returns Manufacturerlist for search

Returns:
array

Definition at line 2637 of file oxubase.php.

oxUBase.getManufacturerTree (  ) 

Returns Manufacturer tree (if it is loaded0

Returns:
oxManufacturerlist

Definition at line 2458 of file oxubase.php.

oxUBase.getMenueList (  ) 

Template variable getter. Returns header menue list

Returns:
array

Definition at line 1276 of file oxubase.php.

oxUBase.getMetaDescription (  ) 

Template variable getter. Returns meta description

Returns:
string

Reimplemented in aList.

Definition at line 1109 of file oxubase.php.

oxUBase.getMetaKeywords (  ) 

Template variable getter. Returns meta keywords

Returns:
string

Definition at line 1086 of file oxubase.php.

oxUBase.getMinOrderPrice (  ) 

Template variable getter. Returns formatted min order price value

Returns:
string

Definition at line 2566 of file oxubase.php.

oxUBase.getMustFillFields (  ) 

Returns array of fields which must be filled during registration

Returns:
array | bool

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

oxUBase.getNewsRealStatus (  ) 

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

Returns:
integer

Definition at line 2580 of file oxubase.php.

oxUBase.getPaymentList (  ) 

Template variable getter. Returns payment id

Returns:
string

Reimplemented in Payment.

Definition at line 1856 of file oxubase.php.

oxUBase.getProduct (  ) 

Empty active product getter

Returns:
null

Reimplemented in Details, MoreDetails, Pricealarm, and Suggest.

Definition at line 2606 of file oxubase.php.

oxUBase.getPromoCurrentList (  ) 

return current promotion list

Returns:
oxActionList

Definition at line 2906 of file oxubase.php.

oxUBase.getPromoFinishedList (  ) 

return last finished promotion list

Returns:
oxActionList

Definition at line 2891 of file oxubase.php.

oxUBase.getPromoFutureList (  ) 

return future promotion list

Returns:
oxActionList

Definition at line 2921 of file oxubase.php.

oxUBase.getRecommSearch (  ) 

Template variable getter. Returns search string

Returns:
string

Reimplemented in RecommList.

Definition at line 1836 of file oxubase.php.

oxUBase.getReviewUserId (  ) 

Template variable getter. Returns review user id

Deprecated:
this getter should not be used in forms, use oxUBase.getReviewUserHash() instead
Returns:
string

Reimplemented in Review.

Definition at line 1847 of file oxubase.php.

oxUBase.getRootManufacturer (  ) 

Template variable getter. Returns root Manufacturer

Returns:
object

Definition at line 2693 of file oxubase.php.

oxUBase.getRootVendor (  ) 

Template variable getter. Returns root vendor

Returns:
object

Definition at line 2671 of file oxubase.php.

oxUBase.getRssLinks (  ) 

Returns RSS links

Returns:
array

Definition at line 1807 of file oxubase.php.

oxUBase.getSearchCatTree (  ) 

Template variable getter. Returns category tree for search

Returns:
array

Definition at line 2735 of file oxubase.php.

oxUBase.getShowPromotionList (  ) 

should promotions list be shown?

Returns:
bool

Definition at line 2936 of file oxubase.php.

oxUBase.getSimilarProducts (  ) 

Template variable getter. Returns similar article list

Returns:
object

Reimplemented in Account_Noticelist, Details, and Suggest.

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

oxUBase.getSortColumns (  ) 

Template variable getter. Returns sorting columns

Returns:
array

Reimplemented in GuestBook.

Definition at line 1817 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 1515 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 1530 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 1948 of file oxubase.php.

oxUBase.getTitlePrefix (  ) 

Returns title prefix used in template

Returns:
string

Definition at line 1554 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 1543 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 2504 of file oxubase.php.

oxUBase.getTopNavigationCatCnt (  ) 

Returns item count in top navigation of categories

Returns:
integer

Definition at line 912 of file oxubase.php.

oxUBase.getVendorId (  ) 

Template variable getter. Returns vendor id

Returns:
string

Definition at line 2703 of file oxubase.php.

oxUBase.getVendorlist (  ) 

Template variable getter. Returns vendorlist for search

Returns:
array

Definition at line 2615 of file oxubase.php.

oxUBase.getVendorTree (  ) 

Returns vendor tree (if it is loaded0

Returns:
oxvendorlist

Definition at line 2436 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, Details, and Review.

Definition at line 585 of file oxubase.php.

oxUBase.getViewProduct (  ) 

Returns current view product object (if it is loaded)

Returns:
oxarticle

Definition at line 2243 of file oxubase.php.

oxUBase.getViewProductList (  ) 

Returns view product list

Returns:
array

Definition at line 2265 of file oxubase.php.

oxUBase.getWishlistName (  ) 

Template variable getter. Returns user name of searched wishlist

Returns:
string

Definition at line 1176 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 Details, order, Payment, RecommAdd, Review, Rss, Search, and Thankyou.

Definition at line 527 of file oxubase.php.

oxUBase.isActive ( $  sName  ) 

Checks if feature is enabled

Parameters:
string $sName feature name
Returns:
bool

Definition at line 27 of file oxubase.php.

oxUBase.isFieldRequired ( $  sField  ) 

Returns if field is required.

Parameters:
string $sField required field to check
Returns:
array | bool

Reimplemented in Register.

Definition at line 2836 of file oxubase.php.

oxUBase.isLanguageLoaded (  ) 

Returns if language should be loaded

Returns:
bool

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

oxUBase.isMoreTagsVisible (  ) 

Should "More tags" link be visible.

Returns:
bool

Reimplemented in Start, and Tags.

Definition at line 1938 of file oxubase.php.

oxUBase.isSortingActive (  ) 

Returns if sorting is active and can be displayed

Returns:
bool

Definition at line 1266 of file oxubase.php.

oxUBase.loadCurrency (  ) 

Returns currency swiching option

Returns:
bool

Definition at line 816 of file oxubase.php.

oxUBase.loadManufacturerTree (  ) 

Returns if show/hide Manufacturers

Returns:
bool

Definition at line 848 of file oxubase.php.

oxUBase.loadVendorTree (  ) 

Returns if show/hide vendors

Returns:
bool

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

oxUBase.prepareMinimumOrderPrice4View (  ) 

performs setup of aViewData according to iMinOrderPrice admin setting

Deprecated:
Returns:
null

Definition at line 2169 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 958 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, Invite, Links, ManufacturerList, MoreDetails, News, Newsletter, order, oxStart, Payment, Pricealarm, RecommList, Register, Review, Rss, Search, Start, Suggest, Tag, Tags, Thankyou, Tpl, User, VendorList, Wishlist, and Wrapping.

Definition at line 2198 of file oxubase.php.

oxUBase.setActCurrency ( $  oCur  ) 

Active language setter

Parameters:
object $oCur corrency object
Returns:
object

Definition at line 1144 of file oxubase.php.

oxUBase.setActiveCategory ( $  oCategory  ) 

Active category setter

Parameters:
oxcategory $oCategory active category
Returns:
null

Definition at line 663 of file oxubase.php.

oxUBase.setActManufacturer ( $  oManufacturer  ) 

Active Manufacturer setter

Parameters:
oxmanufacturer $oManufacturer active Manufacturer
Returns:
null

Definition at line 2377 of file oxubase.php.

oxUBase.setActVendor ( $  oVendor  ) 

Active vendor setter

Parameters:
oxvendor $oVendor active vendor
Returns:
null

Definition at line 2365 of file oxubase.php.

oxUBase.setCategoryTree ( $  oCatTree  ) 

Category list setter

Parameters:
oxcategorylist $oCatTree category tree
Returns:
null

Definition at line 2426 of file oxubase.php.

oxUBase.setCatMore ( $  oCat  ) 

Sets more category

Parameters:
object $oCat category object
Returns:
null

Definition at line 2769 of file oxubase.php.

oxUBase.setCompareItemsCnt ( $  iCount  ) 

Articlelist count in comparison setter

Parameters:
integer $iCount compare items count
Returns:
integer

Definition at line 1166 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 618 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 685 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 640 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 1499 of file oxubase.php.

oxUBase.setListType ( $  sType  ) 

List type setter

Parameters:
string $sType type of list
Returns:
null

Definition at line 724 of file oxubase.php.

oxUBase.setManufacturerlist ( $  aList  ) 

Sets Manufacturerlist for search

Parameters:
array $aList manufacturer list
Returns:
null

Definition at line 2649 of file oxubase.php.

oxUBase.setManufacturerTree ( $  oManufacturerTree  ) 

Manufacturer tree setter

Parameters:
oxManufacturerlist $oManufacturerTree Manufacturer tree
Returns:
null

Definition at line 2470 of file oxubase.php.

oxUBase.setMenueList ( $  aMenue  ) 

Header menue list setter

Parameters:
array $aMenue menu list
Returns:
null

Definition at line 1288 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 1015 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 1027 of file oxubase.php.

oxUBase.setRootManufacturer ( $  oManufacturer  ) 

Sets root Manufacturer

Parameters:
object $oManufacturer manufacturer object
Returns:
null

Definition at line 2683 of file oxubase.php.

oxUBase.setRootVendor ( $  oVendor  ) 

Sets root vendor

Parameters:
object $oVendor vendor object
Returns:
null

Definition at line 2661 of file oxubase.php.

oxUBase.setSearchCatTree ( $  aTree  ) 

Sets category tree for search

Parameters:
array $aTree category tree
Returns:
null

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

oxUBase.setVendorlist ( $  aList  ) 

Sets vendorlist for search

Parameters:
array $aList vendor list
Returns:
null

Definition at line 2627 of file oxubase.php.

oxUBase.setVendorTree ( $  oVendorTree  ) 

Vendor tree setter

Parameters:
oxvendorlist $oVendorTree vendor tree
Returns:
null

Definition at line 2448 of file oxubase.php.

oxUBase.setViewProduct ( $  oProduct  ) 

Sets view product

Parameters:
oxarticle $oProduct view product object
Returns:
null

Definition at line 2255 of file oxubase.php.

oxUBase.setWishlistName ( $  sName  ) 

Sets user name of searched wishlist

Parameters:
string $sName wishlist name
Returns:
null

Definition at line 1188 of file oxubase.php.

oxUBase.showLeftBasket (  ) 

Returns show left basket

Returns:
bool

Definition at line 762 of file oxubase.php.

oxUBase.showRightBasket (  ) 

Returns show right basket

Returns:
bool

Definition at line 735 of file oxubase.php.

oxUBase.showSearch (  ) 

Returns show category search

Returns:
bool

Definition at line 1793 of file oxubase.php.

oxUBase.showSorting (  ) 

Template variable getter. Returns true if sorting is on

Returns:
bool

Definition at line 606 of file oxubase.php.

oxUBase.showTopBasket (  ) 

Returns show top basket

Returns:
bool

Definition at line 789 of file oxubase.php.

oxUBase.showTopCatNavigation (  ) 

Returns show/hide top navigation of categories

Returns:
bool

Definition at line 896 of file oxubase.php.

Member Data Documentation

oxUBase.$_aArticleList = null [protected]

Definition at line 325 of file oxubase.php.

oxUBase.$_aBargainArticleList = null [protected]

Definition at line 355 of file oxubase.php.

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

Url parameters which block redirection

Returns:
null

Definition at line 388 of file oxubase.php.

oxUBase.$_aComponentNames [protected]
Initial value:
 array(
                                    'oxcmp_user'       => 1, 
                                    'oxcmp_lang'       => 1,
                                    'oxcmp_cur'        => 1,
                                    'oxcmp_shop'       => 1,
                                    'oxcmp_categories' => 0,
                                    'oxcmp_utils'      => 1,
                                    'oxcmp_news'       => 0,
                                    'oxcmp_basket'     => 1
                                  )

Definition at line 290 of file oxubase.php.

oxUBase.$_aContents = array() [protected]

Definition at line 466 of file oxubase.php.

oxUBase.$_aManufacturerlist = null [protected]

Definition at line 412 of file oxubase.php.

oxUBase.$_aMenueList = null [protected]

Definition at line 283 of file oxubase.php.

oxUBase.$_aMustFillFields = null [protected]

Definition at line 485 of file oxubase.php.

oxUBase.$_aRssLinks = null [protected]

Definition at line 164 of file oxubase.php.

oxUBase.$_aSearchCatTree = null [protected]

Definition at line 430 of file oxubase.php.

oxUBase.$_aTop5ArticleList = null [protected]

Definition at line 349 of file oxubase.php.

oxUBase.$_aUserComponentNames = array() [protected]

Definition at line 306 of file oxubase.php.

oxUBase.$_aVendorlist = null [protected]

Definition at line 394 of file oxubase.php.

oxUBase.$_blActiveSorting = null [protected]

Definition at line 277 of file oxubase.php.

oxUBase.$_blBargainAction = false [protected]

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

Definition at line 478 of file oxubase.php.

oxUBase.$_blCommonAdded = false [protected]

Definition at line 222 of file oxubase.php.

oxUBase.$_blDontShowEmptyCats = null [protected]

Definition at line 140 of file oxubase.php.

oxUBase.$_blForceNoIndex = false [protected]

Definition at line 238 of file oxubase.php.

oxUBase.$_blIsCallForCache = false [protected]

Definition at line 44 of file oxubase.php.

oxUBase.$_blIsOrderStep = false [protected]

Reimplemented in Basket, order, Payment, Register, and User.

Definition at line 51 of file oxubase.php.

oxUBase.$_blLoadCurrency = null [protected]

Definition at line 122 of file oxubase.php.

oxUBase.$_blLoadLanguage = null [protected]

Definition at line 146 of file oxubase.php.

oxUBase.$_blLoadManufacturerTree = null [protected]

Definition at line 134 of file oxubase.php.

oxUBase.$_blLoadVendorTree = null [protected]

Definition at line 128 of file oxubase.php.

oxUBase.$_blLowOrderPrice = null [protected]

Definition at line 361 of file oxubase.php.

oxUBase.$_blNewsSubscribed = null [protected]

Definition at line 442 of file oxubase.php.

oxUBase.$_blShowLeftBasket = null [protected]

Definition at line 116 of file oxubase.php.

oxUBase.$_blShowRightBasket = null [protected]

Definition at line 104 of file oxubase.php.

oxUBase.$_blShowShipAddress = null [protected]

Definition at line 448 of file oxubase.php.

oxUBase.$_blShowSorting = false [protected]

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

Definition at line 98 of file oxubase.php.

oxUBase.$_blShowTopBasket = null [protected]

Definition at line 110 of file oxubase.php.

oxUBase.$_blShowTopCatNav = null [protected]

Definition at line 152 of file oxubase.php.

oxUBase.$_blTop5Action = false [protected]

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

Definition at line 472 of file oxubase.php.

oxUBase.$_iActPage = null [protected]

Definition at line 319 of file oxubase.php.

oxUBase.$_iCompItemsCnt = null [protected]

Reimplemented in Compare.

Definition at line 250 of file oxubase.php.

oxUBase.$_iLowOrderPrice = null [protected]

Definition at line 370 of file oxubase.php.

oxUBase.$_iNewsRealStatus = null [protected]

Definition at line 382 of file oxubase.php.

oxUBase.$_iTopCatNavItmCnt = null [protected]

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

oxUBase.$_oaComponents = array() [protected]

Definition at line 37 of file oxubase.php.

oxUBase.$_oActCategory = null [protected]

Definition at line 65 of file oxubase.php.

oxUBase.$_oActCurrency = null [protected]

Definition at line 214 of file oxubase.php.

oxUBase.$_oActiveRecommList = null [protected]

Reimplemented in Review.

Definition at line 85 of file oxubase.php.

oxUBase.$_oActManufacturer = null [protected]

Definition at line 72 of file oxubase.php.

oxUBase.$_oActSearch = null [protected]

Definition at line 92 of file oxubase.php.

oxUBase.$_oActVendor = null [protected]

Definition at line 79 of file oxubase.php.

oxUBase.$_oCategoryTree = null [protected]

Definition at line 343 of file oxubase.php.

oxUBase.$_oCatMore = null [protected]

Definition at line 436 of file oxubase.php.

oxUBase.$_oContent = null [protected]

Default content

Returns:
oxContent

Reimplemented in Content.

Definition at line 264 of file oxubase.php.

oxUBase.$_oDelAddress = null [protected]

Reimplemented in Account_User, and order.

Definition at line 454 of file oxubase.php.

oxUBase.$_oManufacturerTree = null [protected]

Definition at line 337 of file oxubase.php.

oxUBase.$_oProduct = null [protected]

Definition at line 313 of file oxubase.php.

oxUBase.$_oRootManufacturer = null [protected]

Definition at line 418 of file oxubase.php.

oxUBase.$_oRootVendor = null [protected]

Definition at line 400 of file oxubase.php.

oxUBase.$_oVendorTree = null [protected]

Definition at line 331 of file oxubase.php.

oxUBase.$_sAdditionalParams = null [protected]

Definition at line 208 of file oxubase.php.

oxUBase.$_sCatTreePath = null [protected]

Definition at line 460 of file oxubase.php.

oxUBase.$_sContentId = null [protected]

Default content id

Returns:
string

Reimplemented in Content.

Definition at line 257 of file oxubase.php.

oxUBase.$_sListOrderBy = null [protected]

Definition at line 170 of file oxubase.php.

oxUBase.$_sListOrderDir = null [protected]

Definition at line 176 of file oxubase.php.

oxUBase.$_sListType = null [protected]

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

Definition at line 58 of file oxubase.php.

oxUBase.$_sManufacturerId = null [protected]

Definition at line 424 of file oxubase.php.

oxUBase.$_sMetaDescription = null [protected]

Definition at line 182 of file oxubase.php.

oxUBase.$_sMetaDescriptionIdent = null [protected]

Reimplemented in Start.

Definition at line 195 of file oxubase.php.

oxUBase.$_sMetaKeywords = null [protected]

Definition at line 188 of file oxubase.php.

oxUBase.$_sMetaKeywordsIdent = null [protected]

Reimplemented in Start.

Definition at line 202 of file oxubase.php.

oxUBase.$_sMinOrderPrice = null [protected]

Definition at line 376 of file oxubase.php.

oxUBase.$_sVendorId = null [protected]

Definition at line 406 of file oxubase.php.

oxUBase.$_sViewResetID = null [protected]

Definition at line 271 of file oxubase.php.

oxUBase.$_sWishlistName = null [protected]

Definition at line 244 of file oxubase.php.

The documentation for this class was generated from the following file:
Generated by  doxygen 1.7.1