Are you looking for a method to validate condition rules in a custom module for Magento 2? Read this blog post to find the complete programmatic method.<\/p>\n\n\n\n
Cart price rules in Magento 2<\/a> are useful for offering discounts based on conditions. It helps merchants get more sales by crafting discount offers strategically. The Magento platform validates the conditions and applies the discount offers on eligible orders. If you\u2019re working on a custom Magento 2 module, which requires interacting with the checkout process, you may need to validate the condition rules.<\/p>\n\n\n\n Recently, I faced a similar situation while working on a custom module. I wanted to get all the cart price rules and validate them through custom modules in Magento 2<\/a>. On my first try, I was able to get the list of custom price rules, but it does not seem to validate the rules. Later on, I found a working method to validate condition rules in Magento 2 custom module.<\/p>\n\n\n\n Let\u2019s see how to do it.<\/p>\n\n\n\n In Magento 2<\/a>, the Rule Factory class is used to create rule objects for various conditions, such as shopping cart price rules, catalogue price rules, and promotion rules. This can be done by using the You need to create models to load the available rules and validate them through Rule Factory. This ensures that only a valid cart price is applied to the quote. To do that, download this rule.rar<\/a> file, and extract it inside the Once you\u2019ve created the required models in the custom module, you can access and validate condition rules.<\/p>\n\n\n\n Now, let\u2019s say we want to validate Magento 2 custom rule condition on order placement. We can use Note: <\/strong>Do not forget to replace So, that\u2019s it.<\/p>\n\n\n\nMethod to Validate Condition Rules in a Custom Module for Magento 2<\/h2>\n\n\n\n
MagentoRuleModelRuleFactory<\/code> class in Magento 2.<\/p>\n\n\n\napp\/code\/Vendor\/Module\/Model\/<\/code> directory. Further, you\u2019ll also need to create message.php<\/strong> in the same directory with the following code:<\/p>\n\n\n\n<?php\n\nnamespace Vendor\\Module\\Model;\n\nuse Magento\\Quote\\Model\\Quote\\Address;\nuse Magento\\Rule\\Model\\AbstractModel;\nuse Magento\\Framework\\Model\\Context;\nuse Magento\\Framework\\Registry;\nuse Magento\\Framework\\Data\\FormFactory;\nuse Magento\\Framework\\Stdlib\\DateTime\\TimezoneInterface;\nuse Magento\\SalesRule\\Model\\Rule\\Condition\\CombineFactory;\nuse Magento\\SalesRule\\Model\\Rule\\Condition\\Product\\CombineFactory as ProductCombineFactory;\nuse Magento\\Framework\\Model\\ResourceModel\\AbstractResource;\nuse Magento\\Framework\\Data\\Collection\\AbstractDb;\n\n\/**\n * Class Message\n * @package Vendor\\Module\\Model\n *\/\nclass Message extends AbstractModel\n{\n \/** @var string *\/\n protected $_eventPrefix = 'vendor_module';\n\n \/** @var string *\/\n protected $_eventObject = 'vendor_message';\n\n \/** @var CombineFactory *\/\n protected $condCombineFactory;\n\n \/** @var ProductCombineFactory *\/\n protected $condProdCombineF;\n\n \/** @var array *\/\n protected $validatedAddresses = [];\n\n \/**\n * Message constructor.\n *\n * @param Context $context\n * @param Registry $registry\n * @param CombineFactory $condCombineFactory\n * @param ProductCombineFactory $condProdCombineF\n * @param AbstractResource|null $resource\n * @param AbstractDb|null $resourceCollection\n * @param array $data\n *\/\n public function __construct(\n Context $context,\n Registry $registry,\n CombineFactory $condCombineFactory,\n ProductCombineFactory $condProdCombineF,\n AbstractResource $resource = null,\n AbstractDb $resourceCollection = null,\n array $data = []\n ) {\n $this->condCombineFactory = $condCombineFactory;\n $this->condProdCombineF = $condProdCombineF;\n parent::__construct($context, $registry, $resource, $resourceCollection, $data);\n }\n\n \/**\n * Define resource model\n *\/\n protected function _construct()\n {\n $this->_init(\\Vendor\\Module\\Model\\ResourceModel\\Message::class);\n $this->setIdFieldName('id');\n }\n\n \/**\n * @return \\Magento\\SalesRule\\Model\\Rule\\Condition\\Combine\n *\/\n public function getConditionsInstance()\n {\n return $this->condCombineFactory->create();\n }\n\n \/**\n * @return \\Magento\\SalesRule\\Model\\Rule\\Condition\\Product\\Combine\n *\/\n public function getActionsInstance()\n {\n return $this->condProdCombineF->create();\n }\n\n \/**\n * Check if address is already validated\n *\n * @param Address|int $address\n * @return bool\n *\/\n public function hasIsValidForAddress($address)\n {\n return isset($this->validatedAddresses[$this->_getAddressId($address)]);\n }\n\n \/**\n * Set validation result for address\n *\n * @param Address|int $address\n * @param bool $validationResult\n * @return $this\n *\/\n public function setIsValidForAddress($address, $validationResult)\n {\n $this->validatedAddresses[$this->_getAddressId($address)] = (bool) $validationResult;\n return $this;\n }\n\n \/**\n * Get validation result for address\n *\n * @param Address|int $address\n * @return bool\n *\/\n public function getIsValidForAddress($address)\n {\n return $this->validatedAddresses[$this->_getAddressId($address)] ?? false;\n }\n\n \/**\n * Get address ID\n *\n * @param Address|int $address\n * @return int|null\n *\/\n private function _getAddressId($address)\n {\n return ($address instanceof Address) ? $address->getId() : $address;\n }\n}<\/pre>\n\n\n\nvalidate()<\/code> function, for example:<\/p>\n\n\n\n<?php\n\nnamespace Vendor\\Module\\Observer;\n\nuse Psr\\Log\\LoggerInterface;\nuse Magento\\Quote\\Model\\QuoteFactory;\nuse Vendor\\Module\\Model\\RuleFactory;\nuse Magento\\Store\\Model\\StoreManagerInterface;\nuse Magento\\Sales\\Model\\OrderFactory;\n\n\/**\n * Class OrderPlace\n * @package Vendor\\Module\\Observer\n *\/\nclass OrderPlace implements \\Magento\\Framework\\Event\\ObserverInterface\n{\n \/** @var LoggerInterface *\/\n protected $logger;\n\n \/** @var StoreManagerInterface *\/\n protected $_storeManager;\n\n \/** @var RuleFactory *\/\n protected $_ruleFactory;\n\n \/** @var QuoteFactory *\/\n protected $_quoteFactory;\n\n \/** @var OrderFactory *\/\n protected $_order;\n\n \/**\n * OrderPlace constructor.\n * \n * @param LoggerInterface $logger\n * @param QuoteFactory $quoteFactory\n * @param OrderFactory $_order\n * @param RuleFactory $ruleFactory\n * @param StoreManagerInterface $storeManager\n *\/\n public function __construct(\n QuoteFactory $quoteFactory,\n RuleFactory $ruleFactory,\n OrderFactory $_order,\n LoggerInterface $logger,\n StoreManagerInterface $storeManager\n ) {\n $this->logger = $logger;\n $this->_storeManager = $storeManager;\n $this->_ruleFactory = $ruleFactory;\n $this->_quoteFactory = $quoteFactory;\n $this->_order = $_order;\n }\n\n \/**\n * Execute observer\n *\n * @param \\Magento\\Framework\\Event\\Observer $observer\n *\/\n public function execute(\\Magento\\Framework\\Event\\Observer $observer)\n {\n try {\n $orderIds = $observer->getEvent()->getOrderIds();\n $orderId = $orderIds[0];\n $order = $this->_order->create()->load($orderId);\n\n \/\/ Load custom rule condition model\n $model = $this->_ruleFactory->create();\n\n \/\/ Load quote from quote ID\n $quoteId = $order->getQuoteId();\n $quote = $this->_quoteFactory->create()->load($quoteId);\n\n \/\/ Load address from quote for validation\n $address = $quote->getShippingAddress() ?: $quote->getBillingAddress();\n\n \/\/ Load quote items for validation\n $items = $quote->getAllItems();\n\n \/\/ Get all rules from the custom rule table\n $ruleData = $model->getCollection();\n\n foreach ($ruleData as $rule) {\n \/\/ Validate address and items using custom rule\n $validate = $rule->validate($address, $items);\n\n \/\/ Add your code based on validate true or false\n }\n\n return true;\n } catch (\\Exception $e) {\n $this->logger->info($e->getMessage());\n }\n }\n}\n<\/pre>\n\n\n\nVendor<\/code> and Module<\/code> names in the above code.<\/p>\n\n\n\n