PurchaseRequest - Code Metrics - Inspection of "Add support for Redsys EMV 3DS" - PatronBase/omnipay-redsys - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#5)

by Michael
created 2020-12-09 20:52 UTC
PurchaseRequest F

↳ Parent: Project
Complexity

Total Complexity
248
Size/Duplication

Total Lines	1695
Duplicated Lines	2.18 %
Coupling/Cohesion

Components	3
Dependencies	4
Test Coverage

Coverage
100%
Importance

Changes
Metric	Value
wmc	248
lcom	3
cbo	4
dl	37
loc	1695
c	0
b	0
f	0
ccs	80
cts	80
cp	1
rs	0.8
103 Methods

Rating	Name	Duplication	Size	Complexity
A	getCard()	0	4	1
A	setCard()	0	4	1
A	getCardholder()	0	4	1
A	setCardholder()	0	4	1
A	getConsumerLanguage()	0	4	1
A	setConsumerLanguage()	0	13	6
A	getHmacKey()	0	4	1
A	setHmacKey()	0	4	1
A	getMerchantData()	0	4	1
A	setMerchantData()	0	4	1
A	getMerchantId()	0	4	1
A	setMerchantId()	0	4	1
A	getMerchantName()	0	4	1
A	setMerchantName()	0	4	1
A	getTerminalId()	0	4	1
A	setTerminalId()	0	4	1
A	getEmail()	0	4	1
A	setEmail()	0	4	1
A	getShippingAddress3()	0	4	1
A	setShippingAddress3()	0	4	1
A	getBillingAddress3()	0	4	1
A	setBillingAddress3()	0	4	1
A	getHomePhoneCountryPrefix()	0	4	1
A	setHomePhoneCountryPrefix()	0	4	1
A	getHomePhone()	0	4	1
A	setHomePhone()	0	4	1
A	getMobilePhoneCountryPrefix()	0	4	1
A	setMobilePhoneCountryPrefix()	0	4	1
A	getMobilePhone()	0	4	1
A	setMobilePhone()	0	4	1
A	getWorkPhoneCountryPrefix()	0	4	1
A	setWorkPhoneCountryPrefix()	0	4	1
A	getWorkPhone()	0	4	1
A	setWorkPhone()	0	4	1
A	getAddressMatch()	0	4	1
A	setAddressMatch()	0	4	1
A	getChallengeWindowSize()	0	4	1
A	setChallengeWindowSize()	0	17	2
A	getCustomerAdditionalInformation()	0	4	1
A	setCustomerAdditionalInformation()	0	4	1
A	get3DsRequestAuthenticationMethodData()	0	4	1
A	set3DsRequestAuthenticationMethodData()	0	4	1
A	get3DsRequestAuthenticationMethod()	0	4	1
A	set3DsRequestAuthenticationMethod()	18	18	2
A	get3DsRequestAuthenticationTime()	0	4	1
A	set3DsRequestAuthenticationTime()	0	4	1
A	getCustomerAccountCreatedIndicator()	0	4	1
A	setCustomerAccountCreatedIndicator()	0	17	2
A	getCustomerAccountCreatedDate()	0	4	1
A	setCustomerAccountCreatedDate()	0	4	1
A	getCustomerAccountChangedIndicator()	0	4	1
A	setCustomerAccountChangedIndicator()	0	16	2
A	getCustomerAccountChangedDate()	0	4	1
A	setCustomerAccountChangedDate()	0	4	1
A	getCustomerPasswordChangedIndicator()	0	4	1
A	setCustomerPasswordChangedIndicator()	0	17	2
A	getCustomerPasswordChangedDate()	0	4	1
A	setCustomerPasswordChangedDate()	0	4	1
A	getCustomerPurchasesInLast6Months()	0	4	1
A	setCustomerPurchasesInLast6Months()	0	4	1
A	getCustomerAccountCardProvisionsLast24Hours()	0	4	1
A	setCustomerAccountCardProvisionsLast24Hours()	0	4	1
A	getCustomerAccountTransactionsLast24Hours()	0	4	1
A	setCustomerAccountTransactionsLast24Hours()	0	4	1
A	getCustomerAccountTransactionsLastYear()	0	4	1
A	setCustomerAccountTransactionsLastYear()	0	4	1
A	getCustomerPaymentMethodCreatedIndicator()	0	4	1
A	setCustomerPaymentMethodCreatedIndicator()	0	17	2
A	getCustomerPaymentMethodCreatedDate()	0	4	1
A	setCustomerPaymentMethodCreatedDate()	0	4	1
A	getShippingAddressFirstUsedIndicator()	0	4	1
A	setShippingAddressFirstUsedIndicator()	0	16	2
A	getShippingAddressFirstUsedDate()	0	4	1
A	setShippingAddressFirstUsedDate()	0	4	1
A	getShippingNameCustomerNameMatch()	0	4	1
A	setShippingNameCustomerNameMatch()	0	4	1
A	getCustomerHasSuspiciousActivity()	0	4	1
A	setCustomerHasSuspiciousActivity()	0	4	1
A	getDeliveryEmail()	0	4	1
A	setDeliveryEmail()	0	4	1
A	getDeliveryTimeframeIndicator()	0	4	1
A	setDeliveryTimeframeIndicator()	0	16	2
A	getGiftCardAmount()	0	4	1
A	setGiftCardAmount()	0	4	1
A	getGiftCardCount()	0	4	1
A	setGiftCardCount()	0	4	1
A	getGiftCardCurrency()	0	4	1
A	setGiftCardCurrency()	0	4	1
A	getPurchasingPreOrder()	0	4	1
A	setPurchasingPreOrder()	0	4	1
A	getPreOrderDate()	0	4	1
A	setPreOrderDate()	0	4	1
A	getCustomerHasPurchasedProductBefore()	0	4	1
A	setCustomerHasPurchasedProductBefore()	0	4	1
A	getShippingAddressIndicator()	0	4	1
A	setShippingAddressIndicator()	19	19	2
A	getScaExemptionIndicator()	0	4	1
A	setScaExemptionIndicator()	0	16	2
A	setTransactionId()	0	15	3
F	getData()	0	222	126
A	sendData()	0	18	1
A	getEndpoint()	0	4	2
A	formatDateTime()	0	8	3
How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class
Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.
Complex classes like PurchaseRequest often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use PurchaseRequest, and based on these observations, apply Extract Interface, too.
<?php

namespace Omnipay\Redsys\Message;

use DateTime;
use DateTimeZone;
use OmniPay\CreditCard;
use Omnipay\Common\Message\AbstractRequest;
use Omnipay\Redsys\Exception\InvalidParameterException;

/**
 * Redsys Purchase Request
 */
class PurchaseRequest extends AbstractRequest
{
    /** @var string */
    protected $liveEndpoint = 'https://sis.redsys.es/sis/realizarPago';
    /** @var string */
    protected $testEndpoint = 'https://sis-t.redsys.es:25443/sis/realizarPago';
    /** @var array */
    protected static $consumerLanguages = array(
        'es' => '001', // Spanish
        'en' => '002', // English
        'ca' => '003', // Catalan - same as Valencian (010)
        'fr' => '004', // French
        'de' => '005', // German
        'nl' => '006', // Dutch
        'it' => '007', // Italian
        'sv' => '008', // Swedish
        'pt' => '009', // Portuguese
        'pl' => '011', // Polish
        'gl' => '012', // Galician
        'eu' => '013', // Basque
    );

    /** @var string 250x400 */
    const CHALLENGE_WINDOW_SIZE_250_400 = "01";
    /** @var string 390x400 */
    const CHALLENGE_WINDOW_SIZE_390_400 = "02";
    /** @var string 500x600 */
    const CHALLENGE_WINDOW_SIZE_500_600 = "03";
    /** @var string 600x400 */
    const CHALLENGE_WINDOW_SIZE_600_400 = "04";
    /** @var string Fullscreen window (default) */
    const CHALLENGE_WINDOW_SIZE_FULLSCREEN = "05";

