TaxConfigProvider Class Reference

Inheritance diagram for TaxConfigProvider:

Public Member Functions
	__construct (TaxHelper $taxHelper, Config $taxConfig, CheckoutSession $checkoutSession, ScopeConfigInterface $scopeConfig)
	getConfig ()
	getDisplayShippingMode ()
	isDisplayShippingPriceExclTax ()
	isDisplayShippingBothPrices ()
	getReviewItemPriceDisplayMode ()
	getReviewTotalsDisplayMode ()
	isFullTaxSummaryDisplayed ()
	isTaxDisplayedInGrandTotal ()

Protected Member Functions
	reloadOnBillingAddress ()

Protected Attributes
	$taxHelper
	$taxConfig
	$scopeConfig
	$checkoutSession

Detailed Description

Definition at line 13 of file TaxConfigProvider.php.

Constructor & Destructor Documentation

__construct()

__construct	(	TaxHelper	$taxHelper,
		Config	$taxConfig,
		CheckoutSession	$checkoutSession,
		ScopeConfigInterface	$scopeConfig
	)

Parameters

TaxHelper	$taxHelper
Config	$taxConfig
CheckoutSession	$checkoutSession
ScopeConfigInterface	$scopeConfig

Definition at line 41 of file TaxConfigProvider.php.

      {
        $this->taxHelper = $taxHelper;
        $this->taxConfig = $taxConfig;
        $this->checkoutSession = $checkoutSession;
        $this->scopeConfig = $scopeConfig;
    }

Member Function Documentation

getConfig()

getConfig

(

)

{Retrieve assoc array of checkout configuration

Returns

array

}

Implements ConfigProviderInterface.

Definition at line 56 of file TaxConfigProvider.php.

    {
        $defaultRegionId = $this->scopeConfig->getValue(
            \Magento\Tax\Model\Config::CONFIG_XML_PATH_DEFAULT_REGION,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
        // prevent wrong assignment on shipping rate estimation requests
        if (0 == $defaultRegionId) {
            $defaultRegionId = null;
        }
        return [
            'isDisplayShippingPriceExclTax' => $this->isDisplayShippingPriceExclTax(),
            'isDisplayShippingBothPrices' => $this->isDisplayShippingBothPrices(),
            'reviewShippingDisplayMode' => $this->getDisplayShippingMode(),
            'reviewItemPriceDisplayMode' => $this->getReviewItemPriceDisplayMode(),
            'reviewTotalsDisplayMode' => $this->getReviewTotalsDisplayMode(),
            'includeTaxInGrandTotal' => $this->isTaxDisplayedInGrandTotal(),
            'isFullTaxSummaryDisplayed' => $this->isFullTaxSummaryDisplayed(),
            'isZeroTaxDisplayed' => $this->taxConfig->displayCartZeroTax(),
            'reloadOnBillingAddress' => $this->reloadOnBillingAddress(),
            'defaultCountryId' => $this->scopeConfig->getValue(
                \Magento\Tax\Model\Config::CONFIG_XML_PATH_DEFAULT_COUNTRY,
                \Magento\Store\Model\ScopeInterface::SCOPE_STORE
            ),
            'defaultRegionId' => $defaultRegionId,
            'defaultPostcode' => $this->scopeConfig->getValue(
                \Magento\Tax\Model\Config::CONFIG_XML_PATH_DEFAULT_POSTCODE,
                \Magento\Store\Model\ScopeInterface::SCOPE_STORE
            ),
        ];
    }

getDisplayShippingMode()

getDisplayShippingMode

(

)

Shipping mode: 'both', 'including', 'excluding'

Returns

string

Definition at line 93 of file TaxConfigProvider.php.

    {
        if ($this->taxConfig->displayCartShippingBoth()) {
            return 'both';
        }
        if ($this->taxConfig->displayCartShippingExclTax()) {
            return 'excluding';
        }
        return 'including';
    }

getReviewItemPriceDisplayMode()

getReviewItemPriceDisplayMode

(

)

Get review item price display mode

Returns

string 'both', 'including', 'excluding'

Definition at line 129 of file TaxConfigProvider.php.

    {
        if ($this->taxHelper->displayCartBothPrices()) {
            return 'both';
        }
        if ($this->taxHelper->displayCartPriceExclTax()) {
            return 'excluding';
        }
        return 'including';
    }

getReviewTotalsDisplayMode()

getReviewTotalsDisplayMode

(

)

Get review item price display mode

Returns

string 'both', 'including', 'excluding'

Definition at line 145 of file TaxConfigProvider.php.

    {
        if ($this->taxConfig->displayCartSubtotalBoth()) {
            return 'both';
        }
        if ($this->taxConfig->displayCartSubtotalExclTax()) {
            return 'excluding';
        }
        return 'including';
    }

isDisplayShippingBothPrices()

isDisplayShippingBothPrices

(

)

Return flag whether to display shipping price including and excluding tax

Returns

bool

Definition at line 119 of file TaxConfigProvider.php.

    {
        return $this->taxHelper->displayShippingBothPrices();
    }

isDisplayShippingPriceExclTax()

isDisplayShippingPriceExclTax

(

)

Return flag whether to display shipping price excluding tax

Returns

bool

Definition at line 109 of file TaxConfigProvider.php.

    {
        return $this->taxHelper->displayShippingPriceExcludingTax();
    }

isFullTaxSummaryDisplayed()

isFullTaxSummaryDisplayed

(

)

Show tax details in checkout totals section flag

Returns

bool

Definition at line 161 of file TaxConfigProvider.php.

    {
        return $this->taxHelper->displayFullSummary();
    }

isTaxDisplayedInGrandTotal()

isTaxDisplayedInGrandTotal

(

)

Display tax in grand total section or not

Returns

bool

Definition at line 171 of file TaxConfigProvider.php.

    {
        return $this->taxConfig->displayCartTaxWithGrandTotal();
    }

reloadOnBillingAddress()

reloadOnBillingAddress ( )

protected

Reload totals(taxes) on billing address update

Returns

bool

Definition at line 181 of file TaxConfigProvider.php.

    {
        $quote = $this->checkoutSession->getQuote();
        $configValue = $this->scopeConfig->getValue(
            Config::CONFIG_XML_PATH_BASED_ON,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
        return 'billing' == $configValue || $quote->isVirtual();
    }

Field Documentation

$checkoutSession

$checkoutSession

protected

Definition at line 33 of file TaxConfigProvider.php.

$scopeConfig

$scopeConfig

protected

Definition at line 28 of file TaxConfigProvider.php.

$taxConfig

$taxConfig

protected

Definition at line 23 of file TaxConfigProvider.php.

$taxHelper

$taxHelper

protected

Definition at line 18 of file TaxConfigProvider.php.

---

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

• vendor/magento/module-tax/Model/TaxConfigProvider.php