ePages 7.28.0 - DE_EPAGES/Order/API/Object/Basket.pm

Package DE_EPAGES::Order::API::Object::Basket

object interface for Basket.

Base
DE_EPAGES::Shop::API::Object::ShopObject

Functions

className
container
dbPackage
insertLineItem
recalculate
taxAreaDigitalByAddress
updatePaymentMethod
updateShippingMethod
updateTaxArea
updateTaxAreaDigital

className

Returns the class name, used for DAL access.

Syntax
$ClassName = $Basket->className;
Return
$ClassName (String)
class name

container

Returns lineitem container of basket.

Syntax
$LineItemContainer = $Basket->container;
Return
$LineItemContainer (object)
a lineitemcontainer object

dbPackage

Returns the database package, used for DAL access.

Syntax
$DbPackage = $Basket->dbPackage;
Return
$DbPackage (String)
database package name

insertLineItem

Insert a lineItem in to container, see DE_EPAGES::Order::API::Object::LineItemContainer::insertLineItem.

Syntax
$Basket->insertLineItem;

recalculate

Recalculate lineitem container, see DE_EPAGES::Order::API::Object::LineItemContainer::recalculate.

Syntax
$Basket->recalculate;

taxAreaDigitalByAddress

Get the basket tax area digital based on the shipping address country Default tax area digital is the tax area based on the shop address Returns the tax area digital for the basket, or undef if the address

Syntax
$TaxDigital = $Basket->taxAreaDigitalByAddress();
Return
$TaxDigital (object)
tax area digital object

updatePaymentMethod

Sets the basket payment method based on the shipping/billing address country Returns 1 if payment method has changed, because of changed country in billing or shipping address

Syntax
$PaymentChanged = $Basket->updatePaymentMethod();
Return
$PaymentChanged (integer)
  • 1 : payment method has changed
  • -1 : no payment method exists | integer
  • undef : existing payment method is ok

updateShippingMethod

Sets the basket shipping method based on the shipping/billing address country Returns 1 if shipping method has changed, because of changed country in billing or shipping address

Syntax
$ShippingChanged = $Basket->updateShippingMethod();
Return
$ShippingChanged (integer)
  • 1 : shipping method has changed
  • -1 : no shipping method exists | integer
  • undef : existing shipping method is ok

updateTaxArea

Sets the basket tax area based on the shipping address country Returns true, if calculation of tax has changed, because of changed country in billing or shipping address

Syntax
$TaxChanged = $Basket->updateTaxArea();
Return
$TaxChanged (boolean)
true if tax area or tax calculation has changed,
otherwise undef

updateTaxAreaDigital

Sets the basket tax area digital based on the shipping address country Default tax area digital is the tax area based on the shop address Returns true, if calculation of tax has changed, because of changed country in billing or shipping address

Syntax
$TaxDigitalChanged = $Basket->updateTaxAreaDigital();
Return
$TaxDigitalChanged (boolean)
true if tax area or tax calculation has changed,
otherwise undef