    /** @var string No 3DS Requestor authentication occurred (i.e. cardholder logged in as guest) */
    const ACCOUNT_AUTHENTICATION_METHOD_NONE = "01";
    /** @var string Login to the cardholder account at the 3DS Requestor system using 3DS Requestor's own credentials */
    const ACCOUNT_AUTHENTICATION_METHOD_OWN_CREDENTIALS = "02";
    /** @var string Login to the cardholder account at the 3DS Requestor system using federated ID */
    const ACCOUNT_AUTHENTICATION_METHOD_FEDERATED_ID = "03";
    /** @var string Login to the cardholder account at the 3DS Requestor system using issuer credentials */
    const ACCOUNT_AUTHENTICATION_METHOD_ISSUER_CREDENTIALS = "04";
    /** @var string Login to the cardholder account at the 3DS Requestor system using third-party authentication */
    const ACCOUNT_AUTHENTICATION_METHOD_THIRD_PARTY_AUTHENTICATION = "05";
    /** @var string Login to the cardholder account at the 3DS Requestor system using FIDO Authenticator */
    const ACCOUNT_AUTHENTICATION_METHOD_FIDO = "06";

    /** @var string No account (guest check-out) */
    const CUSTOMER_ACCOUNT_CREATED_NONE = "01";
    /** @var string Created during this transaction */
    const CUSTOMER_ACCOUNT_CREATED_THIS_TRANSACTION = "02";
    /** @var string Less than 30 days */
    const CUSTOMER_ACCOUNT_CREATED_LAST_30_DAYS = "03";
    /** @var string Between 30 and 60 days */
    const CUSTOMER_ACCOUNT_CREATED_LAST_60_DAYS = "04";
    /** @var string More than 60 day */
    const CUSTOMER_ACCOUNT_CREATED_MORE_THAN_60_DAYS = "05";

    /** @var string Modified in this session */
    const CUSTOMER_ACCOUNT_MODIFIED_THIS_TRANSACTION = "01";
    /** @var string Less than 30 days */
    const CUSTOMER_ACCOUNT_MODIFIED_LAST_30_DAYS = "02";
    /** @var string Between 30 and 60 days */
    const CUSTOMER_ACCOUNT_MODIFIED_LAST_60_DAYS = "03";
    /** @var string More than 60 day */
    const CUSTOMER_ACCOUNT_MODIFIED_MORE_THAN_60_DAYS = "04";

    /** @var string Unchanged */
    const CUSTOMER_ACCOUNT_PASSWORD_MODIFIED_NONE = "01";
    /** @var string Modified in this session */
    const CUSTOMER_ACCOUNT_PASSWORD_MODIFIED_THIS_TRANSACTION = "02";
    /** @var string Less than 30 days */
    const CUSTOMER_ACCOUNT_PASSWORD_MODIFIED_LAST_30_DAYS = "03";
    /** @var string Between 30 and 60 days */
    const CUSTOMER_ACCOUNT_PASSWORD_MODIFIED_LAST_60_DAYS = "04";
    /** @var string More than 60 day */
    const CUSTOMER_ACCOUNT_PASSWORD_MODIFIED_MORE_THAN_60_DAYS = "05";

    /** @var string No account (guest check-out) */
    const PAYMENT_METHOD_CREATED_NONE = "01";
    /** @var string Created during this transaction */
    const PAYMENT_METHOD_CREATED_THIS_TRANSACTION = "02";
    /** @var string Less than 30 days */
    const PAYMENT_METHOD_CREATED_LAST_30_DAYS = "03";
    /** @var string Between 30 and 60 days */
    const PAYMENT_METHOD_CREATED_LAST_60_DAYS = "04";
    /** @var string More than 60 day */
    const PAYMENT_METHOD_CREATED_MORE_THAN_60_DAYS = "05";

    /** @var string For the first time */
    const SHIPPING_ADDRESS_USAGE_THIS_TRANSACTION = "01";
    /** @var string Less than 30 days */
    const SHIPPING_ADDRESS_USAGE_LAST_30_DAYS = "02";
    /** @var string Between 30 and 60 days */
    const SHIPPING_ADDRESS_USAGE_LAST_60_DAYS = "03";
    /** @var string More than 60 day */
    const SHIPPING_ADDRESS_USAGE_MORE_THAN_60_DAYS = "04";

    /** @var string Electronic delivery */
    const DELIVERY_TIMEFRAME_ELECTRONIC_DELIVERY = "01";
    /** @var string Same day shipping */
    const DELIVERY_TIMEFRAME_SAME_DAY = "02";
    /** @var string Next day shipping */
    const DELIVERY_TIMEFRAME_NEXT_DAY = "03";
    /** @var string Shipping in 2 or more days */
    const DELIVERY_TIMEFRAME_2_OR_MORE_DAYS = "04";

    /** @var string Ship to cardholder's billing address */
    const SHIPPING_TO_BILLING_ADDRESS = "01";
    /** @var string Ship to another verified address on file with merchant */
    const SHIPPING_TO_ANOTHER_VERIFIED_ADDRESS = "02";
    /** @var string Ship to address that is different than the cardholder's billing address */
    const SHIPPING_DIFFERENT_BILLING_ADDRESS = "03";
    /** @var string Pick-up at local store (Store address shall be populated in shipping address fields) */
    const SHIPPING_PICK_UP = "04";
    /** @var string Digital goods (includes online services, electronic gift cards and redemption codes) */
    const SHIPPING_DIGITAL = "05";
    /** @var string Travel and Event tickets, not shipped */
    const SHIPPING_TRAVEL = "06";
    /** @var string Other (for example, Gaming, digital services not shipped, emedia subscriptions, etc.) */
    const SHIPPING_OTHER = "07";

    /** @var string Exemption due to low amount (transactions up to € 30) */
    const SCA_EXCEMPTION_LOW_AMOUNT = 'LMV';
    /** @var string Exemption due to low risk */
    const SCA_EXCEMPTION_LOW_RISK = 'TRA';
    /** @var string Exemption for payments identified as corporate. */
    const SCA_EXCEMPTION_CORPORATE = 'COR';
    /**
     * @var string Transactions initiated by the merchant, in which there is no intervention by the customer. They are
     *             outside the scope of PSD2.
     */
    const SCA_EXCEMPTION_MERCHANT_INITIATED = 'MIT';

    /**
     * Get the card field
     *
     * @return OmniPay::CreditCard

     */
    public function getCard()
    {
        return $this->getParameter('card');
    }

    /**
     * Set the card field
     *
     * @param OmniPay::CreditCard $value

     * @return self
     */
    public function setCard($value)
    {
        return $this->setParameter('card', $value);
    }

    public function getCardholder()
    {
        return $this->getParameter('cardholder');
    }

    public function setCardholder($value)
    {
        return $this->setParameter('cardholder', $value);
    }

    public function getConsumerLanguage()
    {
        return $this->getParameter('consumerLanguage');
    }

    /**
     * Set the language presented to the consumer
     *
     * @param string|int Either the ISO 639-1 code to be converted, or the gateway's own numeric language code
     */
    public function setConsumerLanguage($value)
    {
        if (is_int($value)) {
            if ($value < 0 || $value > 13) {
                $value = 1;
            }
            $value = str_pad($value, 3, '0', STR_PAD_LEFT);
        } elseif (!is_numeric($value)) {
            $value = isset(self::$consumerLanguages[$value]) ? self::$consumerLanguages[$value] : '001';
        }

        return $this->setParameter('consumerLanguage', $value);
    }

    public function getHmacKey()
    {
        return $this->getParameter('hmacKey');
    }

