Feature: Withdraw charges

assets/src/js/withdraw.js

@@ -26,13 +26,38 @@
             $("input[name='withdraw-schedule']").on( 'change', (e) => {
                 Dokan_Withdraw.handleScheduleChange( e );
             });
+
+            $( "[name='withdraw_method'][id='withdraw-method']" ).on( 'change', ( e ) => {
+                Dokan_Withdraw.calculateWithdrawCharges();
+            } );
+
+            $( 'input#withdraw-amount' ).on( 'keyup', Dokan_Withdraw.debounce( Dokan_Withdraw.calculateWithdrawCharges, 500 ) );
+        },
+
+        debounce( func, wait, immediate ) {
+            var timeout;
+            return function () {
+                var context = this,
+                    args = arguments;
+                var later = function () {
+                    timeout = null;
+                    if ( ! immediate ) func.apply( context, args );
+                };
+                var callNow = immediate && ! timeout;
+                clearTimeout( timeout );
+                timeout = setTimeout( later, wait );
+                if ( callNow ) func.apply( context, args );
+            };
         },
         openRequestWithdrawWindow: () => {
             const withdrawTemplate = wp.template( 'withdraw-request-popup' ),
                 modal = $( '#dokan-withdraw-request-popup' ).iziModal( {
                     width       : 690,
                     overlayColor: 'rgba(0, 0, 0, 0.8)',
                     headerColor : dokan.modal_header_color,
+                    onOpening   : function ( modal ) {
+                        Dokan_Withdraw.calculateWithdrawCharges();
+                    },
                 } );
 
             modal.iziModal( 'setContent', withdrawTemplate().trim() );
@@ -200,6 +225,89 @@
             const nextDate = $(e.target).data('next-schedule');
             $( '#dokan-withdraw-next-scheduled-date').html(nextDate);
         },
