Adjustment Class Reference

Inheritance diagram for Adjustment:

Public Member Functions
	__construct (TaxHelper $taxHelper, \Magento\Catalog\Helper\Data $catalogHelper, $sortOrder=null)
	getAdjustmentCode ()
	isIncludedInBasePrice ()
	isIncludedInDisplayPrice ()
	extractAdjustment ($amount, SaleableInterface $saleableItem, $context=[])
	applyAdjustment ($amount, SaleableInterface $saleableItem, $context=[])
	isExcludedWith ($adjustmentCode)
	getSortOrder ()

Data Fields
const	ADJUSTMENT_CODE = 'tax'

Protected Attributes
	$taxHelper
	$catalogHelper
	$sortOrder

Detailed Description

Tax pricing adjustment model

Definition at line 16 of file Adjustment.php.

Constructor & Destructor Documentation

__construct()

__construct	(	TaxHelper	$taxHelper,
		\Magento\Catalog\Helper\Data	$catalogHelper,
			$sortOrder = null
	)

Parameters

TaxHelper	$taxHelper
\Magento\Catalog\Helper\Data	$catalogHelper
int | null	$sortOrder

Definition at line 45 of file Adjustment.php.

    {
        $this->taxHelper = $taxHelper;
        $this->catalogHelper = $catalogHelper;
        $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 119 of file Adjustment.php.

    {
        return $this->catalogHelper->getTaxPrice(
            $saleableItem,
            $amount,
            true,
            null,
            null,
            null,
            null,
            null,
            false
        );
    }

extractAdjustment()

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

Extract adjustment amount from the given amount value

Parameters

float	$amount
SaleableInterface	$saleableItem
null | array	$context

Returns

float

Implements AdjustmentInterface.

Definition at line 90 of file Adjustment.php.

    {
        if ($this->taxHelper->priceIncludesTax()) {
            $adjustedAmount = $this->catalogHelper->getTaxPrice(
                $saleableItem,
                $amount,
                false,
                null,
                null,
                null,
                null,
                null,
                false
            );
            $result = $amount - $adjustedAmount;
        } else {
            $result = 0.;
        }
        return $result;
    }

getAdjustmentCode()

getAdjustmentCode

(

)

Get adjustment code

Returns

string

Implements AdjustmentInterface.

Definition at line 57 of file Adjustment.php.

    {
        return self::ADJUSTMENT_CODE;
    }

getSortOrder()

getSortOrder

(

)

Return sort order position

Returns

int

Implements AdjustmentInterface.

Definition at line 150 of file Adjustment.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 140 of file Adjustment.php.

    {
        return $this->getAdjustmentCode() === $adjustmentCode;
    }

isIncludedInBasePrice()

isIncludedInBasePrice

(

)

Define if adjustment is included in base price

Returns

bool

Implements AdjustmentInterface.

Definition at line 67 of file Adjustment.php.

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

isIncludedInDisplayPrice()

isIncludedInDisplayPrice

(

)

Define if adjustment is included in display price

Returns

bool

Implements AdjustmentInterface.

Definition at line 77 of file Adjustment.php.

    {
        return $this->taxHelper->displayPriceIncludingTax() || $this->taxHelper->displayBothPrices();
    }

Field Documentation

$catalogHelper

$catalogHelper

protected

Definition at line 33 of file Adjustment.php.

$sortOrder

$sortOrder

protected

Definition at line 38 of file Adjustment.php.

$taxHelper

$taxHelper

protected

Definition at line 26 of file Adjustment.php.

ADJUSTMENT_CODE

const ADJUSTMENT_CODE = 'tax'

Adjustment code tax

Definition at line 21 of file Adjustment.php.

---

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

• vendor/magento/module-tax/Pricing/Adjustment.php