    public function setHmacKey($value)
    {
        return $this->setParameter('hmacKey', $value);
    }

    public function getMerchantData()
    {
        return $this->getParameter('merchantData');
    }

    public function setMerchantData($value)
    {
        return $this->setParameter('merchantData', $value);
    }

    public function getMerchantId()
    {
        return $this->getParameter('merchantId');
    }

    public function setMerchantId($value)
    {
        return $this->setParameter('merchantId', $value);
    }

    public function getMerchantName()
    {
        return $this->getParameter('merchantName');
    }

    public function setMerchantName($value)
    {
        return $this->setParameter('merchantName', $value);
    }

    public function getTerminalId()
    {
        return $this->getParameter('terminalId');
    }

    public function setTerminalId($value)
    {
        return $this->setParameter('terminalId', $value);
    }

    /**
     * Get the email field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.email field in Redsys documentation.
     *
     * @return string
     */
    public function getEmail()
    {
        return $this->getParameter('email');
    }

    /**
     * Set the email field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.email field in Redsys documentation.
     *
     * @param string $value
     * @return self
     */
    public function setEmail($value)
    {
        return $this->setParameter('email', $value);
    }

    /**
     * Get the shippingAddress3 field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.shippingAddress3 field in Redsys documentation.
     *
     * @return string
     */
    public function getShippingAddress3()
    {
        return $this->getParameter('shippingAddress3');
    }

    /**
     * Set the shippingAddress3 field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.shippingAddress3 field in Redsys documentation.
     *
     * @param string $value
     * @return self
     */
    public function setShippingAddress3($value)
    {
        return $this->setParameter('shippingAddress3', $value);
    }

    /**
     * Get the billingAddress3 field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.billingAddress3 field in Redsys documentation.
     *
     * @return string
     */
    public function getBillingAddress3()
    {
        return $this->getParameter('billingAddress3');
    }

    /**
     * Set the billingAddress3 field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.billingAddress3 field in Redsys documentation.
     *
     * @param string $value
     * @return self
     */
    public function setBillingAddress3($value)
    {
        return $this->setParameter('billingAddress3', $value);
    }

    /**
     * Get the homePhoneCountryPrefix field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.homePhone.cc field in Redsys documentation.
     *
     * @return string
     */
    public function getHomePhoneCountryPrefix()
    {
        return $this->getParameter('homePhoneCountryPrefix');
    }

    /**
     * Set the homePhoneCountryPrefix field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.homePhone.cc field in the Redsys documentation.
     *
     * @param string $value
     * @return self
     */
    public function setHomePhoneCountryPrefix($value)
    {
        return $this->setParameter('homePhoneCountryPrefix', $value);
    }

    /**
     * Get the homePhone field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.homePhone.subscriber field in Redsys documentation.
     *
     * @return string
     */
    public function getHomePhone()
    {
        return $this->getParameter('homePhone');
    }

    /**
     * Set the homePhone field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.homePhone.subscriber field in the Redsys documentation.
     *
     * @param string $value
     * @return self
     */
    public function setHomePhone($value)
    {
        return $this->setParameter('homePhone', $value);
    }

    /**
     * Get the mobilePhoneCountryPrefix field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.mobilePhone.cc field in Redsys documentation.
     *
     * @return string
     */
    public function getMobilePhoneCountryPrefix()
    {
        return $this->getParameter('mobilePhoneCountryPrefix');
    }

    /**
     * Set the mobilePhoneCountryPrefix field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.mobilePhone.cc field in the Redsys documentation.
     *
     * @param string $value
     * @return self
     */
    public function setMobilePhoneCountryPrefix($value)
    {
        return $this->setParameter('mobilePhoneCountryPrefix', $value);
    }

    /**
     * Get the mobilePhone field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.mobilePhone.subscriber field in Redsys documentation.
     *
     * @return string
     */
    public function getMobilePhone()
    {
        return $this->getParameter('mobilePhone');
    }

    /**
     * Set the mobilePhone field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.mobilePhone.subscriber field in the Redsys documentation.
     *
     * @param string $value
     * @return self
     */
    public function setMobilePhone($value)
    {
        return $this->setParameter('mobilePhone', $value);
    }

    /**
     * Get the workPhoneCountryPrefix field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.workPhone.cc field in Redsys documentation.
     *
     * @return string
     */
    public function getWorkPhoneCountryPrefix()
    {
        return $this->getParameter('workPhoneCountryPrefix');
    }

    /**
     * Set the workPhoneCountryPrefix field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.workPhone.cc field in the Redsys documentation.
     *
     * @param string $value
     * @return self
     */
    public function setWorkPhoneCountryPrefix($value)
    {
        return $this->setParameter('workPhoneCountryPrefix', $value);
    }

    /**
     * Get the workPhone field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.workPhone.subscriber field in Redsys documentation.
     *
     * @return string
     */
    public function getWorkPhone()
    {
        return $this->getParameter('workPhone');
    }

    /**
     * Set the workPhone field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.workPhone.subscriber field in the Redsys documentation.
     *
     * @param string $value
     * @return self
     */
    public function setWorkPhone($value)
    {
        return $this->setParameter('workPhone', $value);
    }

    /**
     * Get the addressMatch field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.addrMatch field in Redsys documentation.
     *
     * @return boolean
     */
    public function getAddressMatch()
    {
        return $this->getParameter('addressMatch');
    }

    /**
     * Set the addressMatch field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.addrMatch field in the Redsys documentation.
     *
     * @param boolean $value
     * @return self
     */
    public function setAddressMatch($value)
    {
        return $this->setParameter('addressMatch', $value);
    }

    /**
     * Get the challengeWindowSize field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.challengeWindowSize field in Redsys documentation.
     *
     * @return string One of the self::CHALLENGE_WINDOW_SIZE_* constants
     */
    public function getChallengeWindowSize()
    {
        return $this->getParameter('challengeWindowSize');
    }

    /**
     * Set the challengeWindowSize field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.challengeWindowSize field in the Redsys documentation.
     *
     * @param string $value One of the self::CHALLENGE_WINDOW_SIZE_* constants
     * @return self
     * @throws InvalidParameterException if $value is invalid.
     */
    public function setChallengeWindowSize($value)
    {
        if (in_array(
            $value,
            [
                null,
                self::CHALLENGE_WINDOW_SIZE_250_400,
                self::CHALLENGE_WINDOW_SIZE_390_400,
                self::CHALLENGE_WINDOW_SIZE_500_600,
                self::CHALLENGE_WINDOW_SIZE_600_400,
                self::CHALLENGE_WINDOW_SIZE_FULLSCREEN,
            ]
        )) {
            return $this->setParameter('challengeWindowSize', $value);
        }
        throw new InvalidParameterException("Invalid challengeWindowSize parameter");
    }

    /**
     * Get the customerAdditionalInformation field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctID field in Redsys documentation.
     *
     * @return string
     */
    public function getCustomerAdditionalInformation()
    {
        return $this->getParameter('customerAdditionalInformation');
    }

    /**
     * Set the customerAdditionalInformation field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctID field in the Redsys documentation.
     *
     * @param string $value
     * @return self
     */
    public function setCustomerAdditionalInformation($value)
    {
        return $this->setParameter('customerAdditionalInformation', $value);
    }

    /**
     * Get the 3DsRequestAuthenticationMethodData field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.threeDSRequestorAuthenticationInfo.threeDSReqAuthData field in Redsys
     * documentation.
     *
     * @return string
     */
    public function get3DsRequestAuthenticationMethodData()
    {
        return $this->getParameter('3DsRequestAuthenticationMethodData');
    }

