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: 

<?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\Response;

/**
 * Authentication response wrapper.
 *
 * @author Rene Korss <rene.korss@gmail.com>
 */
class AuthResponse extends Response
{
    /**
     * Authentication methods mapping with token value
     * token => human readable auth method.
     *
     * @var array
     */
    private static $authMethods = [
            1 => 'ID card',
            2 => 'Mobile ID',
            5 => 'One-off code card',
            6 => 'PIN-calculator',
            7 => 'Code card',
        ];

    /**
     * User id (personal code).
     *
     * @var string
     */
    protected $userId;

    /**
     * User name.
     *
     * @var string
     */
    protected $userName;

    /**
     * Country.
     *
     * @var string
     */
    protected $country;

    /**
     * Token.
     *
     * @var int
     */
    protected $token;

    /**
     * RID.
     *
     * @var string
     */
    protected $rid;

    /**
     * Nonce.
     *
     * @var string
     */
    protected $nonce;

    /**
     * Authentication date.
     *
     * @var string
     */
    protected $authDate;

    /**
     * Set user id.
     *
     * @param string $userId User id
     *
     * @return self
     */
    public function setUserId(string $userId) : self
    {
        $this->userId = $userId;
        return $this;
    }

    /**
     * Get user id.
     *
     * @return string User id
     */
    public function getUserId() : ?string
    {
        return $this->userId;
    }

    /**
     * Set user name.
     *
     * @param string $userName User name
     */
    public function setUserName(string $userName) : self
    {
        $this->userName = $userName;
        return $this;
    }

    /**
     * Get user name.
     *
     * @return string User name
     */
    public function getUserName() : ?string
    {
        return $this->userName;
    }

    /**
     * Set user country.
     *
     * @param string $country Country
     */
    public function setUserCountry(string $country) : self
    {
        $this->userCountry = $country;
        return $this;
    }

    /**
     * Get user country.
     *
     * @return string Country
     */
    public function getUserCountry() : ?string
    {
        return $this->userCountry;
    }

    /**
     * Set token.
     *
     * @param string $token Token (VK_TOKEN)
     *
     * @return self
     */
    public function setToken(string $token) : ?self
    {
        $this->token = $token;
        return $this;
    }

    /**
     * Get token.
     *
     * @return string Token
     */
    public function getToken() : string
    {
        return $this->token;
    }

    /**
     * Set nonce.
     *
     * @param string $nonce Nonce (VK_NONCE)
     *
     * @return self
     */
    public function setNonce(string $nonce) : self
    {
        $this->nonce = $nonce;
        return $this;
    }

    /**
     * Get nonce.
     *
     * @return string Nonce
     */
    public function getNonce() : ?string
    {
        return $this->nonce;
    }

    /**
     * Set rid.
     *
     * @param string $rid Rid (VK_RID)
     *
     * @return self
     */
    public function setRid(string $rid) : self
    {
        $this->rid = $rid;
        return $this;
    }

    /**
     * Get rid.
     *
     * @return string Rid
     */
    public function getRid() : ?string
    {
        return $this->rid;
    }

    /**
     * Set auth date.
     *
     * @param string $authDate Auth date
     *
     * @return self
     */
    public function setAuthDate(string $authDate) : self
    {
        $this->authDate = $authDate;
        return $this;
    }

    /**
     * Get auth date.
     *
     * @return string Auth date
     */
    public function getAuthDate() : ?string
    {
        return $this->authDate;
    }

    /**
     * Get human readable auth method.
     *
     * @return string Authentication method
     */
    public function getAuthMethod() : string
    {
        $authMethod = 'unknown';

        if ((int) $this->token > 0 && in_array($this->token, array_keys(self::$authMethods))) {
            $authMethod = self::$authMethods[$this->token];
        }

        return $authMethod;
    }
}