Inheritance diagram for Validator:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\SalesRule\Model\ResourceModel\Rule\CollectionFactory $collectionFactory, \Magento\Catalog\Helper\Data $catalogData, \Magento\SalesRule\Model\Utility $utility, \Magento\SalesRule\Model\RulesApplier $rulesApplier, \Magento\Framework\Pricing\PriceCurrencyInterface $priceCurrency, \Magento\SalesRule\Model\Validator\Pool $validators, \Magento\Framework\Message\ManagerInterface $messageManager, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	init ($websiteId, $customerGroupId, $couponCode)

	setSkipActionsValidation ($flag)

	canApplyRules (AbstractItem $item)

	reset (Address $address)

	process (AbstractItem $item)

	processShippingAmount (Address $address)

	getItemPrice ($item)

	getItemOriginalPrice ($item)

	getItemBasePrice ($item)

	getItemBaseOriginalPrice ($item)

	prepareDescription ($address, $separator=', ')

	getRuleItemTotalsInfo ($key)

	decrementRuleItemTotalsCount ($key)

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	__sleep ()

	__wakeup ()

	setIdFieldName ($name)

	getIdFieldName ()

	getId ()

	setId ($value)

	isDeleted ($isDeleted=null)

	hasDataChanges ()

	setData ($key, $value=null)

	unsetData ($key=null)

	setDataChanges ($value)

	getOrigData ($key=null)

	setOrigData ($key=null, $data=null)

	dataHasChangedFor ($field)

	getResourceName ()

	getResourceCollection ()

	getCollection ()

	load ($modelId, $field=null)

	beforeLoad ($identifier, $field=null)

	afterLoad ()

	isSaveAllowed ()

	setHasDataChanges ($flag)

	save ()

	afterCommitCallback ()

	isObjectNew ($flag=null)

	beforeSave ()

	validateBeforeSave ()

	getCacheTags ()

	cleanModelCache ()

	afterSave ()

	delete ()

	beforeDelete ()

	afterDelete ()

	afterDeleteCommit ()

	getResource ()

	getEntityId ()

	setEntityId ($entityId)

	clearInstance ()

	getStoredData ()

	getEventPrefix ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Protected Member Functions
	_getRules (Address $address=null)

	getAddressId (Address $address)

Protected Member Functions inherited from AbstractModel
	_construct ()

	_init ($resourceModel)

	_setResourceModel ($resourceName, $collectionName=null)

	_getResource ()

	_getEventData ()

	_beforeLoad ($modelId, $field=null)

	_afterLoad ()

	_hasModelChanged ()

	_getValidatorBeforeSave ()

	_createValidatorBeforeSave ()

	_getValidationRulesBeforeSave ()

	_clearReferences ()

	_clearData ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_rules

	$_isFirstTimeResetRun = true

	$_rulesItemTotals = []

	$_skipActionsValidation = false

	$_catalogData = null

	$_collectionFactory

	$validatorUtility

	$rulesApplier

	$priceCurrency

	$validators

	$messageManager

	$counter = 0

Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'

	$_eventObject = 'object'

	$_idFieldName = 'id'

	$_hasDataChanges = false

	$_origData

	$_isDeleted = false

	$_resource

	$_resourceCollection

	$_resourceName

	$_collectionName

	$_cacheTag = false

	$_dataSaveAllowed = true

	$_isObjectNew = null

	$_validatorBeforeSave = null

	$_eventManager

	$_cacheManager

	$_registry

	$_logger

	$_appState

	$_actionValidator

	$storedData = []

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

SalesRule Validator Model

Allows dispatching before and after events for each controller action

@method mixed getCouponCode() @method Validator setCouponCode($code) @method mixed getWebsiteId() @method Validator setWebsiteId($id) @method mixed getCustomerGroupId() @method Validator setCustomerGroupId($id) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 25 of file Validator.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\SalesRule\Model\ResourceModel\Rule\CollectionFactory	$collectionFactory,
		\Magento\Catalog\Helper\Data	$catalogData,
		\Magento\SalesRule\Model\Utility	$utility,
		\Magento\SalesRule\Model\RulesApplier	$rulesApplier,
		\Magento\Framework\Pricing\PriceCurrencyInterface	$priceCurrency,
		\Magento\SalesRule\Model\Validator\Pool	$validators,
		\Magento\Framework\Message\ManagerInterface	$messageManager,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\SalesRule\Model\ResourceModel\Rule\CollectionFactory	$collectionFactory