    /**
     * Set the 3DsRequestAuthenticationMethodData field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.threeDSRequestorAuthenticationInfo.threeDSReqAuthData field in the Redsys
     * documentation.
     *
     * @param string $value
     * @return self
     */
    public function set3DsRequestAuthenticationMethodData($value)
    {
        return $this->setParameter('3DsRequestAuthenticationMethodData', $value);
    }

    /**
     * Get the 3DsRequestAuthenticationMethod field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.threeDSRequestorAuthenticationInfo.threeDSReqAuthMethod field in Redsys
     * documentation.
     *
     * @return string One of the self::ACCOUNT_AUTHENTICATION_METHOD_* constants.
     */
    public function get3DsRequestAuthenticationMethod()
    {
        return $this->getParameter('3DsRequestAuthenticationMethod');
    }

    /**
     * Set the 3DsRequestAuthenticationMethod field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.threeDSRequestorAuthenticationInfo.threeDSReqAuthMethod field in the Redsys
     * documentation.
     *
     * @param string $value One of the self::ACCOUNT_AUTHENTICATION_METHOD_* constants.
     * @return self
     * @throws InvalidParameterException if $value is invalid.
     */
    public function set3DsRequestAuthenticationMethod($value)

    {
        if (in_array(
            $value,
            [
                null,
                self::ACCOUNT_AUTHENTICATION_METHOD_NONE,
                self::ACCOUNT_AUTHENTICATION_METHOD_OWN_CREDENTIALS,
                self::ACCOUNT_AUTHENTICATION_METHOD_FEDERATED_ID,
                self::ACCOUNT_AUTHENTICATION_METHOD_ISSUER_CREDENTIALS,
                self::ACCOUNT_AUTHENTICATION_METHOD_THIRD_PARTY_AUTHENTICATION,
                self::ACCOUNT_AUTHENTICATION_METHOD_FIDO,
            ]
        )) {
            return $this->setParameter('3DsRequestAuthenticationMethod', $value);
        }
        throw new InvalidParameterException("Invalid 3DsRequestAuthenticationMethod parameter");
    }

    /**
     * Get the 3DsRequestAuthenticationTime field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.threeDSRequestorAuthenticationInfo.threeDSReqAuthTimestamp field in Redsys
     * documentation.
     *
     * @return DateTime|int
     */
    public function get3DsRequestAuthenticationTime()
    {
        return $this->getParameter('3DsRequestAuthenticationTime');
    }

    /**
     * Set the 3DsRequestAuthenticationTime field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.threeDSRequestorAuthenticationInfo.threeDSReqAuthTimestamp field in the
     * Redsys documentation.
     *
     * @param DateTime|int $value
     * @return self
     */
    public function set3DsRequestAuthenticationTime($value)
    {
        return $this->setParameter('3DsRequestAuthenticationTime', $value);
    }

    /**
     * Get the customerAccountCreatedIndicator field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.chAccAgeInd field in Redsys documentation.
     *
     * @return string One of the CUSTOMER_ACCOUNT_CREATED_* constants
     */
    public function getCustomerAccountCreatedIndicator()
    {
        return $this->getParameter('customerAccountCreatedIndicator');
    }

    /**
     * Set the customerAccountCreatedIndicator field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.chAccAgeInd field in the Redsys documentation.
     *
     * @param string $value One of the CUSTOMER_ACCOUNT_CREATED_* constants
     * @return self
     * @throws InvalidParameterException if $value is invalid.
     */
    public function setCustomerAccountCreatedIndicator($value)
    {
        if (in_array(
        		$value,
        		[
                null,
                self::CUSTOMER_ACCOUNT_CREATED_NONE,
                self::CUSTOMER_ACCOUNT_CREATED_THIS_TRANSACTION,
                self::CUSTOMER_ACCOUNT_CREATED_LAST_30_DAYS,
                self::CUSTOMER_ACCOUNT_CREATED_LAST_60_DAYS,
                self::CUSTOMER_ACCOUNT_CREATED_MORE_THAN_60_DAYS,
        		]
        )) {
        		return $this->setParameter('customerAccountCreatedIndicator', $value);
        }
    		throw new InvalidParameterException("Invalid customerAccountCreatedIndicator parameter");
    }

    /**
     * Get the customerAccountCreatedDate field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.chAccDate field in Redsys documentation.
     *
     * @return DateTime|int
     */
    public function getCustomerAccountCreatedDate()
    {
        return $this->getParameter('customerAccountCreatedDate');
    }

    /**
     * Set the customerAccountCreatedDate field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.chAccDate field in the Redsys documentation.
     *
     * @param DateTime|int $value
     * @return self
     */
    public function setCustomerAccountCreatedDate($value)
    {
        return $this->setParameter('customerAccountCreatedDate', $value);
    }

    /**
     * Get the customerAccountChangedIndicator field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.chAccChangeInd field in Redsys documentation.
     *
     * @return string One of the CUSTOMER_ACCOUNT_MODIFIED_* constants
     */
    public function getCustomerAccountChangedIndicator()
    {
        return $this->getParameter('customerAccountChangedIndicator');
    }

    /**
     * Set the customerAccountChangedIndicator field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.chAccChangeInd field in the Redsys documentation.
     *
     * @param string $value One of the CUSTOMER_ACCOUNT_MODIFIED_* constants
     * @return self
     * @throws InvalidParameterException if $value is invalid.
     */
    public function setCustomerAccountChangedIndicator($value)
    {
        if (in_array(
        		$value,
        		[
                null,
                self::CUSTOMER_ACCOUNT_MODIFIED_THIS_TRANSACTION,
                self::CUSTOMER_ACCOUNT_MODIFIED_LAST_30_DAYS,
                self::CUSTOMER_ACCOUNT_MODIFIED_LAST_60_DAYS,
                self::CUSTOMER_ACCOUNT_MODIFIED_MORE_THAN_60_DAYS,
        		]
        )) {
        		return $this->setParameter('customerAccountChangedIndicator', $value);
        }
    		throw new InvalidParameterException("Invalid customerAccountChangedIndicator parameter");
    }

    /**
     * Get the customerAccountChangedDate field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.chAccChange field in Redsys documentation.
     *
     * @return DateTime|int
     */
    public function getCustomerAccountChangedDate()
    {
        return $this->getParameter('customerAccountChangedDate');
    }

    /**
     * Set the customerAccountChangedDate field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.chAccChange field in the Redsys documentation.
     *
     * @param DateTime|int $value
     * @return self
     */
    public function setCustomerAccountChangedDate($value)
    {
        return $this->setParameter('customerAccountChangedDate', $value);
    }

    /**
     * Get the customerPasswordAgeIndicator field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.chAccPwChangeInd field in Redsys documentation.
     *
     * @return string One of the CUSTOMER_ACCOUNT_PASSWORD_MODIFIED_* constants
     */
    public function getCustomerPasswordChangedIndicator()
    {
        return $this->getParameter('customerPasswordAgeIndicator');
    }

    /**
     * Set the customerPasswordAgeIndicator field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.chAccPwChangeInd field in the Redsys documentation.
     *
     * @param string $value One of the CUSTOMER_ACCOUNT_PASSWORD_MODIFIED_* constants
     * @return self
     * @throws InvalidParameterException if $value is invalid.
     */
    public function setCustomerPasswordChangedIndicator($value)
    {
        if (in_array(
        		$value,
        		[
                null,
                self::CUSTOMER_ACCOUNT_PASSWORD_MODIFIED_NONE,
                self::CUSTOMER_ACCOUNT_PASSWORD_MODIFIED_THIS_TRANSACTION,
                self::CUSTOMER_ACCOUNT_PASSWORD_MODIFIED_LAST_30_DAYS,
                self::CUSTOMER_ACCOUNT_PASSWORD_MODIFIED_LAST_60_DAYS,
                self::CUSTOMER_ACCOUNT_PASSWORD_MODIFIED_MORE_THAN_60_DAYS,
        		]
        )) {
        		return $this->setParameter('customerPasswordAgeIndicator', $value);
        }
    		throw new InvalidParameterException("Invalid customerPasswordAgeIndicator parameter");
    }

