OxidEsales\EshopCommunity\Application\Model\DeliverySetList Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Application\Model\DeliverySetList:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Model\DeliverySetList:

Public Member Functions
	__construct ()
	setHomeCountry ($sHomeCountry)
	getDeliverySetList ($oUser, $sCountryId, $sDelSet=null)
	getDeliverySetData ($sShipSet, $oUser, $oBasket)
	getUser ()
	setUser ($oUser)
	loadNonRDFaDeliverySetList ()
	loadRDFaDeliverySetList ($sDelId=null)

Protected Member Functions
	_getList ($oUser=null, $sCountryId=null)
	_getFilterSelect ($oUser, $sCountryId)

Protected Attributes
	$_sUserId = null
	$_sCountryId = null
	$_oUser = null
	$_sHomeCountry = null

Detailed Description

DeliverySet list manager.

Constructor & Destructor Documentation

__construct()

OxidEsales\EshopCommunity\Application\Model\DeliverySetList::__construct

(

)

Calls parent constructor and sets home country

Member Function Documentation

_getFilterSelect()

OxidEsales\EshopCommunity\Application\Model\DeliverySetList::_getFilterSelect (   $oUser,   $sCountryId  )

protected

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

Parameters

\OxidEsales\Eshop\Application\Model\User	$oUser	user object
string	$sCountryId	user country id

Returns

string

_getList()

OxidEsales\EshopCommunity\Application\Model\DeliverySetList::_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

\OxidEsales\Eshop\Application\Model\User	$oUser	user object
string	$sCountryId	user country id

Returns

array

getDeliverySetData()

OxidEsales\EshopCommunity\Application\Model\DeliverySetList::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	$sShipSet	current ship set id (can be null if not set yet)
\OxidEsales\Eshop\Application\Model\User	$oUser	active user
double	$oBasket	basket object

Returns

array

getDeliverySetList()

OxidEsales\EshopCommunity\Application\Model\DeliverySetList::getDeliverySetList	(		$oUser,
			$sCountryId,
			$sDelSet = null
	)

Creates current state delivery set list

Parameters

\OxidEsales\Eshop\Application\Model\User	$oUser	user object
string	$sCountryId	user country id
string	$sDelSet	preferred delivery set ID (optional)

Returns

array

getUser()

OxidEsales\EshopCommunity\Application\Model\DeliverySetList::getUser

(

)

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

Returns

\OxidEsales\Eshop\Application\Model\User

loadNonRDFaDeliverySetList()

OxidEsales\EshopCommunity\Application\Model\DeliverySetList::loadNonRDFaDeliverySetList

(

)

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

loadRDFaDeliverySetList()

OxidEsales\EshopCommunity\Application\Model\DeliverySetList::loadRDFaDeliverySetList

(

$sDelId = null

)

Loads delivery set mapped to a predefined GoodRelations delivery method.

Parameters

string

$sDelId

delivery set id

setHomeCountry()

OxidEsales\EshopCommunity\Application\Model\DeliverySetList::setHomeCountry

(

$sHomeCountry

)

Home country setter

Parameters

string

$sHomeCountry

home country id

setUser()

OxidEsales\EshopCommunity\Application\Model\DeliverySetList::setUser

(

$oUser

)

Set current user object

Parameters

\OxidEsales\Eshop\Application\Model\User

$oUser

user object

Member Data Documentation

$_oUser

OxidEsales\EshopCommunity\Application\Model\DeliverySetList::$_oUser = null

protected

$_sCountryId

OxidEsales\EshopCommunity\Application\Model\DeliverySetList::$_sCountryId = null

protected

$_sHomeCountry

OxidEsales\EshopCommunity\Application\Model\DeliverySetList::$_sHomeCountry = null

protected

$_sUserId

OxidEsales\EshopCommunity\Application\Model\DeliverySetList::$_sUserId = null

protected

---

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

• /oxideshop-ce/source/Application/Model/DeliverySetList.php