\Magento\Catalog\Helper\Data	$catalogData
Utility	$utility
RulesApplier	$rulesApplier
\Magento\Framework\Pricing\PriceCurrencyInterface	$priceCurrency
Validator\Pool	$validators
\Magento\Framework\Message\ManagerInterface	$messageManager
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 115 of file Validator.php.

       {
         $this->_collectionFactory = $collectionFactory;
         $this->_catalogData = $catalogData;
         $this->validatorUtility = $utility;
         $this->rulesApplier = $rulesApplier;
         $this->priceCurrency = $priceCurrency;
         $this->validators = $validators;
         $this->messageManager = $messageManager;
         parent::__construct($context, $registry, $resource, $resourceCollection, $data);
     }

Member Function Documentation

◆ _getRules()

_getRules ( Address $address = null )

protected

Get rules collection for current object state

Parameters

Address | null $address

Returns: \Magento\SalesRule\Model\ResourceModel\Rule\Collection

Definition at line 162 of file Validator.php.

     {
         $addressId = $this->getAddressId($address);
         $key = $this->getWebsiteId() . '_'
             . $this->getCustomerGroupId() . '_'
             . $this->getCouponCode() . '_'
             . $addressId;
         if (!isset($this->_rules[$key])) {
             $this->_rules[$key] = $this->_collectionFactory->create()
                 ->setValidationFilter(
                     $this->getWebsiteId(),
                     $this->getCustomerGroupId(),
                     $this->getCouponCode(),
                     null,
                     $address
                 )
                 ->addFieldToFilter('is_active', 1)
                 ->load();
         }
         return $this->_rules[$key];
     }

◆ canApplyRules()

canApplyRules ( AbstractItem $item )

Can apply rules check

Parameters

AbstractItem $item

Returns: bool

Definition at line 223 of file Validator.php.

     {
         $address = $item->getAddress();
         foreach ($this->_getRules($address) as $rule) {
             if (!$this->validatorUtility->canProcessRule($rule, $address) || !$rule->getActions()->validate($item)) {
                 return false;
             }
         }
 
         return true;
     }

◆ decrementRuleItemTotalsCount()

decrementRuleItemTotalsCount ( $key )

Parameters

int $key

Returns: $this

Definition at line 539 of file Validator.php.

     {
         $this->_rulesItemTotals[$key]['items_count']--;
 
         return $this;
     }

◆ getAddressId()

getAddressId ( Address $address )

protected

Parameters

Address $address

Returns: string

Definition at line 188 of file Validator.php.

     {
         if ($address == null) {
             return '';
         }
         if (!$address->hasData('address_sales_rule_id')) {
             if ($address->hasData('address_id')) {
                 $address->setData('address_sales_rule_id', $address->getData('address_id'));
             } else {
                 $type = $address->getAddressType();
                 $tempId = $type . $this->counter++;
                 $address->setData('address_sales_rule_id', $tempId);
             }
         }
         return $address->getData('address_sales_rule_id');
     }

◆ getItemBaseOriginalPrice()

getItemBaseOriginalPrice ( $item )

Return item base original price

Parameters

AbstractItem $item

Returns: float

Definition at line 464 of file Validator.php.

     {
         return $this->_catalogData->getTaxPrice($item, $item->getBaseOriginalPrice(), true);
     }

◆ getItemBasePrice()

getItemBasePrice ( $item )

Return item base price

Parameters

AbstractItem $item

Returns: float

Definition at line 452 of file Validator.php.

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

◆ getItemOriginalPrice()

getItemOriginalPrice ( $item )

Return item original price

Parameters

AbstractItem $item

Returns: float

Definition at line 441 of file Validator.php.

     {
         return $this->_catalogData->getTaxPrice($item, $item->getOriginalPrice(), true);
     }

◆ getItemPrice()

getItemPrice ( $item )

Return item price

Parameters

AbstractItem $item

Returns: float

Definition at line 428 of file Validator.php.

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

◆ getRuleItemTotalsInfo()

getRuleItemTotalsInfo ( $key )

Parameters

int $key

Returns: array

Exceptions

Definition at line 526 of file Validator.php.

     {
         if (empty($this->_rulesItemTotals[$key])) {
             throw new \Magento\Framework\Exception\LocalizedException(__('Item totals are not set for the rule.'));
         }
 
         return $this->_rulesItemTotals[$key];
     }

◆ init()

init	(	$websiteId,
		$customerGroupId,
		$couponCode
	)

Init validator Init process load collection of rules for specific website, customer group and coupon code

