Inheritance diagram for TaxCalculation:

Public Member Functions
	__construct (Calculation $calculation, CalculatorFactory $calculatorFactory, Config $config, TaxDetailsInterfaceFactory $taxDetailsDataObjectFactory, TaxDetailsItemInterfaceFactory $taxDetailsItemDataObjectFactory, StoreManagerInterface $storeManager, TaxClassManagementInterface $taxClassManagement, \Magento\Framework\Api\DataObjectHelper $dataObjectHelper)

	getDefaultCalculatedRate ( $productTaxClassID, $customerId=null, $storeId=null)

	getCalculatedRate ( $productTaxClassID, $customerId=null, $storeId=null)

Public Member Functions inherited from TaxCalculationInterface
	calculateTax (\Magento\Tax\Api\Data\QuoteDetailsInterface $quoteDetails, $storeId=null, $round=true)

Protected Member Functions
	getRate ( $productTaxClassID, $customerId=null, $storeId=null, $isDefault=false)

	processItem (QuoteDetailsItemInterface $item, AbstractCalculator $calculator, $round=true)

	calculateParent ($children, $quantity)

	aggregateItemData ($taxDetailsData, TaxDetailsItemInterface $item)

	getTotalQuantity (QuoteDetailsItemInterface $item)

Protected Attributes
	$taxDetailsDataObjectFactory

	$config

	$calculationTool

	$discountTaxCompensations

	$taxDetailsItemDataObjectFactory

	$storeManager

	$taxClassManagement

	$calculatorFactory

	$dataObjectHelper

Additional Inherited Members
Data Fields inherited from TaxCalculationInterface
const	CALC_UNIT_BASE = 'UNIT_BASE_CALCULATION'

const	CALC_ROW_BASE = 'ROW_BASE_CALCULATION'

const	CALC_TOTAL_BASE = 'TOTAL_BASE_CALCULATION'

Detailed Description

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 26 of file TaxCalculation.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	Calculation	$calculation,
		CalculatorFactory	$calculatorFactory,
		Config	$config,
		TaxDetailsInterfaceFactory	$taxDetailsDataObjectFactory,
		TaxDetailsItemInterfaceFactory	$taxDetailsItemDataObjectFactory,
		StoreManagerInterface	$storeManager,
		TaxClassManagementInterface	$taxClassManagement,
		\Magento\Framework\Api\DataObjectHelper	$dataObjectHelper
	)

Parameters

Calculation	$calculation
CalculatorFactory	$calculatorFactory
Config	$config
TaxDetailsInterfaceFactory	$taxDetailsDataObjectFactory
TaxDetailsItemInterfaceFactory	$taxDetailsItemDataObjectFactory
StoreManagerInterface	$storeManager
TaxClassManagementInterface	$taxClassManagement
\Magento\Framework\Api\DataObjectHelper	$dataObjectHelper

Definition at line 111 of file TaxCalculation.php.

       {
         $this->calculationTool = $calculation;
         $this->calculatorFactory = $calculatorFactory;
         $this->config = $config;
         $this->taxDetailsDataObjectFactory = $taxDetailsDataObjectFactory;
         $this->taxDetailsItemDataObjectFactory = $taxDetailsItemDataObjectFactory;
         $this->storeManager = $storeManager;
         $this->taxClassManagement = $taxClassManagement;
         $this->dataObjectHelper = $dataObjectHelper;
     }

Member Function Documentation

◆ aggregateItemData()

aggregateItemData	(		$taxDetailsData,
		TaxDetailsItemInterface	$item
	)

protected

Add row total item amount to subtotal

Parameters

array	$taxDetailsData
TaxDetailsItemInterface	$item

Returns: array

