OXID eShop CE  4.9.5
 All Classes Files Functions Variables Pages
oxDeliverySetList Class Reference
+ Inheritance diagram for oxDeliverySetList:
+ Collaboration diagram for oxDeliverySetList:

Public Member Functions

 __construct ()
 setHomeCountry ($sHomeCountry)
 getDeliverySetList ($oUser, $sCountryId, $sDelSet=null)
 getDeliverySetData ($sShipSet, $oUser, $oBasket)
 getUser ()
 setUser ($oUser)
 loadNonRDFaDeliverySetList ()
 loadRDFaDeliverySetList ($sDelId=null)
- Public Member Functions inherited from oxList
 offsetExists ($offset)
 offsetGet ($offset)
 offsetSet ($offset, $oBase)
 offsetUnset ($offset)
 arrayKeys ()
 rewind ()
 current ()
 key ()
 prev ()
 next ()
 valid ()
 count ()
 clear ()
 assign ($aArray)
 reverse ()
 __construct ($sObjectName=null)
 __get ($sName)
 getArray ()
 init ($sObjectName, $sCoreTable=null)
 getBaseObject ()
 setBaseObject ($oObject)
 selectString ($sSql)
 add ($oObject)
 assignArray ($aData)
 setSqlLimit ($iStart, $iRecords)
 containsFieldValue ($oVal, $sFieldName)
 getList ()
- Public Member Functions inherited from oxSuperCfg
 __call ($sMethod, $aArgs)
 getConfig ()
 setConfig ($oConfig)
 getSession ()
 setSession ($oSession)
 isAdmin ()
 setAdminMode ($blAdmin)

Protected Member Functions

 _getList ($oUser=null, $sCountryId=null)
 _getFilterSelect ($oUser, $sCountryId)
- Protected Member Functions inherited from oxList
 _assignElement ($oListObject, $aDbFields)
 _getFieldLongName ($sFieldName)

Protected Attributes

 $_sUserId = null
 $_sCountryId = null
 $_oUser = null
 $_sHomeCountry = null
- Protected Attributes inherited from oxList
 $_aArray = array()
 $_blRemovedActive = false
 $_sObjectsInListName = 'oxBase'
 $_sCoreTable = null
 $_sShopID = null
 $_aSqlLimit = array()

Additional Inherited Members

- Static Protected Attributes inherited from oxSuperCfg
static $_oConfig = null
static $_oSession = null
static $_oRights = null
static $_oActUser = null
static $_blIsAdmin = null

Detailed Description

DeliverySet list manager.

Definition at line 7 of file oxdeliverysetlist.php.

Constructor & Destructor Documentation

oxDeliverySetList::__construct ( )

Calls parent constructor and sets home country

Returns
null

Reimplemented from oxSuperCfg.

Definition at line 43 of file oxdeliverysetlist.php.

Member Function Documentation

oxDeliverySetList::_getFilterSelect (   $oUser,
  $sCountryId 
)
protected

Creates delivery set list filter SQL to load current state delivery set list

Parameters
oxUser$oUseruser object
string$sCountryIduser country id
Returns
string

Definition at line 119 of file oxdeliverysetlist.php.

oxDeliverySetList::_getList (   $oUser = null,
  $sCountryId = null 
)
protected

Returns active delivery set list

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

Parameters
oxUser$oUseruser object
string$sCountryIduser country id
Returns
array

Definition at line 76 of file oxdeliverysetlist.php.

oxDeliverySetList::getDeliverySetData (   $sShipSet,
  $oUser,
  $oBasket 
)

Loads delivery set data, checks if it has payments assigned. If active delivery set id is passed - checks if it can be used, if not - takes first ship set id from list which fits. For active ship set collects payment list info. Returns array containing:

  1. all ship sets that has payment (array)
  2. active ship set id (string)
  3. payment list for active ship set (array)
Parameters
string$sShipSetcurrent ship set id (can be null if not set yet)
oxUser$oUseractive user
double$oBasketbasket object
Returns
array

Definition at line 216 of file oxdeliverysetlist.php.

oxDeliverySetList::getDeliverySetList (   $oUser,
  $sCountryId,
  $sDelSet = null 
)

Creates current state delivery set list

Parameters
oxUser$oUseruser object
string$sCountryIduser country id
string$sDelSetpreferred delivery set ID (optional)
Returns
array

Definition at line 184 of file oxdeliverysetlist.php.

oxDeliverySetList::getUser ( )

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

Returns
oxUser

Reimplemented from oxSuperCfg.

Definition at line 270 of file oxdeliverysetlist.php.

oxDeliverySetList::loadNonRDFaDeliverySetList ( )

Loads an object including all delivery sets which are not mapped to a predefined GoodRelations delivery method.

Definition at line 293 of file oxdeliverysetlist.php.

oxDeliverySetList::loadRDFaDeliverySetList (   $sDelId = null)

Loads delivery set mapped to a predefined GoodRelations delivery method.

Parameters
string$sDelIddelivery set id

Definition at line 306 of file oxdeliverysetlist.php.

oxDeliverySetList::setHomeCountry (   $sHomeCountry)

Home country setter

Parameters
string$sHomeCountryhome country id

Definition at line 54 of file oxdeliverysetlist.php.

oxDeliverySetList::setUser (   $oUser)

Set current user object

Parameters
oxUser$oUseruser object

Reimplemented from oxSuperCfg.

Definition at line 284 of file oxdeliverysetlist.php.

Member Data Documentation

oxDeliverySetList::$_oUser = null
protected

Definition at line 29 of file oxdeliverysetlist.php.

oxDeliverySetList::$_sCountryId = null
protected

Definition at line 22 of file oxdeliverysetlist.php.

oxDeliverySetList::$_sHomeCountry = null
protected

Definition at line 36 of file oxdeliverysetlist.php.

oxDeliverySetList::$_sUserId = null
protected

Definition at line 15 of file oxdeliverysetlist.php.


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