PayumTW\Ezship\Api

Complexity

Total Complexity

23

Size/Duplication

Total Lines	300
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

89.11%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getApiEndpoint()	0	13	2
B	createCvsMapTransaction()	0	24	1
B	createTransaction()	0	84	5
B	getTransactionData()	0	35	1
A	verifyHash()	0	6	2
B	keyMap()	0	15	5
B	createXml()	0	16	6

<?php

namespace PayumTW\Ezship;

use Http\Message\MessageFactory;
use Payum\Core\HttpClientInterface;

class Api
{
    protected $keyMap = [
        'su_id' => 'suID',
        'order_id' => 'orderID',
        'order_status' => 'orderStatus',
        'order_type' => 'orderType',
        'order_amount' => 'orderAmount',
        'rv_name' => 'rvName',
        'rv_email' => 'rvEmail',
        'rv_mobile' => 'rvMobile',
        'st_cate' => 'stCate',
        'st_code' => 'stCode',
        'rv_addr' => 'rvAddr',
        'rv_zip' => 'rvZip',
        'rtn_url' => 'rtURL',
        'web_para' => 'webPara',
        // Product
        'detail' => 'Detail',
        'prod_item' => 'prodItem',
        'prod_no' => 'prodNo',
        'prod_name' => 'prodName',
        'prod_price' => 'prodPrice',
        'prod_qty' => 'prodQty',
        'prod_spec' => 'prodSpec',

        'process_id' => 'processID',
    ];

    /**
     * @var \Payum\Core\HttpClientInterface
     */
    protected $client;

    /**
     * @var \Http\Message\MessageFactory
     */
    protected $messageFactory;

    /**
     * @var array
     */
    protected $options = [];

    /**
     * @param array $options
     * @param \Payum\Core\HttpClientInterface $client
     * @param \Http\Message\MessageFactory $messageFactory
     *
     * @throws \Payum\Core\Exception\InvalidArgumentException if an option is invalid
     */
    public function __construct(array $options, HttpClientInterface $client, MessageFactory $messageFactory)
    {
        $this->options = $options;
        $this->client = $client;
        $this->messageFactory = $messageFactory;
    }

    /**
     * @return string
     */
    public function getApiEndpoint($type = 'capture')
    {
        // 網站至ezShip 程式網址：
        $endpoints = [
            'cvs' => ' https://map.ezship.com.tw/ezship_map_web.jsp',
            'capture' => strtolower($this->options['method']) === 'xml' ?
                'https://www.ezship.com.tw/emap/ezship_xml_order_api.jsp' :
                'https://www.ezship.com.tw/emap/ezship_request_order_api.jsp',
            'query' => 'https://www.ezship.com.tw/emap/ezship_request_order_status_api.jsp',
        ];

        return $endpoints[$type];
    }

    /**
     * createCvsMapTransaction.
     *
     * @param array $params
     * @return array
     */
    public function createCvsMapTransaction(array $params)
    {
        $supportedParams = [
            // varchar 100 賣家登入ezShip帳號 需開通網站對接者
            'su_id' => $this->options['su_id'],
            // varchar 10 處理序號或訂單編號 由開通網站自行提供的編號(KEY值)。(非 ezShip 提供)
            'process_id' => null,
            // varchar 3 取件門市通路代號
            'st_cate' => null,
            // varchar 6 取件門市代號
            'st_code' => null,
            // varchar 100 回傳網址路徑及程式名稱 請輸入完整網站路徑網址。如 http://yourdomain.domain/direct/program.php
            'rtn_url' => null,
            // varchar 100 網站所需額外判別資料 由開通網站自行提供，ezShip 將原值回傳
            'web_para' => uniqid(),
        ];

        $params = array_filter(array_replace(
            $supportedParams,
            array_intersect_key($params, $supportedParams)
        ));

        return $this->keyMap($params);
    }

