yiiviet\payment\BasePaymentGateway

Complexity

Total Complexity

30

Size/Duplication

Total Lines	358
Duplicated Lines	13.69 %

Coupling/Cohesion

Components	3
Dependencies	6

Test Coverage

Coverage

82.56%

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	8	2
	initSandboxEnvironment()	0	1	?
A	verifyRequestCommands()	0	17	4
A	purchase()	0	4	1
A	queryDR()	0	4	1
A	refund()	0	4	1
A	queryRefund()	0	4	1
A	verifyRequestPurchaseSuccess()	0	4	1
A	verifyRequestIPN()	0	4	1
A	verifyRequest()	7	34	5
	getVerifyRequestData()	0	1	?
A	verifiedRequest()	0	10	3
A	beforeRequest()	21	21	5
A	afterRequest()	21	21	5

<?php
/**
 * @link https://github.com/yiiviet/yii2-payment
 * @copyright Copyright (c) 2017 Yii Viet
 * @license [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
 */

namespace yiiviet\payment;

use Yii;
use ReflectionClass;

use GatewayClients\DataInterface;

use yii\base\InvalidArgumentException;
use yii\base\InvalidConfigException;

use vxm\gatewayclients\BaseGateway;
use vxm\gatewayclients\RequestEvent;
use vxm\gatewayclients\ResponseData;

/**
 * Lớp BasePaymentGateway thực thi mẫu trừu tượng [[PaymentGatewayInterface]] giúp cho việc xây dựng các lợp thực thi được tối giản.
 *
 * @property BasePaymentClient $client
 * @property BasePaymentClient $defaultClient
 *
 * @author Vuong Minh <vuongxuongminh@gmail.com>
 * @since 1.0
 */
abstract class BasePaymentGateway extends BaseGateway implements PaymentGatewayInterface
{
    /**
     * Lệnh `purchase` sử dụng cho việc khởi tạo truy vấn thanh toán.
     */
    const RC_PURCHASE = 'purchase';

    /**
     * Lệnh `queryDR` sử dụng cho việc truy vấn thông tin giao dịch.
     */
    const RC_QUERY_DR = 'queryDR';

    /**
     * Lệnh `refund` sử dụng cho việc tạo [[request()]] yêu cầu hoàn trả tiền.
     */
    const RC_REFUND = 'refund';

    /**
     * Lệnh `queryRefund` sử dụng cho việc tạo [[request()]] để kiểm tra trang thái của lệnh `refund` đã tạo.
     */
    const RC_QUERY_REFUND = 'queryRefund';

    /**
     * Lệnh `purchaseSuccess` sử dụng cho việc yêu cấu xác thực tính hợp lệ
     * của dữ liệu khi khách hàng thanh toán thành công (cổng thanh toán redirect khách hàng về server).
     */
    const VRC_PURCHASE_SUCCESS = 'purchaseSuccess';

    /**
     * Lệnh `IPN` sử dụng cho việc yêu cấu xác thực tính hợp lệ
     * của dữ liệu khi khách hàng thanh toán thành công (cổng thanh toán bắn request về server).
     */
    const VRC_IPN = 'IPN';

    /**
     * @event RequestEvent được gọi khi dữ liệu truy vấn đã được xác thực.
     * Lưu ý sự kiện này luôn luôn được gọi khi xác thực dữ liệu truy vấn.
     */
    const EVENT_VERIFIED_REQUEST = 'verifiedRequest';

    /**
     * @event VerifiedRequestEvent được gọi khi dữ liệu truy vấn sau khi khách hàng thanh toán thành công,
     * được cổng thanh toán dẫn về hệ thống đã xác thực.
     */
    const EVENT_VERIFIED_REQUEST_PURCHASE_SUCCESS = 'verifiedRequestPurchaseSuccess';

    /**
     * @event VerifiedRequestEvent được gọi khi dữ liệu truy vấn sau khi khách hàng thanh toán thành công,
     * được cổng thanh toán bắn `request` sang hệ thống đã xác thực.
     */
    const EVENT_VERIFIED_REQUEST_IPN = 'verifiedRequestIPN';

    /**
     * @event RequestEvent được gọi trước khi khởi tạo lệnh [[RC_PURCHASE]] ở phương thức [[request()]].
     */
    const EVENT_BEFORE_PURCHASE = 'beforePurchase';

