Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes

oxUBase Class Reference

Inheritance diagram for oxUBase:
Collaboration diagram for oxUBase:

List of all members.

Public Member Functions

 init ()
 getViewId ()
 showSorting ()
 setComponents ($aComponents=null)
 getComponents ()
 getComponent ($sName)
 setIsOrderStep ($blIsOrderStep=null)
 getIsOrderStep ()
 setActiveCategory ($oCategory)
 getActiveCategory ()
 getListType ()
 getListDisplayType ()
 getCustomListDisplayType ()
 setListType ($sType)
 loadCurrency ()
 dontShowEmptyCategories ()
 showCategoryArticlesCount ()
 isLanguageLoaded ()
 getTopNavigationCatCnt ()
 addRssFeed ($sTitle, $sUrl, $key=null)
 getSortOrderByParameterName ()
 getSortOrderParameterName ()
 getSortIdent ()
 getDefaultSorting ()
 getUserSelectedSorting ()
 getSavedSorting ($sSortIdent)
 setListOrderBy ($sColumn)
 setListOrderDirection ($sDirection)
 getListOrderBy ()
 getListOrderDirection ()
 setMetaDescription ($sDescription)
 setMetaKeywords ($sKeywords)
 getMetaKeywords ()
 getMetaDescription ()
 getActCurrency ()
 setActCurrency ($oCur)
 getCompareItemCount ()
 noIndex ()
 getMenueList ()
 setMenueList ($aMenu)
 getNavigationParams ()
 setItemSorting ($sSortIdent, $sSortBy, $sSortDir=null)
 getSorting ($sSortIdent)
 getSortingSql ($sIdent)
 getTitleSuffix ()
 getTitlePageSuffix ()
 getTitlePrefix ()
 getPageTitle ()
 getDynUrlParams ()
 getBaseLink ($iLang=null)
 getLink ($iLang=null)
 getCanonicalUrl ()
 getSimilarRecommListIds ()
 getSearchParamForHtml ()
 showSearch ()
 getRssLinks ()
 getSortColumns ()
 setSortColumns ($aSortColumns)
 getEditTags ()
 getRecommSearch ()
 getPaymentList ()
 getActiveRecommList ()
 getAccessoires ()
 getCrossSelling ()
 getSimilarProducts ()
 getAlsoBoughtTheseProducts ()
 getArticleId ()
 getTitle ()
 getActiveLangAbbr ()
 addGlobalParams ($oShop=null)
 getAdditionalParams ()
 generatePageNavigationUrl ()
 getPageNavigation ()
 getPageNavigationLimitedTop ($iPositionCount=7)
 getPageNavigationLimitedBottom ($iPositionCount=11)
 generatePageNavigation ($iPositionCount=0)
 render ()
 getViewProduct ()
 setViewProduct ($oProduct)
 getViewProductList ()
 getActPage ()
 getActTag ()
 getActVendor ()
 getActManufacturer ()
 setActVendor ($oVendor)
 setActManufacturer ($oManufacturer)
 getActSearch ()
 getCategoryTree ()
 setCategoryTree ($oCatTree)
 getManufacturerTree ()
 setManufacturerTree ($oManufacturerTree)
 getAddUrlParams ()
 getTop5ArticleList ($iCount=null)
 getBargainArticleList ()
 isLowOrderPrice ()
 getMinOrderPrice ()
 getNewsRealStatus ()
 getProduct ()
 getManufacturerlist ()
 setManufacturerlist ($aList)
 setRootVendor ($oVendor)
 getRootVendor ()
 setRootManufacturer ($oManufacturer)
 getRootManufacturer ()
 getVendorId ()
 getManufacturerId ()
 getCatMoreUrl ()
 getCatTreePath ()
 getContentByIdent ($sIdent)
 getContentCategory ()
 getMustFillFields ()
 isFieldRequired ($sField)
 getFormId ()
 canAcceptFormData ()
 getPromoFinishedList ()
 getPromoCurrentList ()
 getPromoFutureList ()
 getShowPromotionList ()
 isEnabledPrivateSales ()
 getFieldValidationErrors ()
 getBreadCrumb ()
 setRootCatChanged ($blRootCatChanged)
 isRootCatChanged ()
 getInvoiceAddress ()
 getDeliveryAddress ()
 setDeliveryAddress ($aDeliveryAddress)
 setInvoiceAddress ($aAddress)
 getActiveUsername ()
 getWishlistUserId ()
 getSearchCatId ()
 getSearchVendor ()
 getSearchManufacturer ()
 getLastProducts ()
 getNewBasketItemMsgType ()
 isActive ($sName)
 isFbWidgetVisible ()
 isEnabledDownloadableFiles ()
 showRememberMe ()
 isVatIncluded ()
 isPriceCalculated ()
 showTags ()
 getWishlistName ()
 getWidgetLink ()

Protected Member Functions

 _getComponentNames ()
 _processRequest ()
 _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)
 _canRedirect ()

