Utility Class Reference

Public Member Functions
	__construct (\Magento\SalesRule\Model\ResourceModel\Coupon\UsageFactory $usageFactory, \Magento\SalesRule\Model\CouponFactory $couponFactory, \Magento\SalesRule\Model\Rule\CustomerFactory $customerFactory, \Magento\Framework\DataObjectFactory $objectFactory, PriceCurrencyInterface $priceCurrency)
	minFix (\Magento\SalesRule\Model\Rule\Action\Discount\Data $discountData, \Magento\Quote\Model\Quote\Item\AbstractItem $item, $qty)
	deltaRoundingFix (\Magento\SalesRule\Model\Rule\Action\Discount\Data $discountData, \Magento\Quote\Model\Quote\Item\AbstractItem $item)
	getItemPrice ($item)
	getItemBasePrice ($item)
	getItemQty ($item, $rule)
	mergeIds ($a1, $a2, $asString=true)
	resetRoundingDeltas ()

Protected Attributes
	$_roundingDeltas = []
	$_baseRoundingDeltas = []
	$usageFactory
	$couponFactory
	$customerFactory
	$objectFactory
	$priceCurrency

Detailed Description

Definition at line 16 of file Utility.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\SalesRule\Model\ResourceModel\Coupon\UsageFactory	$usageFactory,
		\Magento\SalesRule\Model\CouponFactory	$couponFactory,
		\Magento\SalesRule\Model\Rule\CustomerFactory	$customerFactory,
		\Magento\Framework\DataObjectFactory	$objectFactory,
		PriceCurrencyInterface	$priceCurrency
	)

Parameters

\Magento\SalesRule\Model\ResourceModel\Coupon\UsageFactory	$usageFactory
CouponFactory	$couponFactory
Rule\CustomerFactory	$customerFactory
\Magento\Framework\DataObjectFactory	$objectFactory
PriceCurrencyInterface	$priceCurrency

Definition at line 60 of file Utility.php.

      {
        $this->couponFactory = $couponFactory;
        $this->customerFactory = $customerFactory;
        $this->usageFactory = $usageFactory;
        $this->objectFactory = $objectFactory;
        $this->priceCurrency = $priceCurrency;
    }

Member Function Documentation

deltaRoundingFix()

deltaRoundingFix	(	\Magento\SalesRule\Model\Rule\Action\Discount\Data	$discountData,
		\Magento\Quote\Model\Quote\Item\AbstractItem	$item
	)

Process "delta" rounding

Parameters

\Magento\SalesRule\Model\Rule\Action\Discount\Data	$discountData
\Magento\Quote\Model\Quote\Item\AbstractItem	$item

Returns

$this

When we have 100% discount check if totals will not be negative

Definition at line 186 of file Utility.php.

      {
        $discountAmount = $discountData->getAmount();
        $baseDiscountAmount = $discountData->getBaseAmount();
        $rowTotalInclTax = $item->getRowTotalInclTax();
        $baseRowTotalInclTax = $item->getBaseRowTotalInclTax();

        //TODO Seems \Magento\Quote\Model\Quote\Item\AbstractItem::getDiscountPercent() returns float value
        //that can not be used as array index
        $percentKey = $item->getDiscountPercent();
        if ($percentKey) {
            $delta = isset($this->_roundingDeltas[$percentKey]) ? $this->_roundingDeltas[$percentKey] : 0;
            $baseDelta = isset($this->_baseRoundingDeltas[$percentKey]) ? $this->_baseRoundingDeltas[$percentKey] : 0;

            $discountAmount += $delta;
            $baseDiscountAmount += $baseDelta;

            $this->_roundingDeltas[$percentKey] = $discountAmount - $this->priceCurrency->round($discountAmount);
            $this->_baseRoundingDeltas[$percentKey] = $baseDiscountAmount
                - $this->priceCurrency->round($baseDiscountAmount);
        }

        if ($percentKey == 100) {
            $discountDelta = $rowTotalInclTax - $discountAmount;
            $baseDiscountDelta = $baseRowTotalInclTax - $baseDiscountAmount;

            if ($discountDelta < 0) {
                $discountAmount += $discountDelta;
            }

            if ($baseDiscountDelta < 0) {
                $baseDiscountAmount += $baseDiscountDelta;
            }
        }

        $discountData->setAmount($this->priceCurrency->round($discountAmount));
        $discountData->setBaseAmount($this->priceCurrency->round($baseDiscountAmount));

        return $this;
    }

