nhuluc\payment\nganluong\ResponseData

Complexity

Total Complexity

4

Size/Duplication

Total Lines	78
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

37.5%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getIsOk()	0	8	2
A	getMessage()	0	8	2

<?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 nhuluc\payment\nganluong;

use vxm\gatewayclients\ResponseData as BaseResponseData;

/**
 * Lớp ResponseData hổ trợ việc cung cấp, tổng hợp nội dung dữ liệu nhận được từ [[request()]] của [[PaymentGateway]].
 *
 * @method PaymentClient getClient() đối tượng client đã dùng để thực thi request.
 *
 * @property PaymentClient $client đối tượng client đã dùng để thực thi request.
 * @property bool $isOk trạng thái phản hồi từ Ngân Lượng `TRUE` thành công và ngược lại.
 * @property string $message chuỗi thông báo trạng thái convert từ `error_code`.
 * @property string $error_code mã lỗi.
 * @property string $token của đơn hàng, chỉ tồn tại khi `isOk` là TRUE.
 * @property string $checkout_url đường dẫn bạn sẽ redirect khách hàng để thực hiện thanh toán, chỉ tồn tại khi `isOk` là TRUE.
 * @property string $description mô tả, chỉ tồn tại khi `isOk` là FALSE.
 * @property string $auth_url đường dẫn thực thi xác minh, chỉ tồn tại với phương thức seamless và `isOk` là TRUE.
 * @property string $auth_site nguồn thực thi xác minh, chỉ tồn tại với phương thức seamless và `isOk` là TRUE.
 * @property mixed $order_code mã giao dịch tại hệ thống, chỉ tồn tại khi thực thi `queryDR`.
 * @property double $total_amount số tiền đơn hàng, chỉ tồn tại khi thực thi `queryDR`.
 * @property string $payment_method phương thức thanh toán, chỉ tồn tại khi thực thi `queryDR`.
 * @property string $bank_code mã ngân hàng, chỉ tồn tại khi thực thi `queryDR`.
 * @property string $payment_type hình thức thanh toán `1` là trực tiếp, `2` là tạm giữ, chỉ tồn tại khi thực thi `queryDR`.
 * @property string $order_description thông tin đơn hàng, chỉ tồn tại khi thực thi `queryDR`.
 * @property double $tax_amount tiền thuế, chỉ tồn tại khi thực thi `queryDR`.
 * @property double $discount_amount tiền giảm giá, chỉ tồn tại khi thực thi `queryDR`.
 * @property double $fee_shipping phí ship, chỉ tồn tại khi thực thi `queryDR`.
 * @property string $return_url đường dẫn trả về khi thanh toán thành công, chỉ tồn tại khi thực thi `queryDR`.
 * @property string $cancel_url đường dẫn trả về khi hủy thành công, chỉ tồn tại khi thực thi `queryDR`.
 * @property string $notify_url đường dẫn Ngân Lượng gọi về khi khách thanh toán thành công, chỉ tồn tại khi thực thi `queryDR`.
 * @property int $time_limit số phút còn lại để thực thi giao dịch, chỉ tồn tại khi thực thi `queryDR`.
 * @property string $buyer_fullname tên người mua, chỉ tồn tại khi thực thi `queryDR`.
 * @property string $buyer_email email người mua, chỉ tồn tại khi thực thi `queryDR`.
 * @property string $buyer_mobile số điện thoại người mua, chỉ tồn tại khi thực thi `queryDR`.
 * @property string $buyer_address địa chỉ người mua, chỉ tồn tại khi thực thi `queryDR`.
 * @property string $affiliate_code mã đối tác của Ngân Lượng, chỉ tồn tại khi thực thi `queryDR`.
 * @property string $transaction_status trạng thái giao dịch, chỉ tồn tại khi thực thi `queryDR`.
 * @property string $transaction_id mã giao dịch tại Ngân Lượng, chỉ tồn tại khi thực thi `queryDR`.
 *
 * @author Nhu Luc <nguyennhuluc1990@gmail.com>
 * @since 1.0
 */
class ResponseData extends BaseResponseData
{

    /**
     * Mảng tổng hợp các message mà Ngân Lượng sẽ trả về.
     *
     * @var array
     */
    public static $responseMessages = [
        '00' => 'Thành công',
        '99' => 'Lỗi chưa xác minh',
        '06' => 'Mã merchant không tồn tại hoặc bị khóa',
        '02' => 'Địa chỉ IP truy cập bị từ chối',
        '03' => 'Mã checksum không chính xác, truy cập bị từ chối',
        '04' => 'Tên hàm API do merchant gọi tới không hợp lệ (không tồn tại)',
        '05' => 'Sai version của API',
        '07' => 'Sai mật khẩu của merchant',
        '08' => 'Địa chỉ email tài khoản nhận tiền không tồn tại',
        '09' => 'Tài khoản nhận tiền đang bị phong tỏa giao dịch',
        '10' => 'Mã đơn hàng không hợp lệ',
        '11' => 'Số tiền giao dịch lớn hơn hoặc nhỏ hơn quy định',
        '12' => 'Loại tiền tệ không hợp lệ',
        '29' => 'Token không tồn tại',
        '80' => 'Không thêm được đơn hàng',
        '81' => 'Đơn hàng chưa được thanh toán',
        '110' => 'Địa chỉ email tài khoản nhận tiền không phải email chính',
        '111' => 'Tài khoản nhận tiền đang bị khóa',
        '113' => 'Tài khoản nhận tiền chưa cấu hình là người bán nội dung số',
        '114' => 'Giao dịch đang thực hiện, chưa kết thúc',
        '115' => 'Giao dịch bị hủy',
        '118' => 'tax_amount không hợp lệ',
        '119' => 'discount_amount không hợp lệ',
        '120' => 'fee_shipping không hợp lệ',
        '121' => 'return_url không hợp lệ',
        '122' => 'cancel_url không hợp lệ',
        '123' => 'items không hợp lệ',
        '124' => 'transaction_info không hợp lệ',
        '125' => 'quantity không hợp lệ',
        '126' => 'order_description không hợp lệ',
        '127' => 'affiliate_code không hợp lệ',
        '128' => 'time_limit không hợp lệ',
        '129' => 'buyer_fullname không hợp lệ',
        '130' => 'buyer_email không hợp lệ',
        '131' => 'buyer_mobile không hợp lệ',
        '132' => 'buyer_address không hợp lệ',
        '133' => 'total_item không hợp lệ',
        '134' => 'payment_method, bank_code không hợp lệ',
        '135' => 'Lỗi kết nối tới hệ thống ngân hàng',
        '140' => 'Đơn hàng không hỗ trợ thanh toán trả góp'
    ];

    /**
     * @inheritdoc
     */
    public function getIsOk(): bool
    {
        if (isset($this['error_code'])) {
            return $this['error_code'] === PaymentGateway::TRANSACTION_STATUS_SUCCESS;
        } else {
            return false;
        }
    }

    /**
     * Phương thức hổ trợ lấy câu thông báo `message` nhận từ Ngân Lượng.
     *
     * @return null|string Trả về NULL nếu như dữ liệu Ngân Lượng gửi về không tồn tại `error_code`,
     * và ngược lại sẽ là câu thông báo dịch từ `error_code`.
     */
    public function getMessage(): ?string
    {
        if (isset($this['error_code'])) {
            return static::$responseMessages[$this['error_code']];
        } else {
            return null;
        }
    }
}