oxDeliveryList Class Reference

Inheritance diagram for oxDeliveryList:

Inheritance graph
[legend]
Collaboration diagram for oxDeliveryList:

Collaboration graph
[legend]

List of all members.


Detailed Description

Delivery list manager.

Public Member Functions

 __construct ($sObjectsInListName= 'oxdelivery')
 setHomeCountry ($sHomeCountry)
 getDeliveryList ($oBasket, $oUser=null, $sDelCountry=null, $sDelSet=null, $blExclNonMaterial=false)
 hasDeliveries ($oBasket, $oUser, $sDelCountry, $sDeliverySetId, $blExclNonMaterial=false)
 getUser ()
 setUser ($oUser)
 setCollectFittingDeliveriesSets ($blCollectFittingDeliveriesSets=false)

Static Public Member Functions

static getInstance ()

Protected Member Functions

 _getList ($oUser=null, $sCountryId=null, $sDelSet=null)
 _getFilterSelect ($oUser, $sCountryId, $sDelSet)

Protected Attributes

 $_sUserId = null
 $_blPerfLoadDelivery = null
 $_aDeliveries = array()
 $_oUser = null
 $_sHomeCountry = null
 $_blCollectFittingDeliveriesSets = false

Static Private Attributes

static $_instance = null

Constructor & Destructor Documentation

oxDeliveryList.__construct ( sObjectsInListName = 'oxdelivery'  ) 

Class constructor, sets callback so that Shopowner is able to add any information to the article.

Parameters:
string $sObjectsInListName Object in list

Reimplemented from oxList.


Member Function Documentation

static oxDeliveryList.getInstance (  )  [static]

Returns oxDeliveryList instance

Returns:
oxDeliveryList

oxDeliveryList.setHomeCountry ( sHomeCountry  ) 

Home country setter

Parameters:
string $sHomeCountry home country id
Returns:
null

oxDeliveryList._getList ( oUser = null,
sCountryId = null,
sDelSet = null 
) [protected]

Returns active delivery list

Loads all active delivery in list. Additionally checks if set has user customized parameters like assigned users, countries or user groups. Performs additional filtering accordint to these parameters

Parameters:
oxUser $oUser session user object
string $sCountryId user country id
string $sDelSet user chosen delivery set
Returns:
array

oxDeliveryList._getFilterSelect ( oUser,
sCountryId,
sDelSet 
) [protected]

Creates delivery list filter SQL to load current state delivery list

Parameters:
oxuser $oUser session user object
string $sCountryId user country id
string $sDelSet user chosen delivery set
Returns:
string

oxDeliveryList.getDeliveryList ( oBasket,
oUser = null,
sDelCountry = null,
sDelSet = null,
blExclNonMaterial = false 
)

Loads and returns list of deliveries.

Process:

  • first checks if delivery loading is enabled in config - $myConfig->bl_perfLoadDelivery is TRUE;
  • loads deliveryset list by calling this.GetDeliverySetList(...);
  • checks if there is any active (eg. chosen delset in order process etc) deliveryset defined and if its set - rearanges delivery set list by storing active set at the beginning in the list.
  • goes through delsets and loads its deliveries, checks if any delivery fits. By checking calculates and stores conditional amounts:

oDelivery->iItemCnt - items in basket that fits this delivery oDelivery->iProdCnt - products in basket that fits this delivery oDelivery->dPrice - price of products that fits this delivery

  • returns a list of deliveries. NOTICE: for performance reasons deliveries is cached in $myConfig->aDeliveryList.

Parameters:
object $oBasket basket object
oxuser $oUser session user
string $sDelCountry user country id
string $sDelSet delivery set id
bool $blExclNonMaterial exclude non material articles
Returns:
array

oxDeliveryList.hasDeliveries ( oBasket,
oUser,
sDelCountry,
sDeliverySetId,
blExclNonMaterial = false 
)

Checks if deliveries in list fits for current basket and delivery set

Parameters:
oxbasket $oBasket shop basket
oxuser $oUser session user
string $sDelCountry delivery country
string $sDeliverySetId delivery set id to check its relation to delivery list
bool $blExclNonMaterial = false
Returns:
bool

oxDeliveryList.getUser (  ) 

Get current user object. If user is not setted, try to get current user.

Returns:
oxUser

oxDeliveryList.setUser ( oUser  ) 

Set current user object

Parameters:
oxUser $oUser user object
Returns:
null

oxDeliveryList.setCollectFittingDeliveriesSets ( blCollectFittingDeliveriesSets = false  ) 

Force or not to collect deliveries sets instead of deliveries when getting deliveries list in getDeliveryList()

Parameters:
bool $blCollectFittingDeliveriesSets collect deliveries sets or not
Returns:
null


Member Data Documentation

oxDeliveryList.$_instance = null [static, private]

oxDeliveryList.$_sUserId = null [protected]

oxDeliveryList.$_blPerfLoadDelivery = null [protected]

oxDeliveryList.$_aDeliveries = array() [protected]

oxDeliveryList.$_oUser = null [protected]

oxDeliveryList.$_sHomeCountry = null [protected]

oxDeliveryList.$_blCollectFittingDeliveriesSets = false [protected]


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

Generated on Wed Oct 29 23:44:05 2008 for OXID eShop CE by  doxygen 1.5.5