oxUBase Class Reference

Inheritance diagram for oxUBase:

Inheritance graph
[legend]
Collaboration diagram for oxUBase:

Collaboration graph
[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.

Definition at line 13 of file oxubase.php.


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)
 getCatTreePath ()
 getContentByIdent ($sIdent)
 getContentCategory ()

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
 $_sCatTreePath = null
 $_aContents = array()

Member Function Documentation

oxUBase._processRequest (  )  [protected]

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

Returns:
null

Definition at line 184 of file oxubase.php.

oxUBase.init (  ) 

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

Returns:
null

Reimplemented from oxView.

Reimplemented in Content, Details, MoreDetails, Order, Payment, Review, Search, Start, Suggest, Tag, and Thankyou.

Definition at line 217 of file oxubase.php.

oxUBase._setListType (  )  [protected]

Sets active list type if it was not set by request

Returns:
null

Definition at line 242 of file oxubase.php.

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.

Definition at line 256 of file oxubase.php.

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

Adds page number parameter to url and returns modified url

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

Reimplemented in aList, Tag, and VendorList.

Definition at line 271 of file oxubase.php.

oxUBase.generatePageNavigation (  ) 

Generates variables for page navigation

Returns:
stdClass $pageNavigation Object with pagenavigation data

Reimplemented in Tag.

Definition at line 284 of file oxubase.php.

oxUBase.prepareMinimumOrderPrice4View (  ) 

performs setup of aViewData according to iMinOrderPrice admin setting

Returns:
null

Definition at line 331 of file oxubase.php.

oxUBase.render (  ) 

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

Returns:
null

Reimplemented from oxView.

Reimplemented in Account, Account_Newsletter, Account_Noticelist, Account_Order, Account_Password, Account_Recommlist, Account_User, Account_Wishlist, aList, Basket, Compare, Contact, Content, Details, ForgotPwd, GuestBook, Help, Info, Links, MoreDetails, News, Newsletter, Order, Payment, Pricealarm, RecommAdd, RecommList, Register, Review, Search, Start, Suggest, Tag, Tags, Thankyou, Tpl, User, VendorList, Wishlist, and Wrapping.

Definition at line 356 of file oxubase.php.

oxUBase.getViewProduct (  ) 

Returns current view product object (if it is loaded)

Returns:
oxarticle

Definition at line 393 of file oxubase.php.

oxUBase.setViewProduct ( $  oProduct  ) 

Sets view product

Parameters:
oxarticle $oProduct view product object
Returns:
null

Definition at line 407 of file oxubase.php.

oxUBase.getViewProductList (  ) 

Returns view product list

Returns:
array

Definition at line 417 of file oxubase.php.

oxUBase.getActPage (  ) 

Active page getter

Returns:
int

Definition at line 427 of file oxubase.php.

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

Definition at line 443 of file oxubase.php.

oxUBase.setActCategory ( $  oCategory  ) 

Active category setter

Parameters:
oxcategory $oCategory active category
Returns:
null

Definition at line 467 of file oxubase.php.

oxUBase.getActTag (  ) 

Active tag info object getter. Object properties:

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

Returns:
oxstdclass

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

oxUBase.setActVendor ( $  oVendor  ) 

Active vendor setter

Parameters:
oxvendor $oVendor active vendor
Returns:
null

Definition at line 531 of file oxubase.php.

oxUBase.getActSearch (  ) 

Returns fake object which is used to mount navigation info

Returns:
oxstdclass

Definition at line 541 of file oxubase.php.

oxUBase.getActRecommList (  ) 

Returns active recommlist object which is used to mount navigation info

Returns:
object

Definition at line 556 of file oxubase.php.

oxUBase.getCategoryTree (  ) 

Returns category tree (if it is loaded)

Returns:
oxcategorylist

Definition at line 576 of file oxubase.php.

oxUBase.setCategoryTree ( $  oCatTree  ) 

Category list setter

Parameters:
oxcategorylist $oCatTree category tree
Returns:
null

Definition at line 588 of file oxubase.php.

