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 ($sCulumn)
 setListOrderDirection ($sDirection)
 prepareSortColumns ()
 getListOrderBy ()
 getListOrderDirection ()
 setMetaDescription ($sDescription)
 setMetaKeywords ($sKeywords)
 getMetaKeywords ()
 getMetaDescription ()
 getActCurrency ()
 setActCurrency ($oCur)
 getCompareItemCount ()
 noIndex ()
 isSortingActive ()
 getMenueList ()
 setMenueList ($aMenue)
 getNavigationParams ()
 setItemSorting ($sSortIdent, $sSortBy, $sSortDir=null)
 getSorting ($sSortIdent)
 getSortingSql ($sCnid)
 getTitleSuffix ()
 getTitlePageSuffix ()
 getTitlePrefix ()
 getDynUrlParams ()
 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 ()
 getPageNavigationLimitedBottom ()
 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 ()
 getBargainArticleList ()
 isLowOrderPrice ()
 getMinOrderPrice ()
 getNewsRealStatus ()
 getProduct ()
 getManufacturerlist ()
 setManufacturerlist ($aList)
 setRootVendor ($oVendor)
 getRootVendor ()
 setRootManufacturer ($oManufacturer)
 getRootManufacturer ()
 getVendorId ()
 getManufacturerId ()
 getSearchCatTree ()
 setSearchCatTree ($aTree)
 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 ()

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
 $_blActiveSorting = 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
 $_aSearchCatTree = null
 $_blNewsSubscribed = null
 $_oDelAddress = null
 $_sCatTreePath = null
 $_aContents = array()
 $_blTop5Action = true
 $_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 2076 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 2537 of file oxubase.php.

oxUBase._forceNoIndex (  )  [protected]

Forces output noindex meta data for current view

Returns:
null

Definition at line 1218 of file oxubase.php.

oxUBase._getComponentNames (  )  [protected]

Returns component names

Returns:
array

Definition at line 498 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 1120 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 1101 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 1708 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, Credits, Details, ManufacturerList, Tag, and VendorList.

Definition at line 1337 of file oxubase.php.

oxUBase._getSeoRequestParams (  )  [protected]

collects _GET parameters used by eShop SEO and returns uri

Returns:
string

Definition at line 1789 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 1587 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 1350 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 1397 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 527 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 1429 of file oxubase.php.

oxUBase._setNrOfArtPerPage (  )  [protected]

Sets number of articles per page to config value

Returns:
null

Definition at line 1286 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 2008 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 876 of file oxubase.php.

oxUBase.canAcceptFormData (  ) 

Checks if session session form id matches with form id

Returns:
bool

Definition at line 2780 of file oxubase.php.

oxUBase.dontShowEmptyCategories (  ) 

Returns true if empty categories are not loaded

Returns:
bool

Definition at line 816 of file oxubase.php.

oxUBase.generatePageNavigation ( $  iPositionCount = 0  ) 

Generates variables for page navigation

Parameters:
int $iPositionCount - paging possitions count ( 0 - unlimited )
Returns:
stdClass $pageNavigation Object with pagenavigation data

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

oxUBase.getAccessoires (  ) 

Template variable getter. Returns accessoires of article

Returns:
object

Reimplemented in Details.

Definition at line 1924 of file oxubase.php.

oxUBase.getActCurrency (  ) 

Get active currency

Returns:
object

Definition at line 1182 of file oxubase.php.

oxUBase.getActiveCategory (  ) 

Returns active category

Returns:
null

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

Definition at line 719 of file oxubase.php.

oxUBase.getActiveLangAbbr (  ) 

Returns active lang suffix

Returns:
string

Definition at line 1981 of file oxubase.php.

oxUBase.getActiveRecommList (  ) 

Template variable getter. Returns active recommendation lists

Returns:
string

Reimplemented in Account_Recommlist, and Review.

Definition at line 1907 of file oxubase.php.

oxUBase.getActiveUsername (  ) 

Template variable getter. Returns logged in user name

Returns:
string

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

oxUBase.getActPage (  ) 

Active page getter

Returns:
int

Reimplemented in aList.

Definition at line 2270 of file oxubase.php.

oxUBase.getActSearch (  ) 

Returns fake object which is used to mount navigation info

