Calculator Class Reference

Inheritance diagram for Calculator:

Public Member Functions
	__construct (AmountFactory $amountFactory)
	getAmount ($amount, SaleableInterface $saleableItem, $exclude=null, $context=[])

Protected Attributes
	$amountFactory

Detailed Description

Class Calculator

Definition at line 15 of file Calculator.php.

Constructor & Destructor Documentation

__construct()

__construct

(

AmountFactory

$amountFactory

)

Parameters

AmountFactory

$amountFactory

Definition at line 25 of file Calculator.php.

    {
        $this->amountFactory = $amountFactory;
    }

Member Function Documentation

getAmount()

getAmount	(		$amount,
		SaleableInterface	$saleableItem,
			$exclude = null,
			$context = []
	)

Retrieve Amount object based on given float amount, product and exclude option. It is possible to pass "true" or adjustment code to exclude all or specific adjustment from an amount.

Parameters

float | string	$amount
SaleableInterface	$saleableItem
null | bool | string | array	$exclude
null | array	$context

Returns

\Magento\Framework\Pricing\Amount\AmountInterface @SuppressWarnings(PHPMD.CyclomaticComplexity)

Implements CalculatorInterface.

Definition at line 41 of file Calculator.php.

    {
        $baseAmount = $fullAmount = $amount;
        $previousAdjustments = 0;
        $adjustments = [];
        foreach ($saleableItem->getPriceInfo()->getAdjustments() as $adjustment) {
            $code = $adjustment->getAdjustmentCode();
            $toExclude = false;
            if (!is_array($exclude)) {
                if ($exclude === true || ($exclude !== null && $code === $exclude)) {
                    $toExclude = true;
                }
            } else {
                if (in_array($code, $exclude)) {
                    $toExclude = true;
                }
            }
            if ($adjustment->isIncludedInBasePrice()) {
                $adjust = $adjustment->extractAdjustment($baseAmount, $saleableItem, $context);
                $baseAmount -= $adjust;
                $fullAmount = $adjustment->applyAdjustment($fullAmount, $saleableItem, $context);
                $adjust = $fullAmount - $baseAmount - $previousAdjustments;
                if (!$toExclude) {
                    $adjustments[$code] = $adjust;
                }
            } elseif ($adjustment->isIncludedInDisplayPrice($saleableItem)) {
                if ($toExclude) {
                    continue;
                }
                $newAmount = $adjustment->applyAdjustment($fullAmount, $saleableItem, $context);
                $adjust = $newAmount - $fullAmount;
                $adjustments[$code] = $adjust;
                $fullAmount = $newAmount;
                $previousAdjustments += $adjust;
            }
        }

        return $this->amountFactory->create($fullAmount, $adjustments);
    }

Field Documentation

$amountFactory

$amountFactory

protected

Definition at line 20 of file Calculator.php.

---

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

• vendor/magento/framework/Pricing/Adjustment/Calculator.php