Data Class Reference

Inheritance diagram for Data:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Framework\Json\Helper\Data $jsonHelper, Config $taxConfig, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\Locale\FormatInterface $localeFormat, \Magento\Tax\Model\ResourceModel\Sales\Order\Tax\CollectionFactory $orderTaxCollectionFactory, \Magento\Framework\Locale\ResolverInterface $localeResolver, \Magento\Catalog\Helper\Data $catalogHelper, OrderTaxManagementInterface $orderTaxManagement, PriceCurrencyInterface $priceCurrency, Json $serializer=null)
	getPostCodeSubStringLength ()
	getConfig ()
	priceIncludesTax ($store=null)
	applyTaxAfterDiscount ($store=null)
	getPriceDisplayType ($store=null)
	needPriceConversion ($store=null)
	displayFullSummary ($store=null)
	displayZeroTax ($store=null)
	displayCartPriceInclTax ($store=null)
	displayCartPriceExclTax ($store=null)
	displayCartBothPrices ($store=null)
	displaySalesPriceInclTax ($store=null)
	displaySalesPriceExclTax ($store=null)
	displaySalesBothPrices ($store=null)
	displaySalesSubtotalBoth ($store=null)
	displaySalesSubtotalInclTax ($store=null)
	displaySalesSubtotalExclTax ($store=null)
	getPriceFormat ($store=null)
	displayPriceIncludingTax ()
	displayPriceExcludingTax ()
	displayBothPrices ($store=null)
	shippingPriceIncludesTax ($store=null)
	getShippingPriceDisplayType ($store=null)
	displayShippingPriceIncludingTax ()
	displayShippingPriceExcludingTax ()
	displayShippingBothPrices ()
	getShippingTaxClass ($store)
	getShippingPrice ($price, $includingTax=null, $shippingAddress=null, $ctc=null, $store=null)
	discountTax ($store=null)
	getTaxBasedOn ($store=null)
	applyTaxOnCustomPrice ($store=null)
	applyTaxOnOriginalPrice ($store=null)
	getCalculationSequence ($store=null)
	getCalculationAlgorithm ($store=null)
	getCalculatedTaxes ($source)
	getDefaultCustomerTaxClass ()
	getDefaultProductTaxClass ()
	isCrossBorderTradeEnabled ($store=null)
	isCatalogPriceDisplayAffectedByTax ($store=null)
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	CONFIG_DEFAULT_CUSTOMER_TAX_CLASS = 'tax/classes/default_customer_tax_class'
const	CONFIG_DEFAULT_PRODUCT_TAX_CLASS = 'tax/classes/default_product_tax_class'

Protected Member Functions
	_getTaxRateSubtotals ($order)
	calculateTaxForOrder (EntityInterface $current)
Protected Member Functions inherited from AbstractHelper
	_getRequest ()
	_getModuleName ()
	_getUrl ($route, $params=[])

Protected Attributes
	$_config
	$_postCodeSubStringLength = 10
	$jsonHelper
	$_storeManager
	$_localeFormat
	$_orderTaxCollectionFactory
	$_localeResolver
	$catalogHelper
	$orderTaxManagement
	$priceCurrency
Protected Attributes inherited from AbstractHelper
	$_moduleName
	$_request
	$_moduleManager
	$_logger
	$_urlBuilder
	$_httpHeader
	$_eventManager
	$_remoteAddress
	$urlEncoder
	$urlDecoder
	$scopeConfig
	$_cacheConfig

Detailed Description

Tax helper

@SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.CouplingBetweenObjects) @api

Since

100.0.2

Definition at line 28 of file Data.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Framework\Json\Helper\Data	$jsonHelper,
		Config	$taxConfig,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\Locale\FormatInterface	$localeFormat,
		\Magento\Tax\Model\ResourceModel\Sales\Order\Tax\CollectionFactory	$orderTaxCollectionFactory,
		\Magento\Framework\Locale\ResolverInterface	$localeResolver,
		\Magento\Catalog\Helper\Data	$catalogHelper,
		OrderTaxManagementInterface	$orderTaxManagement,
		PriceCurrencyInterface	$priceCurrency,
		Json	$serializer = null
	)

