oxUBase Class Reference

Inheritance diagram for oxUBase:

[legend]

Collaboration diagram for oxUBase:

[legend]

List of all members.

---

Detailed Description

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

Public Member Functions
	init ()
	generatePageNavigationUrl ()
	generatePageNavigation ()
	prepareMinimumOrderPrice4View ()
	render ()
	getViewProduct ()
	setViewProduct ($oProduct)
	getViewProductList ()
	getActPage ()
	getActCategory ()
	setActCategory ($oCategory)
	getActTag ()
	getActVendor ()
	setActVendor ($oVendor)
	getActSearch ()
	getActRecommList ()
	getCategoryTree ()
	setCategoryTree ($oCatTree)
	getVendorTree ()
	setVendorTree ($oVendorTree)
	setSessionCategoryId ($sCategoryId)
	getSessionCategoryId ()
	getAddUrlParams ()
	getLink ($iLang=null)
	getTop5ArticleList ()
	getBargainArticleList ()
	isLowOrderPrice ()
	getMinOrderPrice ()
	getNewsRealStatus ()
	getProduct ()
	getVendorlist ()
	setVendorlist ($aList)
	setRootVendor ($oVendor)
	getRootVendor ()
	getVendorId ()
	getSearchCatTree ()
	setSearchCatTree ($aTree)
	getCatMore ()
	setCatMore ($oCat)
	isNewsSubscribed ()
	setNewsSubscribed ($blNewsSubscribed)
	showShipAddress ()
	setShowShipAddress ($blShowShipAddress)
	getDelAddress ()
	setDelAddress ($oDelAddress)
Protected Member Functions
	_processRequest ()
	_setListType ()
	_addPageNrParam ($sUrl, $iPage, $iLang=null)
	_loadActions ()
	_processListArticles ()
	_canRedirect ()
Protected Attributes
	$_blCommonAdded = false
	$_aComponentNames
	$_aUserComponentNames = array()
	$_oProduct = null
	$_iActPage = null
	$_aArticleList = null
	$_oVendorTree = null
	$_oCategoryTree = null
	$_aTop5ArticleList = null
	$_aBargainArticleList = null
	$_iLowOrderPrice = null
	$_sMinOrderPrice = null
	$_iNewsRealStatus = null
	$_aBlockRedirectParams = array( 'fnc' )
	$_aVendorlist = null
	$_oRootVendor = null
	$_sVendorId = null
	$_aSearchCatTree = null
	$_oCatMore = null
	$_blNewsSubscribed = null
	$_blShowShipAddress = null
	$_oDelAddress = null

---

Member Function Documentation

oxUBase._processRequest

(

)

[protected]

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

Returns:

null

oxUBase.init

(

)

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

Returns:

null

Reimplemented from oxView.

Reimplemented in Content, Details, moreDetails, order, Payment, Review, search, Start, Suggest, Tag, and Thankyou.

oxUBase._setListType

(

)

[protected]

Sets active list type if it was not set by request

Returns:

null

oxUBase.generatePageNavigationUrl

(

)

Generates URL for page navigation

Parameters:

string

$sClass class name

Returns:

string $sUrl String with working page url.

Reimplemented in aList, Tag, and vendorlist.

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

Adds page number parameter to url and returns modified url

Parameters:

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

Returns:

string

Reimplemented in aList, Tag, and vendorlist.

oxUBase.generatePageNavigation

(

)

Generates variables for page navigation

Returns:

stdClass $pageNavigation Object with pagenavigation data

Reimplemented in Tag.

oxUBase.prepareMinimumOrderPrice4View

(

)

performs setup of aViewData according to iMinOrderPrice admin setting

Returns:

null

oxUBase.render

(

)

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

Returns:

null

Reimplemented from oxView.

Reimplemented in account, account_newsletter, account_noticelist, account_order, account_password, account_recommlist, account_user, account_wishlist, aList, Basket, Compare, Contact, Content, Details, ForgotPwd, GuestBook, Help, Info, Links, moreDetails, News, Newsletter, order, Payment, Pricealarm, RecommAdd, RecommList, Review, search, Start, Suggest, Tag, Tags, Thankyou, Tpl, User, vendorlist, wishlist, and Wrapping.

oxUBase.getViewProduct

(

)

Returns current view product object (if it is loaded)

Returns:

oxarticle

oxUBase.setViewProduct

(

$

oProduct

)

Sets view product

Parameters:

oxarticle

$oProduct view product object

Returns:

null

oxUBase.getViewProductList

(

)

Returns view product list

Returns:

array

oxUBase.getActPage

(

)

Active page getter

Returns:

int

oxUBase.getActCategory

(

)

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

Returns:

oxcategory

oxUBase.setActCategory

(

$

oCategory

)

Active category setter

Parameters:

oxcategory

$oCategory active category

Returns:

null

oxUBase.getActTag

(

)

Active tag info object getter. Object properties:

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

Returns:

oxstdclass

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

oxUBase.setActVendor

(

$

oVendor

)

Active vendor setter

Parameters:

oxvendor

$oVendor active vendor

Returns:

null

oxUBase.getActSearch

(

)

Returns fake object which is used to mount navigation info

Returns:

oxstdclass

oxUBase.getActRecommList

(

)

Returns active recommlist object which is used to mount navigation info

Returns:

object

oxUBase.getCategoryTree

(

)

Returns category tree (if it is loaded)

Returns:

oxcategorylist

oxUBase.setCategoryTree

