Tax Class Reference

Inheritance diagram for Tax:

Public Member Functions
	__construct (\Magento\Tax\Model\Config $taxConfig, \Magento\Tax\Api\TaxCalculationInterface $taxCalculationService, \Magento\Tax\Api\Data\QuoteDetailsInterfaceFactory $quoteDetailsDataObjectFactory, \Magento\Tax\Api\Data\QuoteDetailsItemInterfaceFactory $quoteDetailsItemDataObjectFactory, \Magento\Tax\Api\Data\TaxClassKeyInterfaceFactory $taxClassKeyDataObjectFactory, CustomerAddressFactory $customerAddressFactory, CustomerAddressRegionFactory $customerAddressRegionFactory, \Magento\Tax\Helper\Data $taxData, Json $serializer=null)
	collect (\Magento\Quote\Model\Quote $quote, \Magento\Quote\Api\Data\ShippingAssignmentInterface $shippingAssignment, \Magento\Quote\Model\Quote\Address\Total $total)
	mapQuoteExtraTaxables (\Magento\Tax\Api\Data\QuoteDetailsItemInterfaceFactory $itemDataObjectFactory, Address $address, $useBaseCurrency)
	fetch (\Magento\Quote\Model\Quote $quote, \Magento\Quote\Model\Quote\Address\Total $total)
	processConfigArray ($config, $store)
	getLabel ()
Public Member Functions inherited from CommonTaxCollector
	__construct (\Magento\Tax\Model\Config $taxConfig, \Magento\Tax\Api\TaxCalculationInterface $taxCalculationService, \Magento\Tax\Api\Data\QuoteDetailsInterfaceFactory $quoteDetailsDataObjectFactory, \Magento\Tax\Api\Data\QuoteDetailsItemInterfaceFactory $quoteDetailsItemDataObjectFactory, \Magento\Tax\Api\Data\TaxClassKeyInterfaceFactory $taxClassKeyDataObjectFactory, CustomerAddressFactory $customerAddressFactory, CustomerAddressRegionFactory $customerAddressRegionFactory)
	mapAddress (QuoteAddress $address)
	mapItems (ShippingAssignmentInterface $shippingAssignment, $priceIncludesTax, $useBaseCurrency)
	populateAddressData (QuoteDetailsInterface $quoteDetails, QuoteAddress $address)
	updateItemTaxInfo ($quoteItem, $itemTaxDetails, $baseItemTaxDetails, $store)
	convertAppliedTaxes ($appliedTaxes, $baseAppliedTaxes, $extraInfo=[])
Public Member Functions inherited from AbstractTotal
	setCode ($code)
	getCode ()
	getLabel ()
	collect (\Magento\Quote\Model\Quote $quote, \Magento\Quote\Api\Data\ShippingAssignmentInterface $shippingAssignment, \Magento\Quote\Model\Quote\Address\Total $total)
	fetch (\Magento\Quote\Model\Quote $quote, \Magento\Quote\Model\Quote\Address\Total $total)
	_setTotal (\Magento\Quote\Model\Quote\Address\Total $total)
	getItemRowTotal (\Magento\Quote\Model\Quote\Item\AbstractItem $item)
	getItemBaseRowTotal (\Magento\Quote\Model\Quote\Item\AbstractItem $item)
	getIsItemRowTotalCompoundable (\Magento\Quote\Model\Quote\Item\AbstractItem $item)
	processConfigArray ($config, $store)

Protected Member Functions
	clearValues (Address\Total $total)
	getQuoteTaxDetails ($shippingAssignment, $total, $useBaseCurrency)
Protected Member Functions inherited from CommonTaxCollector
	prepareQuoteDetails (ShippingAssignmentInterface $shippingAssignment, $itemDataObjects)
	processShippingTaxInfo (ShippingAssignmentInterface $shippingAssignment, QuoteAddress\Total $total, $shippingTaxDetails, $baseShippingTaxDetails)
	_saveAppliedTaxes (QuoteAddress\Total $total, $applied, $amount, $baseAmount, $rate)
	includeShipping ()
	includeItems ()
	includeExtraTax ()
	saveAppliedTaxes ()
	getNextIncrement ()
