Add dynamic shipping tax calculation #176
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| <?php | ||
| /** | ||
| * Copyright © 2020 FireGento e.V. | ||
| * See LICENSE.md bundled with this module for license details. | ||
| */ | ||
|
|
||
| namespace FireGento\MageSetup\Model\System\Config\Source\Tax; | ||
|
|
||
| use Magento\Framework\Data\OptionSourceInterface; | ||
|
|
||
| /** | ||
| * Source model for Dynamic taxes. | ||
| */ | ||
| class Dynamic implements OptionSourceInterface | ||
| { | ||
| public const DYNAMIC_TYPE_SHIPPING_TAX_DEFAULT = 0; | ||
|
There was a problem hiding this comment. Maybe |
||
| public const DYNAMIC_TYPE_HIGHEST_PRODUCT_TAX = 1; | ||
|
There was a problem hiding this comment. Maybe |
||
|
|
||
| /** | ||
| * @var array | ||
| */ | ||
| private $options; | ||
|
|
||
| /** | ||
| * Method for returning options array | ||
| * | ||
| * @return array|array[] | ||
| */ | ||
| public function toOptionArray(): array | ||
| { | ||
| if (null === $this->options) { | ||
| $options = [ | ||
| [ | ||
| 'value' => self::DYNAMIC_TYPE_SHIPPING_TAX_DEFAULT, | ||
| 'label' => __('No dynamic shipping tax calculation') | ||
| ], | ||
| [ | ||
| 'value' => self::DYNAMIC_TYPE_HIGHEST_PRODUCT_TAX, | ||
| 'label' => __('Use the highest product tax') | ||
| ] | ||
| ]; | ||
|
|
||
| $this->options = $options; | ||
| } | ||
|
|
||
| return $this->options; | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,192 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace FireGento\MageSetup\Plugin\Tax\Config; | ||
|
|
||
| use FireGento\MageSetup\Model\Config as FireGentoConfig; | ||
| use FireGento\MageSetup\Model\System\Config\Source\Tax\Dynamic as FireGentoSource; | ||
| use Magento\Checkout\Model\Cart; | ||
| use Magento\Customer\Model\ResourceModel\GroupRepository; | ||
| use Magento\Customer\Model\Session; | ||
| use Magento\Framework\App\Config\ScopeConfigInterface; | ||
| use Magento\Quote\Model\Quote\Item; | ||
| use Magento\Store\Model\ScopeInterface; | ||
| use Magento\Store\Model\Store; | ||
| use Magento\Tax\Model\Calculation\Proxy; | ||
| use Magento\Tax\Model\Config; | ||
|
|
||
| /** | ||
| * Class ShippingTaxPlugin | ||
| * | ||
| * FireGento\MageSetup\Plugin\Tax\Config | ||
| */ | ||
| class ShippingTaxPlugin | ||
| { | ||
|
|
||
| /** | ||
| * @var ScopeConfigInterface | ||
| */ | ||
| private $scopeConfig; | ||
|
|
||
| /** | ||
| * @var Cart | ||
| */ | ||
| private $cart; | ||
|
|
||
| /** | ||
| * @var Session | ||
| */ | ||
| private $customerSession; | ||
|
|
||
| /** | ||
| * @var GroupRepository | ||
| */ | ||
| private $groupRepository; | ||
|
|
||
| /** | ||
| * @var Proxy | ||
| */ | ||
| private $taxCalculation; | ||
|
|
||
| /** | ||
| * @var FireGentoConfig | ||
| */ | ||
| private $config; | ||
|
|
||
| /** | ||
| * Constructor class | ||
| * | ||
| * @param ScopeConfigInterface $scopeConfig | ||
| * @param Cart $cart | ||
| * @param Session $customerSession | ||
| * @param GroupRepository $groupRepository | ||
| * @param FireGentoConfig $config | ||
| */ | ||
| public function __construct( | ||
| ScopeConfigInterface $scopeConfig, | ||
| Cart $cart, | ||
| Session $customerSession, | ||
| GroupRepository $groupRepository, | ||
| FireGentoConfig $config | ||
| ) { | ||
| $this->scopeConfig = $scopeConfig; | ||
| $this->cart = $cart; | ||
| $this->customerSession = $customerSession; | ||
| $this->groupRepository = $groupRepository; | ||
| $this->config = $config; | ||
| } | ||
|
|
||
| /** | ||
| * After plugin for \Magento\Tax\Model\Config::getShippingTaxClass | ||
| * | ||
| * @param Config $config | ||
| * @param int $shippingTaxClass | ||
| * @param null $store | ||
| * | ||
| * @return bool|int|mixed | ||
| */ | ||
| public function afterGetShippingTaxClass(Config $config, int $shippingTaxClass, $store = null) | ||
| { | ||
| $dynamicType = (int)$this->scopeConfig->getValue( | ||
| $this->config->getDynamicShippingConfigPath(), | ||
| ScopeInterface::SCOPE_STORE, | ||
| $store | ||
| ); | ||
|
|
||
| $quoteItems = $this->cart->getItems(); | ||
|
|
||
| // If the default behaviour was configured or there are no products in cart, use default tax class id | ||
| if ($dynamicType === FireGentoSource::DYNAMIC_TYPE_SHIPPING_TAX_DEFAULT || count($quoteItems) === 0) { | ||
| return $shippingTaxClass; | ||
| } | ||
|
|
||
| $taxClassId = false; | ||
|
|
||
| // Retrieve the highest product tax class | ||
| if ($dynamicType === FireGentoSource::DYNAMIC_TYPE_HIGHEST_PRODUCT_TAX) { | ||
| $taxClassId = $this->getHighestProductTaxClassId($quoteItems, $store); | ||
| } | ||
|
|
||
| // If no tax class id was found, use default one | ||
| if (!$taxClassId) { | ||
| $taxClassId = $shippingTaxClass; | ||
| } | ||
|
|
||
| return $taxClassId; | ||
| } | ||
|
|
||
| /** | ||
| * Method for getting highest product tax class id | ||
| * | ||
| * @param array $quoteItems | ||
| * @param null|string|bool|int|Store $store | ||
| * | ||
| * @return bool|mixed|null | ||
| */ | ||
|
|
||
|
|
||
| private function getHighestProductTaxClassId($quoteItems, $store) | ||
| { | ||
| $taxClassIds = []; | ||
| $highestTaxRate = null; | ||
|
|
||
| foreach ($quoteItems as $quoteItem) { | ||
|
|
||
| /** @var $quoteItem Item */ | ||
| if ($quoteItem->getParentItem()) { | ||
| continue; | ||
| } | ||
|
|
||
| // Retrieve the tax percent | ||
| $taxPercent = $quoteItem->getTaxPercent(); | ||
| if (!$taxPercent) { | ||
| $taxPercent = $this->getTaxPercent($quoteItem->getTaxClassId(), $store); | ||
| } | ||
|
|
||
| // Add the tax class | ||
| if (($taxPercent) && !in_array($taxPercent, $taxClassIds)) { | ||
| $taxClassIds[$taxPercent] = $quoteItem->getTaxClassId(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Fetch the highest tax rate | ||
| */ | ||
| ksort($taxClassIds); | ||
| if (count($taxClassIds) > 0) { | ||
| $highestTaxRate = array_pop($taxClassIds); | ||
| } | ||
| if (!$highestTaxRate || $highestTaxRate === null) { | ||
| return false; | ||
| } | ||
|
|
||
| return $highestTaxRate; | ||
| } | ||
|
|
||
| /** | ||
| * Method for getting tax prcentage | ||
| * | ||
| * @param int $productTaxClassId | ||
| * @param null|string|bool|int|Store $store | ||
| * | ||
| * @return int | ||
| * @throws \Magento\Framework\Exception\LocalizedException | ||
| * @throws \Magento\Framework\Exception\NoSuchEntityException | ||
| */ | ||
| private function getTaxPercent(int $productTaxClassId, $store): int | ||
|
There was a problem hiding this comment. The returnType of the rate is float, not int |
||
| { | ||
| $groupId = $this->customerSession->getCustomerGroupId(); | ||
| $group = $this->groupRepository->getById($groupId); | ||
| $customerTaxClassId = $group->getTaxClassId(); | ||
|
|
||
| $request = $this->taxCalculation->getRateRequest(null, null, $customerTaxClassId, $store); | ||
|
There was a problem hiding this comment. This is not actually set in the constructor. |
||
| $request->setData('product_class_id', $productTaxClassId); | ||
|
|
||
| $taxPercent = $this->taxCalculation->getRate($request); | ||
| if (!$taxPercent) { | ||
| $taxPercent = 0; | ||
| } | ||
|
|
||
| return $taxPercent; | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do not think this adds much value. I think we should add a new method in
\FireGento\MageSetup\Model\System\Config, which returns the actual configuration value of that option.