Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes

oxPrice Class Reference

List of all members.

Public Member Functions

 __construct ($dInitPrice=null)
 setNettoPriceMode ()
 setBruttoPriceMode ()
 setVat ($newVat)
 setUserVat ($newVat)
 getVat ()
 setPrice ($dPrice, $dVat=null)
 getPrice ()
 getBruttoPrice ()
 getNettoPrice ()
 getVatValue ()
 subtractPercent ($dValue)
 addPercent ($dValue)
 addPrice (oxPrice $oPrice)
 add ($dValue)
 subtract ($dValue)
 multiply ($dValue)
 divide ($dValue)
 compare (oxPrice $oPrice)
 setDiscount ($dValue, $sType)
 getDiscounts ()
 calculateDiscount ()

Static Public Member Functions

static percent ($dValue, $dPercent)
static brutto2Netto ($dBrutto, $dVat)
static netto2Brutto ($dNetto, $dVat)
static getPriceInActCurrency ($dPrice)

Protected Member Functions

 _recalculate ()
 _flushDiscounts ()

Protected Attributes

 $_dBrutto = 0.0
 $_dNetto = 0.0
 $_dVat = 0.0
 $_aDiscounts = null
 $_blNetPriceMode

Detailed Description

Price calculation class. Responsible for simple price calculations. Basically contains Brutto, Netto prices and VAT values.

Definition at line 6 of file oxprice.php.


Constructor & Destructor Documentation

oxPrice.__construct ( dInitPrice = null  ) 

Class constructor. Gets price entering mode.

Parameters:
double $dInitPrice given price
Returns:
oxPrice

Definition at line 55 of file oxprice.php.


Member Function Documentation

oxPrice._flushDiscounts (  )  [protected]

Flush assigned discounts

Returns:
null

Definition at line 449 of file oxprice.php.

oxPrice._recalculate (  )  [protected]

Calculates price depending on price entering mode. Round only displayed price to the user, other leave as accurate as possible: in Brutto mode: round Brutto price before calculations; in Netto mode: round Brutto price after calculations;

protected

Deprecated:
since v5.0 (2012-09-14); not needed any more;
Returns:
null

Definition at line 396 of file oxprice.php.

oxPrice.add ( dValue  ) 

Adds given value to price depending on price entering mode, and recalculates price

Parameters:
double $dValue value to add to price
Returns:
null

Definition at line 259 of file oxprice.php.

oxPrice.addPercent ( dValue  ) 

Adds given percent to price depending on price entering mode, and recalculates price

Parameters:
double $dValue percent to add to price
Returns:
null

Definition at line 230 of file oxprice.php.

oxPrice.addPrice ( oxPrice oPrice  ) 

Adds another oxPrice object and recalculates current method.

Parameters:
oxPrice $oPrice object
Returns:
null

Definition at line 242 of file oxprice.php.

static oxPrice.brutto2Netto ( dBrutto,
dVat 
) [static]

Converts Brutto price to Netto using formula: X + $dVat% = $dBrutto X/100 = $dBrutto/(100+$dVAT) X= ($dBrutto/(100+$dVAT))/100 returns X

Parameters:
double $dBrutto brutto price
double $dVat vat
Returns:
double

Definition at line 358 of file oxprice.php.

oxPrice.calculateDiscount (  ) 

Calculates price: affects discounts

Returns:
null

Definition at line 459 of file oxprice.php.

oxPrice.compare ( oxPrice oPrice  ) 

Compares this object to another oxPrice objects. Comparison is performed on brutto price. Result is equal to: 0 - when prices are equal. 1 - when this price is larger than $oPrice. -1 - when this price is smaller than $oPrice.

Parameters:
oxPrice $oPrice price object
Returns:
null

Definition at line 317 of file oxprice.php.

oxPrice.divide ( dValue  ) 

Divides price by given value depending on price entering mode, and recalculates price

Parameters:
double $dValue value for dividing price
Returns:
null

Definition at line 300 of file oxprice.php.

oxPrice.getBruttoPrice (  ) 

Returns brutto price

Returns:
double

Definition at line 169 of file oxprice.php.