Protected Attributes

 $_blFbWidgetsOn = null
 $_sRemoveMetaChars = '.\+*?[^]$(){}=!<>|:&'
 $_oaComponents = array()
 $_blIsOrderStep = false
 $_sListType = null
 $_aListDisplayTypes = array('grid', 'line', 'infogrid')
 $_sListDisplayType = null
 $_sCustomListDisplayType = null
 $_oActCategory = null
 $_oActManufacturer = null
 $_oActVendor = null
 $_oActiveRecommList = null
 $_oActSearch = null
 $_blShowSorting = false
 $_blLoadCurrency = null
 $_blLoadManufacturerTree = null
 $_blDontShowEmptyCats = null
 $_blLoadLanguage = null
 $_iTopCatNavItmCnt = null
 $_aRssLinks = null
 $_sListOrderBy = null
 $_sListOrderDir = null
 $_sMetaDescription = null
 $_sMetaKeywords = null
 $_sMetaDescriptionIdent = null
 $_sMetaKeywordsIdent = null
 $_sAdditionalParams = null
 $_oActCurrency = null
 $_blEnabledPrivateSales = null
 $_blCommonAdded = false
 $_iViewIndexState = VIEW_INDEXSTATE_INDEX
 $_blForceNoIndex = false
 $_iCompItemsCnt = null
 $_sContentId = null
 $_oContent = null
 $_sViewResetID = null
 $_aMenueList = null
 $_aComponentNames
 $_aUserComponentNames = array()
 $_oProduct = null
 $_iActPage = null
 $_aArticleList = null
 $_oManufacturerTree = null
 $_oCategoryTree = null
 $_aTop5ArticleList = null
 $_aBargainArticleList = null
 $_blLowOrderPrice = null
 $_sMinOrderPrice = null
 $_iNewsRealStatus = null
 $_aBlockRedirectParams = array('fnc', 'stoken', 'force_sid', 'force_admin_sid')
 $_oRootVendor = null
 $_sVendorId = null
 $_aManufacturerlist = null
 $_oRootManufacturer = null
 $_sManufacturerId = null
 $_blNewsSubscribed = null
 $_oDelAddress = null
 $_sCatTreePath = null
 $_aContents = array()
 $_blTop5Action = false
 $_blBargainAction = false
 $_aMustFillFields = null
 $_blShowTagCloud = true
 $_blRootCatChanged = false
 $_aInvoiceAddress = null
 $_aDeliveryAddress = null
 $_sActiveUsername = null
 $_blLoadComponents = true
 $_aSortColumns = null

Static Protected Attributes

static $_aCollectedComponentNames = 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 17 of file oxubase.php.

Member Function Documentation

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

Adds page number parameter to url and returns modified url, if page number 0 drops from url

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

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

Definition at line 2042 of file oxubase.php.

oxUBase._canRedirect (  )  [protected]

Checks if current request parameters does not block SEO redirection process

Returns:
bool

Reimplemented in Search.

Definition at line 2498 of file oxubase.php.

oxUBase._forceNoIndex (  )  [protected]

Forces output no index meta data for current view

Definition at line 1200 of file oxubase.php.

oxUBase._getComponentNames (  )  [protected]

Returns component names

Returns:
array

Definition at line 533 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 1104 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 1084 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 1687 of file oxubase.php.

oxUBase._getSeoObjectId (  )  [protected]

Override this function to return object it which is used to identify its seo meta info

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

Definition at line 1303 of file oxubase.php.

oxUBase._getSeoRequestParams (  )  [protected]

collects _GET parameters used by eShop SEO and returns uri

Returns:
string

Definition at line 1768 of file oxubase.php.

oxUBase._getSubject ( $  iLang  )  [protected]

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

Parameters:
int $iLang language id
Returns:
object

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

Definition at line 1562 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 duplicate cleaning
Returns:
string $sString converted string

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

Definition at line 1316 of file oxubase.php.

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

Returns current view keywords separated by comma

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

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

Definition at line 1363 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

Reimplemented in oxWidget.

Definition at line 561 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 separated by comma

Definition at line 1383 of file oxubase.php.

oxUBase._setNrOfArtPerPage (  )  [protected]

Sets number of articles per page to config value

Definition at line 1252 of file oxubase.php.

oxUBase.addGlobalParams ( $  oShop = null  ) 

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

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

Reimplemented from oxView.

Definition at line 1974 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

Definition at line 910 of file oxubase.php.

oxUBase.canAcceptFormData (  ) 

Checks if session session form id matches with form id

Returns:
bool

Definition at line 2715 of file oxubase.php.

oxUBase.dontShowEmptyCategories (  ) 

Returns true if empty categories are not loaded

Returns:
bool

Definition at line 849 of file oxubase.php.

oxUBase.generatePageNavigation ( $  iPositionCount = 0  ) 

Generates variables for page navigation

Parameters:
int $iPositionCount - paging positions count ( 0 - unlimited )
Returns:
stdClass $pageNavigation Object with page navigation data

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

oxUBase.getAccessoires (  ) 

Template variable getter. Returns accessoires of article

Reimplemented in oxwArticleDetails, and Details.