Parameters

int	$websiteId
int	$customerGroupId
string	$couponCode

Returns: $this

Definition at line 149 of file Validator.php.

     {
         $this->setWebsiteId($websiteId)->setCustomerGroupId($customerGroupId)->setCouponCode($couponCode);
 
         return $this;
     }

◆ prepareDescription()

prepareDescription	(		$address,
			$separator = `'`,
		'
	)

Convert address discount description array to string

Parameters

Address	$address
string	$separator

Returns: $this

Definition at line 476 of file Validator.php.

     {
         $descriptionArray = $address->getDiscountDescriptionArray();
         if (!$descriptionArray && $address->getQuote()->getItemVirtualQty() > 0) {
             $descriptionArray = $address->getQuote()->getBillingAddress()->getDiscountDescriptionArray();
         }
 
         $description = $descriptionArray && is_array(
             $descriptionArray
         ) ? implode(
             $separator,
             array_unique($descriptionArray)
         ) : '';
 
         $address->setDiscountDescription($description);
         return $this;
     }

◆ process()

process ( AbstractItem $item )

Quote item discount calculation process

Parameters

AbstractItem $item

Returns: $this

Definition at line 259 of file Validator.php.

     {
         $item->setDiscountAmount(0);
         $item->setBaseDiscountAmount(0);
         $item->setDiscountPercent(0);
 
         $itemPrice = $this->getItemPrice($item);
         if ($itemPrice < 0) {
             return $this;
         }
 
         $appliedRuleIds = $this->rulesApplier->applyRules(
             $item,
             $this->_getRules($item->getAddress()),
             $this->_skipActionsValidation,
             $this->getCouponCode()
         );
         $this->rulesApplier->setAppliedRuleIds($item, $appliedRuleIds);
 
         return $this;
     }

◆ processShippingAmount()

processShippingAmount ( Address $address )

Apply discounts to shipping amount

Parameters

Address $address

Returns: $this @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 288 of file Validator.php.

     {
         $shippingAmount = $address->getShippingAmountForDiscount();
         if ($shippingAmount !== null) {
             $baseShippingAmount = $address->getBaseShippingAmountForDiscount();
         } else {
             $shippingAmount = $address->getShippingAmount();
             $baseShippingAmount = $address->getBaseShippingAmount();
         }
         $quote = $address->getQuote();
         $appliedRuleIds = [];
         foreach ($this->_getRules($address) as $rule) {
             /* @var \Magento\SalesRule\Model\Rule $rule */
             if (!$rule->getApplyToShipping() || !$this->validatorUtility->canProcessRule($rule, $address)) {
                 continue;
             }
 
             $discountAmount = 0;
             $baseDiscountAmount = 0;
             $rulePercent = min(100, $rule->getDiscountAmount());
             switch ($rule->getSimpleAction()) {
                 case \Magento\SalesRule\Model\Rule::TO_PERCENT_ACTION:
                     $rulePercent = max(0, 100 - $rule->getDiscountAmount());
                 // break is intentionally omitted
                 case \Magento\SalesRule\Model\Rule::BY_PERCENT_ACTION:
                     $discountAmount = ($shippingAmount - $address->getShippingDiscountAmount()) * $rulePercent / 100;
                     $baseDiscountAmount = ($baseShippingAmount -
                             $address->getBaseShippingDiscountAmount()) * $rulePercent / 100;
                     $discountPercent = min(100, $address->getShippingDiscountPercent() + $rulePercent);
                     $address->setShippingDiscountPercent($discountPercent);
                     break;
                 case \Magento\SalesRule\Model\Rule::TO_FIXED_ACTION:
                     $quoteAmount = $this->priceCurrency->convert($rule->getDiscountAmount(), $quote->getStore());
                     $discountAmount = $shippingAmount - $quoteAmount;
                     $baseDiscountAmount = $baseShippingAmount - $rule->getDiscountAmount();
                     break;
                 case \Magento\SalesRule\Model\Rule::BY_FIXED_ACTION:
                     $quoteAmount = $this->priceCurrency->convert($rule->getDiscountAmount(), $quote->getStore());
                     $discountAmount = $quoteAmount;
                     $baseDiscountAmount = $rule->getDiscountAmount();
                     break;
                 case \Magento\SalesRule\Model\Rule::CART_FIXED_ACTION:
                     $cartRules = $address->getCartFixedRules();
                     if (!isset($cartRules[$rule->getId()])) {
                         $cartRules[$rule->getId()] = $rule->getDiscountAmount();
                     }
                     if ($cartRules[$rule->getId()] > 0) {
                         $quoteAmount = $this->priceCurrency->convert($cartRules[$rule->getId()], $quote->getStore());
                         $discountAmount = min($shippingAmount - $address->getShippingDiscountAmount(), $quoteAmount);
                         $baseDiscountAmount = min(
                             $baseShippingAmount - $address->getBaseShippingDiscountAmount(),
                             $cartRules[$rule->getId()]
                         );
                         $cartRules[$rule->getId()] -= $baseDiscountAmount;
                     }
 
                     $address->setCartFixedRules($cartRules);
                     break;
             }
 
             $discountAmount = min($address->getShippingDiscountAmount() + $discountAmount, $shippingAmount);
             $baseDiscountAmount = min(
                 $address->getBaseShippingDiscountAmount() + $baseDiscountAmount,
                 $baseShippingAmount
             );
             $address->setShippingDiscountAmount($discountAmount);
             $address->setBaseShippingDiscountAmount($baseDiscountAmount);
             $appliedRuleIds[$rule->getRuleId()] = $rule->getRuleId();
 
             $this->rulesApplier->maintainAddressCouponCode($address, $rule, $this->getCouponCode());
             $this->rulesApplier->addDiscountDescription($address, $rule);
             if ($rule->getStopRulesProcessing()) {
                 break;
             }
         }
 
         $address->setAppliedRuleIds($this->validatorUtility->mergeIds($address->getAppliedRuleIds(), $appliedRuleIds));
         $quote->setAppliedRuleIds($this->validatorUtility->mergeIds($quote->getAppliedRuleIds(), $appliedRuleIds));
 
         return $this;
     }