Returns:
stdClass

Definition at line 2382 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 2286 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 2310 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 2022 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 2441 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 1951 of file oxubase.php.

oxUBase.getArticleId (  ) 

Return the active article id

Returns:
string | bool

Reimplemented in Account.

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

oxUBase.getBreadCrumb (  ) 

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

Returns:
null

Reimplemented in Account, Account_Downloads, Account_Newsletter, Account_Noticelist, Account_Order, Account_Password, 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 2892 of file oxubase.php.

oxUBase.getCanonicalUrl (  ) 

Returns view object canonical url

Returns:
string

Reimplemented in aList, Details, Start, and Tag.

Definition at line 1677 of file oxubase.php.

oxUBase.getCategoryTree (  ) 

Returns category tree (if it is loaded)

Returns:
oxcategorylist

Definition at line 2397 of file oxubase.php.

oxUBase.getCatMoreUrl (  ) 

Template variable getter. Returns more category

Returns:
object

Definition at line 2682 of file oxubase.php.

oxUBase.getCatTreePath (  ) 

Template variable getter. Returns category path

Returns:
string

Reimplemented in aList, ManufacturerList, and VendorList.

Definition at line 2692 of file oxubase.php.

oxUBase.getCompareItemCount (  ) 

Template variable getter. Returns comparison article list count.

Returns:
integer

Definition at line 1204 of file oxubase.php.

oxUBase.getComponent ( $  sName  ) 

Get component object

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

Definition at line 673 of file oxubase.php.

oxUBase.getComponents (  ) 

Get array of component objects

Returns:
array

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

oxUBase.getContentCategory (  ) 

Default content category getter, returns FALSE by default

Returns:
bool

Reimplemented in Content.

Definition at line 2718 of file oxubase.php.

oxUBase.getCrossSelling (  ) 

Template variable getter. Returns crosssellings

Returns:
object

Reimplemented in Details, and Suggest.

Definition at line 1933 of file oxubase.php.

oxUBase.getCustomListDisplayType (  ) 

Returns changed default list type

Returns:
string

Definition at line 770 of file oxubase.php.

oxUBase.getDefaultSorting (  ) 

Returns default category sorting for selected category

Returns:
array

Reimplemented in aList, and GuestBook.

Definition at line 927 of file oxubase.php.

oxUBase.getDeliveryAddress (  ) 

Template variable getter. Returns user delivery address

Returns:
array

Definition at line 2940 of file oxubase.php.

oxUBase.getDynUrlParams (  ) 

returns additional url params for dynamic url building

Returns:
string

Reimplemented in Review.

Definition at line 1597 of file oxubase.php.

oxUBase.getEditTags (  ) 

Returns if tags will be edit

Returns:
bool

Reimplemented in Details.

Definition at line 1880 of file oxubase.php.

oxUBase.getFieldValidationErrors (  ) 

Returns input field validation error array (if available)

Returns:
array

Definition at line 2882 of file oxubase.php.

oxUBase.getFormId (  ) 

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

Returns:
string

Definition at line 2765 of file oxubase.php.

oxUBase.getInvoiceAddress (  ) 

Template variable getter. Returns user address

Returns:
array

Definition at line 2924 of file oxubase.php.

oxUBase.getIsOrderStep (  ) 

Get flag if current view is an order view

Returns:
bool

Definition at line 696 of file oxubase.php.

oxUBase.getLastProducts (  ) 

Template variable getter. Returns last seen products

Returns:
array

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

oxUBase.getListDisplayType (  ) 

Returns list type

Returns:
string

Definition at line 746 of file oxubase.php.

oxUBase.getListOrderBy (  ) 

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

Returns:
array

Definition at line 1048 of file oxubase.php.

oxUBase.getListOrderDirection (  ) 

Template variable getter. Returns list order direction

Returns:
array

Definition at line 1065 of file oxubase.php.

oxUBase.getListType (  ) 

Get list type

Returns:
string list type

Reimplemented in Account.

Definition at line 729 of file oxubase.php.

oxUBase.getManufacturerId (  ) 

Template variable getter. Returns Manufacturer id

Returns:
string

Definition at line 2644 of file oxubase.php.

oxUBase.getManufacturerlist (  ) 