    /**
     * Get the customerPasswordChangedDate field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.chAccPwChange field in Redsys documentation.
     *
     * @return DateTime|int
     */
    public function getCustomerPasswordChangedDate()
    {
        return $this->getParameter('customerPasswordChangedDate');
    }

    /**
     * Set the customerPasswordChangedDate field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.chAccPwChange field in the Redsys documentation.
     *
     * @param DateTime|int $value
     * @return self
     */
    public function setCustomerPasswordChangedDate($value)
    {
        return $this->setParameter('customerPasswordChangedDate', $value);
    }

    /**
     * Get the customerPurchasesInLast6Months field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.nbPurchaseAccount field in Redsys documentation.
     *
     * @return int
     */
    public function getCustomerPurchasesInLast6Months()
    {
        return $this->getParameter('customerPurchasesInLast6Months');
    }

    /**
     * Set the customerPurchasesInLast6Months field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.nbPurchaseAccount field in the Redsys documentation.
     *
     * @param int $value
     * @return self
     */
    public function setCustomerPurchasesInLast6Months($value)
    {
        return $this->setParameter('customerPurchasesInLast6Months', $value);
    }

    /**
     * Get the customerAccountCardProvisionsLast24Hours field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.provisionAttemptsDay field in Redsys documentation.
     *
     * @return int
     */
    public function getCustomerAccountCardProvisionsLast24Hours()
    {
        return $this->getParameter('customerAccountCardProvisionsLast24Hours');
    }

    /**
     * Set the customerAccountCardProvisionsLast24Hours field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.provisionAttemptsDay field in the Redsys documentation.
     *
     * @param int $value
     * @return self
     */
    public function setCustomerAccountCardProvisionsLast24Hours($value)
    {
        return $this->setParameter('customerAccountCardProvisionsLast24Hours', $value);
    }

    /**
     * Get the customerAccountTransactionsLast24Hours field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.txnActivityDay field in Redsys documentation.
     *
     * @return int
     */
    public function getCustomerAccountTransactionsLast24Hours()
    {
        return $this->getParameter('customerAccountTransactionsLast24Hours');
    }

    /**
     * Set the customerAccountTransactionsLast24Hours field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.txnActivityDay field in the Redsys documentation.
     *
     * @param int $value
     * @return self
     */
    public function setCustomerAccountTransactionsLast24Hours($value)
    {
        return $this->setParameter('customerAccountTransactionsLast24Hours', $value);
    }

    /**
     * Get the customerAccountTransactionsLastYear field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.txnActivityYear field in Redsys documentation.
     *
     * @return int
     */
    public function getCustomerAccountTransactionsLastYear()
    {
        return $this->getParameter('customerAccountTransactionsLastYear');
    }

    /**
     * Set the customerAccountTransactionsLastYear field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.txnActivityYear field in the Redsys documentation.
     *
     * @param int $value
     * @return self
     */
    public function setCustomerAccountTransactionsLastYear($value)
    {
        return $this->setParameter('customerAccountTransactionsLastYear', $value);
    }

    /**
     * Get the customerPaymentMethodCreatedIndicator field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.paymentAccInd field in Redsys documentation.
     *
     * @return string One of the PAYMENT_METHOD_CREATED_* constants
     */
    public function getCustomerPaymentMethodCreatedIndicator()
    {
        return $this->getParameter('customerPaymentMethodCreatedIndicator');
    }

    /**
     * Set the customerPaymentMethodCreatedIndicator field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.paymentAccInd field in the Redsys documentation.
     *
     * @param string $value One of the PAYMENT_METHOD_CREATED_* constants
     * @return self
     * @throws InvalidParameterException if $value is invalid.
     */
    public function setCustomerPaymentMethodCreatedIndicator($value)
    {
        if (in_array(
        		$value,
        		[
                null,
                self::PAYMENT_METHOD_CREATED_NONE,
                self::PAYMENT_METHOD_CREATED_THIS_TRANSACTION,
                self::PAYMENT_METHOD_CREATED_LAST_30_DAYS,
                self::PAYMENT_METHOD_CREATED_LAST_60_DAYS,
                self::PAYMENT_METHOD_CREATED_MORE_THAN_60_DAYS,
        		]
        )) {
        		return $this->setParameter('customerPaymentMethodCreatedIndicator', $value);
        }
    		throw new InvalidParameterException("Invalid customerPaymentMethodCreatedIndicator parameter");
    }

    /**
     * Get the customerPaymentMethodCreatedDate field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.paymentAccAge field in Redsys documentation.
     *
     * @return DateTime|int
     */
    public function getCustomerPaymentMethodCreatedDate()
    {
        return $this->getParameter('customerPaymentMethodCreatedDate');
    }

    /**
     * Set the customerPaymentMethodCreatedDate field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.paymentAccAge field in the Redsys documentation.
     *
     * @param DateTime|int $value
     * @return self
     */
    public function setCustomerPaymentMethodCreatedDate($value)
    {
        return $this->setParameter('customerPaymentMethodCreatedDate', $value);
    }

    /**
     * Get the shippingAddressFirstUsedIndicator field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.shipAddressUsageInd field in Redsys documentation.
     *
     * @return string One of the SHIPPING_ADDRESS_USAGE_* constants
     */
    public function getShippingAddressFirstUsedIndicator()
    {
        return $this->getParameter('shippingAddressFirstUsedIndicator');
    }

    /**
     * Set the shippingAddressFirstUsedIndicator field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.shipAddressUsageInd field in the Redsys documentation.
     *
     * @param string $value One of the SHIPPING_ADDRESS_USAGE_* constants
     * @return self
     * @throws InvalidParameterException if $value is invalid.
     */
    public function setShippingAddressFirstUsedIndicator($value)
    {
        if (in_array(
        		$value,
        		[
                null,
                self::SHIPPING_ADDRESS_USAGE_THIS_TRANSACTION,
                self::SHIPPING_ADDRESS_USAGE_LAST_30_DAYS,
                self::SHIPPING_ADDRESS_USAGE_LAST_60_DAYS,
                self::SHIPPING_ADDRESS_USAGE_MORE_THAN_60_DAYS,
        		]
        )) {
        		return $this->setParameter('shippingAddressFirstUsedIndicator', $value);
        }
    		throw new InvalidParameterException("Invalid shippingAddressFirstUsedIndicator parameter");
    }

    /**
     * Get the shippingAddressFirstUsedDate field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.shipAddressUsage field in Redsys documentation.
     *
     * @return DateTime|int
     */
    public function getShippingAddressFirstUsedDate()
    {
        return $this->getParameter('shippingAddressFirstUsedDate');
    }

    /**
     * Set the shippingAddressFirstUsedDate field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.shipAddressUsage field in the Redsys documentation.
     *
     * @param DateTime|int $value
     * @return self
     */
    public function setShippingAddressFirstUsedDate($value)
    {
        return $this->setParameter('shippingAddressFirstUsedDate', $value);
    }

    /**
     * Get the shippingNameCustomerNameMatch field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.shipNameIndicator field in Redsys documentation.
     *
     * @return boolean
     */
    public function getShippingNameCustomerNameMatch()
    {
        return $this->getParameter('shippingNameCustomerNameMatch');
    }

    /**
     * Set the shippingNameCustomerNameMatch field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.shipNameIndicator field in the Redsys documentation.
     *
     * @param boolean $value
     * @return self
     */
    public function setShippingNameCustomerNameMatch($value)
    {
        return $this->setParameter('shippingNameCustomerNameMatch', $value);
    }

