oxVatSelector Class Reference

Inheritance diagram for oxVatSelector:
Inheritance graph
[legend]
Collaboration diagram for oxVatSelector:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 getUserVat (oxUser $oUser, $blCacheReset=false)
 getArticleVat (oxArticle $oArticle)
 getBasketItemVat (oxArticle $oArticle, $oBasket)
 getArticleUserVat (oxArticle $oArticle)

Static Public Member Functions

static getInstance ()

Protected Member Functions

 _getForeignCountryUserVat (oxUser $oUser, oxCountry $oCountry)
 _getVatForArticleCategory (oxArticle $oArticle)
 _getVatCountry (oxUser $oUser=null)

Static Protected Attributes

static $_instance = null
static $_aUserVatCache = array()

Detailed Description

Class, responsible for retrieving correct vat for users and articles

Definition at line 7 of file oxvatselector.php.


Member Function Documentation

oxVatSelector._getForeignCountryUserVat ( oxUser oUser,
oxCountry oCountry 
) [protected]

get vat for user of a foreign country

Parameters:
oxUser $oUser given user object
oxCountry $oCountry given country object
Returns:
unknown

Definition at line 81 of file oxvatselector.php.

oxVatSelector._getVatCountry ( oxUser oUser = null  )  [protected]

Returns country id which VAT should be applied to. Depending on configuration option either user billing country or shipping country (if available) is returned.

Parameters:
oxUser $oUser user object
Returns:
string

Definition at line 203 of file oxvatselector.php.

oxVatSelector._getVatForArticleCategory ( oxArticle oArticle  )  [protected]

return Vat value for oxcategory type assignment only

Parameters:
oxArticle $oArticle given article
Returns:
float | false

Definition at line 100 of file oxvatselector.php.

oxVatSelector.getArticleUserVat ( oxArticle oArticle  ) 

get article user vat

Parameters:
oxArticle $oArticle article object
Returns:
double | false

Definition at line 186 of file oxvatselector.php.

oxVatSelector.getArticleVat ( oxArticle oArticle  ) 

get VAT for given article, can NOT be null

Parameters:
oxArticle $oArticle given article
Returns:
double

Definition at line 146 of file oxvatselector.php.

oxVatSelector.getBasketItemVat ( oxArticle oArticle,
oBasket 
)

Currently returns vats percent that can be applied for basket item ( executes oxVatSelector.getArticleVat()). Can be used to override basket price calculation behaviour (oxarticle.getBasketPrice())

Parameters:
object $oArticle article object
object $oBasket oxbasket object
Returns:
double

Definition at line 174 of file oxvatselector.php.

static oxVatSelector.getInstance (  )  [static]

Returns singleton oxVatSelector object instance or create new if needed

Returns:
oxVatSelector

Definition at line 23 of file oxvatselector.php.

oxVatSelector.getUserVat ( oxUser oUser,
blCacheReset = false 
)

get VAT for user, can NOT be null

Parameters:
oxUser $oUser given user object
bool $blCacheReset reset cache
Exceptions:
oxObjectException if wrong country
Returns:
double | false

Definition at line 47 of file oxvatselector.php.


Member Data Documentation

oxVatSelector.$_aUserVatCache = array() [static, protected]

Definition at line 36 of file oxvatselector.php.

oxVatSelector.$_instance = null [static, protected]

Definition at line 16 of file oxvatselector.php.


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

Generated by  doxygen 1.6.2