Template variable getter. Returns Manufacturerlist for search

Returns:
array

Definition at line 2562 of file oxubase.php.

oxUBase.getManufacturerTree (  ) 

Returns Manufacturer tree (if it is loaded0

Returns:
oxManufacturerlist

Definition at line 2419 of file oxubase.php.

oxUBase.getMenueList (  ) 

Template variable getter. Returns header menue list

Returns:
array

Definition at line 1263 of file oxubase.php.

oxUBase.getMetaDescription (  ) 

Template variable getter. Returns meta description

Returns:
string

Reimplemented in aList.

Definition at line 1159 of file oxubase.php.

oxUBase.getMetaKeywords (  ) 

Template variable getter. Returns meta keywords

Returns:
string

Definition at line 1136 of file oxubase.php.

oxUBase.getMinOrderPrice (  ) 

Template variable getter. Returns formatted min order price value

Returns:
string

Definition at line 2513 of file oxubase.php.

oxUBase.getMustFillFields (  ) 

Returns array of fields which must be filled during registration

Returns:
array | bool

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

oxUBase.getNewBasketItemMsgType (  ) 

Returns added basket item notification message type

Returns:
int

Definition at line 3047 of file oxubase.php.

oxUBase.getNewsRealStatus (  ) 

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

Returns:
integer

Definition at line 2527 of file oxubase.php.

oxUBase.getPageNavigation (  ) 

Template variable getter. Returns page navigation

Returns:
null

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

Definition at line 2098 of file oxubase.php.

oxUBase.getPageNavigationLimitedBottom (  ) 

Template variable getter. Returns page navigation with 11 positions

Returns:
object

Definition at line 2121 of file oxubase.php.

oxUBase.getPageNavigationLimitedTop (  ) 

Template variable getter. Returns page navigation with 7 positions

Returns:
object

Definition at line 2108 of file oxubase.php.

oxUBase.getPaymentList (  ) 

Template variable getter. Returns payment id

Returns:
string

Reimplemented in Payment.

Definition at line 1898 of file oxubase.php.

oxUBase.getProduct (  ) 

Empty active product getter

Returns:
null

Reimplemented in Details, MoreDetails, Pricealarm, and Suggest.

Definition at line 2553 of file oxubase.php.

oxUBase.getPromoCurrentList (  ) 

return current promotion list

Returns:
oxActionList

Definition at line 2819 of file oxubase.php.

oxUBase.getPromoFinishedList (  ) 

return last finished promotion list

Returns:
oxActionList

Definition at line 2804 of file oxubase.php.

oxUBase.getPromoFutureList (  ) 

return future promotion list

Returns:
oxActionList

Definition at line 2834 of file oxubase.php.

oxUBase.getRecommSearch (  ) 

Template variable getter. Returns search string

Returns:
string

Reimplemented in RecommList.

Definition at line 1889 of file oxubase.php.

oxUBase.getRootManufacturer (  ) 

Template variable getter. Returns root Manufacturer

Returns:
object

Definition at line 2618 of file oxubase.php.

oxUBase.getRootVendor (  ) 

Template variable getter. Returns root vendor

Returns:
object

Definition at line 2596 of file oxubase.php.

oxUBase.getRssLinks (  ) 

Returns RSS links

Returns:
array

Definition at line 1844 of file oxubase.php.

oxUBase.getSavedSorting ( $  sSortIdent  ) 

Returns sorting variable from session

Parameters:
string $sSortIdent sorting indent
Returns:
array

Definition at line 965 of file oxubase.php.

oxUBase.getSearchCatId (  ) 

Template variable getter. Returns searched category id

Returns:
string

Reimplemented in Search.

Definition at line 3010 of file oxubase.php.

oxUBase.getSearchCatTree (  ) 

Template variable getter. Returns category tree for search

Returns:
array

Definition at line 2660 of file oxubase.php.

oxUBase.getSearchManufacturer (  ) 

Template variable getter. Returns searched Manufacturer id

Returns:
string

Reimplemented in Search.

Definition at line 3028 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.

Returns:
null

Reimplemented in Account, Details, and Search.

Definition at line 1697 of file oxubase.php.

oxUBase.getSearchVendor (  ) 

Template variable getter. Returns searched vendor id

Returns:
string

Reimplemented in Search.

Definition at line 3019 of file oxubase.php.

oxUBase.getShowPromotionList (  ) 

should promotions list be shown?

Returns:
bool

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

oxUBase.getSimilarRecommListIds (  ) 

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

Returns:
array

Reimplemented in Account_Noticelist, Account_Wishlist, aList, Basket, Compare, Details, and Search.

Definition at line 1687 of file oxubase.php.

oxUBase.getSortColumns (  ) 

Template variable getter. Returns sorting columns

Returns:
array

Reimplemented in GuestBook.

Definition at line 1854 of file oxubase.php.

oxUBase.getSortIdent (  ) 

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

Returns:
string

Reimplemented in GuestBook.

Definition at line 917 of file oxubase.php.

oxUBase.getSorting ( $  sSortIdent  ) 

Returns sorting config for current item

Parameters:
string $sSortIdent sortable item id
Returns:
array

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

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

oxUBase.getSortOrderByParameterName (  ) 

Returns sorted column parameter name

Returns:
string

Reimplemented in GuestBook.

Definition at line 896 of file oxubase.php.

oxUBase.getSortOrderParameterName (  ) 

Returns sorted column direction parameter name

Returns:
string

Reimplemented in GuestBook.

Definition at line 906 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 aList, Content, Details, ManufacturerList, Tag, and VendorList.

Definition at line 1969 of file oxubase.php.

oxUBase.getTitlePageSuffix (  ) 

Returns title page suffix used in template in lists

Returns:
string

Reimplemented in aList, and Tags.

Definition at line 1562 of file oxubase.php.

oxUBase.getTitlePrefix (  ) 

Returns title prefix used in template

Returns:
string

Definition at line 1572 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 1552 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 2451 of file oxubase.php.

oxUBase.getTopNavigationCatCnt (  ) 

Returns item count in top navigation of categories

Returns:
integer

Definition at line 858 of file oxubase.php.

oxUBase.getUserSelectedSorting (  ) 

Returns default category sorting for selected category

Returns:
array

Definition at line 938 of file oxubase.php.

oxUBase.getVendorId (  ) 

Template variable getter. Returns vendor id

Returns:
string

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

oxUBase.getViewProduct (  ) 

Returns current view product object (if it is loaded)

Returns:
oxarticle

Definition at line 2238 of file oxubase.php.

oxUBase.getViewProductList (  ) 

Returns view product list

Returns:
array

Definition at line 2260 of file oxubase.php.

oxUBase.getWishlistName (  ) 

Template variable getter. Returns user name of searched wishlist

Returns:
string

Definition at line 3146 of file oxubase.php.

oxUBase.getWishlistUserId (  ) 

Template variable getter. Returns user id from wishlist

Returns:
string

Definition at line 3000 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 oxWidget, Download, order, Payment, Review, Search, and Thankyou.

Definition at line 561 of file oxubase.php.

oxUBase.isActive ( $  sName  ) 

Checks if feature is enabled

Parameters:
string $sName feature name
Returns:
bool

Definition at line 3059 of file oxubase.php.

oxUBase.isEnabledDownloadableFiles (  ) 

Checks if downloadable files are turned on

Returns:
bool

Definition at line 3085 of file oxubase.php.

oxUBase.isEnabledPrivateSales (  ) 

Checks if private sales is on

Returns:
bool

Definition at line 2866 of file oxubase.php.

oxUBase.isFbWidgetVisible (  ) 

Returns TRUE if facebook widgets are on

Returns:
boolean

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

oxUBase.isLanguageLoaded (  ) 

Returns if language should be loaded

Returns:
bool

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

oxUBase.isPriceCalculated (  ) 

Returns true if price calculation is activated

Returns:
boolean

Definition at line 3126 of file oxubase.php.

oxUBase.isRootCatChanged (  ) 

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

Returns:
bool

Definition at line 2914 of file oxubase.php.

oxUBase.isSortingActive (  ) 

Returns if sorting is active and can be displayed

Returns:
bool
Deprecated:
in v4.7/5.0 on 2013-01-04; use oxUbase.showSorting()

Definition at line 1253 of file oxubase.php.

oxUBase.isVatIncluded (  ) 

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

Returns:
boolean

Definition at line 3106 of file oxubase.php.

oxUBase.loadCurrency (  ) 

Returns currency swiching option

Returns:
bool

Definition at line 800 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 1229 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.

Session variables: listorderby, listorder

Deprecated:
since v4.7.3/5.0.3 (2013-01-07); use getSorting();
Returns:
null

Reimplemented in GuestBook.

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

Definition at line 2214 of file oxubase.php.

oxUBase.setActCurrency ( $  oCur  ) 

Active currency setter

Parameters:
object $oCur corrency object
Returns:
object

Definition at line 1194 of file oxubase.php.

oxUBase.setActiveCategory ( $  oCategory  ) 

Active category setter

Parameters:
oxcategory $oCategory active category
Returns:
null

Definition at line 709 of file oxubase.php.

oxUBase.setActManufacturer ( $  oManufacturer  ) 

Active Manufacturer setter

Parameters:
oxmanufacturer $oManufacturer active Manufacturer
Returns:
null

Definition at line 2372 of file oxubase.php.

oxUBase.setActVendor ( $  oVendor  ) 

Active vendor setter

Parameters:
oxvendor $oVendor active vendor
Returns:
null

Definition at line 2360 of file oxubase.php.

oxUBase.setCategoryTree ( $  oCatTree  ) 

Category list setter

Parameters:
oxcategorylist $oCatTree category tree
Returns:
null

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

oxUBase.setDeliveryAddress ( $  aDeliveryAddress  ) 

Template variable getter. Returns user delivery address

Parameters:
array $aDeliveryAddress delivery address
Returns:
null

Definition at line 2959 of file oxubase.php.

oxUBase.setInvoiceAddress ( $  aAddress  ) 

Template variable setter. Sets user address

Parameters:
array $aAddress user address
Returns:
null

Definition at line 2971 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 686 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)
Returns:
null