Protected Member Functions inherited from AbstractTotal
	_setAddress (\Magento\Quote\Model\Quote\Address $address)
	_getAddress ()
	_getTotal ()
	_setAmount ($amount)
	_setBaseAmount ($baseAmount)
	_addAmount ($amount)
	_addBaseAmount ($baseAmount)
	_getAddressItems (\Magento\Quote\Model\Quote\Address $address)

Protected Attributes
	$counter = 0
	$_taxData
	$_config
	$_discountTaxCompensationes = []
Protected Attributes inherited from CommonTaxCollector
	$_config
	$counter = 0
	$taxCalculationService
	$quoteDetailsDataObjectFactory
	$customerAddressFactory
	$customerAddressRegionFactory
	$taxClassKeyDataObjectFactory
	$quoteDetailsItemDataObjectFactory
Protected Attributes inherited from AbstractTotal
	$_code
	$_address = null
	$_canAddAmountToAddress = true
	$_canSetAddressAmount = true
	$_itemRowTotalKey = null
	$total

Additional Inherited Members
Data Fields inherited from CommonTaxCollector
const	ITEM_TYPE_SHIPPING = 'shipping'
const	ITEM_TYPE_PRODUCT = 'product'
const	ITEM_CODE_SHIPPING = 'shipping'
const	KEY_ITEM = 'item'
const	KEY_BASE_ITEM = 'base_item'
const	KEY_ASSOCIATED_TAXABLE_TYPE = 'type'
const	KEY_ASSOCIATED_TAXABLE_CODE = 'code'
const	KEY_ASSOCIATED_TAXABLE_UNIT_PRICE = 'unit_price'
const	KEY_ASSOCIATED_TAXABLE_BASE_UNIT_PRICE = 'base_unit_price'
const	KEY_ASSOCIATED_TAXABLE_QUANTITY = 'quantity'
const	KEY_ASSOCIATED_TAXABLE_TAX_CLASS_ID = 'tax_class_id'
const	KEY_ASSOCIATED_TAXABLE_PRICE_INCLUDES_TAX = 'price_includes_tax'
const	KEY_ASSOCIATED_TAXABLE_ASSOCIATION_ITEM_CODE = 'associated_item_code'
const	ASSOCIATION_ITEM_CODE_FOR_QUOTE = 'quote'
const	KEY_TAX_DETAILS_TYPE = 'type'
const	KEY_TAX_DETAILS_CODE = 'code'
const	KEY_TAX_DETAILS_PRICE_EXCL_TAX = 'price_excl_tax'
const	KEY_TAX_DETAILS_BASE_PRICE_EXCL_TAX = 'base_price_excl_tax'
const	KEY_TAX_DETAILS_PRICE_INCL_TAX = 'price_incl_tax'
const	KEY_TAX_DETAILS_BASE_PRICE_INCL_TAX = 'base_price_incl_tax'
const	KEY_TAX_DETAILS_ROW_TOTAL = 'row_total_excl_tax'
const	KEY_TAX_DETAILS_BASE_ROW_TOTAL = 'base_row_total_excl_tax'
const	KEY_TAX_DETAILS_ROW_TOTAL_INCL_TAX = 'row_total_incl_tax'
const	KEY_TAX_DETAILS_BASE_ROW_TOTAL_INCL_TAX = 'base_row_total_incl_tax'
const	KEY_TAX_DETAILS_TAX_PERCENT = 'tax_percent'
const	KEY_TAX_DETAILS_ROW_TAX = 'row_tax'
const	KEY_TAX_DETAILS_BASE_ROW_TAX = 'base_row_tax'
const	KEY_TAX_DETAILS_APPLIED_TAXES = 'applied_taxes'

Detailed Description

