How is \Magento\Tax\Model\Config::discountTax() implemented and used?

dmitry_fedyuk · February 2, 2017, 5:56pm

Implementation

magento/magento2/blob/2.1.3/app/code/Magento/Tax/Model/Config.php#L213-L226


/**
 * Get configuration setting "Apply Discount On Prices Including Tax" value
 *
 * @param   null|string|bool|int|Store $store
 * @return  bool
 */
public function discountTax($store = null)
{
    return (int)$this->_scopeConfig->getValue(
        self::CONFIG_XML_PATH_DISCOUNT_TAX,
        \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
        $store
    ) == 1;
}

Details: How is the «Apply Discount On Prices» («Excluding Tax» / «Including Tax») option handled?

Usages

1. Magento\Tax\Helper\Data::applyTaxAfterDiscount()

github.com

magento/magento2/blob/2.1.3/app/code/Magento/Tax/Helper/Data.php#L475-L484


/**
 * Get configuration setting "Apply Discount On Prices Including Tax" value
 *
 * @param  null|string|bool|int|Store $store
 * @return bool
 */
public function discountTax($store = null)
{
    return $this->_config->discountTax($store);
}

2. Magento\Tax\Model\Config::getCalculationSequence()

3. Magento\Tax\Model\Sales\Total\Quote\CommonTaxCollector::updateItemTaxInfo()

github.com

magento/magento2/blob/2.1.3/app/code/Magento/Tax/Model/Sales/Total/Quote/CommonTaxCollector.php#L620-L659


/**
 * Update tax related fields for quote item
 *
 * @param AbstractItem $quoteItem
 * @param TaxDetailsItemInterface $itemTaxDetails
 * @param TaxDetailsItemInterface $baseItemTaxDetails
 * @param Store $store
 * @return $this
 */
public function updateItemTaxInfo($quoteItem, $itemTaxDetails, $baseItemTaxDetails, $store)
{
    //The price should be base price
    $quoteItem->setPrice($baseItemTaxDetails->getPrice());
    $quoteItem->setConvertedPrice($itemTaxDetails->getPrice());
    $quoteItem->setPriceInclTax($itemTaxDetails->getPriceInclTax());
    $quoteItem->setRowTotal($itemTaxDetails->getRowTotal());
    $quoteItem->setRowTotalInclTax($itemTaxDetails->getRowTotalInclTax());
    $quoteItem->setTaxAmount($itemTaxDetails->getRowTax());
    $quoteItem->setTaxPercent($itemTaxDetails->getTaxPercent());
    $quoteItem->setDiscountTaxCompensationAmount($itemTaxDetails->getDiscountTaxCompensationAmount());


    $quoteItem->setBasePrice($baseItemTaxDetails->getPrice());
    $quoteItem->setBasePriceInclTax($baseItemTaxDetails->getPriceInclTax());
    $quoteItem->setBaseRowTotal($baseItemTaxDetails->getRowTotal());
    $quoteItem->setBaseRowTotalInclTax($baseItemTaxDetails->getRowTotalInclTax());
    $quoteItem->setBaseTaxAmount($baseItemTaxDetails->getRowTax());
    $quoteItem->setTaxPercent($baseItemTaxDetails->getTaxPercent());
    $quoteItem->setBaseDiscountTaxCompensationAmount($baseItemTaxDetails->getDiscountTaxCompensationAmount());


    //Set discount calculation price, this may be needed by discount collector
    if ($this->_config->discountTax($store)) {
        $quoteItem->setDiscountCalculationPrice($itemTaxDetails->getPriceInclTax());
        $quoteItem->setBaseDiscountCalculationPrice($baseItemTaxDetails->getPriceInclTax());
    } else {
        $quoteItem->setDiscountCalculationPrice($itemTaxDetails->getPrice());
        $quoteItem->setBaseDiscountCalculationPrice($baseItemTaxDetails->getPrice());
    }


    return $this;
}

4. Magento\Tax\Model\Sales\Total\Quote\CommonTaxCollector::processShippingTaxInfo()

github.com

magento/magento2/blob/2.1.3/app/code/Magento/Tax/Model/Sales/Total/Quote/CommonTaxCollector.php#L661-L696


/**
 * Update tax related fields for shipping
 *
 * @param ShippingAssignmentInterface $shippingAssignment
 * @param QuoteAddress\Total $total
 * @param TaxDetailsItemInterface $shippingTaxDetails
 * @param TaxDetailsItemInterface $baseShippingTaxDetails
 * @return $this
 */
protected function processShippingTaxInfo(
    ShippingAssignmentInterface $shippingAssignment,
    QuoteAddress\Total $total,
    $shippingTaxDetails,
    $baseShippingTaxDetails
) {
    $total->setTotalAmount('shipping', $shippingTaxDetails->getRowTotal());
    $total->setBaseTotalAmount('shipping', $baseShippingTaxDetails->getRowTotal());
    $total->setTotalAmount('shipping_discount_tax_compensation', $shippingTaxDetails->getDiscountTaxCompensationAmount());
    $total->setBaseTotalAmount('shipping_discount_tax_compensation', $baseShippingTaxDetails->getDiscountTaxCompensationAmount());


    $total->setShippingInclTax($shippingTaxDetails->getRowTotalInclTax());
    $total->setBaseShippingInclTax($baseShippingTaxDetails->getRowTotalInclTax());
    $total->setShippingTaxAmount($shippingTaxDetails->getRowTax());
    $total->setBaseShippingTaxAmount($baseShippingTaxDetails->getRowTax());


    //Add the shipping tax to total tax amount
    $total->addTotalAmount('tax', $shippingTaxDetails->getRowTax());
    $total->addBaseTotalAmount('tax', $baseShippingTaxDetails->getRowTax());


    if ($this->_config->discountTax($shippingAssignment->getShipping()->getAddress()->getQuote()->getStore())) {
        $total->setShippingAmountForDiscount($shippingTaxDetails->getRowTotalInclTax());
        $total->setBaseShippingAmountForDiscount($baseShippingTaxDetails->getRowTotalInclTax());
    }


    return $this;
}

5. Magento\Tax\Model\System\Message\Notification\ApplyDiscountOnPrices::checkSettings()

github.com

magento/magento2/blob/a2cf9b8/app/code/Magento/Tax/Model/System/Message/Notification/ApplyDiscountOnPrices.php#L130-L141


/**
 * Check if settings are valid.
 *
 * @param null|int|bool|string|\Magento\Store\Model\Store $store $store
 * @return bool false if settings are incorrect
 */
private function checkSettings($store = null)
{
    return $this->taxConfig->priceIncludesTax($store)
        || !$this->taxConfig->applyTaxAfterDiscount($store)
        || !$this->taxConfig->discountTax($store);
}

dmitry_fedyuk · February 2, 2017, 6:09pm