TaxAdjustment Class Reference

Inheritance diagram for TaxAdjustment:

Public Member Functions
	__construct (WeeeHelper $weeeHelper, TaxHelper $taxHelper, PriceCurrencyInterface $priceCurrency, $sortOrder=null)
	getAdjustmentCode ()
	isIncludedInBasePrice ()
	isIncludedInDisplayPrice ()
	extractAdjustment ($amount, SaleableInterface $saleableItem, $context=[])
	applyAdjustment ($amount, SaleableInterface $saleableItem, $context=[])
	isExcludedWith ($adjustmentCode)
	getSortOrder ()

Data Fields
const	ADJUSTMENT_CODE = 'weee_tax'

Protected Member Functions
	getAmount (SaleableInterface $saleableItem)

Protected Attributes
	$weeeHelper
	$taxHelper
	$sortOrder
	$priceCurrency

Detailed Description

Weee tax pricing adjustment

Definition at line 19 of file TaxAdjustment.php.

Constructor & Destructor Documentation

__construct()

__construct	(	WeeeHelper	$weeeHelper,
		TaxHelper	$taxHelper,
		PriceCurrencyInterface	$priceCurrency,
			$sortOrder = null
	)

Constructor

Parameters

WeeeHelper	$weeeHelper
TaxHelper	$taxHelper
PriceCurrencyInterface	$priceCurrency
int	$sortOrder

Definition at line 58 of file TaxAdjustment.php.

      {
        $this->weeeHelper = $weeeHelper;
        $this->taxHelper = $taxHelper;
        $this->priceCurrency = $priceCurrency;
        $this->sortOrder = $sortOrder;
    }

Member Function Documentation

applyAdjustment()

applyAdjustment	(		$amount,
		SaleableInterface	$saleableItem,
			$context = []
	)

Apply adjustment amount and return result value

Parameters

float	$amount
SaleableInterface	$saleableItem
null | array	$context

Returns

float

Implements AdjustmentInterface.

Definition at line 132 of file TaxAdjustment.php.

    {
        if (isset($context[CustomOptionPriceInterface::CONFIGURATION_OPTION_FLAG])) {
            return $amount;
        }
        return $amount + $this->getAmount($saleableItem);
    }

extractAdjustment()

extractAdjustment	(		$amount,
		SaleableInterface	$saleableItem,
			$context = []
	)

Extract adjustment amount from the given amount value

Parameters

float	$amount
SaleableInterface	$saleableItem
null | array	$context

Returns

float @SuppressWarnings(PHPMD.UnusedFormalParameter)

Implements AdjustmentInterface.

Definition at line 119 of file TaxAdjustment.php.

    {
        return 0;
    }

getAdjustmentCode()

getAdjustmentCode

(

)

Get adjustment code

Returns

string

Implements AdjustmentInterface.

Definition at line 75 of file TaxAdjustment.php.

    {
        return self::ADJUSTMENT_CODE;
    }

getAmount()

getAmount ( SaleableInterface  $saleableItem )

protected

Obtain amount

Parameters

SaleableInterface

$saleableItem

Returns

float

Definition at line 158 of file TaxAdjustment.php.

    {
        $weeeTaxAmount = 0;
        $attributes = $this->weeeHelper->getProductWeeeAttributes($saleableItem, null, null, null, true, false);
        if ($attributes != null) {
            foreach ($attributes as $attribute) {
                $weeeTaxAmount += $attribute->getData('tax_amount');
            }
        }
        $weeeTaxAmount = $this->priceCurrency->convert($weeeTaxAmount);
        return $weeeTaxAmount;
    }

getSortOrder()

getSortOrder

(

)

Return sort order position

Returns

int

Implements AdjustmentInterface.

Definition at line 176 of file TaxAdjustment.php.

    {
        return $this->sortOrder;
    }

isExcludedWith()

isExcludedWith

(

$adjustmentCode

)

Check if adjustment should be excluded from calculations along with the given adjustment

Parameters

string

$adjustmentCode

Returns

bool

Implements AdjustmentInterface.

Definition at line 146 of file TaxAdjustment.php.

    {
        return (($adjustmentCode == self::ADJUSTMENT_CODE) ||
            ($adjustmentCode == \Magento\Tax\Pricing\Adjustment::ADJUSTMENT_CODE));
    }

isIncludedInBasePrice()

isIncludedInBasePrice

(

)

Define if adjustment is included in base price (FPT is excluded from base price)

Returns

bool

Implements AdjustmentInterface.

Definition at line 86 of file TaxAdjustment.php.

    {
        return false;
    }

isIncludedInDisplayPrice()

isIncludedInDisplayPrice

(

)

Define if adjustment is included in display price

Returns

bool

Implements AdjustmentInterface.

Definition at line 96 of file TaxAdjustment.php.

    {
        if ($this->taxHelper->displayPriceExcludingTax()) {
            return false;
        }
        if ($this->weeeHelper->isEnabled() == true &&
            $this->weeeHelper->isTaxable() == true &&
            $this->weeeHelper->typeOfDisplay([\Magento\Weee\Model\Tax::DISPLAY_EXCL]) == false) {
            return true;
        } else {
            return false;
        }
    }

Field Documentation

$priceCurrency

$priceCurrency

protected

Definition at line 48 of file TaxAdjustment.php.

$sortOrder

$sortOrder

protected

Definition at line 43 of file TaxAdjustment.php.

$taxHelper

$taxHelper

protected

Definition at line 36 of file TaxAdjustment.php.

$weeeHelper

$weeeHelper

protected

Definition at line 31 of file TaxAdjustment.php.

ADJUSTMENT_CODE

const ADJUSTMENT_CODE = 'weee_tax'

Adjustment code weee

Definition at line 24 of file TaxAdjustment.php.

---

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

• vendor/magento/module-weee/Pricing/TaxAdjustment.php