Tax totals calculation model @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 21 of file Tax.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Tax\Model\Config	$taxConfig,
		\Magento\Tax\Api\TaxCalculationInterface	$taxCalculationService,
		\Magento\Tax\Api\Data\QuoteDetailsInterfaceFactory	$quoteDetailsDataObjectFactory,
		\Magento\Tax\Api\Data\QuoteDetailsItemInterfaceFactory	$quoteDetailsItemDataObjectFactory,
		\Magento\Tax\Api\Data\TaxClassKeyInterfaceFactory	$taxClassKeyDataObjectFactory,
		CustomerAddressFactory	$customerAddressFactory,
		CustomerAddressRegionFactory	$customerAddressRegionFactory,
		\Magento\Tax\Helper\Data	$taxData,
		Json	$serializer = null
	)

Class constructor

Parameters

\Magento\Tax\Model\Config	$taxConfig
\Magento\Tax\Api\TaxCalculationInterface	$taxCalculationService
\Magento\Tax\Api\Data\QuoteDetailsInterfaceFactory	$quoteDetailsDataObjectFactory
\Magento\Tax\Api\Data\QuoteDetailsItemInterfaceFactory	$quoteDetailsItemDataObjectFactory
\Magento\Tax\Api\Data\TaxClassKeyInterfaceFactory	$taxClassKeyDataObjectFactory
CustomerAddressFactory	$customerAddressFactory
CustomerAddressRegionFactory	$customerAddressRegionFactory
\Magento\Tax\Helper\Data	$taxData
Json	$serializer

Definition at line 69 of file Tax.php.

      {
        $this->setCode('tax');
        $this->_taxData = $taxData;
        $this->serializer = $serializer ?: ObjectManager::getInstance()->get(Json::class);
        parent::__construct(
            $taxConfig,
            $taxCalculationService,
            $quoteDetailsDataObjectFactory,
            $quoteDetailsItemDataObjectFactory,
            $taxClassKeyDataObjectFactory,
            $customerAddressFactory,
            $customerAddressRegionFactory
        );
    }

Member Function Documentation

clearValues()

clearValues ( Address\Total  $total )

protected

Clear tax related total values in address

Parameters

Address\Total

$total

Returns

void

Definition at line 149 of file Tax.php.

    {
        $total->setTotalAmount('subtotal', 0);
        $total->setBaseTotalAmount('subtotal', 0);
        $total->setTotalAmount('tax', 0);
        $total->setBaseTotalAmount('tax', 0);
        $total->setTotalAmount('shipping', 0);
        $total->setBaseTotalAmount('shipping', 0);
        $total->setTotalAmount('discount_tax_compensation', 0);
        $total->setBaseTotalAmount('discount_tax_compensation', 0);
        $total->setTotalAmount('shipping_discount_tax_compensation', 0);
        $total->setBaseTotalAmount('shipping_discount_tax_compensation', 0);
        $total->setSubtotalInclTax(0);
        $total->setBaseSubtotalInclTax(0);
        $total->setShippingInclTax(0);
        $total->setBaseShippingInclTax(0);
        $total->setShippingTaxAmount(0);
        $total->setBaseShippingTaxAmount(0);
        $total->setShippingAmountForDiscount(0);
        $total->setBaseShippingAmountForDiscount(0);
        $total->setBaseShippingAmountForDiscount(0);
        $total->setTotalAmount('extra_tax', 0);
        $total->setBaseTotalAmount('extra_tax', 0);
    }

collect()

collect	(	\Magento\Quote\Model\Quote	$quote,
		\Magento\Quote\Api\Data\ShippingAssignmentInterface	$shippingAssignment,
		\Magento\Quote\Model\Quote\Address\Total	$total
	)

Collect tax totals for quote address

Parameters

\Magento\Quote\Model\Quote	$quote
ShippingAssignmentInterface	$shippingAssignment
Address\Total	$total

Returns

