A set of interfaces and methods to clean up your application's tax calculations. The TaxCalculation
class allows you to do calculations with plain numbers and objects that implement the HasTax
interface on the fly.
use Spatie\TaxCalculator\TaxCalculation;
$items = $myCart->getItems(); // Should return an array of items that implement `HasTax`
TaxCalculation::fromCollection($items)->basePrice(); // 10.00
TaxCalculation::fromCollection($items)->taxPrice(); // 2.10
TaxCalculation::fromCollection($items)->taxedPrice(); // 12.10
$delivery = TaxCalculation::fromTaxedPrice(7.50, 0.21);
TaxCalculation::fromCollection($items)->add($delivery)->taxedPrice(); // 19.60
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
You're free to use this package (it's MIT-licensed), but if it makes it to your production environment you are required to send us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.
The best postcards will get published on the open source page on our website.
You can install the package via composer:
composer require spatie/tax-calculator
The interfaces are provided so you can keep working with your domain objects instead of having to pass around floats everywhere. However, they're not strictly necessary to do calculations.
public function basePrice(): float;
public function taxedPrice(): float;
public function taxPrice(): float;
basePrice
: The item's price excluding taxestaxedPrice
: The item's price including taxestaxPrice
: The item's tax amount (= taxedPrice() - basePrice()
)
public function taxRate(): float;
HasTaxWithRate
extends HasTax
, and also has a taxRate
method. This is useful for items that have a fixed tax rate, but can't be used on collections that contain items with various rates.
The HasTaxWithRate
trait provides default implementations of taxPrice
and taxedPrice
, since they can be deducted by a simple multiplication of basePrice
and taxRate
.
...
Please see CHANGELOG for more information what has changed recently.
$ composer test
Please see CONTRIBUTING for details.
If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
The MIT License (MIT). Please see License File for more information.