Constructor

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Framework\Json\Helper\Data	$jsonHelper
Config	$taxConfig
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\Locale\FormatInterface	$localeFormat
\Magento\Tax\Model\ResourceModel\Sales\Order\Tax\CollectionFactory	$orderTaxCollectionFactory
\Magento\Framework\Locale\ResolverInterface	$localeResolver
\Magento\Catalog\Helper\Data	$catalogHelper
OrderTaxManagementInterface	$orderTaxManagement
PriceCurrencyInterface	$priceCurrency
Json	$serializer	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 117 of file Data.php.

      {
        parent::__construct($context);
        $this->priceCurrency = $priceCurrency;
        $this->_config = $taxConfig;
        $this->jsonHelper = $jsonHelper;
        $this->_storeManager = $storeManager;
        $this->_localeFormat = $localeFormat;
        $this->_orderTaxCollectionFactory = $orderTaxCollectionFactory;
        $this->_localeResolver = $localeResolver;
        $this->catalogHelper = $catalogHelper;
        $this->orderTaxManagement = $orderTaxManagement;
        $this->serializer = $serializer ?: ObjectManager::getInstance()->get(Json::class);
    }

Member Function Documentation

_getTaxRateSubtotals()

_getTaxRateSubtotals (   $order )

protected

Returns the array of tax rates for the order

Parameters

\Magento\Sales\Model\Order

$order

Returns

array

Definition at line 654 of file Data.php.

    {
        return $this->_orderTaxCollectionFactory->create()->loadByOrder($order)->toArray();
    }

applyTaxAfterDiscount()

applyTaxAfterDiscount

(

$store = null

)

Check what taxes should be applied after discount

Parameters

null | int | string | Store

$store

Returns

bool

Definition at line 185 of file Data.php.

    {
        return $this->_config->applyTaxAfterDiscount($store);
    }

applyTaxOnCustomPrice()

applyTaxOnCustomPrice

(

$store = null

)

Check if tax can be applied to custom price

Parameters

null | string | bool | int | Store

$store

Returns

bool

Definition at line 515 of file Data.php.

    {
        return (int) $this->scopeConfig->getValue(
            Config::CONFIG_XML_PATH_APPLY_ON,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
            $store
        ) == 0;
    }

applyTaxOnOriginalPrice()

applyTaxOnOriginalPrice

(

$store = null

)

Check if tax should be applied just to original price

Parameters

null | string | bool | int | Store

$store

Returns

bool

Definition at line 530 of file Data.php.

    {
        return (int) $this->scopeConfig->getValue(
            Config::CONFIG_XML_PATH_APPLY_ON,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
            $store
        ) == 1;
    }

calculateTaxForOrder()

calculateTaxForOrder ( EntityInterface  $current )

protected

Parameters

EntityInterface

$current

Returns

array

Definition at line 700 of file Data.php.

    {
        $taxClassAmount = [];

        $orderTaxDetails = $this->orderTaxManagement->getOrderTaxDetails($current->getId());
        $appliedTaxes = $orderTaxDetails->getAppliedTaxes();
        foreach ($appliedTaxes as $appliedTax) {
            $taxCode = $appliedTax->getCode();
            $taxClassAmount[$taxCode]['tax_amount'] = $appliedTax->getAmount();
            $taxClassAmount[$taxCode]['base_tax_amount'] = $appliedTax->getBaseAmount();
            $taxClassAmount[$taxCode]['title'] = $appliedTax->getTitle();
            $taxClassAmount[$taxCode]['percent'] = $appliedTax->getPercent();
        }

        return $taxClassAmount;
    }

discountTax()

discountTax

(

$store = null

)

Get configuration setting "Apply Discount On Prices Including Tax" value

Parameters

null | string | bool | int | Store

$store

Returns

bool

Definition at line 489 of file Data.php.

    {
        return $this->_config->discountTax($store);
    }

displayBothPrices()

displayBothPrices

(

$store = null

)

Check if we have display in catalog prices including and excluding tax

Parameters

null | int | string | Store

$store

Returns

bool

Definition at line 381 of file Data.php.

    {
        return $this->getPriceDisplayType($store) == Config::DISPLAY_TYPE_BOTH;
    }

displayCartBothPrices()

displayCartBothPrices

(

$store = null

)

Check if need display cart prices excluding and including tax

Parameters

null | int | string | Store

$store

Returns

bool

Definition at line 266 of file Data.php.

    {
        return $this->_config->displayCartPricesBoth($store);
    }

displayCartPriceExclTax()

displayCartPriceExclTax

(

$store = null

)

Check if need display cart prices excluding price

Parameters

null | int | string | Store

$store

Returns

bool

Definition at line 255 of file Data.php.

    {
        return $this->_config->displayCartPricesExclTax($store);
    }

displayCartPriceInclTax()

displayCartPriceInclTax