Definition at line 328 of file TaxCalculation.php.

     {
         $taxDetailsData[TaxDetails::KEY_SUBTOTAL]
             = $taxDetailsData[TaxDetails::KEY_SUBTOTAL] + $item->getRowTotal();
 
         $taxDetailsData[TaxDetails::KEY_TAX_AMOUNT]
             = $taxDetailsData[TaxDetails::KEY_TAX_AMOUNT] + $item->getRowTax();
 
         $taxDetailsData[TaxDetails::KEY_DISCOUNT_TAX_COMPENSATION_AMOUNT] =
             $taxDetailsData[TaxDetails::KEY_DISCOUNT_TAX_COMPENSATION_AMOUNT]
             + $item->getDiscountTaxCompensationAmount();
 
         $itemAppliedTaxes = $item->getAppliedTaxes();
         if ($itemAppliedTaxes === null) {
             return $taxDetailsData;
         }
         $appliedTaxes = $taxDetailsData[TaxDetails::KEY_APPLIED_TAXES];
         foreach ($itemAppliedTaxes as $taxId => $itemAppliedTax) {
             if (!isset($appliedTaxes[$taxId])) {
                 //convert rate data object to array
                 $rates = [];
                 $rateDataObjects = $itemAppliedTax->getRates();
                 foreach ($rateDataObjects as $rateDataObject) {
                     $rates[$rateDataObject->getCode()] = [
                         AppliedTaxRate::KEY_CODE => $rateDataObject->getCode(),
                         AppliedTaxRate::KEY_TITLE => $rateDataObject->getTitle(),
                         AppliedTaxRate::KEY_PERCENT => $rateDataObject->getPercent(),
                     ];
                 }
                 $appliedTaxes[$taxId] = [
                     AppliedTax::KEY_AMOUNT => $itemAppliedTax->getAmount(),
                     AppliedTax::KEY_PERCENT => $itemAppliedTax->getPercent(),
                     AppliedTax::KEY_RATES => $rates,
                     AppliedTax::KEY_TAX_RATE_KEY => $itemAppliedTax->getTaxRateKey(),
                 ];
             } else {
                 $appliedTaxes[$taxId][AppliedTax::KEY_AMOUNT] += $itemAppliedTax->getAmount();
             }
         }
 
         $taxDetailsData[TaxDetails::KEY_APPLIED_TAXES] = $appliedTaxes;
         return $taxDetailsData;
     }

◆ calculateParent()

calculateParent	(	$children,
		$quantity
	)

protected

Calculate row information for item based on children calculation

Parameters

	TaxDetailsItemInterface[]	$children
int	$quantity

Returns: TaxDetailsItemInterface

Definition at line 294 of file TaxCalculation.php.

     {
         $rowTotal = 0.00;
         $rowTotalInclTax = 0.00;
         $rowTax = 0.00;
         $taxableAmount = 0.00;
 
         foreach ($children as $child) {
             $rowTotal += $child->getRowTotal();
             $rowTotalInclTax += $child->getRowTotalInclTax();
             $rowTax += $child->getRowTax();
             $taxableAmount += $child->getTaxableAmount();
         }
 
         $price = $this->calculationTool->round($rowTotal / $quantity);
         $priceInclTax = $this->calculationTool->round($rowTotalInclTax / $quantity);
 
         $taxDetailsItemDataObject = $this->taxDetailsItemDataObjectFactory->create()
             ->setPrice($price)
             ->setPriceInclTax($priceInclTax)
             ->setRowTotal($rowTotal)
             ->setRowTotalInclTax($rowTotalInclTax)
             ->setRowTax($rowTax);
 
         return $taxDetailsItemDataObject;
     }

◆ getCalculatedRate()

getCalculatedRate	(	$productTaxClassID,
		$customerId = `null`,
		$storeId = `null`
	)

{Get rate request

Parameters

int	$productTaxClassID
int	$customerId
string	$storeId

Returns: float

}

Implements TaxCalculationInterface.

Definition at line 216 of file TaxCalculation.php.

       {
         return $this->getRate($productTaxClassID, $customerId, $storeId);
     }

◆ getDefaultCalculatedRate()

getDefaultCalculatedRate	(	$productTaxClassID,
		$customerId = `null`,
		$storeId = `null`
	)