Reimplemented in ManufacturerList, Search, Tag, and VendorList.

Definition at line 1498 of file oxubase.php.

oxUBase.setListOrderBy ( $  sCulumn  ) 

Set sorting column name

Parameters:
string $sCulumn - column name
Returns:
string

Definition at line 980 of file oxubase.php.

oxUBase.setListOrderDirection ( $  sDirection  ) 

Set sorting directions

Parameters:
string $sDirection - direction desc / asc
Returns:
string

Definition at line 992 of file oxubase.php.

oxUBase.setListType ( $  sType  ) 

List type setter

Parameters:
string $sType type of list
Returns:
null

Definition at line 789 of file oxubase.php.

oxUBase.setManufacturerlist ( $  aList  ) 

Sets Manufacturerlist for search

Parameters:
array $aList manufacturer list
Returns:
null

Definition at line 2574 of file oxubase.php.

oxUBase.setManufacturerTree ( $  oManufacturerTree  ) 

Manufacturer tree setter

Parameters:
oxManufacturerlist $oManufacturerTree Manufacturer tree
Returns:
null

Definition at line 2431 of file oxubase.php.

oxUBase.setMenueList ( $  aMenue  ) 

Header menue list setter

Parameters:
array $aMenue menu list
Returns:
null

Definition at line 1275 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 1077 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 1089 of file oxubase.php.