oxUBase.getVendorTree (  ) 

Returns vendor tree (if it is loaded0

Returns:
oxvendorlist

Definition at line 598 of file oxubase.php.

oxUBase.setVendorTree ( $  oVendorTree  ) 

Vendor tree setter

Parameters:
oxvendorlist $oVendorTree vendor tree
Returns:
null

Definition at line 610 of file oxubase.php.

oxUBase._loadActions (  )  [protected]

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

Template variables:

articlebargainlist, aTop5Articles

Returns:
null

Definition at line 624 of file oxubase.php.

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

Definition at line 638 of file oxubase.php.

oxUBase.getSessionCategoryId (  ) 

Active category id getter

Returns:
string

Definition at line 648 of file oxubase.php.

oxUBase._processListArticles (  )  [protected]

Iterates through list articles and performs list view specific tasks

Returns:
null

Reimplemented in RecommList, and VendorList.

Definition at line 658 of file oxubase.php.

oxUBase.getAddUrlParams (  ) 

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

Returns:
string

Reimplemented in RecommList, Search, and Tag.

Definition at line 673 of file oxubase.php.

oxUBase.getLink ( $  iLang = null  ) 

get link of current view

Parameters:
int $iLang requested language
Returns:
string

Reimplemented from oxView.

Definition at line 684 of file oxubase.php.

oxUBase.getTop5ArticleList (  ) 

Template variable getter. Returns Top 5 article list

Returns:
array

Reimplemented in aList.

Definition at line 698 of file oxubase.php.

oxUBase.getBargainArticleList (  ) 

Template variable getter. Returns bargain article list

Returns:
array

Reimplemented in aList.

Definition at line 720 of file oxubase.php.

oxUBase.isLowOrderPrice (  ) 

Template variable getter. Returns if order price is to low

Returns:
integer

Definition at line 740 of file oxubase.php.

oxUBase.getMinOrderPrice (  ) 

Template variable getter. Returns min order price

Returns:
string

Definition at line 750 of file oxubase.php.

oxUBase.getNewsRealStatus (  ) 

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

Returns:
integer

Definition at line 760 of file oxubase.php.

oxUBase._canRedirect (  )  [protected]

Checks if current request parameters does not block SEO redirection process

Returns:
bool

Definition at line 770 of file oxubase.php.

oxUBase.getProduct (  ) 

Empty active product getter

Returns:
null

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

Definition at line 786 of file oxubase.php.

oxUBase.getVendorlist (  ) 

Template variable getter. Returns vendorlist for search

Returns:
array

Definition at line 795 of file oxubase.php.

oxUBase.setVendorlist ( $  aList  ) 

Sets vendorlist for search

Parameters:
array $aList
Returns:
null

Definition at line 807 of file oxubase.php.

oxUBase.setRootVendor ( $  oVendor  ) 

Sets root vendor

Parameters:
object $oVendor
Returns:
null

Definition at line 819 of file oxubase.php.

oxUBase.getRootVendor (  ) 

Template variable getter. Returns root vendor

Returns:
object

Definition at line 829 of file oxubase.php.

oxUBase.getVendorId (  ) 

Template variable getter. Returns vendor id

Returns:
string

Definition at line 839 of file oxubase.php.

oxUBase.getSearchCatTree (  ) 

Template variable getter. Returns category tree for search

Returns:
array

Definition at line 854 of file oxubase.php.

oxUBase.setSearchCatTree ( $  aTree  ) 

Sets category tree for search

Parameters:
array $aTree
Returns:
null

Definition at line 866 of file oxubase.php.

oxUBase.getCatMore (  ) 

Template variable getter. Returns more category

Returns:
object

Definition at line 876 of file oxubase.php.

oxUBase.setCatMore ( $  oCat  ) 

Sets more category

Parameters:
object $oCat
Returns:
null

Definition at line 888 of file oxubase.php.

oxUBase.isNewsSubscribed (  ) 

Template variable getter. Returns if user subscribed for newsletter

Returns:
bool

Reimplemented in User.

Definition at line 898 of file oxubase.php.

oxUBase.setNewsSubscribed ( $  blNewsSubscribed  ) 

Sets if user subscribed for newsletter

Parameters:
bool $blNewsSubscribed
Returns:
null

Definition at line 910 of file oxubase.php.

oxUBase.showShipAddress (  ) 

Template variable getter. Returns if show user shipping address

Returns:
bool

Reimplemented in User.

Definition at line 920 of file oxubase.php.

oxUBase.setShowShipAddress ( $  blShowShipAddress  ) 

Sets if show user shipping address

Parameters:
bool $blShowShipAddress
Returns:
null

Definition at line 932 of file oxubase.php.

oxUBase.getDelAddress (  ) 

Template variable getter. Returns shipping address

Returns:
bool

Reimplemented in Order, Register, and User.

Definition at line 942 of file oxubase.php.

oxUBase.setDelAddress ( $  oDelAddress  ) 

Sets shipping address

Parameters:
bool $oDelAddress
Returns:
null

Definition at line 954 of file oxubase.php.

oxUBase.getCatTreePath (  ) 

Template variable getter. Returns category path

Returns:
string

Reimplemented in aList, and VendorList.

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

oxUBase.getContentCategory (  ) 

Default content category getter, returns FALSE by default

Returns:
bool

Reimplemented in Content.

Definition at line 990 of file oxubase.php.

Member Data Documentation

oxUBase.$_blCommonAdded = false [protected]

Definition at line 21 of file oxubase.php.

oxUBase.$_aComponentNames [protected]

Initial value:

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

Reimplemented from oxView.

Definition at line 28 of file oxubase.php.

oxUBase.$_aUserComponentNames = array() [protected]

Definition at line 44 of file oxubase.php.

oxUBase.$_oProduct = null [protected]

Definition at line 51 of file oxubase.php.

oxUBase.$_iActPage = null [protected]

Definition at line 57 of file oxubase.php.

oxUBase.$_aArticleList = null [protected]

Definition at line 63 of file oxubase.php.

oxUBase.$_oVendorTree = null [protected]

Definition at line 69 of file oxubase.php.

oxUBase.$_oCategoryTree = null [protected]

Definition at line 75 of file oxubase.php.

oxUBase.$_aTop5ArticleList = null [protected]

Definition at line 81 of file oxubase.php.

oxUBase.$_aBargainArticleList = null [protected]

Definition at line 87 of file oxubase.php.

oxUBase.$_iLowOrderPrice = null [protected]

Definition at line 93 of file oxubase.php.

oxUBase.$_sMinOrderPrice = null [protected]

Definition at line 99 of file oxubase.php.

oxUBase.$_iNewsRealStatus = null [protected]

Definition at line 105 of file oxubase.php.

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

Definition at line 114 of file oxubase.php.

oxUBase.$_aVendorlist = null [protected]

Definition at line 120 of file oxubase.php.

oxUBase.$_oRootVendor = null [protected]

Definition at line 126 of file oxubase.php.

oxUBase.$_sVendorId = null [protected]

Definition at line 132 of file oxubase.php.

oxUBase.$_aSearchCatTree = null [protected]

Definition at line 138 of file oxubase.php.

oxUBase.$_oCatMore = null [protected]

Definition at line 144 of file oxubase.php.

oxUBase.$_blNewsSubscribed = null [protected]

Definition at line 150 of file oxubase.php.

oxUBase.$_blShowShipAddress = null [protected]

Definition at line 156 of file oxubase.php.

oxUBase.$_oDelAddress = null [protected]

Reimplemented in Account_User, and Order.

Definition at line 162 of file oxubase.php.

oxUBase.$_sCatTreePath = null [protected]

Definition at line 168 of file oxubase.php.

oxUBase.$_aContents = array() [protected]

Definition at line 174 of file oxubase.php.

The documentation for this class was generated from the following file:
Generated on Thu Feb 19 15:09:37 2009 for OXID eShop CE by  doxygen 1.5.5