1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 

<?php
/**
 * RKD Banklink.
 *
 * @link https://github.com/renekorss/Banklink/
 *
 * @author Rene Korss <rene.korss@gmail.com>
 * @copyright 2016-2019 Rene Korss
 * @license MIT
 */
namespace RKD\Banklink;

use RKD\Banklink\Protocol\ProtocolInterface;
use RKD\Banklink\Request\AuthRequest;
use RKD\Banklink\Request\PaymentRequest;
use RKD\Banklink\Request\RequestInterface;
use RKD\Banklink\Response\ResponseInterface;
use UnexpectedValueException;

/**
 * Abstract class for every banklink.
 *
 * @author Rene Korss <rene.korss@gmail.com>
 */
abstract class Banklink
{
    /**
     * Protocol object used for communication.
     *
     * @var RKD\Banklink\Protocol
     */
    protected $protocol;

    /**
     * Request data.
     *
     * @var array
     */
    protected $requestData = null;

    /**
     * Authentication data.
     *
     * @var array
     */
    protected $authData = null;

    /**
     * Request url.
     *
     * @var mixed
     */
    protected $requestUrl;

    /**
     * Test request url.
     *
     * @var mixed
     */
    protected $testRequestUrl;

    /**
     * Request encoding.
     *
     * @var string
     */
    protected $requestEncoding = 'UTF-8';

    /**
     * Response encoding.
     *
     * @var string
     */
    protected $responseEncoding = 'UTF-8';

    /**
     * Init banklink.
     *
     * @param RKD\Banklink\Protocol $protocol   Protocol object used
     */
    public function __construct(ProtocolInterface $protocol)
    {
        $this->protocol = $protocol;
    }

    /**
     * Activate debug mode. Changes requestUrl to testRequestUrl
     *
     * @return self
     */
    public function debugMode() : self
    {
        return $this->setRequestUrl($this->testRequestUrl);
    }

    /**
     * Set request URL
     *
     * @param string $requestUrl Request URL
     *
     * @return self
     */
    public function setRequestUrl($requestUrl) : self
    {
        $this->requestUrl = $requestUrl;
        return $this;
    }

    /**
     * Get payment object
     *
     * @param int    $orderId           Order ID
     * @param float  $sum               Sum of order
     * @param string $message           Transaction description
     * @param string $language          Language
     * @param string $currency          Currency. Default: EUR
     * @param array  $customRequestData Optional custom request data
     * @param string $timezone          Timezone. Default: Europe/Tallinn
     *
     * @return RKD\Banklink\Request\PaymentRequest Payment object
     */
    public function getPaymentRequest(
        int $orderId,
        float $sum,
        string $message,
        string $language = 'EST',
        string $currency = 'EUR',
        array $customRequestData = [],
        string $timezone = 'Europe/Tallinn'
    ) : RequestInterface {
        if ($this->requestData) {
            return $this->requestData;
        }

        $requestData = $this->protocol->getPaymentRequest(
            $orderId,
            $sum,
            $message,
            $language,
            $currency,
            array_merge($this->getAdditionalRequestFields(), $customRequestData),
            $this->requestEncoding,
            $timezone
        );

        // Add additional fields
        $requestData = array_merge($requestData, $this->getAdditionalFields());

        $this->requestData = new PaymentRequest($this->getRequestUrlFor('payment'), $requestData);

        return $this->requestData;
    }

    /**
     * Get authentication object
     *
     * @param string|null $recId    Bank identifier
     * @param string|null $nonce    Random nonce
     * @param string|null $rid      Session identifier.
     * @param string      $language Language
     * @param string      $timezone Timezone. Default: Europe/Tallinn
     *
     * @return RKD\Banklink\Request\RequestInterface Authentication object
     */
    public function getAuthRequest(
        ?string $recId = null,
        ?string $nonce = null,
        ?string $rid = null,
        string $language = 'EST',
        string $timezone = 'Europe/Tallinn'
    ) : RequestInterface {
        if ($this->authData) {
            return $this->authData;
        }

        $authData = $this->protocol->getAuthRequest($recId, $nonce, $rid, $this->requestEncoding, $language, $timezone);

        // Add additional fields
        $authData = array_merge($authData, $this->getAdditionalFields());

        $this->authData = new AuthRequest($this->getRequestUrlFor('auth'), $authData);

        return $this->authData;
    }

    /**
     * Handles response from bank.
     *
     * @param array $responseData Response data from bank
     *
     * @return RKD\Banklink\Response\ResponseInterface Response object, depending on request made
     */
    public function handleResponse(array $responseData) : ResponseInterface
    {
        return $this->protocol->handleResponse($responseData, $this->getResponseEncoding($responseData));
    }

    /**
     * Get request url based on type
     *
     * @param string $type Request URL type
     *
     * @return string Request URL
     *
     * @throws UnexpectedValueException If requestUrl is in wrong type or not set
     */
    public function getRequestUrlFor(string $type) : string
    {
        if (is_string($this->requestUrl)) {
            return $this->requestUrl;
        } elseif (is_array($this->requestUrl) && array_key_exists($type, $this->requestUrl)) {
            return $this->requestUrl[$type];
        }

        throw new UnexpectedValueException(sprintf('requestUrl is not string or array containing desired type (%s)', $type));
    }

    /**
     * Get encoding for response, if response data has it.
     *
     * @param array $responseData Response data from bank
     *
     * @return string Encoding
     */
    protected function getResponseEncoding(array $responseData) : string
    {
        if ($this->getEncodingField() && isset($responseData[$this->getEncodingField()])) {
            return $responseData[$this->getEncodingField()];
        }

        return $this->responseEncoding;
    }

    /**
     * Detect if bank sent us data with encoding field.
     *
     * @return string|null Encoding field name
     */
    protected function getEncodingField() : string
    {
        return ''; // @codeCoverageIgnore
    }

    /**
     * Add additional fields.
     *
     * @return array Array of additional fields
     */
    protected function getAdditionalFields() : array
    {
        return []; // @codeCoverageIgnore
    }

    /**
     * Additional request fields merged to request data
     *
     * @return array Array of additional request fields to send to bank
     */
    protected function getAdditionalRequestFields() : array
    {
        return []; // @codeCoverageIgnore
    }
}