sunfoxcz / price-calculator

src/PriceCalculator.php

<?php declare(strict_types=1);

namespace Sunfox\PriceCalculator;

use Nette;


/**
 * @property float $basePrice
 * @property IDiscount $discount
 * @property float $price
 * @property float $vatRate
 * @property float $priceVat
 * @property float $decimalPoints
 */
class PriceCalculator implements IPriceCalculator
{
	use Nette\SmartObject;

	/** @var float */
	protected $basePrice = 0.0;

	/** @var IDiscount|NULL */
	protected $discount = NULL;

	/** @var float */
	protected $price = 0.0;

	/** @var float */
	protected $vatRate = 0.0;

	/** @var float */
	protected $priceVat = 0.0;

	/** @var int */
	protected $decimalPoints = 2;

	/** @var string */
	protected $calculateFrom = self::FROM_BASEPRICE;


	/**
	 * @param int|float VAT rate
	 * @param int|float Price without VAT and discount
	 * @param int|float Discount without VAT
	 */
	public function __construct($vatRate = 0.0, $basePrice = 0.0, IDiscount $discount = NULL)
	{
		$this->setVatRate($vatRate);
		$this->setBasePrice($basePrice);
		$this->setDiscount($discount);
	}

	/**
	 * Get price without VAT and discount.
	 *
	 * @return float
	 */
	public function getBasePrice()
	{
		return $this->basePrice;
	}

	/**
	 * Set price without VAT and discount.
	 *
	 * @param int|float
	 * @return IPriceCalculator
	 */
	public function setBasePrice($value)
	{
		$this->basePrice = (float) $value;
		$this->calculateFrom = self::FROM_BASEPRICE;
		return $this;
	}

	/**
	 * Get discount in percent without VAT.
	 *
	 * @return IDiscount
	 */
	public function getDiscount()
	{
		return $this->discount;

The expression $this->discount; of type Sunfox\PriceCalculator\IDiscount|null adds the type Sunfox\PriceCalculator\IDiscount to the return on line 84 which is incompatible with the return type declared by the interface Sunfox\PriceCalculator\IPriceCalculator::getDiscount of type double.

	}

	/**
	 * Set discount instance.
	 *
	 * @param IDiscount
	 * @return IPriceCalculator
	 */
	public function setDiscount(IDiscount $discount = NULL)
	{
		$this->discount = $discount;
		return $this;
	}

	/**
	 * Set amount discount.
	 *
	 * @param int|float
	 * @return IPriceCalculator
	 */
	public function setAmountDiscount($value)
	{
		$this->discount = new Discount\AmountDiscount($value);
		return $this;
	}

	/**
	 * Set percent discount.
	 *
	 * @param int|float
	 * @return IPriceCalculator
	 */
	public function setPercentDiscount($value)
	{
		$this->discount = new Discount\PercentDiscount($value);
		return $this;
	}

	/**
	 * Get price after discount without VAT.
	 *
	 * @return float
	 */
	public function getPrice()
	{
		return $this->price;
	}

	/**
	 * Set price after discount without VAT.
	 *
	 * @param int|float
	 * @return IPriceCalculator
	 */
	public function setPrice($value)
	{
		$this->price = (float) $value;
		$this->calculateFrom = self::FROM_PRICE;
		return $this;
	}

	/**
	 * Get VAT rate in percent.
	 *
	 * @return float
	 */
	public function getVatRate()
	{
		return $this->vatRate;
	}

	/**
	 * Set VAT rate in percent.
	 *
	 * @param int|float
	 * @return IPriceCalculator
	 */
	public function setVatRate($value)
	{
		$this->vatRate = (float) $value;
		return $this;
	}

	/**
	 * Get price after discount with VAT.
	 *
	 * @return float
	 */
	public function getPriceVat()
	{
		return $this->priceVat;
	}

	/**
	 * Set price after discount with VAT.
	 *
	 * @param int|float
	 * @return IPriceCalculator
	 */
	public function setPriceVat($value)
	{
		$this->priceVat = (float) $value;
		$this->calculateFrom = self::FROM_PRICEVAT;
		return $this;
	}

	/**
	 * Get decimal point for rounding.
	 *
	 * @return float
	 */
	public function getDecimalPoints()
	{
		return $this->decimalPoints;
	}

	/**
	 * Set decimal point for rounding.
	 *
	 * @param int
	 * @return IPriceCalculator
	 */
	public function setDecimalPoints($value)
	{
		$this->decimalPoints = (int) $value;
		return $this;
	}

	/**
	 * Calculate prices and return result.
	 *
	 * @return PriceCalculatorResult
	 */
	public function calculate()
	{
		$basePrice = round($this->basePrice, $this->decimalPoints);
		$price = round($this->price, $this->decimalPoints);
		$priceVat = round($this->priceVat, $this->decimalPoints);

		if ($this->calculateFrom === self::FROM_BASEPRICE) {
			$price = round($this->discount ? $this->discount->addDiscount($basePrice) : $basePrice, $this->decimalPoints);
			$priceVat = round($price * ($this->vatRate / 100 + 1), $this->decimalPoints);
		} elseif ($this->calculateFrom === self::FROM_PRICE) {
			$basePrice = $this->discount ? round($this->discount->removeDiscount($price), $this->decimalPoints) : $price;
			$priceVat = round($price * ($this->vatRate / 100 + 1), $this->decimalPoints);
		} elseif ($this->calculateFrom === self::FROM_PRICEVAT) {
			$price = round($priceVat / ($this->vatRate / 100 + 1), $this->decimalPoints);
			$basePrice = $this->discount ? round($this->discount->removeDiscount($price), $this->decimalPoints) : $price;
		}

		$vat = $priceVat - $price;

		return new PriceCalculatorResult(
			$this, $basePrice, $this->discount, $price, $this->vatRate, $vat, $priceVat
		);
	}

}