    /**
     * @event RequestEvent được gọi sau khi khởi tạo lệnh [[RC_PURCHASE]] ở phương thức [[request()]].
     */
    const EVENT_AFTER_PURCHASE = 'afterPurchase';

    /**
     * @event RequestEvent được gọi trước khi khởi tạo lệnh [[RC_QUERY_DR]] ở phương thức [[request()]].
     */
    const EVENT_BEFORE_QUERY_DR = 'beforeQueryDR';

    /**
     * @event RequestEvent được gọi sau khi khởi tạo lệnh [[RC_QUERY_DR]] ở phương thức [[request()]].
     */
    const EVENT_AFTER_QUERY_DR = 'afterQueryDR';

    /**
     * @event RequestEvent được gọi trước khi khởi tạo lệnh [[RC_REFUND]] ở phương thức [[request()]].
     * @since 1.0.3
     */
    const EVENT_BEFORE_REFUND = 'beforeRefund';

    /**
     * @event RequestEvent được gọi sau khi khởi tạo lệnh [[RC_REFUND]] ở phương thức [[request()]].
     * @since 1.0.3
     */
    const EVENT_AFTER_REFUND = 'afterRefund';

    /**
     * @event RequestEvent được gọi trước khi khởi tạo lệnh [[RC_QUERY_REFUND]] ở phương thức [[request()]].
     * @since 1.0.3
     */
    const EVENT_BEFORE_QUERY_REFUND = 'beforeQueryRefund';

    /**
     * @event RequestEvent được gọi sau khi khởi tạo lệnh [[RC_QUERY_REFUND]] ở phương thức [[request()]].
     * @since 1.0.3
     */
    const EVENT_AFTER_QUERY_REFUND = 'afterQueryRefund';

    /**
     * @var bool nếu là môi trường test thì thiết lập là TRUE và ngược lại.
     */
    public $sandbox = false;

    /**
     * @var array
     */
    public $verifiedDataConfig = [];

    /**
     * @inheritdoc
     */
    public function init()
    {
        if ($this->sandbox) {
            $this->initSandboxEnvironment();
        }

        parent::init();
    }

    /**
     * Phương thức khởi tạo môi trường thử nghiệm.
     * Nó chỉ được gọi khi thuộc tính `sandbox` được thiết lập là TRUE.
     */
    abstract protected function initSandboxEnvironment();

    /**
     * Thuộc tính để cache lại tiến trình của [[verifyRequestCommands()]] nhầm tối ưu tốc độ khi gọi nhiều lần.
     *
     * @see verifyRequestCommands
     * @var array
     */
    private $_verifyRequestCommands;

    /**
     * Phương thức này tự động thu thập các lệnh xác thực thông qua các hằng được khai bảo bằng tiền tố `VRC_`.
     * `VRC` có nghĩa là Verify Request Command.
     *
     * @inheritdoc
     * @throws \ReflectionException
     */
    public function verifyRequestCommands(): array
    {
        if ($this->_verifyRequestCommands === null) {
            $reflection = new ReflectionClass($this);

            $commands = [];
            foreach ($reflection->getConstants() as $name => $value) {
                if (strpos($name, 'VRC_') === 0) {
                    $commands[] = $value;
                }
            }

            return $this->_verifyRequestCommands = $commands;
        } else {
            return $this->_verifyRequestCommands;
        }
    }

    /**
     * Phương thức này là phương thức ánh xạ của [[request()]] nó sẽ tạo lệnh [[RC_PURCHASE]] để tạo yêu cầu giao dịch tới cổng thanh toán.
     *
     * @param array $data dữ liệu dùng để yêu cầu tạo giao dịch thanh toán bên trong thường có giá tiền, địa chỉ giao hàng...
     * @param string|int $clientId PaymentClient id dùng để tạo yêu cầu thanh toán.
     * @return ResponseData|DataInterface Phương thức sẽ trả về mẫu trừu tượng [[DataInterface]] để lấy thông tin trả về từ cổng thanh toán.
     * @throws InvalidConfigException|\ReflectionException
     */
    public function purchase(array $data, $clientId = null): DataInterface
    {
        return $this->request(self::RC_PURCHASE, $data, $clientId);
    }