    /**
     * Get the customerHasSuspiciousActivity field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.suspiciousAccActivity field in Redsys documentation.
     *
     * @return boolean
     */
    public function getCustomerHasSuspiciousActivity()
    {
        return $this->getParameter('customerHasSuspiciousActivity');
    }

    /**
     * Set the customerHasSuspiciousActivity field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.acctInfo.suspiciousAccActivity field in the Redsys documentation.
     *
     * @param boolean $value
     * @return self
     */
    public function setCustomerHasSuspiciousActivity($value)
    {
        return $this->setParameter('customerHasSuspiciousActivity', $value);
    }

    /**
     * Get the deliveryEmail field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.MerchantRiskIndicator.deliveryEmailAddress field in Redsys documentation.
     *
     * @return string
     */
    public function getDeliveryEmail()
    {
        return $this->getParameter('deliveryEmail');
    }

    /**
     * Set the deliveryEmail field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.MerchantRiskIndicator.deliveryEmailAddress field in the Redsys
     * documentation.
     *
     * @param string $value
     * @return self
     */
    public function setDeliveryEmail($value)
    {
        return $this->setParameter('deliveryEmail', $value);
    }

    /**
     * Get the deliveryTimeframeIndicator field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.MerchantRiskIndicator.deliveryTimeframe field in Redsys documentation.
     *
     * @return string One of the DELIVERY_TIMEFRAME_* constants
     */
    public function getDeliveryTimeframeIndicator()
    {
        return $this->getParameter('deliveryTimeframeIndicator');
    }

    /**
     * Set the deliveryTimeframeIndicator field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.MerchantRiskIndicator.deliveryTimeframe field in the Redsys documentation.
     *
     * @param string $value One of the DELIVERY_TIMEFRAME_* constants
     * @return self
     * @throws InvalidParameterException if $value is invalid.
     */
    public function setDeliveryTimeframeIndicator($value)
    {
        if (in_array(
        		$value,
        		[
                null,
                self::DELIVERY_TIMEFRAME_ELECTRONIC_DELIVERY,
                self::DELIVERY_TIMEFRAME_SAME_DAY,
                self::DELIVERY_TIMEFRAME_NEXT_DAY,
                self::DELIVERY_TIMEFRAME_2_OR_MORE_DAYS,
        		]
        )) {
        		return $this->setParameter('deliveryTimeframeIndicator', $value);
        }
    		throw new InvalidParameterException("Invalid deliveryTimeframeIndicator parameter");
    }

    /**
     * Get the giftCardAmount field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.MerchantRiskIndicator.giftCardAmount field in Redsys documentation.
     *
     * @return int
     */
    public function getGiftCardAmount()
    {
        return $this->getParameter('giftCardAmount');
    }

    /**
     * Set the giftCardAmount field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.MerchantRiskIndicator.giftCardAmount field in the Redsys documentation.
     *
     * @param int $value
     * @return self
     */
    public function setGiftCardAmount($value)
    {
        return $this->setParameter('giftCardAmount', $value);
    }

    /**
     * Get the giftCardCount field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.MerchantRiskIndicator.giftCardCount field in Redsys documentation.
     *
     * @return int
     */
    public function getGiftCardCount()
    {
        return $this->getParameter('giftCardCount');
    }

    /**
     * Set the giftCardCount field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.MerchantRiskIndicator.giftCardCount field in the Redsys documentation.
     *
     * @param int $value
     * @return self
     */
    public function setGiftCardCount($value)
    {
        return $this->setParameter('giftCardCount', $value);
    }

    /**
     * Get the giftCardCurrency field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.MerchantRiskIndicator.giftCardCurr field in Redsys documentation.
     *
     * @return string ISO-4217 currency code
     */
    public function getGiftCardCurrency()
    {
        return $this->getParameter('giftCardCurrency');
    }

    /**
     * Set the giftCardCurrency field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.MerchantRiskIndicator.giftCardCurr field in the Redsys documentation.
     *
     * @param string $value ISO-4217 currency code
     * @return self
     */
    public function setGiftCardCurrency($value)
    {
        return $this->setParameter('giftCardCurrency', $value);
    }

    /**
     * Get the purchasingPreOrder field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.MerchantRiskIndicator.preOrderPurchaseInd field in Redsys documentation.
     *
     * @return boolean True if the customer is purchasing a preorder
     */
    public function getPurchasingPreOrder()
    {
        return $this->getParameter('purchasingPreOrder');
    }

    /**
     * Set the purchasingPreOrder field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.MerchantRiskIndicator.preOrderPurchaseInd field in the Redsys
     * documentation.
     *
     * @param boolean $value True if the customer is purchasing a preorder
     * @return self
     */
    public function setPurchasingPreOrder($value)
    {
        return $this->setParameter('purchasingPreOrder', $value);
    }

    /**
     * Get the preOrderDate field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.MerchantRiskIndicator.preOrderDate field in Redsys documentation.
     *
     * @return DateTime|int
     */
    public function getPreOrderDate()
    {
        return $this->getParameter('preOrderDate');
    }

    /**
     * Set the preOrderDate field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.MerchantRiskIndicator.preOrderDate field in the Redsys documentation.
     *
     * @param DateTime|int $value
     * @return self
     */
    public function setPreOrderDate($value)
    {
        return $this->setParameter('preOrderDate', $value);
    }

    /**
     * Get the customerHasPurchasedProductBefore field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.MerchantRiskIndicator.reorderItemsInd field in Redsys documentation.
     *
     * @return boolean
     */
    public function getCustomerHasPurchasedProductBefore()
    {
        return $this->getParameter('customerHasPurchasedProductBefore');
    }

    /**
     * Set the customerHasPurchasedProductBefore field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.MerchantRiskIndicator.reorderItemsInd field in the Redsys documentation.
     *
     * @param boolean $value
     * @return self
     */
    public function setCustomerHasPurchasedProductBefore($value)
    {
        return $this->setParameter('customerHasPurchasedProductBefore', $value);
    }

    /**
     * Get the shippingAddressIndicator field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.MerchantRiskIndicator.shipIndicator field in Redsys documentation.
     *
     * @return string One of the self::SHIPPING_* constants
     */
    public function getShippingAddressIndicator()
    {
        return $this->getParameter('shippingAddressIndicator');
    }

    /**
     * Set the shippingAddressIndicator field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.MerchantRiskIndicator.shipIndicator field in the Redsys documentation.
     *
     * @param string $value One of the self::SHIPPING_* constants
     * @return self
     * @throws InvalidParameterException if $value is invalid.
     */
    public function setShippingAddressIndicator($value)

    {
        if (in_array(
        		$value,
        		[
                null,
                self::SHIPPING_TO_BILLING_ADDRESS,
                self::SHIPPING_TO_ANOTHER_VERIFIED_ADDRESS,
                self::SHIPPING_DIFFERENT_BILLING_ADDRESS,
                self::SHIPPING_PICK_UP,
                self::SHIPPING_DIGITAL,
                self::SHIPPING_TRAVEL,
                self::SHIPPING_OTHER,
        		]
        )) {
        		return $this->setParameter('shippingAddressIndicator', $value);
        }
    		throw new InvalidParameterException("Invalid shippingAddressIndicator parameter");
    }

    /**
     * Get the SCA exemption field
     *
     * Corresponds to the Ds_Merchant_Excep_Sca field in Redsys documentation.
     *
     * @return string One of the self::SCA_EXCEMPTION_* constants
     */
    public function getScaExemptionIndicator()
    {
        return $this->getParameter('scaExemptionIndicator');
    }

