OxidEsales\EshopCommunity\Application\Model\BasketReservation Class Reference

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

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

Public Member Functions
	getReservations ()
	getReservedAmount ($sArticleId)
	reserveBasket (\OxidEsales\Eshop\Application\Model\Basket $oBasket)
	commitArticleReservation ($sArticleId, $dAmount)
	discardArticleReservation ($sArticleId)
	discardReservations ()
	discardUnusedReservations ($iLimit)
	getTimeLeft ()
	renewExpiration ()

Protected Member Functions
	_getReservationsId ()
	_loadReservations ($sBasketId)
	_getReservedItems ()
	_basketDifference (\OxidEsales\Eshop\Application\Model\Basket $oBasket)
	_reserveArticles ($aBasketDiff)
	getUtilsObjectInstance ()

Protected Attributes
	$_oReservations = null
	$_aCurrentlyReserved = null

Detailed Description

Basket reservations handler class

Member Function Documentation

_basketDifference()

OxidEsales\EshopCommunity\Application\Model\BasketReservation::_basketDifference ( \OxidEsales\Eshop\Application\Model\Basket  $oBasket )

protected

compute difference of reserved amounts vs basket items

Parameters

\OxidEsales\Eshop\Application\Model\Basket

$oBasket

basket object

Returns

array

_getReservationsId()

OxidEsales\EshopCommunity\Application\Model\BasketReservation::_getReservationsId ( )

protected

return the ID of active resevations user basket

Returns

string

_getReservedItems()

OxidEsales\EshopCommunity\Application\Model\BasketReservation::_getReservedItems ( )

protected

return currently reserved items in an array format array (artId => amount)

Returns

array

_loadReservations()

OxidEsales\EshopCommunity\Application\Model\BasketReservation::_loadReservations (   $sBasketId )

protected

load reservation or create new reservation user basket

Parameters

string

$sBasketId

basket id for this user basket

Returns

\OxidEsales\EshopCommunity\Application\Model\UserBasket

_reserveArticles()

OxidEsales\EshopCommunity\Application\Model\BasketReservation::_reserveArticles (   $aBasketDiff )

protected

reserve articles given the basket difference array

Parameters

array

$aBasketDiff

basket difference array

See also

oxBasketReservation::_basketDifference

commitArticleReservation()

OxidEsales\EshopCommunity\Application\Model\BasketReservation::commitArticleReservation	(		$sArticleId,
			$dAmount
	)

commit reservation of given article amount deletes this amount from active reservations userBasket, update sold amount

Parameters

string	$sArticleId	article id
double	$dAmount	amount to use

discardArticleReservation()

OxidEsales\EshopCommunity\Application\Model\BasketReservation::discardArticleReservation

(

$sArticleId

)

discard one article reservation return the reserved stock to article

Parameters

string

$sArticleId

article id

discardReservations()

OxidEsales\EshopCommunity\Application\Model\BasketReservation::discardReservations

(

)

discard all reserved articles

discardUnusedReservations()

OxidEsales\EshopCommunity\Application\Model\BasketReservation::discardUnusedReservations

(

$iLimit

)

periodic cleanup: discards timed out reservations even if they are not for the current user

Parameters

int

$iLimit

limit for discarding (performance related)

Exceptions

Exception

Returns

null

getReservations()

OxidEsales\EshopCommunity\Application\Model\BasketReservation::getReservations

(

)

get reservations collection

Returns

\OxidEsales\EshopCommunity\Application\Model\UserBasket

getReservedAmount()

OxidEsales\EshopCommunity\Application\Model\BasketReservation::getReservedAmount

(

$sArticleId

)

return currently reserved amount for an article

Parameters

string

$sArticleId

article id

Returns

double

getTimeLeft()

OxidEsales\EshopCommunity\Application\Model\BasketReservation::getTimeLeft

(

)

return time left (in seconds) for basket before expiration

Returns

int

getUtilsObjectInstance()

OxidEsales\EshopCommunity\Application\Model\BasketReservation::getUtilsObjectInstance ( )

protected

Returns

\OxidEsales\Eshop\Core\UtilsObject

renewExpiration()

OxidEsales\EshopCommunity\Application\Model\BasketReservation::renewExpiration

(

)

renews expiration timer to maximum value

reserveBasket()

OxidEsales\EshopCommunity\Application\Model\BasketReservation::reserveBasket

(

\OxidEsales\Eshop\Application\Model\Basket

$oBasket

)

reserve given basket items, only when not in admin mode

Parameters

\OxidEsales\Eshop\Application\Model\Basket

$oBasket

basket object

Member Data Documentation

$_aCurrentlyReserved

OxidEsales\EshopCommunity\Application\Model\BasketReservation::$_aCurrentlyReserved = null

protected

$_oReservations

OxidEsales\EshopCommunity\Application\Model\BasketReservation::$_oReservations = null

protected

---

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

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