* @copyright 2007-2017 PrestaShop SA * @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0) * International Registered Trademark & Property of PrestaShop SA */ /** * @since 1.5.0 * * TaxCaculator is responsible of the tax computation */ class TaxCalculatorCore { /** * COMBINE_METHOD sum taxes * eg: 100€ * (10% + 15%) */ const COMBINE_METHOD = 1; /** * ONE_AFTER_ANOTHER_METHOD apply taxes one after another * eg: (100€ * 10%) * 15% */ const ONE_AFTER_ANOTHER_METHOD = 2; /** * @var array $taxes */ public $taxes; /** * @var int $computation_method (COMBINE_METHOD | ONE_AFTER_ANOTHER_METHOD) */ public $computation_method; /** * @param array $taxes * @param int $computation_method (COMBINE_METHOD | ONE_AFTER_ANOTHER_METHOD) */ public function __construct(array $taxes = array(), $computation_method = TaxCalculator::COMBINE_METHOD) { // sanity check foreach ($taxes as $tax) { if (!($tax instanceof Tax)) { throw new Exception('Invalid Tax Object'); } } $this->taxes = $taxes; $this->computation_method = (int)$computation_method; } /** * Compute and add the taxes to the specified price * * @param float $price_te price tax excluded * @return float price with taxes */ public function addTaxes($price_te) { return $price_te * (1 + ($this->getTotalRate() / 100)); } /** * Compute and remove the taxes to the specified price * * @param float $price_ti price tax inclusive * @return float price without taxes */ public function removeTaxes($price_ti) { return $price_ti / (1 + $this->getTotalRate() / 100); } /** * @return float total taxes rate */ public function getTotalRate() { $taxes = 0; if ($this->computation_method == TaxCalculator::ONE_AFTER_ANOTHER_METHOD) { $taxes = 1; foreach ($this->taxes as $tax) { $taxes *= (1 + (abs($tax->rate) / 100)); } $taxes = $taxes - 1; $taxes = $taxes * 100; } else { foreach ($this->taxes as $tax) { $taxes += abs($tax->rate); } } return (float)$taxes; } public function getTaxesName() { $name = ''; foreach ($this->taxes as $tax) { $name .= $tax->name[(int)Context::getContext()->language->id].' - '; } $name = rtrim($name, ' - '); return $name; } /** * Return the tax amount associated to each taxes of the TaxCalculator * * @param float $price_te * @param string|null $checkInDate * @param int $numNights * @param int $numAdults * @param int[] $childrenAges * @param int|null $collectionType * @param int $quantity * @param int|null $idCurrency * @return array $taxes_amount */ public function getTaxesAmount( $price_te, $checkInDate = null, $numNights = 1, $numAdults = 1, $childrenAges = array(), $collectionType = null, $quantity = 1, $idCurrency = null, &$validNightsByTax = null ) { $taxes_amounts = array(); $tourismTaxIds = array(); foreach ($this->taxes as $tax) { if (TaxConfiguration::getByTaxId((int) $tax->id)) { $tourismTaxIds[] = $tax->id; } } if ($checkInDate !== null && $collectionType !== null && Configuration::get('QLO_USE_TOURISM_TAX') && $collectionType !== HotelBranchInformation::TAX_COLLECTION_TYPE_AT_HOTEL) { if (!$idCurrency) { $context = Context::getContext(); $idCurrency = Validate::isLoadedObject($context->currency) ? (int) $context->currency->id : (int) Configuration::get('PS_CURRENCY_DEFAULT'); } $checkIn = new DateTime($checkInDate); $isoDayIndex = $checkIn->format('N') - 1; $infantMaxAge = Configuration::get('QLO_GLOBAL_MAX_INFANT_AGE'); $childMaxAge = Configuration::get('WK_GLOBAL_CHILD_MAX_AGE'); $eligibleChildAges = array_filter($childrenAges, function ($age) use ($infantMaxAge, $childMaxAge) { return $age >= $infantMaxAge && $age < $childMaxAge; }); $runningPriceExcl = (float) $price_te; foreach ($this->taxes as $tax) { $tourismTax = TaxConfiguration::getByTaxId((int) $tax->id); if (!$tourismTax) { continue; } $hasMultiRanges = (bool) $tourismTax->has_multiple_valid_ranges; $validityRanges = $hasMultiRanges ? TaxValidityRange::getByTaxId((int) $tax->id) : null; $specialDays = null; if ($tourismTax->special_days) { $decoded = json_decode($tourismTax->special_days, true); $specialDays = is_array($decoded) ? $decoded : array(); } $isPerNight = (bool) $tourismTax->per_night; if ($isPerNight) { $validNights = 0; for ($i = 0; $i < $numNights; $i++) { $night = clone $checkIn; $night->modify('+' . $i . ' days'); if ($hasMultiRanges && !TaxValidityRange::dateMatchesAnyRange($validityRanges, $night)) { continue; } if ($specialDays !== null && !in_array(TaxConfiguration::DAY_KEYS[$night->format('N') - 1], $specialDays)) { continue; } $validNights++; } if ($validNights === 0) { continue; } } else { if ($hasMultiRanges && !TaxValidityRange::dateMatchesAnyRange($validityRanges, $checkIn)) { continue; } if ($specialDays !== null && !in_array(TaxConfiguration::DAY_KEYS[$isoDayIndex], $specialDays)) { continue; } $validNights = $numNights; } if ($validNightsByTax !== null) { $validNightsByTax[$tax->id] = $validNights; } $taxType = (int) $tourismTax->calculation_type; $baseValue = (float) $tourismTax->tax_value; if ($tourismTax->has_tiered_pricing) { $tier = TaxPriceTier::getMatchingTier((int) $tax->id, $runningPriceExcl); if ($tier) { $baseValue = (float) $tier['tax_value']; } } $adultMultiplier = 1; if ($isPerNight) { $adultMultiplier *= $validNights; } if ($tourismTax->per_person) { $adultMultiplier *= $numAdults; } if ($taxType === TaxConfiguration::CALCULATION_TYPE_FIXED) { $unitAmountAdult = $baseValue; $totalAmountAdult = $baseValue * $adultMultiplier; } else { $unitAmountAdult = $runningPriceExcl * ($baseValue / 100); $totalAmountAdult = $unitAmountAdult * $adultMultiplier; } $totalAmountChild = 0.0; if ($tourismTax->apply_on_child && !empty($eligibleChildAges)) { $contribution = TaxChildRange::getChildContribution( $tax->id, $eligibleChildAges, (int) $tourismTax->child_calculation_type, $unitAmountAdult, $tourismTax->has_child_age_range ); if ($contribution['count'] > 0) { $nightMultiplier = $isPerNight ? $validNights : 1; $totalAmountChild = $contribution['total'] * $nightMultiplier; } } if ($this->computation_method == TaxCalculator::ONE_AFTER_ANOTHER_METHOD) { $runningPriceExcl += $unitAmountAdult; } $totalAmountAdult = Tools::convertPrice($totalAmountAdult, $idCurrency); $totalAmountChild = Tools::convertPrice($totalAmountChild, $idCurrency); $taxes_amounts[$tax->id] = Tools::ps_round(($totalAmountAdult + $totalAmountChild) * max(1, $quantity), 6); } } foreach ($this->taxes as $tax) { if (in_array($tax->id, $tourismTaxIds)) { continue; } if (!isset($taxes_amounts[$tax->id])) { $taxes_amounts[$tax->id] = 0; } if ($this->computation_method == TaxCalculator::ONE_AFTER_ANOTHER_METHOD) { $taxes_amounts[$tax->id] += $price_te * (abs($tax->rate) / 100); $price_te = $price_te + $taxes_amounts[$tax->id]; } else { $taxes_amounts[$tax->id] += ($price_te * (abs($tax->rate) / 100)); } } return $taxes_amounts; } /** * * @param float $price_te * @return float $amount */ public function getTaxesTotalAmount( $price_te, $checkInDate = null, $numNights = 1, $numAdults = 1, $childrenAges = array(), $collectionType = null, $quantity = 1, $idCurrency = null ) { $amount = 0; $taxes = $this->getTaxesAmount($price_te, $checkInDate, $numNights, $numAdults, $childrenAges, $collectionType, $quantity, $idCurrency); foreach ($taxes as $tax) { $amount += $tax; } return $amount; } /** * * @param float $price_te * @param string $checkInDate * @param int $numNights * @param int $numAdults * @param int[] $childrenAges * @param int $collectionType * @param int $quantity * @return float price with tourism tax */ public function addTourismTaxes($price_te, $checkInDate, $numNights, $numAdults, $childrenAges, $collectionType, $quantity = 1) { return $price_te + $this->getTaxesTotalAmount($price_te, $checkInDate, $numNights, $numAdults, $childrenAges, $collectionType, $quantity); } /** * * @param float $price_ti * @param string $checkInDate 'YYYY-MM-DD' * @param int $numNights * @param int $numAdults * @param int[] $childrenAges Ages at check-in date * @param int $collectionType HotelBranchInformation::TAX_COLLECTION_TYPE_* * @param int $quantity Line quantity multiplier * @return float price without tourism tax */ public function removeTourismTaxes($price_ti, $checkInDate, $numNights, $numAdults, $childrenAges, $collectionType, $quantity = 1) { return $price_ti - $this->getTaxesTotalAmount($price_ti, $checkInDate, $numNights, $numAdults, $childrenAges, $collectionType, $quantity); } }