    /**
     * Set the SCA exemption field
     *
     * Corresponds to the Ds_Merchant_Emv3Ds.MerchantRiskIndicator.shipIndicator field in the Redsys documentation.
     *
     * @param string $value One of the self::SCA_EXCEMPTION_* constants
     * @return self
     * @throws InvalidParameterException if $value is invalid.
     */
    public function setScaExemptionIndicator($value)
    {
        if (in_array(
        		$value,
        		[
                null,
                self::SCA_EXCEMPTION_LOW_AMOUNT,
                self::SCA_EXCEMPTION_LOW_RISK,
                self::SCA_EXCEMPTION_CORPORATE,
                self::SCA_EXCEMPTION_MERCHANT_INITIATED,
        		]
        )) {
        		return $this->setParameter('scaExemptionIndicator', $value);
        }
    		throw new InvalidParameterException("Invalid scaExemptionIndicator parameter");
    }

    /**
     * Override the abstract method to add requirement that it must start with 4 numeric characters
     *
     * @param string|int $value The transaction ID (merchant order) to set for the transaction
     */
    public function setTransactionId($value)
    {
        $start = substr($value, 0, 4);
        $numerics = 0;
        foreach (str_split($start) as $char) {
            if (is_numeric($char)) {
                $numerics++;
            } else {
                break;
            }
        }
        $value = str_pad(substr($start, 0, $numerics), 4, 0, STR_PAD_LEFT).substr($value, $numerics);

        parent::setTransactionId($value);
    }

