Added mall.cart.extendAvailablePaymentMethods event

Author: verenaroe

components/PaymentMethodSelector.php

@@ -257,7 +257,7 @@ protected function setData()
 
         $method = PaymentMethod::where('id', $this->order->payment_method_id ?? $this->cart->payment_method_id)->first();
 
-        $this->setVar('methods', PaymentMethod::orderBy('sort_order', 'ASC')->get());
+        $this->setVar('paymentMethods', PaymentMethod::getAvailableByCart($this->cart));
         $this->setVar('customerMethods', $this->getCustomerMethods());
         $this->setVar('activeMethod', $method);
         $this->setVar('shippingSelectionBeforePayment', GeneralSettings::get('shipping_selection_before_payment', false));	// Needed by themes

components/QuickCheckout.php

@@ -505,7 +505,9 @@ protected function setData()
             $paymentMethod = PaymentMethod::getDefault();
             $cart->setPaymentMethod($paymentMethod);
         }
-        $this->setVar('paymentMethods', PaymentMethod::orderBy('sort_order', 'ASC')->get());
+
+        $this->setVar('paymentMethods', PaymentMethod::getAvailableByCart($cart));
+
         $this->setVar('customerPaymentMethods', $this->getCustomerMethods());
 
         //        $this->setVar('dataLayer', $this->handleDataLayer());

docs/.vitepress/config.mts

@@ -18,7 +18,7 @@ export default defineConfig({
         },
         siteTitle: false,
         editLink: {
-            pattern: 'https://github.com/OFFLINE-GmbH/oc-mall-plugin/edit/develop/src/docs/:path',
+            pattern: 'https://github.com/OFFLINE-GmbH/oc-mall-plugin/tree/next/docs/:path',
             text: 'Edit this page on GitHub'
         },
         lastUpdated: {

docs/development/core/events.md

@@ -81,6 +81,10 @@ This event is emitted when the quantity of a cart product has changed. It receiv
 * `oldQuantity` the old quantity value 
 * `newQuantity` the new quantity value 
 
+### `mall.cart.extendAvailablePaymentMethods`
+
+This event allows to customize the payment methods based on the current cart.
+
 ## Checkout
 
 ### `mall.checkout.succeeded`

models/PaymentMethod.php

@@ -15,6 +15,7 @@
 use October\Rain\Database\Traits\Sortable;
 use October\Rain\Database\Traits\Validation;
 use October\Rain\Parse\Twig;
+use October\Rain\Support\Facades\Event;
 use OFFLINE\Mall\Classes\Database\IsStates;
 use OFFLINE\Mall\Classes\Payments\PaymentGateway;
 use OFFLINE\Mall\Classes\Totals\PaymentTotal;
@@ -206,6 +207,21 @@ public static function getDefault(): ?self
         return $default;
     }
 
+    /**
+     * Get all available payment methods.
+     * @param Cart $cart
+     * @return mixed
+     */
+    public static function getAvailableByCart(Cart $cart)
+    {
+        $results = array_filter(Event::fire('mall.cart.extendAvailablePaymentMethods', [$cart]) ?? []);
+        if (count($results) > 0) {
+            return $results[0];
+        }
+
+        return PaymentMethod::orderBy('sort_order', 'ASC')->get();
+    }
+
     /**
      * Include all payment methods, even disabled ones.
      * @param Builder $query