+        calculateWithdrawCharges: () => {
+            let charges = $( "select[name='withdraw_method'][id='withdraw-method'] option:selected" ).data();
+            if (
+                $( '#dokan-send-withdraw-request-popup-form > .dokan-alert-danger' ).length
+                || ! charges
+            ) {
+                return;
+            }
+
+            let withdrawMethod = $(
+                "[name='withdraw_method'][id='withdraw-method']"
+            ).val();
+            let withdrawAmount = $(
+                "[name='withdraw_amount'][id='withdraw-amount']"
+            ).val();
+            withdrawAmount = accounting.unformat(
+                withdrawAmount,
+                dokan_refund.mon_decimal_point
+            );
+            let { chargePercentage, chargeFixed } = $(
+                "select[name='withdraw_method'][id='withdraw-method'] option:selected"
+            ).data();
+            let chargeAmount = 0;
+            let nonce = $( '#dokan_withdraw_charge_nonce' ).val();
+
+            $.post(
+                dokan.ajaxurl,
+                {
+                    action: 'dokan_handle_get_withdraw_method_charge',
+                    dokan_withdraw_charge_nonce: nonce,
+                    method: withdrawMethod,
+                    amount: withdrawAmount,
+                },
+                ( response ) => {
+                    let data = response.data ? response.data : {};
+                    Dokan_Withdraw.showWithdrawChargeHtml( data );
+
+                    $( '#dokan-withdraw-request-submit' ).attr(
+                        'disabled',
+                        ! response.success
+                    );
+                }
+            );
+        },
+
+        showWithdrawChargeHtml( chargeData ) {
+            let chargeSection = $( '#dokan-withdraw-charge-section' );
+            let revivableSection = $( '#dokan-withdraw-revivable-section' );
+
+            if ( ! chargeData.plain || ! chargeData.plain.charge ) {
+                chargeSection.hide();
+                revivableSection.hide();
+
+                return;
+            }
+
+            let chargeText = '';
+
+            if (
+                chargeData.plain.charge_data &&
+                chargeData.plain.charge_data.fixed
+            ) {
+                chargeText += `${ chargeData.html.charge_data.fixed }`;
+            }
+
+            if (
+                chargeData.plain.charge_data &&
+                chargeData.plain.charge_data.percentage
+            ) {
+                chargeText += chargeText ? ' + ' : '';
+                chargeText += `${ chargeData.html.charge_data.percentage }`;
+                chargeText += ` = ${ chargeData.html.charge }`;
+            }
+
+            $( '#dokan-withdraw-charge-section-text' ).html( chargeText );
+
+            $( '#dokan-withdraw-revivable-section-text' ).html(
+                chargeData.plain.receivable ? chargeData.html.receivable : ''
+            );
+
+            chargeSection.show();
+            revivableSection.show();
+        },
     };
 
     $(document).ready(function() {

dokan.php

@@ -50,6 +50,7 @@
  * @class WeDevs_Dokan The class that holds the entire WeDevs_Dokan plugin
  *
  * @property WeDevs\Dokan\BackgroundProcess\Manager $bg_process Instance of WeDevs\Dokan\BackgroundProcess\Manager class
+ * @property WeDevs\Dokan\Withdraw\Manager $withdraw Instance of WeDevs\Dokan\Withdraw\Manager class
  */
 final class WeDevs_Dokan {
 

includes/Admin/Settings.php

@@ -319,7 +319,7 @@ public function get_settings_sections() {
                 'description'          => __( 'Withdraw Settings, Threshold', 'dokan-lite' ),
                 'document_link'        => 'https://wedevs.com/docs/dokan/settings/withdraw-options/',
                 'settings_title'       => __( 'Withdraw Settings', 'dokan-lite' ),
-                'settings_description' => __( 'You can configure your store\'s withdrawal methods, limits, order status and more.', 'dokan-lite' ),
+                'settings_description' => __( 'You can configure your store\'s withdrawal methods, charges, limits, order status and more.', 'dokan-lite' ),
             ],
             [
                 'id'                   => 'dokan_reverse_withdrawal',
@@ -587,6 +587,24 @@ public function get_settings_fields() {
                     'options' => dokan_withdraw_get_methods(),
                     'tooltip' => __( 'Check to add available payment methods for vendors to withdraw money.', 'dokan-lite' ),
                 ],
+                'withdraw_charges'      => [
+                    'name'               => 'withdraw_charges',
+                    'label'              => __( 'Withdraw Charges', 'dokan-lite' ),
+                    'desc'               => __( 'Select suitable withdraw charges for vendors', 'dokan-lite' ),
+                    'type'               => 'charges',
+                    'options'            => dokan_withdraw_get_methods(),
+                    'chargeable_methods' => dokan_withdraw_get_chargeable_methods(),
+                    'default'            => dokan_withdraw_get_method_charges(),
+                    'show_if'            => [
+                        'withdraw_methods' => [
+                            'contains-any' => array_keys( dokan_withdraw_get_methods() ),
+                        ],
+                    ],
+                    'items_show_if'      => [
+                        'key'       => 'withdraw_methods',
+                        'condition' => 'contains-key-value',
+                    ],
+                ],
                 'withdraw_limit'        => [
                     'name'                       => 'withdraw_limit',
                     'label'                      => __( 'Minimum Withdraw Limit', 'dokan-lite' ),

includes/Assets.php

@@ -482,7 +482,7 @@ public function get_scripts() {
             ],
             'dokan-script'              => [
                 'src'     => $asset_url . '/js/dokan.js',
-                'deps'    => [ 'imgareaselect', 'customize-base', 'customize-model', 'dokan-i18n-jed', 'jquery-tiptip', 'moment', 'dokan-date-range-picker' ],
+                'deps'    => [ 'imgareaselect', 'customize-base', 'customize-model', 'dokan-i18n-jed', 'jquery-tiptip', 'moment', 'dokan-date-range-picker', 'dokan-accounting' ],
                 'version' => filemtime( $asset_path . 'js/dokan.js' ),
             ],
             'dokan-vue-vendor'          => [

includes/Dashboard/Templates/Withdraw.php

@@ -434,13 +434,16 @@ public function withdraw_dashboard_layout_display() {
             return;
         }
 
+        /**
+         * @var $last_withdraw \WeDevs\Dokan\Withdraw\Withdraw[]
+         */
         $last_withdraw = dokan()->withdraw->get_withdraw_requests( dokan_get_current_user_id(), 1, 1 );
         $payment_details = __( 'You do not have any approved withdraw yet.', 'dokan-lite' );
 
         if ( ! empty( $last_withdraw ) ) {
-            $last_withdraw_amount      = '<strong>' . wc_price( $last_withdraw[0]->amount ) . '</strong>';
-            $last_withdraw_date        = '<strong><em>' . dokan_format_date( $last_withdraw[0]->date ) . '</em></strong>';
-            $last_withdraw_method_used = '<strong>' . dokan_withdraw_get_method_title( $last_withdraw[0]->method ) . '</strong>';
+            $last_withdraw_amount      = '<strong>' . wc_price( $last_withdraw[0]->get_amount() ) . '</strong>';
+            $last_withdraw_date        = '<strong><em>' . dokan_format_date( $last_withdraw[0]->get_date() ) . '</em></strong>';
+            $last_withdraw_method_used = '<strong>' . dokan_withdraw_get_method_title( $last_withdraw[0]->get_method() ) . '</strong>';
 
             // translators: 1: Last formatted withdraw amount 2: Last formatted withdraw date 3: Last formatted withdraw method used.
             $payment_details = sprintf( __( '%1$s on %2$s to %3$s', 'dokan-lite' ), $last_withdraw_amount, $last_withdraw_date, $last_withdraw_method_used );
@@ -502,9 +505,10 @@ public function withdraw_request_popup_form_content() {
         $default_withdraw_method = dokan_withdraw_get_default_method( $current_user_id );
         dokan_get_template_part(
             'withdraw/request-form', '', array(
-				'amount'          => NumberUtil::round( $balance, wc_get_price_decimals(), PHP_ROUND_HALF_DOWN ), // we are setting 12.3456 to 12.34 not 12.35
-				'withdraw_method' => $default_withdraw_method,
-				'payment_methods' => $payment_methods,
+				'amount'           => NumberUtil::round( $balance, wc_get_price_decimals(), PHP_ROUND_HALF_DOWN ), // we are setting 12.3456 to 12.34 not 12.35
+				'withdraw_method'  => $default_withdraw_method,
+				'payment_methods'  => $payment_methods,
+                'withdraw_charges' => dokan_withdraw_get_method_charges(),
             )
         );
     }

includes/REST/WithdrawController.php

@@ -4,6 +4,7 @@
 
 use Exception;
 use WeDevs\Dokan\Cache;
+use WeDevs\Dokan\Withdraw\Withdraw;
 use WP_Error;
 use WP_REST_Controller;
 use WP_REST_Request;
@@ -115,6 +116,43 @@ public function register_routes() {
 				'schema' => [ $this, 'get_public_batch_schema' ],
 			]
         );
+
+        register_rest_route(
+            $this->namespace, '/' . $this->rest_base . '/charges', [
+                [
+                    'methods'             => WP_REST_Server::READABLE,
+                    'callback'            => [ $this, 'get_all_method_charges' ],
+                    'permission_callback' => [ $this, 'get_items_permissions_check' ],
+                ],
+            ]
+        );
+
+        $methods = array_keys( dokan_withdraw_get_methods() );
+
+        register_rest_route(
+            $this->namespace, '/' . $this->rest_base . '/charge', [
+                [
+                    'methods'             => WP_REST_Server::READABLE,
+                    'callback'            => [ $this, 'get_method_charge' ],
+                    'permission_callback' => [ $this, 'get_items_permissions_check' ],
+                    'args'                => [
+                        'method' => [
+                            'description' => __( 'Withdraw method key', 'dokan-lite' ),
+                            'type'        => 'string',
+                            'context'     => [ 'view' ],
+                            'enum'        => $methods,
+                            'required'    => true,
+                        ],
+                        'amount' => [
+                            'description' => __( 'Withdraw amount', 'dokan-lite' ),
+                            'type'        => 'number',
+                            'context'     => [ 'view' ],
+                            'required'    => true,
+                        ],
+                    ],
+                ],
+            ]
+        );
     }
 
     /**
@@ -350,29 +388,37 @@ public function create_item( $request ) {
                 throw new DokanException( 'dokan_rest_withdraw_error', __( 'No vendor found', 'dokan-lite' ), 404 );
             }
 
-            $args = [
-                'user_id' => $user_id,
-                'amount'  => $request['amount'],
-                'date'    => current_time( 'mysql' ),
-                'method'  => $request['method'],
-                'note'    => $note,
-                'ip'      => dokan_get_client_ip(),
-            ];
-
             if ( dokan()->withdraw->has_pending_request( $user_id ) ) {
                 throw new DokanException( 'dokan_rest_withdraw_error', __( 'You already have a pending withdraw request', 'dokan-lite' ), 400 );
             }
 
-            $validate_request = dokan()->withdraw->is_valid_approval_request( $args );
+            $validate_request = dokan()->withdraw->is_valid_approval_request(
+                [
+					'user_id' => $user_id,
+					'amount'  => $request['amount'],
+					'method'  => $request['method'],
+				]
+            );
 
             if ( is_wp_error( $validate_request ) ) {
                 throw new DokanException( 'dokan_rest_withdraw_error', $validate_request->get_error_message(), 400 );
             }
 
-            $withdraw = dokan()->withdraw->create( $args );
+            $withdraw = new Withdraw();
 
-            if ( is_wp_error( $withdraw ) ) {
-                throw new DokanException( $withdraw->get_error_code(), $withdraw->get_error_message(), 400 );
+            $withdraw
+                ->set_user_id( $user_id )
+                ->set_amount( $request['amount'] )
+                ->set_date( current_time( 'mysql' ) )
+                ->set_status( dokan()->withdraw->get_status_code( 'pending' ) )
+                ->set_method( $request['method'] )
+                ->set_ip( dokan_get_client_ip() )
+                ->set_note( $note );
+
+            $result = $withdraw->save();
+
+            if ( is_wp_error( $result ) ) {
+                throw new DokanException( $result->get_error_code(), $result->get_error_message(), 400 );
             }
 
             $response = $this->prepare_item_for_response( $withdraw, $request );
@@ -612,11 +658,61 @@ public function batch_items( $request ) {
         );
     }
 
+    /**
+     * Get all withdraw method charges.
+     *
+     * @since DOKAN_SINCE
+     *
+     * @return WP_Error|\WP_HTTP_Response|WP_REST_Response
+     */
+    public function get_all_method_charges() {
+        $all_charges = dokan_withdraw_get_method_charges();
+
+        return rest_ensure_response( $all_charges );
+    }
+
+    /**
+     * Get withdraw method charge.
+     *
+     * @since DOKAN_SINCE
+     *
+     * @return WP_Error|\WP_HTTP_Response|WP_REST_Response
+     */
+    public function get_method_charge( $request ) {
+        $method = $request->get_param( 'method' );
+        $amount = wc_format_decimal( $request->get_param( 'amount' ) );
+
+        $withdraw = new Withdraw();
+
+        $withdraw->set_method( $method )
+                ->set_amount( $amount )
+                ->calculate_charge();
+
+        $response = [
+            'charge'      => $withdraw->get_charge(),
+            'receivable'  => $withdraw->get_receivable_amount(),
+            'charge_data' => $withdraw->get_charge_data(),
+        ];
+
+        if ( $withdraw->get_receivable_amount() < 0 ) {
+            return new WP_Error(
+                'invalid-withdraw-amount',
+                __( 'Invalid withdraw amount. The withdraw charge is greater than the withdraw amount', 'dokan-lite' ),
+                $response
+            );
+        }
+
+        return rest_ensure_response( $response );
+    }
+
     /**
      * Prepare data for response
      *
      * @since 2.8.0
      *
+     * @param $withdraw \WeDevs\Dokan\Withdraw\Withdraw
+     * @param $request \WP_REST_Request
+     *
      * @return WP_REST_Response|WP_Error
      */
     public function prepare_item_for_response( $withdraw, $request ) {
@@ -645,6 +741,9 @@ public function prepare_item_for_response( $withdraw, $request ) {
             'note'         => $withdraw->get_note(),
             'details'      => $details,
             'ip'           => $withdraw->get_ip(),
+            'charge'       => $withdraw->get_charge(),
+            'receivable'   => $withdraw->get_receivable_amount(),
+            'charge_data'  => $withdraw->get_charge_data(),
         ];
 
         $response = rest_ensure_response( $data );