Definition at line 1896 of file oxubase.php.

oxUBase.getActCurrency (  ) 

Get active currency

Returns:
object

Definition at line 1167 of file oxubase.php.

oxUBase.getActiveCategory (  ) 

Returns active category

Returns:
null

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

Definition at line 749 of file oxubase.php.

oxUBase.getActiveLangAbbr (  ) 

Returns active lang suffix

Returns:
string

Definition at line 1947 of file oxubase.php.

oxUBase.getActiveRecommList (  ) 

Template variable getter. Returns active recommendation lists

Returns:
oxRecommList

Reimplemented in Account_Recommlist, and Review.

Definition at line 1880 of file oxubase.php.

oxUBase.getActiveUsername (  ) 

Template variable getter. Returns logged in user name

Returns:
string

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

oxUBase.getActPage (  ) 

Active page getter

Returns:
int

Reimplemented in aList.

Definition at line 2228 of file oxubase.php.

oxUBase.getActSearch (  ) 

Returns fake object which is used to mount navigation info

Returns:
stdClass

Definition at line 2339 of file oxubase.php.

oxUBase.getActTag (  ) 

Active tag info object getter. Object properties:

  • sTag current tag
  • link link leading to tag article list
Returns:
stdClass

Definition at line 2245 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 2271 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 1988 of file oxubase.php.

oxUBase.getAddUrlParams (  ) 

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

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

Definition at line 2393 of file oxubase.php.

oxUBase.getAlsoBoughtTheseProducts (  ) 

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

Reimplemented in oxwArticleDetails, Details, and Thankyou.

Definition at line 1917 of file oxubase.php.

oxUBase.getArticleId (  ) 

Return the active article id

Reimplemented in oxwReview, and Account.

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

oxUBase.getBaseLink ( $  iLang = null  ) 

Get base link of current view

Parameters:
int $iLang requested language
Returns:
string

Definition at line 1615 of file oxubase.php.

oxUBase.getBreadCrumb (  ) 

Returns Bread Crumb - you are here page1/page2/page3...

Returns:
null

Reimplemented in Account, Account_Newsletter, Account_Noticelist, Account_Order, Account_Recommlist, Account_User, Account_Wishlist, aList, Basket, ClearCookies, Compare, Contact, Content, Details, ForgotPwd, GuestBook, Invite, Links, ManufacturerList, News, Newsletter, order, Payment, RecommList, Register, Search, Suggest, Tag, Tags, Thankyou, User, VendorList, and Wishlist.

Definition at line 2834 of file oxubase.php.

oxUBase.getCanonicalUrl (  ) 

Returns view object canonical url

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

oxUBase.getCatMoreUrl (  ) 

Template variable getter. Returns more category

Returns:
object

Definition at line 2615 of file oxubase.php.

oxUBase.getCatTreePath (  ) 

Template variable getter. Returns category path

Returns:
string

Reimplemented in aList, ManufacturerList, and VendorList.

Definition at line 2625 of file oxubase.php.

oxUBase.getCompareItemCount (  ) 

Template variable getter. Returns comparison article list count.

Returns:
integer

Definition at line 1187 of file oxubase.php.

oxUBase.getComponent ( $  sName  ) 

Get component object

Parameters:
string $sName name of component object
Returns:
object

Definition at line 706 of file oxubase.php.

oxUBase.getComponents (  ) 

Get array of component objects

Returns:
array

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

oxUBase.getContentCategory (  ) 

Default content category getter, returns FALSE by default

Returns:
bool

Reimplemented in Content.

Definition at line 2652 of file oxubase.php.

oxUBase.getCrossSelling (  ) 

Template variable getter. Returns crosssellings

Reimplemented in oxwArticleDetails, Details, and Suggest.

Definition at line 1903 of file oxubase.php.

oxUBase.getCustomListDisplayType (  ) 

Returns changed default list type

Returns:
string

Definition at line 803 of file oxubase.php.

oxUBase.getDefaultSorting (  ) 

Returns default category sorting for selected category

Returns:
null

Reimplemented in oxwArticleDetails, aList, Details, and GuestBook.

Definition at line 961 of file oxubase.php.

oxUBase.getDeliveryAddress (  ) 

Template variable getter. Returns user delivery address

Returns:
array

Definition at line 2881 of file oxubase.php.

oxUBase.getDynUrlParams (  ) 

returns additional url params for dynamic url building

Returns:
string

Reimplemented in Review.

Definition at line 1572 of file oxubase.php.

oxUBase.getEditTags (  ) 

Returns if tags will be edit

Reimplemented in Details.

Definition at line 1857 of file oxubase.php.

oxUBase.getFieldValidationErrors (  ) 

Returns input field validation error array (if available)

Returns:
array

Definition at line 2824 of file oxubase.php.

oxUBase.getFormId (  ) 

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

Returns:
string

Definition at line 2700 of file oxubase.php.

oxUBase.getInvoiceAddress (  ) 

Template variable getter. Returns user address

Returns:
array

Definition at line 2864 of file oxubase.php.

