From fac56cf17485de18ccbf934b9c47bd4799b187b2 Mon Sep 17 00:00:00 2001
From: Nathaniel Hammond <nathaniel@pixelandtonic.com>
Date: Tue, 24 Sep 2024 09:56:20 +0100
Subject: [PATCH] =?UTF-8?q?Added=20=E2=80=9CVariant=20Search=E2=80=9D=20co?=
 =?UTF-8?q?ndition=20rule=20for=20product=20conditions=20#3689?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 CHANGELOG-WIP.md                              | 10 +-
 .../conditions/products/ProductCondition.php  |  1 +
 .../ProductVariantSearchConditionRule.php     | 93 +++++++++++++++++++
 src/translations/en/commerce.php              |  1 +
 4 files changed, 104 insertions(+), 1 deletion(-)
 create mode 100644 src/elements/conditions/products/ProductVariantSearchConditionRule.php

diff --git a/CHANGELOG-WIP.md b/CHANGELOG-WIP.md
index b89120d813..c192e19d5d 100644
--- a/CHANGELOG-WIP.md
+++ b/CHANGELOG-WIP.md
@@ -1,3 +1,11 @@
 # Release Notes for Craft Commerce 4.7 (WIP)
 
-## Unreleased
+### Store Management
+- Product conditions can now have a “Variant Search” rule. ([#3689](https://github.com/craftcms/commerce/issues/3689))
+
+### Administration
+
+### Development
+
+### Extensibility
+- Added `craft\commerce\elements\conditions\products\ProductVariantSearchConditionRule`.
\ No newline at end of file
diff --git a/src/elements/conditions/products/ProductCondition.php b/src/elements/conditions/products/ProductCondition.php
index e00df945cf..ff1a5c772d 100644
--- a/src/elements/conditions/products/ProductCondition.php
+++ b/src/elements/conditions/products/ProductCondition.php
@@ -25,6 +25,7 @@ protected function conditionRuleTypes(): array
     {
         return array_merge(parent::conditionRuleTypes(), [
             ProductTypeConditionRule::class,
+            ProductVariantSearchConditionRule::class,
             ProductVariantSkuConditionRule::class,
             ProductVariantStockConditionRule::class,
             ProductVariantHasUnlimitedStockConditionRule::class,
diff --git a/src/elements/conditions/products/ProductVariantSearchConditionRule.php b/src/elements/conditions/products/ProductVariantSearchConditionRule.php
new file mode 100644
index 0000000000..cfa31155b5
--- /dev/null
+++ b/src/elements/conditions/products/ProductVariantSearchConditionRule.php
@@ -0,0 +1,93 @@
+<?php
+/**
+ * @link https://craftcms.com/
+ * @copyright Copyright (c) Pixel & Tonic, Inc.
+ * @license https://craftcms.github.io/license/
+ */
+
+namespace  craft\commerce\elements\conditions\products;
+
+use Craft;
+use craft\base\conditions\BaseTextConditionRule;
+use craft\base\ElementInterface;
+use craft\commerce\elements\db\ProductQuery;
+use craft\commerce\elements\Product;
+use craft\commerce\elements\Variant;
+use craft\elements\conditions\ElementConditionRuleInterface;
+use craft\elements\db\ElementQueryInterface;
+use craft\helpers\ArrayHelper;
+use yii\base\InvalidConfigException;
+
+/**
+ * Product Variant Search Condition Rule
+ *
+ * @author Pixel & Tonic, Inc. <support@pixelandtonic.com>
+ * @since 4.7.0
+ */
+class ProductVariantSearchConditionRule extends BaseTextConditionRule implements ElementConditionRuleInterface
+{
+    /**
+     * @inheritdoc
+     */
+    public function getLabel(): string
+    {
+        return Craft::t('commerce', 'Variant Search');
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getExclusiveQueryParams(): array
+    {
+        return [];
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function operators(): array
+    {
+        return [];
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function paramValue(): ?string
+    {
+        return trim(parent::paramValue()); // TODO: Change the autogenerated stub
+    }
+
+    /**
+     * @param ElementQueryInterface $query
+     */
+    public function modifyQuery(ElementQueryInterface $query): void
+    {
+        $variantQuery = Variant::find();
+        $variantQuery->select(['commerce_variants.productId as id']);
+        $variantQuery->search($this->paramValue());
+
+        /** @var ProductQuery $query */
+        $query->andWhere(['elements.id' => $variantQuery]);
+    }
+
+    /**
+     * @param Product $element
+     * @return bool
+     * @throws InvalidConfigException
+     */
+    public function matchElement(ElementInterface $element): bool
+    {
+        $variantIds = ArrayHelper::getColumn($element->getVariants(), 'id');
+        if (empty($variantIds)) {
+            return false;
+        }
+
+        // Perform a variant query search to ensure it is the same process as `modifyQuery`
+        $variantQuery = Variant::find();
+        $variantQuery->search($this->paramValue());
+        $variantQuery->id($variantIds);
+
+        return $variantQuery->count() > 0;
+    }
+}
diff --git a/src/translations/en/commerce.php b/src/translations/en/commerce.php
index 9a5f6e4491..ee64b359a3 100644
--- a/src/translations/en/commerce.php
+++ b/src/translations/en/commerce.php
@@ -1120,6 +1120,7 @@
     'Variant Has Unlimited Stock' => 'Variant Has Unlimited Stock',
     'Variant Price' => 'Variant Price',
     'Variant SKU' => 'Variant SKU',
+    'Variant Search' => 'Variant Search',
     'Variant Stock' => 'Variant Stock',
     'Variant Title Format' => 'Variant Title Format',
     'Variants' => 'Variants',