oxUBase.setRootCatChanged ( $  blRootCatChanged  ) 

Sets if active root category was changed

Parameters:
bool $blRootCatChanged root category changed
Returns:
null

Definition at line 2904 of file oxubase.php.

oxUBase.setRootManufacturer ( $  oManufacturer  ) 

Sets root Manufacturer

Parameters:
object $oManufacturer manufacturer object
Returns:
null

Definition at line 2608 of file oxubase.php.

oxUBase.setRootVendor ( $  oVendor  ) 

Sets root vendor

Parameters:
object $oVendor vendor object
Returns:
null

Definition at line 2586 of file oxubase.php.

oxUBase.setSearchCatTree ( $  aTree  ) 

Sets category tree for search

Parameters:
array $aTree category tree
Returns:
null

Definition at line 2672 of file oxubase.php.

oxUBase.setSortColumns ( $  aSortColumns  ) 

Set sorting columns

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

Definition at line 1870 of file oxubase.php.

oxUBase.setViewProduct ( $  oProduct  ) 

Sets view product

Parameters:
oxarticle $oProduct view product object
Returns:
null

Definition at line 2250 of file oxubase.php.

oxUBase.showCategoryArticlesCount (  ) 

Returns true if empty categories are not loaded

Returns:
bool

Definition at line 832 of file oxubase.php.

