RulesApplier Class Reference

Public Member Functions
	__construct (\Magento\SalesRule\Model\Rule\Action\Discount\CalculatorFactory $calculatorFactory, \Magento\Framework\Event\ManagerInterface $eventManager, \Magento\SalesRule\Model\Utility $utility, ChildrenValidationLocator $childrenValidationLocator=null)
	applyRules ($item, $rules, $skipValidation, $couponCode)
	addDiscountDescription ($address, $rule)
	maintainAddressCouponCode ($address, $rule, $couponCode)
	setAppliedRuleIds (\Magento\Quote\Model\Quote\Item\AbstractItem $item, array $appliedRuleIds)

Protected Member Functions
	applyRule ($item, $rule, $address, $couponCode)
	getDiscountData ($item, $rule)
	setDiscountData ($discountData, $item)
	eventFix (\Magento\SalesRule\Model\Rule\Action\Discount\Data $discountData, \Magento\Quote\Model\Quote\Item\AbstractItem $item, \Magento\SalesRule\Model\Rule $rule, $qty)

Protected Attributes
	$_eventManager
	$validatorUtility

Detailed Description

Definition at line 17 of file RulesApplier.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\SalesRule\Model\Rule\Action\Discount\CalculatorFactory	$calculatorFactory,
		\Magento\Framework\Event\ManagerInterface	$eventManager,
		\Magento\SalesRule\Model\Utility	$utility,
		ChildrenValidationLocator	$childrenValidationLocator = null
	)

Parameters

\Magento\SalesRule\Model\Rule\Action\Discount\CalculatorFactory	$calculatorFactory
\Magento\Framework\Event\ManagerInterface	$eventManager
\Magento\SalesRule\Model\Utility	$utility
ChildrenValidationLocator | null	$childrenValidationLocator

Definition at line 47 of file RulesApplier.php.

      {
        $this->calculatorFactory = $calculatorFactory;
        $this->validatorUtility = $utility;
        $this->_eventManager = $eventManager;
        $this->childrenValidationLocator = $childrenValidationLocator
             ?: ObjectManager::getInstance()->get(ChildrenValidationLocator::class);
    }

Member Function Documentation

addDiscountDescription()

addDiscountDescription	(		$address,
			$rule
	)

Add rule discount description label to address object

Parameters

Address	$address
\Magento\SalesRule\Model\Rule	$rule

Returns

$this

Definition at line 116 of file RulesApplier.php.

    {
        $description = $address->getDiscountDescriptionArray();
        $ruleLabel = $rule->getStoreLabel($address->getQuote()->getStore());
        $label = '';
        if ($ruleLabel) {
            $label = $ruleLabel;
        } else {
            if (strlen($address->getCouponCode())) {
                $label = $address->getCouponCode();
            }
        }

        if (strlen($label)) {
            $description[$rule->getId()] = $label;
        }

        $address->setDiscountDescriptionArray($description);

        return $this;
    }

applyRule()

applyRule (   $item,   $rule,   $address,   $couponCode  )

protected

Parameters

\Magento\Quote\Model\Quote\Item\AbstractItem	$item
\Magento\SalesRule\Model\Rule	$rule
\Magento\Quote\Model\Quote\Address	$address
mixed	$couponCode

Returns

$this

Definition at line 145 of file RulesApplier.php.

    {
        $discountData = $this->getDiscountData($item, $rule);
        $this->setDiscountData($discountData, $item);

        $this->maintainAddressCouponCode($address, $rule, $couponCode);
        $this->addDiscountDescription($address, $rule);

        return $this;
    }

applyRules()

applyRules	(		$item,
			$rules,
			$skipValidation,
			$couponCode
	)

Apply rules to current order item

Parameters

\Magento\Quote\Model\Quote\Item\AbstractItem	$item
\Magento\SalesRule\Model\ResourceModel\Rule\Collection	$rules
bool	$skipValidation
mixed	$couponCode

Returns