$this @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 103 of file Tax.php.

      {
        $this->clearValues($total);
        if (!$shippingAssignment->getItems()) {
            return $this;
        }

        $baseTaxDetails = $this->getQuoteTaxDetails($shippingAssignment, $total, true);
        $taxDetails = $this->getQuoteTaxDetails($shippingAssignment, $total, false);

        //Populate address and items with tax calculation results
        $itemsByType = $this->organizeItemTaxDetailsByType($taxDetails, $baseTaxDetails);
        if (isset($itemsByType[self::ITEM_TYPE_PRODUCT])) {
            $this->processProductItems($shippingAssignment, $itemsByType[self::ITEM_TYPE_PRODUCT], $total);
        }

        if (isset($itemsByType[self::ITEM_TYPE_SHIPPING])) {
            $shippingTaxDetails = $itemsByType[self::ITEM_TYPE_SHIPPING][self::ITEM_CODE_SHIPPING][self::KEY_ITEM];
            $baseShippingTaxDetails =
                $itemsByType[self::ITEM_TYPE_SHIPPING][self::ITEM_CODE_SHIPPING][self::KEY_BASE_ITEM];
            $this->processShippingTaxInfo($shippingAssignment, $total, $shippingTaxDetails, $baseShippingTaxDetails);
        }

        //Process taxable items that are not product or shipping
        $this->processExtraTaxables($total, $itemsByType);

        //Save applied taxes for each item and the quote in aggregation
        $this->processAppliedTaxes($total, $shippingAssignment, $itemsByType);

        if ($this->includeExtraTax()) {
            $total->addTotalAmount('extra_tax', $total->getExtraTaxAmount());
            $total->addBaseTotalAmount('extra_tax', $total->getBaseExtraTaxAmount());
        }

        return $this;
    }

fetch()

fetch	(	\Magento\Quote\Model\Quote	$quote,
		\Magento\Quote\Model\Quote\Address\Total	$total
	)

Add tax totals information to address object

Parameters

\Magento\Quote\Model\Quote	$quote
Address\Total	$total

Returns

array|null @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Modify subtotal

Definition at line 318 of file Tax.php.

    {
        $totals = [];
        $store = $quote->getStore();
        $applied = $total->getAppliedTaxes();
        if (is_string($applied)) {
            $applied = $this->serializer->unserialize($applied);
        }
        $amount = $total->getTaxAmount();
        if ($amount === null) {
            $this->enhanceTotalData($quote, $total);
            $amount = $total->getTaxAmount();
        }
        $taxAmount = $amount + $total->getTotalAmount('discount_tax_compensation');

        $area = null;
        if ($this->_config->displayCartTaxWithGrandTotal($store) && $total->getGrandTotal()) {
            $area = 'taxes';
        }

        $totals[] = [
            'code' => $this->getCode(),
            'title' => __('Tax'),
            'full_info' => $applied ? $applied : [],
            'value' => $amount,
            'area' => $area,
        ];

        if ($this->_config->displayCartSubtotalBoth($store) || $this->_config->displayCartSubtotalInclTax($store)) {
            if ($total->getSubtotalInclTax() > 0) {
                $subtotalInclTax = $total->getSubtotalInclTax();
            } else {
                $subtotalInclTax = $total->getSubtotal() + $taxAmount - $total->getShippingTaxAmount();
            }

            $totals[] = [
                'code' => 'subtotal',
                'title' => __('Subtotal'),
                'value' => $subtotalInclTax,
                'value_incl_tax' => $subtotalInclTax,
                'value_excl_tax' => $total->getSubtotal(),
            ];
        }

        if (empty($totals)) {
            return null;
        }
        return $totals;
    }

getLabel()

getLabel

(

)

Get Tax label

Returns

\Magento\Framework\Phrase

Definition at line 436 of file Tax.php.

    {
        return __('Tax');
    }

getQuoteTaxDetails()

getQuoteTaxDetails (   $shippingAssignment,   $total,   $useBaseCurrency  )

protected

Call tax calculation service to get tax details on the quote and items

Parameters

ShippingAssignmentInterface	$shippingAssignment
Address\Total	$total
bool	$useBaseCurrency

Returns

\Magento\Tax\Api\Data\TaxDetailsInterface

