feat: Add refund support to Cash payment gateway and refactor initialization

Author: mralaminahamed

includes/Gateways/Cash.php

@@ -1,6 +1,8 @@
 <?php
 namespace WeDevs\WePOS\Gateways;
 
+use Automattic\WooCommerce\Enums\OrderInternalStatus;
+
 /**
 * Cash gateway payment for POS
 */
@@ -36,6 +38,9 @@ protected function setup_properties() {
         $this->method_title       = __( 'Cash', 'wepos' );
         $this->method_description = __( 'Have your customers pay with cash', 'wepos' );
         $this->has_fields         = false;
+        $this->supports           = array(
+            'refunds'
+        );
     }
 
     /**
@@ -118,4 +123,32 @@ public function process_payment( $order_id ) {
         );
     }
 
+    /**
+     * Process refund.
+     *
+     * If the gateway declares 'refunds' support, this will allow it to refund.
+     * a passed in amount.
+     *
+     * @param  int        $order_id Order ID.
+     * @param  float|null $amount Refund amount.
+     * @param  string     $reason Refund reason.
+     * @return bool|\WP_Error True or false based on success, or a WP_Error object.
+     */
+    public function process_refund( $order_id, $amount = null, $reason = '' ) {
+        $order = wc_get_order( $order_id );
+
+        if ( ! $this->can_refund_order( $order ) ) {
+            return new \WP_Error( 'error', __( 'Refund failed.', 'woocommerce' ) );
+        }
+
+        $order->add_order_note(
+        /* translators: 1: Refund amount, 2: Refund reason */
+            sprintf( __( 'Refunded %1$s - Reason: %2$s', 'woocommerce' ), $amount, $reason ) // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+        );
+
+        $order->update_status(OrderInternalStatus::REFUNDED );
+        $order->save();
+
+        return true;
+    }
  }

includes/Gateways/Manager.php

@@ -14,7 +14,7 @@ class Manager {
      */
     public function __construct() {
         add_action( 'plugins_loaded', [ $this, 'init_gateways' ], 11, 1 );
-        add_action( 'woocommerce_payment_gateways', [ $this, 'payment_gateways' ] );
+        add_filter( 'woocommerce_payment_gateways', [ $this, 'payment_gateways' ] );
     }
 
     /**

wepos.php

@@ -313,6 +313,7 @@ public function includes() {
     public function init_hooks() {
         add_action( 'init', [ $this, 'init_classes' ] );
         add_action( 'init', [ $this, 'localization_setup' ] );
+        add_action( 'wepos_loaded', [ $this, 'load_payment_gateways' ] );
     }
 
     /**
@@ -340,9 +341,6 @@ public function init_classes() {
         $this->container['common'] = new WeDevs\WePOS\Common();
         $this->container['rest']   = new WeDevs\WePOS\REST\Manager();
         $this->container['assets'] = new WeDevs\WePOS\Assets();
-
-        // Payment gateway manager
-        $this->container['gateways'] = new \WeDevs\WePOS\Gateways\Manager();
     }
 
     /**
@@ -354,6 +352,18 @@ public function localization_setup() {
         load_plugin_textdomain( 'wepos', false, dirname( plugin_basename( __FILE__ ) ) . '/languages/' );
     }
 
+    /**
+     * Load the payment gateways.
+     *
+     * @since WEPOS_SINCE
+     *
+     * @return void
+     */
+    public function load_payment_gateways() {
+        // Payment gateway manager
+        $this->container['gateways'] = new \WeDevs\WePOS\Gateways\Manager();
+    }
+
     /**
      * On WC init, include cart required files in REST request
      *