oxDeliverySetList Class Reference

Inheritance diagram for oxDeliverySetList:

[legend]

Collaboration diagram for oxDeliverySetList:

[legend]

List of all members.

---

Detailed Description

DeliverySet list manager.

Public Member Functions
	__construct ($sObjectsInListName= 'oxdeliveryset')
	setHomeCountry ($sHomeCountry)
	getDeliverySetList ($oUser, $sCountryId, $sDelSet=null)
	getDeliverySetData ($sShipSet, $oUser, $oBasket)
	getUser ()
	setUser ($oUser)
Static Public Member Functions
static	getInstance ()
Protected Member Functions
	_getList ($oUser=null, $sCountryId=null)
	_getFilterSelect ($oUser, $sCountryId)
Protected Attributes
	$_sUserId = null
	$_sCountryId = null
	$_oUser = null
	$_sHomeCountry = null
Static Private Attributes
static	$_instance = null

---

Constructor & Destructor Documentation

oxDeliverySetList.__construct

(

$

sObjectsInListName = 'oxdeliveryset'

)

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

oxDeliverySetList.setHomeCountry

(

$

sHomeCountry

)

Home country setter

Parameters:

string

$sHomeCountry home country id

Returns:

null

static oxDeliverySetList.getInstance

(

)

[static]

Returns oxDeliverySetList instance

Returns:

oxDeliverySetList

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 accordint to these parameters

Parameters:

	oxUser	$oUser user object
	string	$sCountryId user country id

Returns:

array

oxDeliverySetList._getFilterSelect	(	$	oUser,
		$	sCountryId
	)			[protected]

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

Parameters:

	oxUser	$oUser user object
	string	$sCountryId user country id

Returns:

string

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

Creates current state delivery set list

Parameters:

	oxUser	$oUser user object
	string	$sCountryId user country id
	string	$sDelSet preferred delivery set ID (optional)

Returns:

array

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

Loads deliveryset 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. Retuns 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)
	oxuser	$oUser active user
	double	$oBasket basket object

Returns:

array

oxDeliverySetList.getUser

(

)

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

Returns:

oxUser

oxDeliverySetList.setUser

(

$

oUser

)

Set current user object

Parameters:

oxUser

$oUser user object

Returns:

null

---

Member Data Documentation

oxDeliverySetList.$_instance = null [static, private]

oxDeliverySetList.$_sUserId = null [protected]

oxDeliverySetList.$_sCountryId = null [protected]

oxDeliverySetList.$_oUser = null [protected]

oxDeliverySetList.$_sHomeCountry = null [protected]

---

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

• core/oxdeliverysetlist.php