OXID eShop CE  4.9.7
 All Classes Files Functions Variables Pages
oxPriceList Class Reference

Public Member Functions

 __construct ()
 getBruttoSum ()
 getNettoSum ()
 getSum ($isNettoMode=true)
 getVatInfo ($isNettoMode=true)
 getPriceInfo ()
 getMostUsedVatPercent ()
 getProportionalVatPercent ()
 addToPriceList ($oPrice)
 calculateToPrice ()
 getCount ()

Protected Attributes

 $_aList = array()

Detailed Description

Price list class. Deals with a list of oxPrice object. The main reason why we can't just sum oxPrice objects is that they have different VAT percents.

Definition at line 8 of file oxpricelist.php.

Constructor & Destructor Documentation

oxPriceList::__construct ( )

Class constructor. The constructor is defined in order to be possible to call parent::__construct() in modules.

Returns
null;

Definition at line 23 of file oxpricelist.php.

Member Function Documentation

oxPriceList::addToPriceList (   $oPrice)

Add an oxPrice object to prices array

Parameters
oxprice$oPriceoxprice object

Definition at line 173 of file oxpricelist.php.

oxPriceList::calculateToPrice ( )

Recalculate price list to one price: sum total value of prices, and calculate VAT

Returns
null

Definition at line 183 of file oxpricelist.php.

oxPriceList::getBruttoSum ( )

Returns Brutto price sum

Returns
double

Definition at line 32 of file oxpricelist.php.

oxPriceList::getCount ( )

Return count of added oxPrices

Returns
int

Definition at line 216 of file oxpricelist.php.

oxPriceList::getMostUsedVatPercent ( )

Iterates through applied VATs and fetches VAT for delivery. If not VAT was applied - default VAT (myConfig->dDefaultVAT) will be used

Returns
double

Definition at line 131 of file oxpricelist.php.

oxPriceList::getNettoSum ( )

Returns the sum of list Netto prices

Returns
double

Definition at line 47 of file oxpricelist.php.

oxPriceList::getPriceInfo ( )

Return prices separated to different array elements depending on VAT

Returns
array

Definition at line 111 of file oxpricelist.php.

oxPriceList::getProportionalVatPercent ( )

Iterates through applied VATs and calculates proportional VAT

Returns
double

Definition at line 148 of file oxpricelist.php.

oxPriceList::getSum (   $isNettoMode = true)

Returns the sum of list Netto prices

Parameters
bool$isNettoModemode in which calculate sum, default netto
Returns
double

Definition at line 64 of file oxpricelist.php.

oxPriceList::getVatInfo (   $isNettoMode = true)

Returns VAT values sum separated to different array elements depending on VAT

Parameters
bool$isNettoModemode in which calculate sum, default netto
Returns
array

Definition at line 80 of file oxpricelist.php.

Member Data Documentation

oxPriceList::$_aList = array()
protected

Definition at line 16 of file oxpricelist.php.


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