    /**
     * createTransaction.
     *
     * @param array $params
     * @return array
     */
    public function createTransaction(array $params)
    {
        $params = $this->keyMap($params, true);

        $orderStatus = 'A05';
        if (empty($params['st_code']) === false) {
            $orderStatus = 'A01';

            $params['st_code'] = empty($params['st_cate']) === false ?
                $params['st_cate'].$params['st_code'] :
                $params['st_code'];
        }

        $supportedParams = [
            // varchar 100 賣家登入ezShip帳號 需開通網站對接者，取貨付款訂單須帳號於合約期間內
            'su_id' => $this->options['su_id'],
            // varchar 10 訂單編號
            'order_id' => null,
            /*
             * varchar 3 訂單狀態
             * A01 超商取貨新訂單，不需在ezShip上確認訂單，可直接印單 (回覆snID)
             * A02 超商取貨新訂單，需在ezShip上確認訂單，確認後才可進行印單 (預設值, 回覆snID)
             * A03 超商取貨新訂單，使用 輕鬆袋或迷你袋 (不回覆snID，不需在ezShip上確認訂單，需登錄編號)
             * A04 超商取貨新訂單，使用 輕鬆袋或迷你袋 (不回覆snID，需在ezShip上確認訂單，需登錄編號)
             * A05 宅配新訂單，不需在ezShip上確認訂單，可直接印單 (回覆snID，10碼數字)
             * A06 宅配新訂單，需在ezShip上確認訂單，確認後才可進行印單 (回覆snID，10碼數字)
             */

            'order_status' => $orderStatus,
            // varchar 1 訂單類別 1 取貨付款 3 取貨不付款
            'order_type' => '3',
            /*
             * 代收金額或訂單金額
             * 若<orderType>=1，為代收金額 10~6,000
             * 若<orderType>=3，為訂單金額 0~2,000
             */
            'order_amount' => null,
            /*
             * varchar 60 取件人姓名
             * 若<orderType>=1，建議為取件人身分證件上之真實姓名
             * 若<orderType>=3，須為取件人身分證件上之真實姓名
             */
            'rv_name' => null,
            // varchar 100 取件人電子郵件 發送取件通知信函
            'rv_email' => null,
            // varchar 10 取件人行動電話 發送取件通知簡訊
            'rv_mobile' => null,
            // varchar 9 取件門市
            // 通路別+門市代號 電子地圖回傳之 <stCate><stCode> orderStatus 為 A01、A02、A03、A04 時必須 ( 店到店資料 )
            'st_code' => null,
            // varchar 120 取件人收件地址 orderStatus 為 A05、A06 時必須 ( 宅配資料 )
            'rv_addr' => null,
            // varchar 10 取件人郵遞區號 orderStatus 為 A05、A06 時必須 ( 宅配資料 )
            'rv_zip' => null,
            // varchar 100 回傳網址路徑及程式名稱 請輸入完整網站路徑網址。如 http://yourdomain.domain/direct/program.php
            'rtn_url' => null,
            // varchar 100 網站所需額外判別資料 ezShip 將原值回傳，供網站判別用
            'web_para' => uniqid(),
            // 商品明細
            'details' => [],
        ];

        $params = array_filter(array_replace(
            $supportedParams,
            array_intersect_key($params, $supportedParams)
        ));

        $params['order_amount'] = (string) $params['order_type'] === '3' ? '0' : $params['order_amount'];

        $details = $params['details'];
        unset($params['details']);

        if (strtolower($this->options['method']) === 'xml') {
            $details = implode('', array_map(function ($detail) {
                return $this->createXml($this->keyMap(['detail' => $detail]), ['prodName', 'prodSpec']);
            }, $details));

            return [
                'web_map_xml' => '<ORDER>'.$this->createXml($this->keyMap($params), ['rvName', 'rvAddr']).$details.'</ORDER>',
            ];
        }

        return $params;
    }

    /**
     * getTransactionData.
     *
     * @param mixed $params
     * @return array
     */
    public function getTransactionData(array $params)
    {
        $supportedParams = [
            // varchar 100 賣家登入ezShip帳號 需開通網站對接者
            'su_id' => $this->options['su_id'],
            // varchar 10 ezShip店到店編號 訂單成立後，ezShip回傳給網站的店到店編號
            'sn_id' => null,
            //  varchar 100 回傳網址路徑及程式名稱 請輸入完整網站路徑網址。如 http://yourdomain.domain/direct/program.php
            'rtn_url' => null,
            // varchar 100 網站所需額外判別資料 由開通網站自行提供，ezShip 將原值回傳。
            'web_para' => uniqid(),
            /*
             * varchar 3 訂單狀態
             * S01 尚未寄件或尚未收到超商總公司提供的寄件訊息
             * S02 運往取件門市途中
             * S03 已送達取件門市
             * S04 已完成取貨
             * S05 退貨 (包含：已退回物流中心 / 再寄一次給取件人 / 退回給寄件人)
             * S06 配送異常 (包含：刪單 / 門市閉店 / 貨故)
             * E00 參數傳遞內容有誤或欄位短缺
             * E01 <su_id>帳號不存在
             * E02 <su_id>帳號無網站串接權限
             * E03 <sn_id>店到店編號有誤
             * E04 <su_id>帳號與<sn_id>店到店編號無法對應
             * E99 系統錯誤
             */
        ];

        $params = array_filter(array_replace(
            $supportedParams,
            array_intersect_key($params, $supportedParams)
        ));

        return $params;
    }

    /**
     * verifyHash.
     *
     * @param array $params
     * @param array $details
     * @return bool
     */
    public function verifyHash($params, $details)
    {
        $webPara = isset($params['web_para']) === true ? $params['web_para'] : $params['webPara'];

        return $webPara === $details['web_para'];
    }

    /**
     * keyMap.
     *
     * @param array $array
     * @param bool $flip
     * @return array
     */
    protected function keyMap($array, $flip = false)
    {
        $map = $flip === true ? array_flip($this->keyMap) : $this->keyMap;
        $result = [];
        foreach ($array as $key => $value) {
            $key = isset($map[$key]) === true ? $map[$key] : $key;
            if (is_array($value) === true) {
                $result[$key] = $this->keyMap($value, $flip);
            } else {
                $result[$key] = $value;
            }
        }

        return $result;
    }

    /**
     * createXml.
     *
     * @param array $array
     * @param array $cdataSections
     * @return string
     */
    protected function createXml($array, $cdataSections = [])
    {
        $xml = '';
        foreach ($array as $key => $value) {
            if (is_array($value) === true) {
                $xml .= sprintf('<%s>%s</%s>', $key, $this->createXml($value, $cdataSections), $key);
            } else {
                if (empty($value) === false && (in_array($key, $cdataSections, true) === true || (bool) preg_match('/[<>&]/', $value) === true)) {
                    $value = '<![CDATA['.$value.']]>';
                }
                $xml .= sprintf('<%s>%s</%s>', $key, $value, $key);
            }
        }

        return $xml;
    }
}