    public function getData()
    {
        $this->validate('merchantId', 'terminalId', 'amount', 'currency');

        // generate EMV 3DS request if any of the EMV parameters are set
        if ($this->getCardholder() !== null
            || $this->getEmail() !== null
            || $this->getHomePhoneCountryPrefix() !== null
            || $this->getHomePhone() !== null
            || $this->getMobilePhoneCountryPrefix() !== null
            || $this->getMobilePhone() !== null
            || $this->getWorkPhoneCountryPrefix() !== null
            || $this->getWorkPhone() !== null
            || ($this->getCard() !== null && $this->getCard()->getShippingAddress1() !== null)
            || ($this->getCard() !== null && $this->getCard()->getShippingAddress2() !== null)
            || $this->getShippingAddress3() !== null
            || ($this->getCard() !== null && $this->getCard()->getShippingCity() !== null)
            || ($this->getCard() !== null && $this->getCard()->getShippingPostcode() !== null)
            || ($this->getCard() !== null && $this->getCard()->getShippingState() !== null)
            || ($this->getCard() !== null && $this->getCard()->getShippingCountry() !== null)
            || $this->getAddressMatch() !== null
            || ($this->getCard() !== null && $this->getCard()->getBillingAddress1() !== null)
            || ($this->getCard() !== null && $this->getCard()->getBillingAddress2() !== null)
            || $this->getBillingAddress3() !== null
            || ($this->getCard() !== null && $this->getCard()->getBillingCity() !== null)
            || ($this->getCard() !== null && $this->getCard()->getBillingPostcode() !== null)
            || ($this->getCard() !== null && $this->getCard()->getBillingState() !== null)
            || ($this->getCard() !== null && $this->getCard()->getBillingCountry() !== null)
            || $this->getChallengeWindowSize() !== null
            || $this->getCustomerAdditionalInformation() !== null
            || $this->get3DsRequestAuthenticationMethodData() !== null
            || $this->get3DsRequestAuthenticationMethod() !== null
            || $this->get3DsRequestAuthenticationTime() !== null
            || $this->getCustomerAccountCreatedIndicator() !== null
            || $this->getCustomerAccountCreatedDate() !== null
            || $this->getCustomerAccountChangedIndicator() !== null
            || $this->getCustomerAccountChangedDate() !== null
            || $this->getCustomerPasswordChangedIndicator() !== null
            || $this->getCustomerPasswordChangedDate() !== null
            || $this->getCustomerPurchasesInLast6Months() !== null
            || $this->getCustomerAccountCardProvisionsLast24Hours() !== null
            || $this->getCustomerAccountTransactionsLast24Hours() !== null
            || $this->getCustomerAccountTransactionsLastYear() !== null
            || $this->getCustomerPaymentMethodCreatedIndicator() !== null
            || $this->getCustomerPaymentMethodCreatedDate() !== null
            || $this->getShippingAddressFirstUsedIndicator() !== null
            || $this->getShippingAddressFirstUsedDate() !== null
            || $this->getShippingNameCustomerNameMatch() !== null
            || $this->getCustomerHasSuspiciousActivity() !== null
            || $this->getDeliveryEmail() !== null
            || $this->getDeliveryTimeframeIndicator() !== null
            || $this->getGiftCardAmount() !== null
            || $this->getGiftCardCount() !== null
            || $this->getGiftCardCurrency() !== null
            || $this->getPurchasingPreOrder() !== null
            || $this->getPreOrderDate() !== null
            || $this->getCustomerHasPurchasedProductBefore() !== null
            || $this->getShippingAddressIndicator() !== null
        ) {
            $emv_3ds_parameters = array_filter([
                'cardholderName'      => $this->getCardholder(),
                'email'               => $this->getEmail(),
                'shipAddrLine1'       => ($this->getCard() !== null ? $this->getCard()->getShippingAddress1() : null),
                'shipAddrLine2'       => ($this->getCard() !== null ? $this->getCard()->getShippingAddress2() : null),
                'shipAddrLine3'       => $this->getShippingAddress3(),
                'shipAddrCity'        => ($this->getCard() !== null ? $this->getCard()->getShippingCity() : null),
                'shipAddrPostCode'    => ($this->getCard() !== null ? $this->getCard()->getShippingPostcode() : null),
                'shipAddrState'       => ($this->getCard() !== null ? $this->getCard()->getShippingState() : null),
                'shipAddrCountry'     => ($this->getCard() !== null ? $this->getCard()->getShippingCountry() : null),
                'addrMatch'           => $this->getAddressMatch() === null
                    ? null
                    : ($this->getAddressMatch() ? "Y" : "N"),
                'billAddrLine1'       => ($this->getCard() !== null ? $this->getCard()->getBillingAddress1() : null),
                'billAddrLine2'       => ($this->getCard() !== null ? $this->getCard()->getBillingAddress2() : null),
                'billAddrLine3'       => $this->getBillingAddress3(),
                'billAddrCity'        => ($this->getCard() !== null ? $this->getCard()->getBillingCity() : null),
                'billAddrPostCode'    => ($this->getCard() !== null ? $this->getCard()->getBillingPostcode() : null),
                'billAddrState'       => ($this->getCard() !== null ? $this->getCard()->getBillingState() : null),
                'billAddrCountry'     => ($this->getCard() !== null ? $this->getCard()->getBillingCountry() : null),
                'challengeWindowSize' => $this->getChallengeWindowSize(),
                'acctID'              => $this->getCustomerAdditionalInformation(),
            ])
            + ($this->getHomePhoneCountryPrefix() === null && $this->getHomePhone() === null
                ? []
                : ['homePhone' => array_filter([
                    'cc'         => $this->getHomePhoneCountryPrefix(),
                    'subscriber' => $this->getHomePhone(),
                ])]
            )
            + ($this->getMobilePhoneCountryPrefix() === null && $this->getMobilePhone() === null
                ? []
                : ['mobilePhone' => array_filter([
                    'cc'         => $this->getMobilePhoneCountryPrefix(),
                    'subscriber' => $this->getMobilePhone(),
                ])]
            )
            + ($this->getWorkPhoneCountryPrefix() === null && $this->getWorkPhone() === null
                ? []
                : ['workPhone' => array_filter([
                    'cc'         => $this->getWorkPhoneCountryPrefix(),
                    'subscriber' => $this->getWorkPhone(),
                ])]
            )
            + ($this->get3DsRequestAuthenticationMethodData() !== null
                || $this->get3DsRequestAuthenticationMethod() !== null
                || $this->get3DsRequestAuthenticationTime() !== null
                ? ['threeDSRequestorAuthenticationInfo' => array_filter([
                    'threeDSReqAuthData'      => $this->get3DsRequestAuthenticationMethodData(),
                    'threeDSReqAuthMethod'    => $this->get3DsRequestAuthenticationMethod(),
                    'threeDSReqAuthTimestamp' => $this->formatDateTime(
                        $this->get3DsRequestAuthenticationTime(),
                        "YmdHi"
                    ),
                ])]
                : []
            )
            + ($this->getCustomerAccountCreatedIndicator() !== null
                || $this->getCustomerAccountCreatedDate() !== null
                || $this->getCustomerAccountChangedIndicator() !== null
                || $this->getCustomerAccountChangedDate() !== null
                || $this->getCustomerPasswordChangedIndicator() !== null
                || $this->getCustomerPasswordChangedDate() !== null
                || $this->getCustomerPurchasesInLast6Months() !== null
                || $this->getCustomerAccountCardProvisionsLast24Hours() !== null
                || $this->getCustomerAccountTransactionsLast24Hours() !== null
                || $this->getCustomerAccountTransactionsLastYear() !== null
                || $this->getCustomerPaymentMethodCreatedIndicator() !== null
                || $this->getCustomerPaymentMethodCreatedDate() !== null
                || $this->getShippingAddressFirstUsedIndicator() !== null
                || $this->getShippingAddressFirstUsedDate() !== null
                || $this->getShippingNameCustomerNameMatch() !== null
                || $this->getCustomerHasSuspiciousActivity() !== null
                ? ['acctInfo' => array_filter([
                    'chAccAgeInd'           => $this->getCustomerAccountCreatedIndicator(),
                    'chAccDate'             => $this->formatDateTime($this->getCustomerAccountCreatedDate(), "Ymd"),
                    'chAccChangeInd'        => $this->getCustomerAccountChangedIndicator(),
                    'chAccChange'           => $this->formatDateTime(
                        $this->getCustomerAccountChangedDate(),
                        "Ymd"
                    ),
                    'chAccPwChangeInd'      => $this->getCustomerPasswordChangedIndicator(),
                    'chAccPwChange'         => $this->formatDateTime(
                        $this->getCustomerPasswordChangedDate(),
                        "Ymd"
                    ),
                    'nbPurchaseAccount'     => $this->getCustomerPurchasesInLast6Months(),
                    'provisionAttemptsDay'  => $this->getCustomerAccountCardProvisionsLast24Hours(),
                    'txnActivityDay'        => $this->getCustomerAccountTransactionsLast24Hours(),
                    'txnActivityYear'       => $this->getCustomerAccountTransactionsLastYear(),
                    'paymentAccInd'         => $this->getCustomerPaymentMethodCreatedIndicator(),
                    'paymentAccAge'         => $this->formatDateTime(
                        $this->getCustomerPaymentMethodCreatedDate(),
                        "Ymd"
                    ),
                    'shipAddressUsageInd'   => $this->getShippingAddressFirstUsedIndicator(),
                    'shipAddressUsage'      => $this->formatDateTime($this->getShippingAddressFirstUsedDate(), "Ymd"),
                    'shipNameIndicator'     => $this->getShippingNameCustomerNameMatch() === null
                        ? null
                        : ($this->getShippingNameCustomerNameMatch() ? "01" : "02"),
                    'suspiciousAccActivity' => $this->getCustomerHasSuspiciousActivity() === null
                        ? null
                        : ($this->getCustomerHasSuspiciousActivity() ? "02" : "01"),
                ])]
                : []
            )
            + ($this->getDeliveryEmail() !== null
                || $this->getDeliveryTimeframeIndicator() !== null
                || $this->getGiftCardAmount() !== null
                || $this->getGiftCardAmount() !== null
                || $this->getGiftCardCount() !== null
                || $this->getGiftCardCurrency() !== null
                || $this->getPurchasingPreOrder() !== null
                || $this->getPreOrderDate() !== null
                || $this->getCustomerHasPurchasedProductBefore() !== null
                || $this->getShippingAddressIndicator() !== null
                ? ['merchantRiskIndicator' => array_filter([
                    'deliveryEmailAddress' => $this->getDeliveryEmail(),
                    'deliveryTimeframe'    => $this->getDeliveryTimeframeIndicator(),
                    'giftCardAmount'       => $this->getGiftCardAmount() === null
                        ? null
                        : (int) $this->getGiftCardAmount(),
                    'giftCardCount'        => $this->getGiftCardCount(),
                    'giftCardCurr'         => $this->getGiftCardCurrency(),
                    'preOrderPurchaseInd'  => $this->getPurchasingPreOrder() === null
                        ? null
                        : ($this->getPurchasingPreOrder() ? "02" : "01"),
                    'preOrderDate'         => $this->formatDateTime($this->getPreOrderDate(), "Ymd"),
                    'reorderItemsInd'      => $this->getCustomerHasPurchasedProductBefore() === null
                        ? null
                        : ($this->getCustomerHasPurchasedProductBefore() ? "02" : "01"),
                    'shipIndicator'        => $this->getShippingAddressIndicator(),
                ])]
                : []
            );
        }
        else {
            $emv_3ds_parameters = null;
        }

        return [
            // mandatory fields
            'Ds_Merchant_MerchantCode'       => $this->getMerchantId(),
            'Ds_Merchant_Terminal'           => $this->getTerminalId(),
            'Ds_Merchant_TransactionType'    => '0',                          // Authorisation
            'Ds_Merchant_Amount'             => $this->getAmountInteger(),
            'Ds_Merchant_Currency'           => $this->getCurrencyNumeric(),  // uses ISO-4217 codes
            'Ds_Merchant_Order'              => $this->getTransactionId(),
            'Ds_Merchant_MerchantUrl'        => $this->getNotifyUrl(),
            // optional fields
            'Ds_Merchant_ProductDescription' => $this->getDescription(),
            'Ds_Merchant_Cardholder'         => $this->getCardholder(),
            'Ds_Merchant_UrlOK'              => $this->getReturnUrl(),
            'Ds_Merchant_UrlKO'              => $this->getReturnUrl(),
            'Ds_Merchant_MerchantName'       => $this->getMerchantName(),
            'Ds_Merchant_ConsumerLanguage'   => $this->getConsumerLanguage(),
            'Ds_Merchant_MerchantData'       => $this->getMerchantData(),
        ]
        + ($this->getScaExemptionIndicator() === null
            ? []
            : ['Ds_Merchant_Excep_Sca' => $this->getScaExemptionIndicator()])
        + ($emv_3ds_parameters === null ? [] : ['Ds_Merchant_Emv3Ds' => $emv_3ds_parameters]);
    }

    public function sendData($data)
    {
        $security = new Security;

        $encoded_data = $security->encodeMerchantParameters($data);

        $response_data = array(
            'Ds_SignatureVersion'   => Security::VERSION,
            'Ds_MerchantParameters' => $encoded_data,
            'Ds_Signature'          => $security->createSignature(
                $encoded_data,
                $data['Ds_Merchant_Order'],
                $this->getHmacKey()
            ),
        );

        return $this->response = new PurchaseResponse($this, $response_data);
    }

    public function getEndpoint()
    {
        return $this->getTestMode() ? $this->testEndpoint : $this->liveEndpoint;
    }

    /**
     * Convert a DateTime or timestamp to a formatted date.
     *
     * @param DateTime|int $date The date to format.
     * @param string $format The format to use.
     *
     * @return string|null The formatted date, or null if date isn't a timestamp or DateTime object.
     */
    protected static function formatDateTime($date, $format)
    {
        if (is_int($date)) {
            return (new DateTime())->setTimestamp($date)->format($format);
        } elseif ($date instanceof DateTime) {
            return $date->setTimezone(new DateTimeZone('UTC'))->format($format);
        }
    }
}

PatronBase / omnipay-redsys