(

$

oCatTree

)

Category list setter

Parameters:

oxcategorylist

$oCatTree category tree

Returns:

null

oxUBase.getVendorTree

(

)

Returns vendor tree (if it is loaded0

Returns:

oxvendorlist

oxUBase.setVendorTree

(

$

oVendorTree

)

Vendor tree setter

Parameters:

oxvendorlist

$oVendorTree vendor tree

Returns:

null

oxUBase._loadActions

(

)

[protected]

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

Template variables:

articlebargainlist, aTop5Articles

Returns:

null

oxUBase.setSessionCategoryId

(

$

sCategoryId

)

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

Parameters:

string

$sCategoryId active category Id

Returns:

null

oxUBase.getSessionCategoryId

(

)

Active category id getter

Returns:

string

oxUBase._processListArticles

(

)

[protected]

Iterates through list articles and performs list view specific tasks

Returns:

null

Reimplemented in RecommList, and vendorlist.

oxUBase.getAddUrlParams

(

)

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

Returns:

string

Reimplemented in RecommList, search, and Tag.

oxUBase.getLink

(

$

iLang = null

)

get link of current view

Parameters:

int

$iLang requested language

Returns:

string

Reimplemented from oxView.

oxUBase.getTop5ArticleList

(

)

Template variable getter. Returns Top 5 article list

Returns:

array

Reimplemented in aList.

oxUBase.getBargainArticleList

(

)

Template variable getter. Returns bargain article list

Returns:

array

Reimplemented in aList.

oxUBase.isLowOrderPrice

(

)

Template variable getter. Returns if order price is to low

Returns:

integer

oxUBase.getMinOrderPrice

(

)

Template variable getter. Returns min order price

Returns:

string

oxUBase.getNewsRealStatus

(

)

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

Returns:

integer

oxUBase._canRedirect

(

)

[protected]

Checks if current request parameters does not block SEO redirection process

Returns:

bool

oxUBase.getProduct

(

)

Empty active product getter

Returns:

null

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

oxUBase.getVendorlist

(

)

Template variable getter. Returns vendorlist for search

Returns:

array

oxUBase.setVendorlist

(

$

aList

)

Sets vendorlist for search

Parameters:

array

$aList

Returns:

null

oxUBase.setRootVendor

(

$

oVendor

)

Sets root vendor

Parameters:

object

$oVendor

Returns:

null

oxUBase.getRootVendor

(

)

Template variable getter. Returns root vendor

Returns:

object

oxUBase.getVendorId

(

)

Template variable getter. Returns vendor id

Returns:

string

oxUBase.getSearchCatTree

(

)

Template variable getter. Returns category tree for search

Returns:

array

oxUBase.setSearchCatTree

(

$

aTree

)

Sets category tree for search

Parameters:

array

$aTree

Returns:

null

oxUBase.getCatMore

(

)

Template variable getter. Returns more category

Returns:

object

oxUBase.setCatMore

(

$

oCat

)

Sets more category

Parameters:

object

$oCat

Returns:

null

oxUBase.isNewsSubscribed

(

)

Template variable getter. Returns if user subscribed for newsletter

Returns:

bool

Reimplemented in User.

oxUBase.setNewsSubscribed

(

$

blNewsSubscribed

)

Sets if user subscribed for newsletter

Parameters:

bool

$blNewsSubscribed

Returns:

null

oxUBase.showShipAddress

(

)

Template variable getter. Returns if show user shipping address

Returns:

bool

Reimplemented in User.

oxUBase.setShowShipAddress

(

$

blShowShipAddress

)

Sets if show user shipping address

Parameters:

bool

$blShowShipAddress

Returns:

null

oxUBase.getDelAddress

(

)

Template variable getter. Returns shipping address

Returns:

bool

Reimplemented in order, and User.

oxUBase.setDelAddress

(

$

oDelAddress

)

Sets shipping address

Parameters:

bool

$oDelAddress

Returns:

null

---

Member Data Documentation

oxUBase.$_blCommonAdded = false [protected]

oxUBase.$_aComponentNames [protected]

Initial value:

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

Reimplemented from oxView.

oxUBase.$_aUserComponentNames = array() [protected]

oxUBase.$_oProduct = null [protected]

oxUBase.$_iActPage = null [protected]

oxUBase.$_aArticleList = null [protected]

oxUBase.$_oVendorTree = null [protected]

oxUBase.$_oCategoryTree = null [protected]

oxUBase.$_aTop5ArticleList = null [protected]

oxUBase.$_aBargainArticleList = null [protected]

oxUBase.$_iLowOrderPrice = null [protected]

oxUBase.$_sMinOrderPrice = null [protected]

oxUBase.$_iNewsRealStatus = null [protected]

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

Executes parent method parent.init(). If oxUBase._blCommonAdded is true - in array oxUBase._aComponentNames stores newly defined component names and allready registered in oxUBase._aUserComponentNames

Returns:

null

oxUBase.$_aVendorlist = null [protected]

oxUBase.$_oRootVendor = null [protected]

oxUBase.$_sVendorId = null [protected]

oxUBase.$_aSearchCatTree = null [protected]

oxUBase.$_oCatMore = null [protected]

oxUBase.$_blNewsSubscribed = null [protected]

oxUBase.$_blShowShipAddress = null [protected]

oxUBase.$_oDelAddress = null [protected]

Reimplemented in account_user, and order.

---

The documentation for this class was generated from the following file:

• views/oxubase.php