◆ reset()

reset ( Address $address )

Reset quote and address applied rules

Parameters

Address $address

Returns: $this

Definition at line 241 of file Validator.php.

     {
         $this->validatorUtility->resetRoundingDeltas();
         if ($this->_isFirstTimeResetRun) {
             $address->setAppliedRuleIds('');
             $address->getQuote()->setAppliedRuleIds('');
             $this->_isFirstTimeResetRun = false;
         }
 
         return $this;
     }

◆ setSkipActionsValidation()

setSkipActionsValidation ( $flag )

Set skip actions validation flag

Parameters

bool $flag

Returns: $this

Definition at line 211 of file Validator.php.

     {
         $this->_skipActionsValidation = $flag;
         return $this;
     }

Field Documentation

◆ $_catalogData

$_catalogData = null

protected

Definition at line 61 of file Validator.php.

◆ $_collectionFactory

$_collectionFactory

protected

Definition at line 66 of file Validator.php.

◆ $_isFirstTimeResetRun

$_isFirstTimeResetRun = true

protected

Definition at line 40 of file Validator.php.

◆ $_rules

$_rules

protected

Definition at line 32 of file Validator.php.

◆ $_rulesItemTotals

$_rulesItemTotals = []

protected

Definition at line 47 of file Validator.php.

◆ $_skipActionsValidation

$_skipActionsValidation = false

protected

Definition at line 54 of file Validator.php.

◆ $counter

$counter = 0

protected

Definition at line 98 of file Validator.php.

◆ $messageManager

$messageManager

protected

Definition at line 91 of file Validator.php.

◆ $priceCurrency

$priceCurrency

protected

Definition at line 81 of file Validator.php.

◆ $rulesApplier

$rulesApplier

protected

Definition at line 76 of file Validator.php.

◆ $validators

$validators

protected

Definition at line 86 of file Validator.php.

◆ $validatorUtility

$validatorUtility

protected

Definition at line 71 of file Validator.php.

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

vendor/magento/module-sales-rule/Model/Validator.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getRules()

◆ canApplyRules()

◆ decrementRuleItemTotalsCount()

◆ getAddressId()

◆ getItemBaseOriginalPrice()

◆ getItemBasePrice()

◆ getItemOriginalPrice()

◆ getItemPrice()

◆ getRuleItemTotalsInfo()

◆ init()

◆ prepareDescription()

◆ process()

◆ processShippingAmount()

◆ reset()

◆ setSkipActionsValidation()

Field Documentation

◆ $_catalogData

◆ $_collectionFactory

◆ $_isFirstTimeResetRun

◆ $_rules

◆ $_rulesItemTotals

◆ $_skipActionsValidation

◆ $counter

◆ $messageManager

◆ $priceCurrency

◆ $rulesApplier

◆ $validators

◆ $validatorUtility