(

$store = null

)

Check if need display cart prices included tax

Parameters

null | int | string | Store

$store

Returns

bool

Definition at line 244 of file Data.php.

    {
        return $this->_config->displayCartPricesInclTax($store);
    }

displayFullSummary()

displayFullSummary

(

$store = null

)

Check if need display full tax summary information in totals block

Parameters

null | int | string | Store

$store

Returns

bool

Definition at line 222 of file Data.php.

    {
        return $this->_config->displayCartFullSummary($store);
    }

displayPriceExcludingTax()

displayPriceExcludingTax

(

)

Check if we have display in catalog prices excluding tax

Returns

bool

Definition at line 370 of file Data.php.

    {
        return $this->getPriceDisplayType() == Config::DISPLAY_TYPE_EXCLUDING_TAX;
    }

displayPriceIncludingTax()

displayPriceIncludingTax

(

)

Check if we have display in catalog prices including tax

Returns

bool

Definition at line 360 of file Data.php.

    {
        return $this->getPriceDisplayType() == Config::DISPLAY_TYPE_INCLUDING_TAX;
    }

displaySalesBothPrices()

displaySalesBothPrices

(

$store = null

)

Check if need display order prices excluding and including tax

Parameters

null | int | string | Store

$store

Returns

bool

Definition at line 299 of file Data.php.

    {
        return $this->_config->displaySalesPricesBoth($store);
    }

displaySalesPriceExclTax()

displaySalesPriceExclTax

(

$store = null

)

Check if need display order prices excluding price

Parameters

null | int | string | Store

$store

Returns

bool

Definition at line 288 of file Data.php.

    {
        return $this->_config->displaySalesPricesExclTax($store);
    }

displaySalesPriceInclTax()

displaySalesPriceInclTax

(

$store = null

)

Check if need display order prices included tax

Parameters

null | int | string | Store

$store

Returns

bool

Definition at line 277 of file Data.php.

    {
        return $this->_config->displaySalesPricesInclTax($store);
    }

displaySalesSubtotalBoth()

displaySalesSubtotalBoth

(

$store = null

)

Check if we need display price include and exclude tax for order/invoice subtotal

Parameters

null | int | string | Store

$store

Returns

bool

Definition at line 310 of file Data.php.

    {
        return $this->_config->displaySalesSubtotalBoth($store);
    }

displaySalesSubtotalExclTax()

displaySalesSubtotalExclTax

(

$store = null

)

Check if we need display price exclude tax for order/invoice subtotal

Parameters

null | int | string | Store

$store

Returns

bool

Definition at line 332 of file Data.php.

    {
        return $this->_config->displaySalesSubtotalExclTax($store);
    }

displaySalesSubtotalInclTax()

displaySalesSubtotalInclTax

(

$store = null

)

Check if we need display price include tax for order/invoice subtotal

Parameters

null | int | string | Store

$store

Returns

bool

Definition at line 321 of file Data.php.

    {
        return $this->_config->displaySalesSubtotalInclTax($store);
    }

displayShippingBothPrices()

displayShippingBothPrices

(

)

Returns whether the shipping price should display both with and without taxes

Returns

bool

Definition at line 433 of file Data.php.

    {
        return $this->getShippingPriceDisplayType() == Config::DISPLAY_TYPE_BOTH;
    }

displayShippingPriceExcludingTax()

displayShippingPriceExcludingTax

(

)

Returns whether the shipping price should display without taxes

Returns

bool

Definition at line 423 of file Data.php.

    {
        return $this->getShippingPriceDisplayType() == Config::DISPLAY_TYPE_EXCLUDING_TAX;
    }

displayShippingPriceIncludingTax()

displayShippingPriceIncludingTax

(

)

Returns whether the shipping price should display with taxes included

Returns

bool

Definition at line 413 of file Data.php.

    {
        return $this->getShippingPriceDisplayType() == Config::DISPLAY_TYPE_INCLUDING_TAX;
    }

displayZeroTax()

displayZeroTax

(

$store = null

)

Check if need display zero tax in subtotal

Parameters

null | int | string | Store

$store

Returns

bool

Definition at line 233 of file Data.php.

    {
        return $this->_config->displayCartZeroTax($store);
    }

getCalculatedTaxes()

getCalculatedTaxes

(

$source

)

Get calculated taxes for each tax class

This method returns array with format: array( $index => array( 'tax_amount' => $taxAmount, 'base_tax_amount' => $baseTaxAmount, 'title' => $title, 'percent' => $percent ) )