    /**
     * Phương thức này là phương thức ánh xạ của [[request()]] nó sẽ tạo lệnh [[RC_QUERY_DR]] để tạo yêu cầu truy vấn giao dịch tới cổng thanh toán.
     *
     * @param array $data dữ liệu dùng để truy vấn thông tin giao dịch bên trong thường có mã giao dịch từ cổng thanh toán...
     * @param string|int $clientId PaymentClient id dùng để tạo yêu cầu truy vấn giao dịch.
     * @return ResponseData|DataInterface Phương thức sẽ trả về mẫu trừu tượng [[DataInterface]] để lấy thông tin trả về từ cổng thanh toán.
     * @throws InvalidConfigException|\ReflectionException
     */
    public function queryDR(array $data, $clientId = null): DataInterface
    {
        return $this->request(self::RC_QUERY_DR, $data, $clientId);
    }

    /**
     * Phương thức này là phương thức ánh xạ của [[request()]] nó sẽ tạo lệnh [[RC_REFUND]] để tạo yêu cầu hoàn tiền tới cổng thanh toán.
     *
     * @param array $data dữ liệu yêu cầu hoàn trả.
     * @param null $clientId Client id sử dụng để tạo yêu cầu.
     * Nếu không thiết lập [[getDefaultClient()]] sẽ được gọi để xác định client.
     * @return ResponseData|DataInterface Trả về [[DataInterface]] là dữ liệu tổng hợp từ MOMO phản hồi.
     * @throws \ReflectionException|\yii\base\InvalidConfigException|\yii\base\InvalidArgumentException
     * @since 1.0.3
     */
    public function refund(array $data, $clientId = null): DataInterface
    {
        return $this->request(self::RC_REFUND, $data, $clientId);
    }

    /**
     * Phương thức này là phương thức ánh xạ của [[request()]] nó sẽ tạo lệnh [[RC_QUERY_REFUND]] để tạo yêu cầu truy vấn trạng thái hoàn tiền tới cổng thanh toán.
     *
     * @param array $data dữ liệu trạng thái hoàn tiền.
     * @param null $clientId Client id sử dụng để tạo yêu cầu truy vấn trạng thái.
     * Nếu không thiết lập [[getDefaultClient()]] sẽ được gọi để xác định client.
     * @return ResponseData|DataInterface Trả về [[DataInterface]] là dữ liệu tổng hợp từ MOMO phản hồi.
     * @throws \ReflectionException|\yii\base\InvalidConfigException|\yii\base\InvalidArgumentException
     * @since 1.0.3
     */
    public function queryRefund(array $data, $clientId = null): DataInterface
    {
        return $this->request(self::RC_QUERY_REFUND, $data, $clientId);
    }

    /**
     * @inheritdoc
     */
    public function beforeRequest(RequestEvent $event)

This method seems to be duplicated in your project.

    {
        switch ($event->command) {
            case self::RC_PURCHASE:
                $this->trigger(self::EVENT_BEFORE_PURCHASE, $event);
                break;
            case self::RC_QUERY_DR:
                $this->trigger(self::EVENT_BEFORE_QUERY_DR, $event);
                break;
            case self::RC_REFUND:
                $this->trigger(self::EVENT_BEFORE_REFUND, $event);
                break;
            case self::RC_QUERY_REFUND:
                $this->trigger(self::EVENT_BEFORE_QUERY_REFUND, $event);
                break;
            default:
                break;
        }

        parent::beforeRequest($event);
    }

    /**
     * @inheritdoc
     */
    public function afterRequest(RequestEvent $event)

This method seems to be duplicated in your project.

    {
        switch ($event->command) {
            case self::RC_PURCHASE:
                $this->trigger(self::EVENT_AFTER_PURCHASE, $event);
                break;
            case self::RC_QUERY_DR:
                $this->trigger(self::EVENT_AFTER_QUERY_DR, $event);
                break;
            case self::RC_REFUND:
                $this->trigger(self::EVENT_AFTER_REFUND, $event);
                break;
            case self::RC_QUERY_REFUND:
                $this->trigger(self::EVENT_AFTER_QUERY_REFUND, $event);
                break;
            default:
                break;
        }

        parent::afterRequest($event);
    }