Definition at line 182 of file Tax.php.

    {
        $address = $shippingAssignment->getShipping()->getAddress();
        //Setup taxable items
        $priceIncludesTax = $this->_config->priceIncludesTax($address->getQuote()->getStore());
        $itemDataObjects = $this->mapItems($shippingAssignment, $priceIncludesTax, $useBaseCurrency);

        //Add shipping
        $shippingDataObject = $this->getShippingDataObject($shippingAssignment, $total, $useBaseCurrency);
        if ($shippingDataObject != null) {
            $itemDataObjects[] = $shippingDataObject;
        }

        //process extra taxable items associated only with quote
        $quoteExtraTaxables = $this->mapQuoteExtraTaxables(
            $this->quoteDetailsItemDataObjectFactory,
            $address,
            $useBaseCurrency
        );
        if (!empty($quoteExtraTaxables)) {
            $itemDataObjects = array_merge($itemDataObjects, $quoteExtraTaxables);
        }

        //Preparation for calling taxCalculationService
        $quoteDetails = $this->prepareQuoteDetails($shippingAssignment, $itemDataObjects);

        $taxDetails = $this->taxCalculationService
            ->calculateTax($quoteDetails, $address->getQuote()->getStore()->getStoreId());

        return $taxDetails;
    }

mapQuoteExtraTaxables()

mapQuoteExtraTaxables	(	\Magento\Tax\Api\Data\QuoteDetailsItemInterfaceFactory	$itemDataObjectFactory,
		Address	$address,
			$useBaseCurrency
	)

Map extra taxables associated with quote

Parameters

\Magento\Tax\Api\Data\QuoteDetailsItemInterfaceFactory	$itemDataObjectFactory
Address	$address
bool	$useBaseCurrency

Returns

\Magento\Tax\Api\Data\QuoteDetailsItemInterface[]

Definition at line 222 of file Tax.php.

      {
        $itemDataObjects = [];
        $extraTaxables = $address->getAssociatedTaxables();
        if (!$extraTaxables) {
            return [];
        }

        foreach ($extraTaxables as $extraTaxable) {
            if ($useBaseCurrency) {
                $unitPrice = $extraTaxable[self::KEY_ASSOCIATED_TAXABLE_BASE_UNIT_PRICE];
            } else {
                $unitPrice = $extraTaxable[self::KEY_ASSOCIATED_TAXABLE_UNIT_PRICE];
            }
            $itemDataObjects[] = $itemDataObjectFactory->create()
                ->setCode($extraTaxable[self::KEY_ASSOCIATED_TAXABLE_CODE])
                ->setType($extraTaxable[self::KEY_ASSOCIATED_TAXABLE_TYPE])
                ->setQuantity($extraTaxable[self::KEY_ASSOCIATED_TAXABLE_QUANTITY])
                ->setTaxClassKey(
                    $this->taxClassKeyDataObjectFactory->create()
                        ->setType(TaxClassKeyInterface::TYPE_ID)
                        ->setValue($extraTaxable[self::KEY_ASSOCIATED_TAXABLE_TAX_CLASS_ID])
                )
                ->setUnitPrice($unitPrice)
                ->setIsTaxIncluded($extraTaxable[self::KEY_ASSOCIATED_TAXABLE_PRICE_INCLUDES_TAX])
                ->setAssociatedItemCode($extraTaxable[self::KEY_ASSOCIATED_TAXABLE_ASSOCIATION_ITEM_CODE]);
        }

        return $itemDataObjects;
    }

processConfigArray()

processConfigArray	(		$config,
			$store
	)

Process model configuration array. This method can be used for changing totals collect sort order

Parameters

array	$config
store	$store

Returns

array

Definition at line 417 of file Tax.php.

    {
        $calculationSequence = $this->_taxData->getCalculationSequence($store);
        switch ($calculationSequence) {
            case Calculation::CALC_TAX_BEFORE_DISCOUNT_ON_INCL:
                $config['before'][] = 'discount';
                break;
            default:
                $config['after'][] = 'discount';
                break;
        }
        return $config;
    }

Field Documentation

$_config

$_config

protected

Definition at line 42 of file Tax.php.

$_discountTaxCompensationes

$_discountTaxCompensationes = []

protected

Definition at line 49 of file Tax.php.

$_taxData

$_taxData

protected

Definition at line 35 of file Tax.php.

$counter

$counter = 0

protected

Definition at line 28 of file Tax.php.

---

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

• vendor/magento/module-tax/Model/Sales/Total/Quote/Tax.php