Parameters

Definition at line 581 of file Data.php.

    {
        $taxClassAmount = [];
        if (empty($source)) {
            return $taxClassAmount;
        }
        $current = $source;
        if ($source instanceof Invoice || $source instanceof Creditmemo) {
            $source = $current->getOrder();
        }
        if ($current == $source) {
            $taxClassAmount = $this->calculateTaxForOrder($current);
        } else {
            $taxClassAmount = $this->calculateTaxForItems($source, $current);
        }

        foreach ($taxClassAmount as $key => $tax) {
            $taxClassAmount[$key]['tax_amount'] = $this->priceCurrency->round($tax['tax_amount']);
            $taxClassAmount[$key]['base_tax_amount'] = $this->priceCurrency->round($tax['base_tax_amount']);
        }

        return array_values($taxClassAmount);
    }

getCalculationAlgorithm()

getCalculationAlgorithm

(

$store = null

)

Get tax calculation algorithm code

Parameters

null | string | bool | int | Store

$store

Returns

string

Definition at line 559 of file Data.php.

    {
        return $this->_config->getAlgorithm($store);
    }

getCalculationSequence()

getCalculationSequence

(

$store = null

)

Get taxes/discounts calculation sequence

This sequence depends on "Catalog price include tax", "Apply Tax After Discount" and "Apply Discount On Prices Including Tax" configuration options.

Parameters

null | int | string | Store

$store

Returns

string

Definition at line 548 of file Data.php.

    {
        return $this->_config->getCalculationSequence($store);
    }

getConfig()

getConfig

(

)

Get tax configuration object

Returns

Config

Definition at line 163 of file Data.php.

    {
        return $this->_config;
    }

getDefaultCustomerTaxClass()

getDefaultCustomerTaxClass

(

)

Retrieve default customer tax class from config

Returns

string|null