oxUBase.getIsOrderStep (  ) 

Get flag if current view is an order view

Returns:
bool

Definition at line 728 of file oxubase.php.

oxUBase.getLastProducts (  ) 

Template variable getter. Returns last seen products

Definition at line 2968 of file oxubase.php.

oxUBase.getLink ( $  iLang = null  ) 

Get link of current view. In url its include also page number if it is list page

Parameters:
int $iLang requested language
Returns:
string

Reimplemented in oxwArticleBox, RecommList, and Suggest.

Definition at line 1649 of file oxubase.php.

oxUBase.getListDisplayType (  ) 

Returns list type

Returns:
string

Definition at line 777 of file oxubase.php.

oxUBase.getListOrderBy (  ) 

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

Returns:
array

Definition at line 1031 of file oxubase.php.

oxUBase.getListOrderDirection (  ) 

Template variable getter. Returns list order direction

Returns:
array

Definition at line 1048 of file oxubase.php.

oxUBase.getListType (  ) 

Get list type

Returns:
string list type

Reimplemented in Account.

Definition at line 759 of file oxubase.php.

oxUBase.getManufacturerId (  ) 

Template variable getter. Returns Manufacturer id

Returns:
string

Definition at line 2598 of file oxubase.php.

oxUBase.getManufacturerlist (  ) 

Template variable getter. Returns Manufacturer list for search

Returns:
array

Definition at line 2521 of file oxubase.php.

oxUBase.getManufacturerTree (  ) 