    /**
     * Phương thức này là phương thức ánh xạ của [[verifyRequest()]] nó sẽ tạo lệnh [[VRC_PURCHASE_SUCCESS]]
     * để tạo yêu cầu xác minh tính hợp lệ của dữ liệu trả về từ máy khách đến máy chủ.
     *
     * @param \yii\web\Request|null $request Đối tượng `request` thực hiện truy cập hệ thống.
     * @param null|int|string $clientId PaymentClient id dùng để xác thực tính hợp lệ của dữ liệu.
     * @return bool|VerifiedData|DataInterface Sẽ trả về FALSE nếu như dữ liệu không hợp lệ ngược lại sẽ trả về thông tin đơn hàng đã được xác thực.
     * @throws InvalidConfigException|\ReflectionException
     */
    public function verifyRequestPurchaseSuccess(\yii\web\Request $request = null, $clientId = null)
    {
        return $this->verifyRequest(self::VRC_PURCHASE_SUCCESS, $request, $clientId);
    }

    /**
     * Phương thức này là phương thức ánh xạ của [[verifyRequest()]] nó sẽ tạo lệnh [[VRC_IPN]]
     * để tạo yêu cầu xác minh tính hợp lệ của dữ liệu trả về từ cổng thanh toán đến máy chủ.
     *
     * @param \yii\web\Request|null $request Đối tượng `request` thực hiện truy cập hệ thống.
     * @param null|int|string $clientId PaymentClient id dùng để xác thực tính hợp lệ của dữ liệu.
     * @return bool|VerifiedData|DataInterface Sẽ trả về FALSE nếu như dữ liệu không hợp lệ ngược lại sẽ trả về thông tin đơn hàng đã được xác thực.
     * @throws InvalidConfigException|\ReflectionException
     */
    public function verifyRequestIPN(\yii\web\Request $request = null, $clientId = null)
    {
        return $this->verifyRequest(self::VRC_IPN, $request, $clientId);
    }

    /**
     * @inheritdoc
     * @throws InvalidConfigException|\ReflectionException
     */
    public function verifyRequest($command, \yii\web\Request $request = null, $clientId = null)
    {
        if (in_array($command, $this->verifyRequestCommands(), true)) {
            $client = $this->getClient($clientId);

            if ($request === null) {

This code seems to be duplicated across your project.

                if (Yii::$app instanceof \yii\web\Application) {
                    $request = Yii::$app->getRequest();
                } else {
                    throw new InvalidArgumentException('Request instance arg must be set to verify return request is valid or not!');
                }
            }

            $data = $this->getVerifyRequestData($command, $request);
            /** @var VerifiedData $requestData */
            $verifyData = Yii::createObject($this->verifiedDataConfig, [$command, $data, $client]);
            if ($verifyData->validate()) {
                /** @var VerifiedRequestEvent $event */
                $event = Yii::createObject([
                    'class' => VerifiedRequestEvent::class,
                    'verifiedData' => $verifyData,
                    'client' => $client,
                    'command' => $command
                ]);
                $this->verifiedRequest($event);

                return $verifyData;
            } else {
                return false;
            }
        } else {
            throw new InvalidArgumentException("Verify request command: `$command` invalid in " . __CLASS__);
        }
    }

    /**
     * Phương thúc lấy dữ liệu cần xác minh từ lệnh yêu cầu và đối tượng `request`.
     *
     * @param int|string $command Lệnh yêu cầu lấy dữ liệu cần được xác minh.
     * @param \yii\web\Request $request Đối tượng `request` được yêu cầu lấy dữ liệu.
     * @return array Trả về mảng dữ liệu cần được xác minh.
     */
    abstract protected function getVerifyRequestData($command, \yii\web\Request $request): array;

    /**
     * Phương thức được gọi sau khi việc xác minh tính hợp hệ của dữ liệu thành công.
     * Nó được xây dựng để kích hoạt các sự kiện liên quan khi dữ liệu đã được xác minh.
     *
     * @param VerifiedRequestEvent $event
     */
    public function verifiedRequest(VerifiedRequestEvent $event)
    {
        if ($event->command === self::VRC_IPN) {
            $this->trigger(self::EVENT_VERIFIED_REQUEST_IPN, $event);
        } elseif ($event->command === self::VRC_PURCHASE_SUCCESS) {
            $this->trigger(self::EVENT_VERIFIED_REQUEST_PURCHASE_SUCCESS, $event);
        }

        $this->trigger(self::EVENT_VERIFIED_REQUEST, $event);
    }


}