getItemBasePrice()

getItemBasePrice

(

$item

)

Return item base price

Parameters

\Magento\Quote\Model\Quote\Item\AbstractItem

$item

Returns

float

Definition at line 252 of file Utility.php.

    {
        $price = $item->getDiscountCalculationPrice();
        return $price !== null ? $item->getBaseDiscountCalculationPrice() : $item->getBaseCalculationPrice();
    }

getItemPrice()

getItemPrice

(

$item

)

Return item price

Parameters

\Magento\Quote\Model\Quote\Item\AbstractItem

$item

Returns

float

Definition at line 239 of file Utility.php.

    {
        $price = $item->getDiscountCalculationPrice();
        $calcPrice = $item->getCalculationPrice();
        return $price === null ? $calcPrice : $price;
    }

getItemQty()

getItemQty	(		$item,
			$rule
	)

Return discount item qty

Parameters

\Magento\Quote\Model\Quote\Item\AbstractItem	$item
\Magento\SalesRule\Model\Rule	$rule

Returns

int

Definition at line 265 of file Utility.php.

    {
        $qty = $item->getTotalQty();
        $discountQty = $rule->getDiscountQty();
        return $discountQty ? min($qty, $discountQty) : $qty;
    }

mergeIds()

mergeIds	(		$a1,
			$a2,
			$asString = true
	)

Merge two sets of ids

Parameters

array | string	$a1
array | string	$a2
bool	$asString

Returns

array|string

Definition at line 280 of file Utility.php.

    {
        if (!is_array($a1)) {
            $a1 = empty($a1) ? [] : explode(',', $a1);
        }
        if (!is_array($a2)) {
            $a2 = empty($a2) ? [] : explode(',', $a2);
        }
        $a = array_unique(array_merge($a1, $a2));
        if ($asString) {
            $a = implode(',', $a);
        }
        return $a;
    }

minFix()

minFix	(	\Magento\SalesRule\Model\Rule\Action\Discount\Data	$discountData,
		\Magento\Quote\Model\Quote\Item\AbstractItem	$item,
			$qty
	)

Parameters

\Magento\SalesRule\Model\Rule\Action\Discount\Data	$discountData
\Magento\Quote\Model\Quote\Item\AbstractItem	$item
float	$qty

Returns

void

Definition at line 161 of file Utility.php.

      {
        $itemPrice = $this->getItemPrice($item);
        $baseItemPrice = $this->getItemBasePrice($item);

        $itemDiscountAmount = $item->getDiscountAmount();
        $itemBaseDiscountAmount = $item->getBaseDiscountAmount();

        $discountAmount = min($itemDiscountAmount + $discountData->getAmount(), $itemPrice * $qty);
        $baseDiscountAmount = min($itemBaseDiscountAmount + $discountData->getBaseAmount(), $baseItemPrice * $qty);

        $discountData->setAmount($discountAmount);
        $discountData->setBaseAmount($baseDiscountAmount);
    }

resetRoundingDeltas()

resetRoundingDeltas

(

)

Returns

void

Definition at line 298 of file Utility.php.

    {
        $this->_roundingDeltas = [];
        $this->_baseRoundingDeltas = [];
    }

Field Documentation

$_baseRoundingDeltas

$_baseRoundingDeltas = []

protected

Definition at line 26 of file Utility.php.

$_roundingDeltas

$_roundingDeltas = []

protected

Definition at line 21 of file Utility.php.

$couponFactory

$couponFactory

protected

Definition at line 36 of file Utility.php.

$customerFactory

$customerFactory

protected

Definition at line 41 of file Utility.php.

$objectFactory

$objectFactory

protected

Definition at line 46 of file Utility.php.

$priceCurrency

$priceCurrency

protected

Definition at line 51 of file Utility.php.

$usageFactory

$usageFactory

protected

Definition at line 31 of file Utility.php.

---

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

• vendor/magento/module-sales-rule/Model/Utility.php