Adjustment Class Reference

Inheritance diagram for Adjustment:

Public Member Functions
	__construct (WeeeHelper $weeeHelper, 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'

Protected Member Functions
	getAmount (SaleableInterface $saleableItem)

Protected Attributes
	$weeeHelper
	$sortOrder
	$priceCurrency

Detailed Description

Weee pricing adjustment

Definition at line 18 of file Adjustment.php.

Constructor & Destructor Documentation

__construct()

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

Constructor

Parameters

WeeeHelper	$weeeHelper
PriceCurrencyInterface	$priceCurrency
int	$sortOrder

Definition at line 51 of file Adjustment.php.

    {
        $this->weeeHelper = $weeeHelper;
        $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 117 of file Adjustment.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 104 of file Adjustment.php.

    {
        return 0;
    }

getAdjustmentCode()

getAdjustmentCode

(

)

Get adjustment code

Returns

string

Implements AdjustmentInterface.

Definition at line 63 of file Adjustment.php.

    {
        return self::ADJUSTMENT_CODE;
    }

getAmount()

getAmount ( SaleableInterface  $saleableItem )

protected

Obtain amount

Parameters

SaleableInterface

$saleableItem

Returns

float

Definition at line 143 of file Adjustment.php.

    {
        $weeeAmount = $this->weeeHelper->getAmountExclTax($saleableItem);
        $weeeAmount = $this->priceCurrency->convert($weeeAmount);
        return $weeeAmount;
    }

getSortOrder()

getSortOrder

(

)

Return sort order position

Returns

int

Implements AdjustmentInterface.

Definition at line 155 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 131 of file Adjustment.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 74 of file Adjustment.php.

    {
        return false;
    }

isIncludedInDisplayPrice()

isIncludedInDisplayPrice

(

)

Define if adjustment is included in display price

Returns

bool

Implements AdjustmentInterface.

Definition at line 84 of file Adjustment.php.

    {
        return $this->weeeHelper->typeOfDisplay(
            [
                \Magento\Weee\Model\Tax::DISPLAY_INCL,
                \Magento\Weee\Model\Tax::DISPLAY_INCL_DESCR,
                \Magento\Weee\Model\Tax::DISPLAY_EXCL_DESCR_INCL,
            ]
        );
    }

Field Documentation

$priceCurrency

$priceCurrency

protected

Definition at line 42 of file Adjustment.php.

$sortOrder

$sortOrder

protected

Definition at line 37 of file Adjustment.php.

$weeeHelper

$weeeHelper

protected

Definition at line 30 of file Adjustment.php.

ADJUSTMENT_CODE

const ADJUSTMENT_CODE = 'weee'

Adjustment code weee

Definition at line 23 of file Adjustment.php.

---

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

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