oxcmp_basket Class Reference

Inheritance diagram for oxcmp_basket:
[legend]
Collaboration diagram for oxcmp_basket:
[legend]

List of all members.


Detailed Description

Main shopping basket manager. Arranges shopping basket contents, updates amounts, prices, taxes etc. oxcmp

Definition at line 8 of file oxcmp_basket.php.


Public Member Functions

 render ()
 tobasket ($sProductId=null, $dAmount=null, $aSel=null, $aPersParam=null, $blOverride=false)
 changebasket ($sProductId=null, $dAmount=null, $aSel=null, $aPersParam=null, $blOverride=true)
 wl_tobasket ($sProductId=null, $dAmount=null, $aSel=null, $aPersParam=null, $blOverride=false)

Public Attributes

 $aRedirectParams

Protected Member Functions

 _getRedirectUrl ()
 _getItems ($sProductId=null, $dAmount=null, $aSel=null, $aPersParam=null, $blOverride=false)
 _addItems ($aProducts)
 _setLastCall ($sCallName, $aProductInfo, $aBasketInfo)

Protected Attributes

 $_blIsComponent = true

Member Function Documentation

oxcmp_basket.render (  ) 

Loads basket ($oBasket = $mySession->getBasket()), calls oBasket->calculateBasket, executes parent.render() and returns basket object.

Returns:
object $oBasket basket object

Reimplemented from oxView.

Definition at line 39 of file oxcmp_basket.php.

oxcmp_basket.tobasket ( sProductId = null,
dAmount = null,
aSel = null,
aPersParam = null,
blOverride = false 
)

Basket content update controller. Before adding article - check if client is not a search engine. If yes - exits method by returning false. If no - executes oxcmp_basket._addItems() and puts article to basket. Returns position where to redirect user browser.

Parameters:
string $sProductId Product ID (default null)
double $dAmount Product amount (default null)
array $aSel (default null)
array $aPersParam (default null)
bool $blOverride If true means increase amount of chosen article (default false)
Returns:
mixed

Definition at line 68 of file oxcmp_basket.php.

oxcmp_basket.changebasket ( sProductId = null,
dAmount = null,
aSel = null,
aPersParam = null,
blOverride = true 
)

Similar to tobasket, except that as product id "bindex" parameter is (can be) taken

Parameters:
string $sProductId Product ID (default null)
double $dAmount Product amount (default null)
array $aSel (default null)
array $aPersParam (default null)
bool $blOverride If true means increase amount of chosen article (default false)
Returns:
mixed

Definition at line 113 of file oxcmp_basket.php.

oxcmp_basket.wl_tobasket ( sProductId = null,
dAmount = null,
aSel = null,
aPersParam = null,
blOverride = false 
)

Adds articles to shopping basket or updates amount. and special handling, stores wishid so that we can substract them properly from wishlist. Puts article to basket (oxcmp_basket.tobasket()) and sets delivery address of user whose wish list article was loaded.

Parameters:
string $sProductId Product ID (default null)
double $dAmount Product amount (default null)
array $aSel (default null)
array $aPersParam (default null)
bool $blOverride If true means increase amount of chosen article (default false)
Returns:
mixed

Definition at line 164 of file oxcmp_basket.php.

oxcmp_basket._getRedirectUrl (  )  [protected]

Formats and returns redirect URL where shop must be redirected after storing something to basket

Returns:
string $sClass.$sPosition redirection URL

Definition at line 207 of file oxcmp_basket.php.

oxcmp_basket._getItems ( sProductId = null,
dAmount = null,
aSel = null,
aPersParam = null,
blOverride = false 
) [protected]

Collects and returns array of items to add to basket. Product info is taken not only from given parameters, but additionally from request 'aproducts' parameter

Parameters:
string $sProductId product ID
double $dAmount product amount
array $aSel product select lists
array $aPersParam product persistent parameters
bool $blOverride amount override status
Returns:
mixed

Definition at line 246 of file oxcmp_basket.php.

oxcmp_basket._addItems ( aProducts  )  [protected]

Adds all articles user wants to add to basket. Returns last added to basket item.

Parameters:
array $aProducts products to add array
Returns:
object $oBasketItem last added basket item

Definition at line 301 of file oxcmp_basket.php.

oxcmp_basket._setLastCall ( sCallName,
aProductInfo,
aBasketInfo 
) [protected]

Setting last call data to session (data used by econda)

Parameters:
string $sCallName name of action ('tobasket', 'changebasket')
array $aProductInfo data which comes from request when you press button "to basket"
array $aBasketInfo array returned by oxbasket.getBasketSummary()

Definition at line 339 of file oxcmp_basket.php.


Member Data Documentation

oxcmp_basket.$_blIsComponent = true [protected]

Reimplemented from oxView.

Definition at line 15 of file oxcmp_basket.php.

oxcmp_basket.$aRedirectParams

Initial value:

 array( 'cnid',        // category id
                                     'anid',        // active article id
                                     'tpl',         // spec. template
                                     'listtype',    // list type
                                     'searchcnid',  // search category
                                     'searchvendor',// search vendor
                                     'searchtag',   // search vendor
                                     'searchrecomm',// search vendor
                                     'recommid'     // recomm. list id
                                    )

Definition at line 22 of file oxcmp_basket.php.


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

Generated on Thu Dec 4 12:05:21 2008 for OXID eShop CE by  doxygen 1.5.5