oxPrice.getDiscounts (  ) 

Returns assigned discounts

Returns:
array

Definition at line 439 of file oxprice.php.

oxPrice.getNettoPrice (  ) 

Returns netto price

Returns:
double

Definition at line 183 of file oxprice.php.

oxPrice.getPrice (  ) 

Returns price depending on mode brutto or netto

Returns:
double

Definition at line 155 of file oxprice.php.

static oxPrice.getPriceInActCurrency ( dPrice  )  [static]

Returns price multiplied by current currency

Parameters:
string $dPrice price value
Returns:
double

Definition at line 414 of file oxprice.php.

oxPrice.getVat (  ) 

Returns VAT percent

Returns:
double

Definition at line 123 of file oxprice.php.

oxPrice.getVatValue (  ) 

Returns absolute VAT value

Returns:
double

Definition at line 197 of file oxprice.php.

oxPrice.multiply ( dValue  ) 

Multiplies price by given value depending on price entering mode, and recalculates price

Parameters:
double $dValue value for multiplying price
Returns:
null

Definition at line 286 of file oxprice.php.

static oxPrice.netto2Brutto ( dNetto,
dVat 
) [static]

Converts Netto price to Brutto using formula: X = $dNetto + $dVat% returns X

Parameters:
double $dNetto netto price
double $dVat vat
Returns:
double

Definition at line 379 of file oxprice.php.

static oxPrice.percent ( dValue,
dPercent 
) [static]

Private function for percent value calculations

Parameters:
double $dValue value
double $dPercent percent
Returns:
double

Definition at line 341 of file oxprice.php.

oxPrice.setBruttoPriceMode (  ) 

Brutto price mode setter

Returns:
null

Definition at line 79 of file oxprice.php.

oxPrice.setDiscount ( dValue,
sType 
)

Sets discount to price

Parameters:
double $dValue discount value
string $sType discount type: abs or %
Returns:
null

Definition at line 429 of file oxprice.php.

oxPrice.setNettoPriceMode (  ) 

Netto price mode setter

Returns:
null

Definition at line 69 of file oxprice.php.

oxPrice.setPrice ( dPrice,
dVat = null 
)

Sets new price and VAT percent(optional). Recalculates price by price entering mode

Parameters:
double $dPrice new price
double $dVat VAT
Returns:
null

Definition at line 137 of file oxprice.php.

oxPrice.setUserVat ( newVat  ) 

Sets new base VAT percent, recalculates brutto, and then netto price (in brutto mode). if bruttoMode then BruttoPrice =(BruttoPrice - oldVAT% ) + newVat; oldVAT = newVat; finally recalculate; USE ONLY TO CHANGE BASE VAT (in case when local VAT differs from user VAT), USE setVat() in usual case !!!

Parameters:
double $newVat vat percent
Deprecated:
since v5.0 (2012-09-14); use setVat();
Returns:
null

Definition at line 110 of file oxprice.php.

oxPrice.setVat ( newVat  ) 

Sets new VAT percent, and recalculates price.

Parameters:
double $newVat vat percent
Returns:
null

Definition at line 91 of file oxprice.php.

oxPrice.subtract ( dValue  ) 

Subtracts given value from price depending on price entering mode, and recalculates price

Parameters:
double $dValue value to subtracts from price
Returns:
null

Definition at line 273 of file oxprice.php.

oxPrice.subtractPercent ( dValue  ) 

Subtracts given percent from price depending on price entering mode, and recalculates price

Parameters:
double $dValue percent to subtract from price
Returns:
null

Definition at line 216 of file oxprice.php.


Member Data Documentation

oxPrice.$_aDiscounts = null [protected]

Definition at line 35 of file oxprice.php.

oxPrice.$_blNetPriceMode [protected]

Definition at line 46 of file oxprice.php.

oxPrice.$_dBrutto = 0.0 [protected]

Definition at line 13 of file oxprice.php.

oxPrice.$_dNetto = 0.0 [protected]

Definition at line 20 of file oxprice.php.

oxPrice.$_dVat = 0.0 [protected]

Definition at line 27 of file oxprice.php.


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