Config.php 5.55 KB
Newer Older
Ketan's avatar
Ketan committed
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
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */

declare(strict_types=1);

namespace Magento\AuthorizenetAcceptjs\Gateway;

use Magento\AuthorizenetAcceptjs\Model\Adminhtml\Source\Environment;
use Magento\Framework\App\Config\ScopeConfigInterface;

/**
 * Houses configuration for this gateway
 */
class Config extends \Magento\Payment\Gateway\Config\Config
{
    const METHOD = 'authorizenet_acceptjs';
    private const KEY_LOGIN_ID = 'login';
    private const KEY_TRANSACTION_KEY = 'trans_key';
    private const KEY_ENVIRONMENT = 'environment';
    private const KEY_LEGACY_TRANSACTION_HASH = 'trans_md5';
    private const KEY_SIGNATURE_KEY = 'trans_signature_key';
    private const KEY_PAYMENT_ACTION = 'payment_action';
    private const KEY_SHOULD_EMAIL_CUSTOMER = 'email_customer';
    private const KEY_ADDITIONAL_INFO_KEYS = 'paymentInfoKeys';
    private const KEY_CLIENT_KEY = 'public_client_key';
    private const KEY_CVV_ENABLED = 'cvv_enabled';
    private const KEY_TRANSACTION_SYNC_KEYS = 'transactionSyncKeys';
    private const ENDPOINT_URL_SANDBOX = 'https://apitest.authorize.net/xml/v1/request.api';
    private const ENDPOINT_URL_PRODUCTION = 'https://api.authorize.net/xml/v1/request.api';
    private const SOLUTION_ID_SANDBOX = 'AAA102993';
    private const SOLUTION_ID_PRODUCTION = 'AAA175350';

    /**
     * @param ScopeConfigInterface $scopeConfig
     * @param null|string $methodCode
     * @param string $pathPattern
     */
    public function __construct(
        ScopeConfigInterface $scopeConfig,
        $methodCode = null,
        $pathPattern = self::DEFAULT_PATH_PATTERN
    ) {
        parent::__construct($scopeConfig, $methodCode, $pathPattern);
    }

    /**
     * Gets the login id
     *
     * @param int|null $storeId
     * @return string
     */
    public function getLoginId($storeId = null): ?string
    {
        return $this->getValue(Config::KEY_LOGIN_ID, $storeId);
    }

    /**
     * Gets the current environment
     *
     * @param int|null $storeId
     * @return string
     */
    public function getEnvironment($storeId = null): string
    {
        return $this->getValue(Config::KEY_ENVIRONMENT, $storeId);
    }

    /**
     * Gets the transaction key
     *
     * @param int|null $storeId
     * @return string
     */
    public function getTransactionKey($storeId = null): ?string
    {
        return $this->getValue(Config::KEY_TRANSACTION_KEY, $storeId);
    }

    /**
     * Gets the API endpoint URL
     *
     * @param int|null $storeId
     * @return string
     */
    public function getApiUrl($storeId = null): string
    {
        $environment = $this->getValue(Config::KEY_ENVIRONMENT, $storeId);

        return $environment === Environment::ENVIRONMENT_SANDBOX
            ? self::ENDPOINT_URL_SANDBOX
            : self::ENDPOINT_URL_PRODUCTION;
    }

    /**
     * Gets the configured signature key
     *
     * @param int|null $storeId
     * @return string
     */
    public function getTransactionSignatureKey($storeId = null): ?string
    {
        return $this->getValue(Config::KEY_SIGNATURE_KEY, $storeId);
    }

    /**
     * Gets the configured legacy transaction hash
     *
     * @param int|null $storeId
     * @return string
     */
    public function getLegacyTransactionHash($storeId = null): ?string
    {
        return $this->getValue(Config::KEY_LEGACY_TRANSACTION_HASH, $storeId);
    }

    /**
     * Gets the configured payment action
     *
     * @param int|null $storeId
     * @return string
     */
    public function getPaymentAction($storeId = null): ?string
    {
        return $this->getValue(Config::KEY_PAYMENT_ACTION, $storeId);
    }

    /**
     * Gets the configured client key
     *
     * @param int|null $storeId
     * @return string
     */
    public function getClientKey($storeId = null): ?string
    {
        return $this->getValue(Config::KEY_CLIENT_KEY, $storeId);
    }

    /**
     * Should authorize.net email the customer their receipt.
     *
     * @param int|null $storeId
     * @return bool
     */
    public function shouldEmailCustomer($storeId = null): bool
    {
        return (bool)$this->getValue(Config::KEY_SHOULD_EMAIL_CUSTOMER, $storeId);
    }

    /**
     * Should the cvv field be shown
     *
     * @param int|null $storeId
     * @return bool
     */
    public function isCvvEnabled($storeId = null): bool
    {
        return (bool)$this->getValue(Config::KEY_CVV_ENABLED, $storeId);
    }

    /**
     * Retrieves the solution id for the given store based on environment
     *
     * @param int|null $storeId
     * @return string
     */
    public function getSolutionId($storeId = null): ?string
    {
        $environment = $this->getValue(Config::KEY_ENVIRONMENT, $storeId);

        return $environment === Environment::ENVIRONMENT_SANDBOX
            ? self::SOLUTION_ID_SANDBOX
            : self::SOLUTION_ID_PRODUCTION;
    }

    /**
     * Returns the keys to be pulled from the transaction and displayed
     *
     * @param int|null $storeId
     * @return string[]
     */
    public function getAdditionalInfoKeys($storeId = null): array
    {
        return explode(',', $this->getValue(Config::KEY_ADDITIONAL_INFO_KEYS, $storeId) ?? '');
    }

    /**
     * Returns the keys to be pulled from the transaction and displayed when syncing the transaction
     *
     * @param int|null $storeId
     * @return string[]
     */
    public function getTransactionInfoSyncKeys($storeId = null): array
    {
        return explode(',', $this->getValue(Config::KEY_TRANSACTION_SYNC_KEYS, $storeId) ?? '');
    }
}