Definition at line 664 of file Data.php.

    {
        return $this->scopeConfig->getValue(
            self::CONFIG_DEFAULT_CUSTOMER_TAX_CLASS,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
    }

getDefaultProductTaxClass()

getDefaultProductTaxClass

(

)

Retrieve default product tax class from config

Returns

string|null

Definition at line 677 of file Data.php.

    {
        return $this->scopeConfig->getValue(
            self::CONFIG_DEFAULT_PRODUCT_TAX_CLASS,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
    }

getPostCodeSubStringLength()

getPostCodeSubStringLength

(

)

Return max postcode length to create search templates

Returns

int $len

Definition at line 148 of file Data.php.

    {
        $len = (int) $this->_postCodeSubStringLength;
        if ($len <= 0) {
            $len = 10;
        }

        return $len;
    }

getPriceDisplayType()

getPriceDisplayType

(

$store = null

)

Get product price display type 1 - Excluding tax 2 - Including tax 3 - Both

Parameters

null | int | string | Store

$store

Returns

int

Definition at line 199 of file Data.php.

    {
        return $this->_config->getPriceDisplayType($store);
    }

getPriceFormat()

getPriceFormat

(

$store = null

)

Get prices javascript format json

Parameters

null | int | string | Store

$store

Returns

string

Definition at line 343 of file Data.php.

    {
        $this->_localeResolver->emulate($store);
        $priceFormat = $this->_localeFormat->getPriceFormat();
        $this->_localeResolver->revert();
        if ($store) {
            $priceFormat['pattern'] = $this->_storeManager->getStore($store)->getCurrentCurrency()->getOutputFormat();
        }

        return $this->jsonHelper->jsonEncode($priceFormat);
    }

getShippingPrice()

getShippingPrice	(		$price,
			$includingTax = null,
			$shippingAddress = null,
			$ctc = null,
			$store = null
	)

Get shipping price

Parameters

float	$price
bool | null	$includingTax
Address | null	$shippingAddress
int | null	$ctc
null | string | bool | int | Store	$store

Returns

float

Definition at line 459 of file Data.php.

    {
        $pseudoProduct = new \Magento\Framework\DataObject();
        $pseudoProduct->setTaxClassId($this->getShippingTaxClass($store));

        $billingAddress = false;
        if ($shippingAddress && $shippingAddress->getQuote() && $shippingAddress->getQuote()->getBillingAddress()) {
            $billingAddress = $shippingAddress->getQuote()->getBillingAddress();
        }

        $price = $this->catalogHelper->getTaxPrice(
            $pseudoProduct,
            $price,
            $includingTax,
            $shippingAddress,
            $billingAddress,
            $ctc,
            $store,
            $this->shippingPriceIncludesTax($store)
        );

        return $price;
    }

getShippingPriceDisplayType()

getShippingPriceDisplayType

(

$store = null

)

Get shipping price display type

Parameters

null | string | bool | int | Store

$store

Returns

int

Definition at line 403 of file Data.php.

    {
        return $this->_config->getShippingPriceDisplayType($store);
    }

getShippingTaxClass()

getShippingTaxClass

(

$store

)

Get tax class id specified for shipping tax estimation

Parameters

null | string | bool | int | Store

$store

Returns

int

Definition at line 444 of file Data.php.

    {
        return $this->_config->getShippingTaxClass($store);
    }

getTaxBasedOn()

getTaxBasedOn

(

$store = null

)

Get value of "Apply Tax On" custom/original price configuration settings

Parameters

null | string | bool | int | Store

$store

Returns

string|null

Definition at line 500 of file Data.php.

    {
        return $this->scopeConfig->getValue(
            Config::CONFIG_XML_PATH_BASED_ON,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
            $store
        );
    }

isCatalogPriceDisplayAffectedByTax()

isCatalogPriceDisplayAffectedByTax

(

$store = null

)

Check whether display price is affected by different tax rates

Parameters

null | int | string | Store

$store

Returns

bool

Definition at line 786 of file Data.php.

    {
        if ($this->displayBothPrices($store)) {
            return true;
        }

        $priceInclTax = $this->priceIncludesTax($store);
        if ($priceInclTax) {
            return ($this->isCrossBorderTradeEnabled($store) xor $this->displayPriceIncludingTax());
        } else {
            return $this->displayPriceIncludingTax();
        }
    }

isCrossBorderTradeEnabled()

isCrossBorderTradeEnabled

(

$store = null

)

Return whether cross border trade is enabled or not

Parameters

null | int | string | Store

$store

Returns

bool

Definition at line 691 of file Data.php.

    {
        return (bool) $this->_config->crossBorderTradeEnabled($store);
    }

needPriceConversion()

needPriceConversion

(

$store = null

)

Check if necessary do product price conversion If it necessary will be returned conversion type (minus or plus)

Parameters

null | int | string | Store

$store

Returns

bool

Definition at line 211 of file Data.php.

    {
        return $this->_config->needPriceConversion($store);
    }

priceIncludesTax()

priceIncludesTax

(

$store = null

)

Check if product prices inputed include tax

Parameters

null | int | string | Store

$store

Returns

bool

Definition at line 174 of file Data.php.

    {
        return $this->_config->priceIncludesTax($store) || $this->_config->getNeedUseShippingExcludeTax();
    }

shippingPriceIncludesTax()

shippingPriceIncludesTax

(

$store = null

)

Check if shipping prices include tax

Parameters

null | string | bool | int | Store

$store

Returns

bool

Definition at line 392 of file Data.php.

    {
        return $this->_config->shippingPriceIncludesTax($store);
    }

Field Documentation

$_config

$_config

protected

Definition at line 45 of file Data.php.

$_localeFormat

$_localeFormat

protected

Definition at line 69 of file Data.php.

$_localeResolver

$_localeResolver

protected

Definition at line 79 of file Data.php.

$_orderTaxCollectionFactory

$_orderTaxCollectionFactory

protected

Definition at line 74 of file Data.php.

$_postCodeSubStringLength

$_postCodeSubStringLength = 10

protected

Definition at line 52 of file Data.php.

$_storeManager

$_storeManager

protected

Definition at line 64 of file Data.php.

$catalogHelper

$catalogHelper

protected

Definition at line 84 of file Data.php.

$jsonHelper

$jsonHelper

protected

Definition at line 59 of file Data.php.

$orderTaxManagement

$orderTaxManagement

protected

Definition at line 89 of file Data.php.

$priceCurrency

$priceCurrency

protected

Definition at line 94 of file Data.php.

CONFIG_DEFAULT_CUSTOMER_TAX_CLASS

const CONFIG_DEFAULT_CUSTOMER_TAX_CLASS = 'tax/classes/default_customer_tax_class'

Default tax class for customers

Definition at line 33 of file Data.php.

CONFIG_DEFAULT_PRODUCT_TAX_CLASS

const CONFIG_DEFAULT_PRODUCT_TAX_CLASS = 'tax/classes/default_product_tax_class'

Default tax class for products

Definition at line 38 of file Data.php.

---

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

• vendor/magento/module-tax/Helper/Data.php