oxUBase.showRememberMe (  ) 

Returns true if "Remember me" are ON

Returns:
boolean

Definition at line 3095 of file oxubase.php.

oxUBase.showSearch (  ) 

Returns show category search

Returns:
bool

Definition at line 1830 of file oxubase.php.

oxUBase.showSorting (  ) 

Template variable getter. Returns true if sorting is on

Returns:
bool

Definition at line 639 of file oxubase.php.

oxUBase.showTags (  ) 

Returns true if tags are ON

Returns:
boolean

Definition at line 3136 of file oxubase.php.

Member Data Documentation

oxUBase.$_aArticleList = null [protected]

Definition at line 310 of file oxubase.php.

oxUBase.$_aBargainArticleList = null [protected]

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

oxUBase.$_aCollectedComponentNames = null [static, protected]

Definition at line 475 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 oxwCategoryTree, oxwCurrencyList, oxWidget, oxwLanguageList, oxwManufacturerList, oxwMiniBasket, oxwRecommendation, and oxwServiceMenu.

Definition at line 275 of file oxubase.php.

oxUBase.$_aContents = array() [protected]

Definition at line 419 of file oxubase.php.

oxUBase.$_aDeliveryAddress = null [protected]

Definition at line 462 of file oxubase.php.

oxUBase.$_aInvoiceAddress = null [protected]

Definition at line 456 of file oxubase.php.

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

Definition at line 57 of file oxubase.php.

oxUBase.$_aManufacturerlist = null [protected]

Definition at line 377 of file oxubase.php.

oxUBase.$_aMenueList = null [protected]

Definition at line 268 of file oxubase.php.

oxUBase.$_aMustFillFields = null [protected]

Definition at line 438 of file oxubase.php.

oxUBase.$_aRssLinks = null [protected]

Definition at line 147 of file oxubase.php.

oxUBase.$_aSearchCatTree = null [protected]

Definition at line 395 of file oxubase.php.

oxUBase.$_aSortColumns = null [protected]

Reimplemented in GuestBook.

Definition at line 491 of file oxubase.php.

oxUBase.$_aTop5ArticleList = null [protected]

Definition at line 328 of file oxubase.php.

oxUBase.$_aUserComponentNames = array() [protected]

Definition at line 291 of file oxubase.php.

oxUBase.$_blActiveSorting = null [protected]

Definition at line 262 of file oxubase.php.

oxUBase.$_blBargainAction = false [protected]

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

Definition at line 431 of file oxubase.php.

oxUBase.$_blCommonAdded = false [protected]

Definition at line 211 of file oxubase.php.

oxUBase.$_blDontShowEmptyCats = null [protected]

Definition at line 129 of file oxubase.php.

oxUBase.$_blEnabledPrivateSales = null [protected]

Definition at line 203 of file oxubase.php.

oxUBase.$_blFbWidgetsOn = null [protected]

Definition at line 23 of file oxubase.php.

oxUBase.$_blForceNoIndex = false [protected]

Definition at line 227 of file oxubase.php.

oxUBase.$_blIsOrderStep = false [protected]

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

Definition at line 43 of file oxubase.php.

oxUBase.$_blLoadComponents = true [protected]

Reimplemented in oxWidget.

Definition at line 483 of file oxubase.php.

oxUBase.$_blLoadCurrency = null [protected]

Definition at line 117 of file oxubase.php.

oxUBase.$_blLoadLanguage = null [protected]

Definition at line 135 of file oxubase.php.

oxUBase.$_blLoadManufacturerTree = null [protected]

Definition at line 123 of file oxubase.php.

oxUBase.$_blLowOrderPrice = null [protected]

Definition at line 340 of file oxubase.php.

oxUBase.$_blNewsSubscribed = null [protected]

Definition at line 401 of file oxubase.php.

oxUBase.$_blRootCatChanged = false [protected]

Definition at line 450 of file oxubase.php.

oxUBase.$_blShowSorting = false [protected]

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

