[5.x] Reports

.github/workflows/ci.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - '5.x'
+      - '5.4'
   pull_request:
 permissions:
   contents: read

CHANGELOG-WIP.md

@@ -0,0 +1,17 @@
+# Release Notes for Craft Commerce 5.4 (WIP)
+
+### Store Management
+- It is now possible to set a variant’s status from the Product Edit screen. ([#3953](https://github.com/craftcms/commerce/discussions/3953))
+- Added an Order condition builder to gateways. ([#3913](https://github.com/craftcms/commerce/discussions/3913))
+
+### Extensibility
+- Added `craft\commerce\base\Gateway::setOrderCondition()`.
+- Added `craft\commerce\base\Gateway::getOrderCondition()`.
+- Added `craft\commerce\base\Gateway::getConfig()`.
+- Added `craft\commerce\base\Gateway::hasOrderCondition()`.
+
+### System
+- Fixed a bug where gateway settings weren’t storing project config values consistently. ([#3941](https://github.com/craftcms/commerce/issues/3941))
+
+
+

CHANGELOG.md

@@ -1,10 +1,10 @@
 # Release Notes for Craft Commerce
 
-## Unreleased
+## 5.3.9 - 2025-04-15
 
-- Fixed a bug where the customer selection UI was being hidden on the Edit Order page. ([#3968](https://github.com/craftcms/commerce/issues/3968))
+- Fixed a bug where the customer selection menu on Edit Order pgaes could be hidden behind an address card. ([#3968](https://github.com/craftcms/commerce/issues/3968))
 - Fixed a PHP error that could occur when rendering a PDF. ([#3967](https://github.com/craftcms/commerce/issues/3967))
-- Fixed a bug where the account activation email template wasn’t always getting rendered in the correct site. 
+- Fixed a bug where account activation emails weren’t always getting rendered for the correct site. 
 
 ## 5.3.8 - 2025-04-02
 

src/Plugin.php

@@ -83,6 +83,7 @@
 use craft\commerce\services\Products;
 use craft\commerce\services\ProductTypes;
 use craft\commerce\services\Purchasables;
+use craft\commerce\services\Reports;
 use craft\commerce\services\Sales;
 use craft\commerce\services\ShippingCategories;
 use craft\commerce\services\ShippingMethods;
@@ -218,6 +219,7 @@ public static function config(): array
                 'productTypes' => ['class' => ProductTypes::class],
                 'products' => ['class' => Products::class],
                 'purchasables' => ['class' => Purchasables::class],
+                'reports' => ['class' => Reports::class],
                 'sales' => ['class' => Sales::class],
                 'shippingCategories' => ['class' => ShippingCategories::class],
                 'shippingMethods' => ['class' => ShippingMethods::class],
@@ -391,6 +393,13 @@ public function getCpNavItem(): ?array
             ];
         }
 
+        if ($userService->checkPermission('commerce-manageReporting')) {
+            $ret['subnav']['reporting'] = [
+                'label' => Craft::t('commerce', 'Reporting'),
+                'url' => 'commerce/reporting',
+            ];
+        }
+
         if (Craft::$app->getUser()->checkPermission('commerce-manageInventoryStockLevels')) {
             $ret['subnav']['inventory'] = [
                 'label' => Craft::t('commerce', 'Inventory'),
@@ -599,6 +608,7 @@ private function _registerPermissions(): void
 
                             ],
                         ],
+                        'commerce-manageReporting' => ['label' => Craft::t('commerce', 'Manage reporting')],
                         'commerce-manageSubscriptions' => ['label' => Craft::t('commerce', 'Manage subscriptions')],
                         'commerce-manageSubscriptionPlans' => ['label' => Craft::t('commerce', 'Manage subscription plans')],
                         'commerce-manageInventoryStockLevels' => ['label' => Craft::t('commerce', 'Manage inventory stock levels')],

src/base/Gateway.php

@@ -9,9 +9,13 @@
 
 use Craft;
 use craft\base\SavableComponent;
+use craft\commerce\elements\conditions\orders\DiscountOrderCondition;
+use craft\commerce\elements\conditions\orders\GatewayOrderCondition;
 use craft\commerce\elements\Order;
 use craft\commerce\models\payments\BasePaymentForm;
 use craft\commerce\models\Transaction;
+use craft\elements\conditions\ElementConditionInterface;
+use craft\helpers\Json;
 use craft\helpers\StringHelper;
 use craft\helpers\UrlHelper;
 
@@ -32,6 +36,12 @@ abstract class Gateway extends SavableComponent implements GatewayInterface
 {
     use GatewayTrait;
 
+    /**
+     * @var ElementConditionInterface|null
+     * @since 5.4.0
+     */
+    private ?ElementConditionInterface $_orderCondition = null;
+
     /**
      * Returns the name of this payment method.
      *
@@ -103,7 +113,7 @@ public function defineRules(): array
         $rules = parent::defineRules();
         $rules[] = [['paymentType', 'handle'], 'required'];
 
-        $rules[] = [['name', 'handle', 'paymentType', 'isFrontendEnabled', 'sortOrder'], 'safe'];
+        $rules[] = [['name', 'handle', 'paymentType', 'isFrontendEnabled', 'orderCondition', 'sortOrder'], 'safe'];
 
         return $rules;
     }
@@ -124,6 +134,10 @@ public function getPaymentConfirmationFormHtml(array $params): string
      */
     public function availableForUseWithOrder(Order $order): bool
     {
+        if ($this->hasOrderCondition() && !$this->getOrderCondition()->matchElement($order)) {
+            return false;
+        }
+
         return true;
     }
 
@@ -135,6 +149,16 @@ public function supportsPartialPayment(): bool
         return true;
     }
 
+    /**
+     * Returns true if this gateway has an order condition
+     *
+     * @since 5.4.0
+     */
+    public function hasOrderCondition(): bool
+    {
+        return $this->getOrderCondition()->getConditionRules() !== [];
+    }
+
     /**
      * Returns payment Form HTML
      */
@@ -157,4 +181,66 @@ public function transactionSupportsRefund(Transaction $transaction): bool
     {
         return true;
     }
+
+
+    /**
+     * Gets the order condition for this gateway
+     *
+     * @since 5.4.0
+     */
+    public function getOrderCondition(): ElementConditionInterface
+    {
+        /** @var DiscountOrderCondition $condition */
+        $condition = $this->_orderCondition ?? new GatewayOrderCondition();
+        $condition->mainTag = 'div';
+        $condition->name = 'orderCondition';
+
+        return $condition;
+    }
+
+    /**
+     * Sets the order condition for this gateway
+     *
+     * @since 5.4.0
+     */
+    public function setOrderCondition(ElementConditionInterface|string|array $condition): void
+    {
+        if (empty($condition)) {
+            $this->_orderCondition = null;
+            return;
+        }
+
+        if (is_string($condition)) {
+            $condition = Json::decodeIfJson($condition);
+        }
+
+        if (!$condition instanceof GatewayOrderCondition) {
+            $condition['class'] = GatewayOrderCondition::class;
+            /** @var GatewayOrderCondition $condition */
+            $condition = \Craft::$app->getConditions()->createCondition($condition);
+        }
+        $condition->forProjectConfig = true;
+
+        $this->_orderCondition = $condition;
+    }
+
+    /**
+     * @return array
+     * @since 5.4.0
+     */
+    public function getConfig(): array
+    {
+        $configData = [
+            'name' => $this->name,
+            'handle' => $this->handle,
+            'type' => get_class($this),
+            'settings' => $this->getSettings(),
+            'sortOrder' => ($this->sortOrder ?? 99),
+            'paymentType' => $this->paymentType,
+            'isFrontendEnabled' => $this->getIsFrontendEnabled(false),
+            'orderCondition' => $this->getOrderCondition()->getConfig(),
+        ];
+
+        return $configData;
+    }
 }