Returns Manufacturer tree (if it is loaded0

Returns:
oxManufacturerList

Definition at line 2375 of file oxubase.php.

oxUBase.getMenueList (  ) 

Template variable getter. Returns header menu list

Returns:
array

Definition at line 1234 of file oxubase.php.

oxUBase.getMetaDescription (  ) 

Template variable getter. Returns meta description

Returns:
string

Reimplemented in aList, and Details.

Definition at line 1144 of file oxubase.php.

oxUBase.getMetaKeywords (  ) 

Template variable getter. Returns meta keywords

Returns:
string

Definition at line 1121 of file oxubase.php.

oxUBase.getMinOrderPrice (  ) 

Template variable getter. Returns formatted min order price value

Deprecated:
in v4.8/5.1 on 2013-10-14; use oxBasket method
Returns:
string

Definition at line 2473 of file oxubase.php.

oxUBase.getMustFillFields (  ) 

Returns array of fields which must be filled during registration

Returns:
array | bool

Definition at line 2662 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 broken templates problems

Returns:
array

Reimplemented in Account, Account_Noticelist, Account_Recommlist, Details, and RecommList.

Definition at line 1421 of file oxubase.php.

oxUBase.getNewBasketItemMsgType (  ) 

Returns added basket item notification message type

Returns:
int

Definition at line 2978 of file oxubase.php.

oxUBase.getNewsRealStatus (  ) 

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

Returns:
integer

Definition at line 2488 of file oxubase.php.

oxUBase.getPageNavigation (  ) 

Template variable getter. Returns page navigation

Reimplemented in Account_Order, Account_Recommlist, aList, Compare, GuestBook, News, Review, and Search.

Definition at line 2063 of file oxubase.php.

oxUBase.getPageNavigationLimitedBottom ( $  iPositionCount = 11  ) 

Template variable getter. Returns page navigation with default 11 positions

Parameters:
int $iPositionCount - paging positions count ( 0 - unlimited )
Returns:
object

Definition at line 2089 of file oxubase.php.

oxUBase.getPageNavigationLimitedTop ( $  iPositionCount = 7  ) 

Template variable getter. Returns page navigation with default 7 positions

Parameters:
int $iPositionCount - paging positions count ( 0 - unlimited )
Returns:
object

Definition at line 2075 of file oxubase.php.

oxUBase.getPageTitle (  ) 

Returns full page title

Returns:
string

Definition at line 1533 of file oxubase.php.

oxUBase.getPaymentList (  ) 

Template variable getter. Returns payment id

Reimplemented in Payment.

Definition at line 1871 of file oxubase.php.

oxUBase.getProduct (  ) 

Empty active product getter

Reimplemented in oxwArticleBox, oxwArticleDetails, Details, MoreDetails, Pricealarm, and Suggest.

Definition at line 2512 of file oxubase.php.

oxUBase.getPromoCurrentList (  ) 

return current promotion list

Returns:
oxActionList

Definition at line 2756 of file oxubase.php.

oxUBase.getPromoFinishedList (  ) 

return last finished promotion list

Returns:
oxActionList

Definition at line 2740 of file oxubase.php.

oxUBase.getPromoFutureList (  ) 

return future promotion list

Returns:
oxActionList

Definition at line 2772 of file oxubase.php.

oxUBase.getRecommSearch (  ) 

Template variable getter. Returns search string

Reimplemented in RecommList.

Definition at line 1864 of file oxubase.php.

oxUBase.getRootManufacturer (  ) 

Template variable getter. Returns root Manufacturer

Returns:
object

Definition at line 2571 of file oxubase.php.

oxUBase.getRootVendor (  ) 

Template variable getter. Returns root vendor

Returns:
object

Definition at line 2551 of file oxubase.php.

oxUBase.getRssLinks (  ) 

Returns RSS links

Returns:
array

Definition at line 1824 of file oxubase.php.

oxUBase.getSavedSorting ( $  sSortIdent  ) 

Returns sorting variable from session

Parameters:
string $sSortIdent sorting indent
Returns:
array

Definition at line 998 of file oxubase.php.

oxUBase.getSearchCatId (  ) 

Template variable getter. Returns searched category id

Reimplemented in Search.

Definition at line 2947 of file oxubase.php.

oxUBase.getSearchManufacturer (  ) 

Template variable getter. Returns searched Manufacturer id

Reimplemented in Search.

Definition at line 2961 of file oxubase.php.

oxUBase.getSearchParamForHtml (  ) 

Template variable getter. Returns search parameter for Html So far this method is implemented in search (search.php) view.

Reimplemented in Account, Details, and Search.

Definition at line 1676 of file oxubase.php.

oxUBase.getSearchVendor (  ) 

Template variable getter. Returns searched vendor id

Reimplemented in Search.

Definition at line 2954 of file oxubase.php.

oxUBase.getShowPromotionList (  ) 

should promotions list be shown?

Returns:
bool

Definition at line 2788 of file oxubase.php.

oxUBase.getSimilarProducts (  ) 

Template variable getter. Returns similar article list

Reimplemented in oxwArticleDetails, Account_Noticelist, Details, and Suggest.

Definition at line 1910 of file oxubase.php.

oxUBase.getSimilarRecommListIds (  ) 

Return array of id to form recommend list. Should be overridden if need.

Returns:
array

Reimplemented in oxwArticleDetails, Account_Noticelist, Account_Wishlist, aList, Basket, Compare, Details, 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 1834 of file oxubase.php.

oxUBase.getSortIdent (  ) 

Returns page sort ident. It is used as ident in session variable aSorting[ident]

Returns:
string

Reimplemented in GuestBook.

Definition at line 951 of file oxubase.php.

oxUBase.getSorting ( $  sSortIdent  ) 

Returns sorting config for current item

Parameters:
string $sSortIdent sortable item id
Returns:
array

Definition at line 1467 of file oxubase.php.

oxUBase.getSortingSql ( $  sIdent  ) 

Returns part of SQL query with sorting params

Parameters:
string $sIdent sortable item id
Returns:
string

Definition at line 1492 of file oxubase.php.

oxUBase.getSortOrderByParameterName (  ) 

Returns sorted column parameter name

Returns:
string

Reimplemented in GuestBook.

Definition at line 930 of file oxubase.php.

oxUBase.getSortOrderParameterName (  ) 

Returns sorted column direction parameter name

Returns:
string

Reimplemented in GuestBook.

Definition at line 940 of file oxubase.php.

oxUBase.getTitle (  ) 

Returns current view title. Default is search for translation of PAGE_TITLE_{view_class_name}

Returns:
string

Reimplemented in Account, aList, Contact, Content, Details, ForgotPwd, ManufacturerList, News, Newsletter, RecommAdd, RecommList, Search, Tag, VendorList, and Wishlist.

Definition at line 1933 of file oxubase.php.

oxUBase.getTitlePageSuffix (  ) 

Returns title page suffix used in template in lists

Reimplemented in aList, and Tags.

Definition at line 1513 of file oxubase.php.

oxUBase.getTitlePrefix (  ) 

Returns title prefix used in template

Returns:
string

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

oxUBase.getTop5ArticleList ( $  iCount = null  ) 

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

Parameters:
integer $iCount - product count in list
Returns:
array

Definition at line 2405 of file oxubase.php.

oxUBase.getTopNavigationCatCnt (  ) 

Returns item count in top navigation of categories

Returns:
integer

Definition at line 893 of file oxubase.php.

oxUBase.getUserSelectedSorting (  ) 

Returns default category sorting for selected category

Returns:
array

Definition at line 971 of file oxubase.php.

oxUBase.getVendorId (  ) 

Template variable getter. Returns vendor id

Returns:
string

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

oxUBase.getViewProduct (  ) 

Returns current view product object (if it is loaded)

Returns:
oxArticle

Definition at line 2198 of file oxubase.php.

oxUBase.getViewProductList (  ) 

Returns view product list

Returns:
array

Definition at line 2218 of file oxubase.php.

oxUBase.getWidgetLink (  ) 

Get widget link for Ajax calls

Returns:
string

Definition at line 3101 of file oxubase.php.

oxUBase.getWishlistName (  ) 

Template variable getter. Returns user name of searched wishlist

Returns:
string

Definition at line 3080 of file oxubase.php.

oxUBase.getWishlistUserId (  ) 

Template variable getter. Returns user id from wish list

Returns:
string

Definition at line 2939 of file oxubase.php.

oxUBase.init (  ) 

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

Reimplemented from oxView.

Reimplemented in oxWidget, Download, order, Payment, Review, and Thankyou.

Definition at line 595 of file oxubase.php.

oxUBase.isActive ( $  sName  ) 

Checks if feature is enabled

Parameters:
string $sName feature name
Returns:
bool

Definition at line 2990 of file oxubase.php.

oxUBase.isEnabledDownloadableFiles (  ) 

Checks if downloadable files are turned on

Returns:
bool

Definition at line 3017 of file oxubase.php.

oxUBase.isEnabledPrivateSales (  ) 

Checks if private sales is on

Returns:
bool

Definition at line 2807 of file oxubase.php.

oxUBase.isFbWidgetVisible (  ) 

Returns TRUE if facebook widgets are on

Returns:
boolean

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

oxUBase.isLanguageLoaded (  ) 

Returns if language should be loaded

Returns:
bool

Definition at line 876 of file oxubase.php.

oxUBase.isLowOrderPrice (  ) 

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

Deprecated:
in v4.8/5.1 on 2013-10-14; use oxBasket method
Returns:
bool

Definition at line 2457 of file oxubase.php.

oxUBase.isPriceCalculated (  ) 

Returns true if price calculation is activated

Returns:
boolean

Definition at line 3060 of file oxubase.php.

oxUBase.isRootCatChanged (  ) 

Template variable getter. Returns true if active root category was changed

Returns:
bool

Definition at line 2854 of file oxubase.php.

oxUBase.isVatIncluded (  ) 

Returns true if articles shown in shop with VAT. Checks users VAT and options.

Returns:
boolean

Reimplemented in oxwArticleBox.

Definition at line 3038 of file oxubase.php.

oxUBase.loadCurrency (  ) 

Returns currency switching option

Returns:
bool

Definition at line 832 of file oxubase.php.

oxUBase.noIndex (  ) 

Marks that current view is marked as no index, no follow and article details links must contain no follow tags

Returns:
int

Reimplemented in Details.

Definition at line 1211 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 oxwArticleBox, oxwCategoryTree, oxwCookieNote, oxwRating, oxwReview, Account, Account_Newsletter, Account_Noticelist, Account_Order, Account_Password, Account_Recommlist, Account_User, Account_Wishlist, aList, Basket, ClearCookies, Content, Details, GuestBook, Invite, ManufacturerList, order, Payment, RecommAdd, Register, Review, Rss, Search, Start, Tag, Tags, Thankyou, Tpl, User, and VendorList.

Definition at line 2173 of file oxubase.php.

oxUBase.setActCurrency ( $  oCur  ) 

Active currency setter

Parameters:
object $oCur corrency object

Definition at line 1177 of file oxubase.php.

oxUBase.setActiveCategory ( $  oCategory  ) 

Active category setter

Parameters:
oxCategory $oCategory active category

Definition at line 739 of file oxubase.php.

oxUBase.setActManufacturer ( $  oManufacturer  ) 

Active Manufacturer setter

Parameters:
oxManufacturer $oManufacturer active Manufacturer

Definition at line 2329 of file oxubase.php.

oxUBase.setActVendor ( $  oVendor  ) 

Active vendor setter

Parameters:
oxVendor $oVendor active vendor

Definition at line 2319 of file oxubase.php.

oxUBase.setCategoryTree ( $  oCatTree  ) 

Category list setter

Parameters:
oxCategoryList $oCatTree category tree

Definition at line 2365 of file oxubase.php.

oxUBase.setComponents ( $  aComponents = null  ) 

Set array of component objects

Parameters:
array $aComponents array of components objects

Definition at line 684 of file oxubase.php.

oxUBase.setDeliveryAddress ( $  aDeliveryAddress  ) 

Template variable setter. Sets user delivery address

Parameters:
array $aDeliveryAddress delivery address

Definition at line 2899 of file oxubase.php.

oxUBase.setInvoiceAddress ( $  aAddress  ) 

Template variable setter. Sets user address

Parameters:
array $aAddress user address

Definition at line 2909 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

Definition at line 718 of file oxubase.php.

oxUBase.setItemSorting ( $  sSortIdent,
$  sSortBy,
$  sSortDir = null 
)

Sets sorting item config

Parameters:
string $sSortIdent sortable item id
string $sSortBy sort field
string $sSortDir sort direction (optional)

Definition at line 1451 of file oxubase.php.

oxUBase.setListOrderBy ( $  sColumn  ) 

Set sorting column name

Parameters:
string $sColumn - column name

Definition at line 1011 of file oxubase.php.

oxUBase.setListOrderDirection ( $  sDirection  ) 

Set sorting directions

Parameters:
string $sDirection - direction desc / asc

Definition at line 1021 of file oxubase.php.

oxUBase.setListType ( $  sType  ) 

List type setter

Parameters:
string $sType type of list

Definition at line 821 of file oxubase.php.

oxUBase.setManufacturerlist ( $  aList  ) 

Sets Manufacturer list for search

Parameters:
array $aList manufacturer list

Definition at line 2531 of file oxubase.php.

oxUBase.setManufacturerTree ( $  oManufacturerTree  ) 

Manufacturer tree setter

Parameters:
oxManufacturerList $oManufacturerTree Manufacturer tree

Definition at line 2385 of file oxubase.php.

oxUBase.setMenueList ( $  aMenu  ) 

Header menu list setter

Parameters:
array $aMenu menu list

Definition at line 1244 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 1060 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 1072 of file oxubase.php.

oxUBase.setRootCatChanged ( $  blRootCatChanged  ) 

Sets if active root category was changed

Parameters:
bool $blRootCatChanged root category changed

Definition at line 2844 of file oxubase.php.

oxUBase.setRootManufacturer ( $  oManufacturer  ) 

Sets root Manufacturer

Parameters:
object $oManufacturer manufacturer object

Definition at line 2561 of file oxubase.php.

oxUBase.setRootVendor ( $  oVendor  ) 

Sets root vendor

Parameters:
object $oVendor vendor object

Definition at line 2541 of file oxubase.php.

oxUBase.setSortColumns ( $  aSortColumns  ) 

Set sorting columns

Parameters:
array $aSortColumns array of column names array('name1', 'name2',...)

Definition at line 1849 of file oxubase.php.

oxUBase.setViewProduct ( $  oProduct  ) 

Sets view product

Parameters:
oxArticle $oProduct view product object

Definition at line 2208 of file oxubase.php.

oxUBase.showCategoryArticlesCount (  ) 

Returns true if empty categories are not loaded

Returns:
bool

Definition at line 866 of file oxubase.php.

oxUBase.showRememberMe (  ) 

Returns true if "Remember me" are ON

Returns:
boolean

Definition at line 3027 of file oxubase.php.

oxUBase.showSearch (  ) 

Returns show category search

Returns:
bool

Definition at line 1809 of file oxubase.php.

oxUBase.showSorting (  ) 

Template variable getter. Returns true if sorting is on

Returns:
bool

Definition at line 674 of file oxubase.php.

oxUBase.showTags (  ) 

Returns true if tags are ON

Returns:
boolean

Definition at line 3070 of file oxubase.php.

Member Data Documentation

oxUBase.$_aArticleList = null [protected]

Definition at line 327 of file oxubase.php.

oxUBase.$_aBargainArticleList = null [protected]

Definition at line 355 of file oxubase.php.

oxUBase.$_aBlockRedirectParams = array('fnc', 'stoken', 'force_sid', 'force_admin_sid') [protected]

Url parameters which block redirection

Returns:
null

Definition at line 383 of file oxubase.php.

oxUBase.$_aCollectedComponentNames = null [static, protected]

Definition at line 510 of file oxubase.php.

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

Reimplemented in oxwArticleBox, oxwArticleDetails, oxwCategoryTree, oxwCurrencyList, oxWidget, oxwLanguageList, oxwManufacturerList, oxwMiniBasket, oxwRating, oxwRecommendation, oxwReview, and oxwServiceMenu.

Definition at line 289 of file oxubase.php.

oxUBase.$_aContents = array() [protected]

Definition at line 446 of file oxubase.php.

oxUBase.$_aDeliveryAddress = null [protected]

Definition at line 495 of file oxubase.php.

oxUBase.$_aInvoiceAddress = null [protected]

Definition at line 488 of file oxubase.php.

oxUBase.$_aListDisplayTypes = array('grid', 'line', 'infogrid') [protected]

Definition at line 60 of file oxubase.php.

oxUBase.$_aManufacturerlist = null [protected]

Definition at line 404 of file oxubase.php.

oxUBase.$_aMenueList = null [protected]

Definition at line 281 of file oxubase.php.

oxUBase.$_aMustFillFields = null [protected]

Definition at line 467 of file oxubase.php.

oxUBase.$_aRssLinks = null [protected]

Definition at line 158 of file oxubase.php.

oxUBase.$_aSortColumns = null [protected]

Reimplemented in GuestBook.

Definition at line 526 of file oxubase.php.

oxUBase.$_aTop5ArticleList = null [protected]

Definition at line 348 of file oxubase.php.

oxUBase.$_aUserComponentNames = array() [protected]

Definition at line 306 of file oxubase.php.

oxUBase.$_blBargainAction = false [protected]

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

Definition at line 460 of file oxubase.php.

oxUBase.$_blCommonAdded = false [protected]

Definition at line 230 of file oxubase.php.

oxUBase.$_blDontShowEmptyCats = null [protected]

Definition at line 137 of file oxubase.php.

oxUBase.$_blEnabledPrivateSales = null [protected]

Definition at line 221 of file oxubase.php.

oxUBase.$_blFbWidgetsOn = null [protected]

Definition at line 25 of file oxubase.php.

oxUBase.$_blForceNoIndex = false [protected]

Definition at line 246 of file oxubase.php.

oxUBase.$_blIsOrderStep = false [protected]

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

Definition at line 46 of file oxubase.php.

oxUBase.$_blLoadComponents = true [protected]

Reimplemented in oxWidget.

Definition at line 518 of file oxubase.php.

oxUBase.$_blLoadCurrency = null [protected]

Definition at line 123 of file oxubase.php.

oxUBase.$_blLoadLanguage = null [protected]

Definition at line 144 of file oxubase.php.

oxUBase.$_blLoadManufacturerTree = null [protected]

Definition at line 130 of file oxubase.php.

oxUBase.$_blLowOrderPrice = null [protected]

Definition at line 362 of file oxubase.php.

oxUBase.$_blNewsSubscribed = null [protected]

Definition at line 425 of file oxubase.php.

oxUBase.$_blRootCatChanged = false [protected]

Definition at line 481 of file oxubase.php.

oxUBase.$_blShowSorting = false [protected]

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

Definition at line 116 of file oxubase.php.

oxUBase.$_blShowTagCloud = true [protected]

Reimplemented in Account, aList, and Compare.

Definition at line 474 of file oxubase.php.

oxUBase.$_blTop5Action = false [protected]

Reimplemented in Start.

Definition at line 453 of file oxubase.php.

oxUBase.$_iActPage = null [protected]

Definition at line 320 of file oxubase.php.

oxUBase.$_iCompItemsCnt = null [protected]

Reimplemented in Compare.

Definition at line 253 of file oxubase.php.

oxUBase.$_iNewsRealStatus = null [protected]

Definition at line 376 of file oxubase.php.

oxUBase.$_iTopCatNavItmCnt = null [protected]

Definition at line 151 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_Downloads, Account_Noticelist, Account_Wishlist, Basket, Contact, ForgotPwd, GuestBook, ManufacturerList, MoreDetails, Newsletter, Register, Review, Search, Tag, and VendorList.

Definition at line 238 of file oxubase.php.

oxUBase.$_oaComponents = array() [protected]

Definition at line 39 of file oxubase.php.

oxUBase.$_oActCategory = null [protected]

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

oxUBase.$_oActManufacturer = null [protected]

Definition at line 88 of file oxubase.php.

oxUBase.$_oActSearch = null [protected]

Definition at line 109 of file oxubase.php.

oxUBase.$_oActVendor = null [protected]

Definition at line 95 of file oxubase.php.

oxUBase.$_oCategoryTree = null [protected]

Definition at line 341 of file oxubase.php.

oxUBase.$_oContent = null [protected]

Default content

Returns:
oxContent

Reimplemented in Content.

Definition at line 267 of file oxubase.php.

oxUBase.$_oDelAddress = null [protected]

Reimplemented in order.

Definition at line 432 of file oxubase.php.

oxUBase.$_oManufacturerTree = null [protected]

Definition at line 334 of file oxubase.php.

oxUBase.$_oProduct = null [protected]

Definition at line 313 of file oxubase.php.

oxUBase.$_oRootManufacturer = null [protected]

Definition at line 411 of file oxubase.php.

oxUBase.$_oRootVendor = null [protected]

Definition at line 390 of file oxubase.php.

oxUBase.$_sActiveUsername = null [protected]

Definition at line 502 of file oxubase.php.

oxUBase.$_sAdditionalParams = null [protected]

Definition at line 207 of file oxubase.php.

oxUBase.$_sCatTreePath = null [protected]

Definition at line 439 of file oxubase.php.

oxUBase.$_sContentId = null [protected]

Default content id

Returns:
string

Reimplemented in Content, and Credits.

Definition at line 260 of file oxubase.php.

oxUBase.$_sCustomListDisplayType = null [protected]

Definition at line 74 of file oxubase.php.

oxUBase.$_sListDisplayType = null [protected]

Reimplemented in Start.

Definition at line 67 of file oxubase.php.

oxUBase.$_sListOrderBy = null [protected]

Reimplemented in GuestBook.

Definition at line 165 of file oxubase.php.

oxUBase.$_sListOrderDir = null [protected]

Reimplemented in GuestBook.

Definition at line 172 of file oxubase.php.

oxUBase.$_sListType = null [protected]

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

Definition at line 53 of file oxubase.php.

oxUBase.$_sManufacturerId = null [protected]

Definition at line 418 of file oxubase.php.

oxUBase.$_sMetaDescription = null [protected]

Definition at line 179 of file oxubase.php.

oxUBase.$_sMetaDescriptionIdent = null [protected]

Reimplemented in Account, and Start.

Definition at line 193 of file oxubase.php.

oxUBase.$_sMetaKeywords = null [protected]

Definition at line 186 of file oxubase.php.

oxUBase.$_sMetaKeywordsIdent = null [protected]

Reimplemented in Account, and Start.

Definition at line 200 of file oxubase.php.

oxUBase.$_sMinOrderPrice = null [protected]

Definition at line 369 of file oxubase.php.

oxUBase.$_sRemoveMetaChars = '.\+*?[^]$(){}=!<>|:&' [protected]

Definition at line 32 of file oxubase.php.

oxUBase.$_sVendorId = null [protected]

Definition at line 397 of file oxubase.php.

oxUBase.$_sViewResetID = null [protected]

Definition at line 274 of file oxubase.php.

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