Definition at line 111 of file oxubase.php.

oxUBase.$_blShowTagCloud = true [protected]

Reimplemented in Account, aList, and Compare.

Definition at line 444 of file oxubase.php.

oxUBase.$_blTop5Action = true [protected]

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

Definition at line 425 of file oxubase.php.

oxUBase.$_iActPage = null [protected]

Definition at line 304 of file oxubase.php.

oxUBase.$_iCompItemsCnt = null [protected]

Reimplemented in Compare.

Definition at line 233 of file oxubase.php.

oxUBase.$_iNewsRealStatus = null [protected]

Definition at line 352 of file oxubase.php.

oxUBase.$_iTopCatNavItmCnt = null [protected]

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

oxUBase.$_oaComponents = array() [protected]

Definition at line 36 of file oxubase.php.

oxUBase.$_oActCategory = null [protected]

Definition at line 78 of file oxubase.php.

oxUBase.$_oActCurrency = null [protected]

Definition at line 197 of file oxubase.php.

oxUBase.$_oActiveRecommList = null [protected]

Reimplemented in Review.

Definition at line 98 of file oxubase.php.

oxUBase.$_oActManufacturer = null [protected]

Definition at line 85 of file oxubase.php.

oxUBase.$_oActSearch = null [protected]

Definition at line 105 of file oxubase.php.

oxUBase.$_oActVendor = null [protected]

Definition at line 92 of file oxubase.php.

oxUBase.$_oCategoryTree = null [protected]

Definition at line 322 of file oxubase.php.

oxUBase.$_oContent = null [protected]

Default content

Returns:
oxContent

Reimplemented in Content.

Definition at line 247 of file oxubase.php.

oxUBase.$_oDelAddress = null [protected]

Reimplemented in order.

Definition at line 407 of file oxubase.php.

oxUBase.$_oManufacturerTree = null [protected]

Definition at line 316 of file oxubase.php.

oxUBase.$_oProduct = null [protected]

Definition at line 298 of file oxubase.php.

oxUBase.$_oRootManufacturer = null [protected]

Definition at line 383 of file oxubase.php.

oxUBase.$_oRootVendor = null [protected]

Definition at line 365 of file oxubase.php.

oxUBase.$_sActiveUsername = null [protected]

Definition at line 468 of file oxubase.php.

oxUBase.$_sAdditionalParams = null [protected]

Definition at line 191 of file oxubase.php.

oxUBase.$_sCatTreePath = null [protected]

Definition at line 413 of file oxubase.php.

oxUBase.$_sContentId = null [protected]

Default content id

Returns:
string

Reimplemented in Content, and Credits.

Definition at line 240 of file oxubase.php.

oxUBase.$_sCustomListDisplayType = null [protected]

Definition at line 71 of file oxubase.php.

oxUBase.$_sListDisplayType = null [protected]

Reimplemented in Start.

Definition at line 64 of file oxubase.php.

oxUBase.$_sListOrderBy = null [protected]

Reimplemented in GuestBook.

Definition at line 153 of file oxubase.php.

oxUBase.$_sListOrderDir = null [protected]

Reimplemented in GuestBook.

Definition at line 159 of file oxubase.php.

oxUBase.$_sListType = null [protected]

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

Definition at line 50 of file oxubase.php.

oxUBase.$_sManufacturerId = null [protected]

Definition at line 389 of file oxubase.php.

oxUBase.$_sMetaDescription = null [protected]

Definition at line 165 of file oxubase.php.

oxUBase.$_sMetaDescriptionIdent = null [protected]

Reimplemented in Account, and Start.

Definition at line 178 of file oxubase.php.

oxUBase.$_sMetaKeywords = null [protected]

Definition at line 171 of file oxubase.php.

oxUBase.$_sMetaKeywordsIdent = null [protected]

Reimplemented in Account, and Start.

Definition at line 185 of file oxubase.php.

oxUBase.$_sMinOrderPrice = null [protected]

Definition at line 346 of file oxubase.php.

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

Definition at line 29 of file oxubase.php.

oxUBase.$_sVendorId = null [protected]

Definition at line 371 of file oxubase.php.

oxUBase.$_sViewResetID = null [protected]

Definition at line 254 of file oxubase.php.

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