array @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 70 of file RulesApplier.php.

    {
        $address = $item->getAddress();
        $appliedRuleIds = [];
        /* @var $rule \Magento\SalesRule\Model\Rule */
        foreach ($rules as $rule) {
            if (!$this->validatorUtility->canProcessRule($rule, $address)) {
                continue;
            }

            if (!$skipValidation && !$rule->getActions()->validate($item)) {
                if (!$this->childrenValidationLocator->isChildrenValidationRequired($item)) {
                     continue;
                }
                $childItems = $item->getChildren();
                $isContinue = true;
                if (!empty($childItems)) {
                    foreach ($childItems as $childItem) {
                        if ($rule->getActions()->validate($childItem)) {
                            $isContinue = false;
                        }
                    }
                }
                if ($isContinue) {
                    continue;
                }
            }

            $this->applyRule($item, $rule, $address, $couponCode);
            $appliedRuleIds[$rule->getRuleId()] = $rule->getRuleId();

            if ($rule->getStopRulesProcessing()) {
                break;
            }
        }

        return $appliedRuleIds;
    }

eventFix()

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

protected

Fire event to allow overwriting of discount amounts

Parameters

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

Returns

$this

Definition at line 227 of file RulesApplier.php.

      {
        $quote = $item->getQuote();
        $address = $item->getAddress();

        $this->_eventManager->dispatch(
            'salesrule_validator_process',
            [
                'rule' => $rule,
                'item' => $item,
                'address' => $address,
                'quote' => $quote,
                'qty' => $qty,
                'result' => $discountData
            ]
        );

        return $this;
    }

getDiscountData()

getDiscountData (   $item,   $rule  )

protected

Parameters

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

Returns

\Magento\SalesRule\Model\Rule\Action\Discount\Data

We can't use row total here because row total not include tax Discount can be applied on price included tax

Definition at line 161 of file RulesApplier.php.

    {
        $qty = $this->validatorUtility->getItemQty($item, $rule);

        $discountCalculator = $this->calculatorFactory->create($rule->getSimpleAction());
        $qty = $discountCalculator->fixQuantity($qty, $rule);
        $discountData = $discountCalculator->calculate($rule, $item, $qty);

        $this->eventFix($discountData, $item, $rule, $qty);
        $this->validatorUtility->deltaRoundingFix($discountData, $item);

        $this->validatorUtility->minFix($discountData, $item, $qty);

        return $discountData;
    }

maintainAddressCouponCode()

maintainAddressCouponCode	(		$address,
			$rule,
			$couponCode
	)

Set coupon code to address if $rule contains validated coupon

Parameters

Address	$address
\Magento\SalesRule\Model\Rule	$rule
mixed	$couponCode

Returns

$this

Definition at line 205 of file RulesApplier.php.

    {
        /*
        Rule is a part of rules collection, which includes only rules with 'No Coupon' type or with validated coupon.
        As a result, if rule uses coupon code(s) ('Specific' or 'Auto' Coupon Type), it always contains validated coupon
        */
        if ($rule->getCouponType() != \Magento\SalesRule\Model\Rule::COUPON_TYPE_NO_COUPON) {
            $address->setCouponCode($couponCode);
        }

        return $this;
    }

setAppliedRuleIds()

setAppliedRuleIds	(	\Magento\Quote\Model\Quote\Item\AbstractItem	$item,
		array	$appliedRuleIds
	)

Parameters

\Magento\Quote\Model\Quote\Item\AbstractItem	$item
	int[]	$appliedRuleIds

Returns

$this

Definition at line 256 of file RulesApplier.php.

    {
        $address = $item->getAddress();
        $quote = $item->getQuote();

        $item->setAppliedRuleIds(join(',', $appliedRuleIds));
        $address->setAppliedRuleIds($this->validatorUtility->mergeIds($address->getAppliedRuleIds(), $appliedRuleIds));
        $quote->setAppliedRuleIds($this->validatorUtility->mergeIds($quote->getAppliedRuleIds(), $appliedRuleIds));

        return $this;
    }

setDiscountData()

setDiscountData (   $discountData,   $item  )

protected

Parameters

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

Returns

$this

Definition at line 187 of file RulesApplier.php.

    {
        $item->setDiscountAmount($discountData->getAmount());
        $item->setBaseDiscountAmount($discountData->getBaseAmount());
        $item->setOriginalDiscountAmount($discountData->getOriginalAmount());
        $item->setBaseOriginalDiscountAmount($discountData->getBaseOriginalAmount());

        return $this;
    }

Field Documentation

$_eventManager

$_eventManager

protected

Definition at line 24 of file RulesApplier.php.

$validatorUtility

$validatorUtility

protected

Definition at line 29 of file RulesApplier.php.

---

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

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