oxDeliverySetList Class Reference

Inheritance diagram for oxDeliverySetList:

Collaboration diagram for oxDeliverySetList:

List of all members.

Public Member Functions
	__construct ($sObjectsInListName= 'oxdeliveryset')
	setHomeCountry ($sHomeCountry)
	getDeliverySetList ($oUser, $sCountryId, $sDelSet=null)
	getDeliverySetData ($sShipSet, $oUser, $oBasket)
	getUser ()
	setUser ($oUser)
	loadNonRDFaDeliverySetList ()
	loadRDFaDeliverySetList ($sDelId=null)
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

---

Detailed Description

DeliverySet list manager.

Definition at line 7 of file oxdeliverysetlist.php.

---

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.

Definition at line 49 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	$oUser user object
	string	$sCountryId user country id

Returns:

string

Definition at line 140 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 accordint to these parameters

Parameters:

	oxUser	$oUser user object
	string	$sCountryId user country id

Returns:

array

Definition at line 97 of file oxdeliverysetlist.php.

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

Definition at line 236 of file oxdeliverysetlist.php.

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

Definition at line 205 of file oxdeliverysetlist.php.

static oxDeliverySetList.getInstance

(

)

[static]

Returns oxDeliverySetList instance

Deprecated:

since v5.0 (2012-08-10); Use oxRegistry.get("oxDeliverySetList") instead.

Returns:

oxDeliverySetList

Definition at line 78 of file oxdeliverysetlist.php.

oxDeliverySetList.getUser

(

)

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

Returns:

oxUser

Definition at line 290 of file oxdeliverysetlist.php.

oxDeliverySetList.loadNonRDFaDeliverySetList

(

)

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

Returns:

null

Definition at line 317 of file oxdeliverysetlist.php.

oxDeliverySetList.loadRDFaDeliverySetList

(

$

sDelId = null

)

Loads delivery set mapped to a predefined GoodRelations delivery method.

Parameters:

string

$sDelId delivery set id

Returns:

null

Definition at line 332 of file oxdeliverysetlist.php.

oxDeliverySetList.setHomeCountry

(

$

sHomeCountry

)

Home country setter

Parameters:

string

$sHomeCountry home country id

Returns:

null

Definition at line 62 of file oxdeliverysetlist.php.

oxDeliverySetList.setUser

(

$

oUser

)

Set current user object

Parameters:

oxUser

$oUser user object

Returns:

null

Definition at line 306 of file oxdeliverysetlist.php.

---

Member Data Documentation

oxDeliverySetList.$_instance = null [static, private]

Definition at line 13 of file oxdeliverysetlist.php.

oxDeliverySetList.$_oUser = null [protected]

Definition at line 34 of file oxdeliverysetlist.php.

oxDeliverySetList.$_sCountryId = null [protected]

Definition at line 27 of file oxdeliverysetlist.php.

oxDeliverySetList.$_sHomeCountry = null [protected]

Definition at line 41 of file oxdeliverysetlist.php.

oxDeliverySetList.$_sUserId = null [protected]

Definition at line 20 of file oxdeliverysetlist.php.

---

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

• application/models/oxdeliverysetlist.php