{Get default rate request

Parameters

int	$productTaxClassID
int	$customerId
string	$storeId

Returns: float

}

Implements TaxCalculationInterface.

Definition at line 205 of file TaxCalculation.php.

       {
         return $this->getRate($productTaxClassID, $customerId, $storeId, true);
     }

◆ getRate()

getRate	(	$productTaxClassID,
		$customerId = `null`,
		$storeId = `null`,
		$isDefault = `false`
	)

protected

Calculate rate based on default parameter

Parameters

int	$productTaxClassID
int \| null	$customerId
string \| null	$storeId
bool	$isDefault

Returns: float

Definition at line 233 of file TaxCalculation.php.

       {
         if ($storeId === null) {
             $storeId = $this->storeManager->getStore()->getStoreId();
         }
         if (!$isDefault) {
             $addressRequestObject = $this->calculationTool->getRateRequest(null, null, null, $storeId, $customerId);
         } else {
             $addressRequestObject = $this->calculationTool->getDefaultRateRequest($storeId, $customerId);
         }
         $addressRequestObject->setProductClassId($productTaxClassID);
         return $this->calculationTool->getRate($addressRequestObject);
     }

◆ getTotalQuantity()

getTotalQuantity ( QuoteDetailsItemInterface $item )

protected

Calculates the total quantity for this item.

What this really means is that if this is a child item, it return the parent quantity times the child quantity and return that as the child's quantity.

Parameters

QuoteDetailsItemInterface $item

Returns: float

Definition at line 381 of file TaxCalculation.php.

     {
         if ($item->getParentCode()) {
             $parentQuantity = $this->keyedItems[$item->getParentCode()]->getQuantity();
             return $parentQuantity * $item->getQuantity();
         }
         return $item->getQuantity();
     }

◆ processItem()

processItem	(	QuoteDetailsItemInterface	$item,
		AbstractCalculator	$calculator,
			$round = `true`
	)

protected

Calculate item tax with customized rounding level

Parameters

QuoteDetailsItemInterface	$item
AbstractCalculator	$calculator
bool	$round

Returns: TaxDetailsItemInterface

Definition at line 278 of file TaxCalculation.php.

       {
         $quantity = $this->getTotalQuantity($item);
         return $calculator->calculate($item, $quantity, $round);
     }

Field Documentation

◆ $calculationTool

$calculationTool

protected

Definition at line 47 of file TaxCalculation.php.

◆ $calculatorFactory

$calculatorFactory

protected

Definition at line 94 of file TaxCalculation.php.

◆ $config

$config

protected

Definition at line 40 of file TaxCalculation.php.

◆ $dataObjectHelper

$dataObjectHelper

protected

Definition at line 99 of file TaxCalculation.php.

◆ $discountTaxCompensations

$discountTaxCompensations

protected

Definition at line 54 of file TaxCalculation.php.

◆ $storeManager

$storeManager

protected

Definition at line 66 of file TaxCalculation.php.

◆ $taxClassManagement

$taxClassManagement

protected

Definition at line 87 of file TaxCalculation.php.

◆ $taxDetailsDataObjectFactory

$taxDetailsDataObjectFactory

protected

Definition at line 33 of file TaxCalculation.php.

◆ $taxDetailsItemDataObjectFactory

$taxDetailsItemDataObjectFactory

protected

Definition at line 61 of file TaxCalculation.php.

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

vendor/magento/module-tax/Model/TaxCalculation.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ aggregateItemData()

◆ calculateParent()

◆ getCalculatedRate()

◆ getDefaultCalculatedRate()

◆ getRate()

◆ getTotalQuantity()

◆ processItem()

Field Documentation

◆ $calculationTool

◆ $calculatorFactory

◆ $config

◆ $dataObjectHelper

◆ $discountTaxCompensations

◆ $storeManager

◆ $taxClassManagement

◆ $taxDetailsDataObjectFactory

◆ $taxDetailsItemDataObjectFactory