Gateway.

*

* @version 1.0.0

* @package Storeengine

*/

namespace Storeengine;

use Exception;

use StoreEngine\Classes\Exceptions\StoreEngineException;

use StoreEngine\Classes\Exceptions\StoreEngineInvalidOrderStatusException;

use StoreEngine\Classes\Exceptions\StoreEngineInvalidOrderStatusTransitionException;

use StoreEngine\Classes\Order;

use StoreEngine\Classes\OrderContext;

use StoreEngine\Classes\OrderStatus\OrderStatus;

use StoreEngine\Payment\Gateways\PaymentGateway;

use StoreEngine\Utils\Formatting;

use StoreEngine\Utils\Helper;

use WP_Error;

if ( ! defined( ‘ABSPATH’ ) ) {

exit;

}

final class Gateway extends PaymentGateway {

public int $index = 1;

public function __construct() {

$this->setup();

$this->init_admin_fields();

$this->init_settings();

$this->title = $this->get_option( ‘title’ );

$this->description = $this->get_option( ‘description’ );

// While loading StoreEngine triggers separate gateway init hook, for each gateway with the

// reference of the gateway instance as only argument, so developer can hook into the process

// after initializing the gateway class and do things…

// add_action( ‘storeengine/gateway/’ . $this->id . ‘/init’, [ $this, ‘init’ ] );

// See the class-plugin.php example file.

}

protected function setup() {

// Id must be unique to this gateway.

// This will be used for saving the config data in options table as serialized array.

// Option key will be storeengine_payment__settings

$this->id = ‘’;

$this->icon = SE_GATEWAY__PLUGIN_URL . ‘/assets/images/icon.svg’;

// Title/description for admin interface.

$this->method_title = __( ‘’, ‘’ );

$this->method_description = __( ‘ works by adding payment fields on the checkout and then sending the details to  for verification.’, ‘’ );

// Checkout page field flag.

$this->has_fields = true;

// Verify config flag to run verify_config method while updating gateway settings from admin dashboard.

$this->verify_config = true;

// This can be [‘products’, ‘refund’,’subscriptions’,…] see the stripe addon.

$this->supports = [ ‘products’, ‘refunds’, ];

}

 

/**

* Loads field config for admin interface.

* This data will be used for rendering the gateway settings interface with react

* in admin-dashboard `StoreEngine ➔ Settings ➔ Payment Methods.`

*

* Field key will be used for storing the value as key=>value pair serialized array in options table

*

* Allowed field types: safe_text, text, textarea, password & checkbox. With special type `repeater` allowing all

* 5 types of filed as children

* Each field can have label (string), type (string), tooltip (string), default (bool|string|int|float), priority (int) data.

* Repeater should include the children in `fields` array and follow the same key=>field config.

* Default for repeater should be an array with the field keys.

*

* @return void

*/

protected function init_admin_fields() {

$this->admin_fields = [

‘title’ => [

‘label’ => __( ‘Title’, ‘’ ),

‘type’ => ‘safe_text’,

‘tooltip’ => __( ‘Payment method description that the customer will see on your checkout.’, ‘’ ),

‘default’ => __( ‘ Payment Gateway’, ‘’ ),

],

‘description’ => [

‘label’ => __( ‘Description’, ‘’ ),

‘type’ => ‘textarea’,

‘tooltip’ => __( ‘Payment method description that the customer will see on your website.’, ‘’ ),

‘default’ => __( ‘Pay with .’, ‘’ ),

],

‘is_production’ => [

‘label’ => __( ‘Is Live Mode?’, ‘’ ),

‘tooltip’ => __( ‘Enable  Live (Production) Mode.’, ‘’ ),

‘type’ => ‘checkbox’,

‘default’ => true,

],

‘api_key’ => [

‘label’ => __( ‘Application Key’, ‘’ ),

‘type’ => ‘text’,

‘tooltip’ => __( ‘Get your app Key from your  account.’, ‘’ ),

‘dependency’ => [ ‘is_production’ => true ],

‘autocomplete’ => ‘none’,

‘required’ => true,

],

‘api_secret’ => [

‘label’ => __( ‘Application Secret’, ‘’ ),

‘type’ => ‘password’,

‘tooltip’ => __( ‘Get your app Secret from your  account.’, ‘’ ),

‘dependency’ => [ ‘is_production’ => true ],

‘autocomplete’ => ‘none’,

‘required’ => true,

],

‘test_api_key’ => [

‘label’ => __( ‘Application Key (Sandbox)’, ‘’ ),

‘type’ => ‘text’,

‘tooltip’ => __( ‘Get your sandbox app Key from your  account.’, ‘’ ),

‘dependency’ => [ ‘is_production’ => false ],

‘autocomplete’ => ‘none’,

‘required’ => true,

],

‘test_api_secret’ => [

‘label’ => __( ‘Application Secret (Sandbox)’, ‘’ ),

‘type’ => ‘password’,

‘tooltip’ => __( ‘Get your sandbox app Secret from your  account.’, ‘’ ),

‘dependency’ => [ ‘is_production’ => false ],

‘autocomplete’ => ‘none’,

‘required’ => true,

],

‘a_checkbox’ => [

‘label’ => __( ‘A checkbox’, ‘’ ),

‘type’ => ‘checkbox’,

‘tooltip’ => __( ‘This is a checkbox.’, ‘’ ),

‘required’ => true,

‘default’ => true,

],

‘some_repeater’ => [

‘label’ => __( ‘Some repeater’, ‘’ ),

‘type’ => ‘repeater’,

‘fields’ => [

‘some_field’ => [

‘label’ => __( ‘Some-Field’, ‘’ ),

‘type’ => ‘string’,

‘tooltip’ => __( ‘Some-field\’s tooltip’, ‘’ ),

‘required’ => true,

],

‘other_field’ => [

‘label’ => __( ‘Other-Field’, ‘’ ),

‘type’ => ‘checkbox’,

‘tooltip’ => __( ‘Other-field\’s tooltip’, ‘’ ),

‘required’ => true,

]

],

‘default’ => [

[

‘some_field’ => ‘Some value’,

‘other_field’ => true,

],

],

],

];

}

/**

* Verify Config.

*

* @param array $config

*

* @return void

* @throws StoreEngineException

*/

public function verify_config( array $config ): void {

$is_production = $config[‘is_production’] ?? true;

if ( $is_production ) {

$api_key = $config[‘api_key’] ?? ”;

$api_secret = $config[‘api_secret’] ?? ”;

} else {

$api_key = $config[‘test_api_key’] ?? ”;

$api_secret = $config[‘test_api_secret’] ?? ”;

}

if ( ! $api_key ) {

throw new StoreEngineException( __( ‘ API key is required.’, ‘’ ), ‘api-key-is-required’, 400 );

}

if ( ! $api_secret ) {

throw new StoreEngineException( __( ‘ API secret key is required.’, ‘’ ), ‘api-secret-is-required’, 400 );

}

// Validate the credentials.

}

public function is_currency_supported( string $currency = null ): bool {

if ( ! $currency ) {

$currency = Formatting::get_currency();

}

return ‘BDT’ === $currency;

}

public function is_available(): bool {

if ( ! $this->is_currency_supported() ) {

return false;

}

return parent::is_available();

}

public function validate_minimum_order_amount( $order ) {

if ( $order->get_total() < 1 ) {

/* translators: 1) amount (including currency symbol) */

throw new StoreEngineException(

sprintf(

__( ‘Sorry, the minimum allowed order total is %1$s to use this payment method.’, ‘’ ),

Formatting::price( 1 )

),

‘did-not-meet-minimum-amount’

);

}

}

/**

* @param Order $order

*

* @return array|WP_Error

* @throws StoreEngineException

* @throws StoreEngineInvalidOrderStatusTransitionException

*/

public function process_payment( Order $order ) {

$payment_needed = $this->is_payment_needed( $order );

if ( $payment_needed ) {

$this->validate_minimum_order_amount( $order );

}

try {

$order_context = new OrderContext( $order->get_status() );

if ( $payment_needed ) {

$response = $this->call_gateway_api( $order, $order_context );

if ( is_wp_error( $response ) ) {

return $response;

}

} else {

$order->set_paid_status( ‘paid’ );

$order_context->proceed_to_next_status( ‘process_order’, $order, [ ‘note’ => _x( ‘Payment not needed.’, ‘bKash payment method’, ‘’ ) ] );

}

return [

‘result’ => ‘success’,

‘redirect’ => $order->get_checkout_order_received_url(),

];

} catch ( StoreEngineException $e ) {

$order->update_status(

OrderStatus::PAYMENT_FAILED,

/* translators: %s. Error details. */

sprintf( __( ‘Payment failed. Error: %s’, ‘’ ), $e->getMessage() )

);

throw $e;

} catch ( Exception $e ) {

$order->update_status(

OrderStatus::PAYMENT_FAILED,

/* translators: %s. Error details. */

sprintf( __( ‘Payment failed. Error: %s’, ‘’ ), $e->getMessage() )

);

throw new StoreEngineException( $e->getMessage(), ‘processing_error’, null, 0, $e );

}

}

protected function call_gateway_api( Order $order, OrderContext $order_context ) {

$response = (object) [

‘id’ => wp_generate_password(),

];

try {

$rand = random_int( 1, 11 );

if ( $rand % 3 === 0 ) {

sleep( 2 );

$order->set_paid_status( ‘paid’ );

$order_context->proceed_to_next_status( ‘process_order’, $order, [

/* translators: transaction id */

‘note’ => sprintf( __( ‘bKash charge complete (Charge ID: %s)’, ‘’ ), $response->id ),

‘transaction_id’ => $response->id,

] );

$order->save();

} else if ( $rand % 2 === 0 ) {

return new WP_Error( ‘unable-to-process’, ‘Unable to process payment. Please try after sometime.’ );

} else {

if ( random_int( 3, 7 ) % 3 === 0 ) {

$order->set_transaction_id( $response->id ); // Save the transaction ID to link the order to the Stripe charge ID. This is to fix reviews that result in refund.

$order->set_paid_status( ‘on_hold’ );

// Keep the order on hold for admin review.

$order_context->proceed_to_next_status( ‘hold_order’, $order, [

‘note’ => __( ‘Payment required review.’, ‘’ ),

‘transaction_id’ => $response->id,

] );

}

throw new Exception( ‘Some Error from.’ );

}

} catch ( Exception $e ) {

Helper::log_error( $e );

$order->set_paid_status( ‘failed’ );

/* translators: %s. Error message. */

$order_context->proceed_to_next_status( ‘payment_failed’, $order, sprintf( __( ‘Error while capturing the payment. Error: %s’, ‘’ ), $e->getMessage() ) );

}

return $response;

}

/**

* Process refund via  API.

* @see Helper::create_refund()

* @see Helper::refund_payment()

* @see GatewayStripe::process_refund()

*

* @param int $order_id Order ID.

* @param float|string|null $amount Refund amount.

* @param string $reason Refund reason.

*

* @return bool|WP_Error True or false based on success, or a WP_Error object.

* @throws StoreEngineException

*/

public function process_refund( int $order_id, $amount = null, string $reason = ” ) {

return new WP_Error( ‘not-implemented’, __( ‘Feature not implemented’, ‘’ ) );

}

}