CreditCardPayment::serializeContents() - Code Metrics - eBayEnterprise/RetailOrderManagement-SDK - Measure and Improve Code Quality continuously with Scrutinizer

CreditCardPayment::serializeContents() A
last analyzed 2016-01-20 19:07 UTC

↳ Parent: CreditCardPayment

Complexity

Conditions	1
Paths	1

Size

Total Lines	15
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	15
rs	9.4285
cc	1
eloc	13
nc	1
nop	0

<?php
/**
 * Copyright (c) 2013-2014 eBay Enterprise, Inc.
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is bundled with this package in the file LICENSE.md.
 * It is also available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * @copyright   Copyright (c) 2013-2015 eBay Enterprise, Inc. (http://www.ebayenterprise.com/)
 * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 */

namespace eBayEnterprise\RetailOrderManagement\Payload\Order;

use DateTime;
use eBayEnterprise\RetailOrderManagement\Payload\IPayload;
use eBayEnterprise\RetailOrderManagement\Payload\IPayloadMap;
use eBayEnterprise\RetailOrderManagement\Payload\ISchemaValidator;
use eBayEnterprise\RetailOrderManagement\Payload\IValidatorIterator;
use eBayEnterprise\RetailOrderManagement\Payload\PayloadFactory;
use eBayEnterprise\RetailOrderManagement\Payload\Payment\TAmount;
use eBayEnterprise\RetailOrderManagement\Payload\TPayload;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;

class CreditCardPayment implements ICreditCardPayment
{
    use TPayload, TAmount, TCustomAttributeContainer, TCardPayment;

    const ROOT_NODE = 'CreditCard';

    /** @var DateTime */
    protected $createTimeStamp;
    /** @var float */
    protected $amount;
    /** @var string */
    protected $responseCode;
    /** @var string */
    protected $bankAuthorizationCode;
    /** @var string */
    protected $cvv2ResponseCode;
    /** @var string */
    protected $avsResponseCode;
    /** @var string */
    protected $phoneResponseCode;
    /** @var string */
    protected $nameResponseCode;
    /** @var string */
    protected $emailResponseCode;
    /** @var string */
    protected $extendedAuthDescription;
    /** @var string */
    protected $extendedAuthReasonCode;
    /** @var float */
    protected $amountAuthorized;
    /** @var DateTime */
    protected $expirationDate;
    /** @var DateTime */
    protected $startDate;
    /** @var string */
    protected $issueNumber;
    /** @var string */
    protected $authenticationAvailable;
    /** @var string */
    protected $authenticationStatus;
    /** @var string */
    protected $cavvUcaf;
    /** @var string */
    protected $transactionId;
    /** @var string */
    protected $eci;
    /** @var string */
    protected $payerAuthenticationResponse;
    /** @var string */
    protected $purchasePlanCode;
    /** @var string */
    protected $purchasePlanDescription;
    /** @var array */
    protected $allowedResponseCodes = [
        self::RESPONSE_CODE_APPROVED,
        self::RESPONSE_CODE_ACCEPTORDERWITHEXCEPTION,
        self::RESPONSE_CODE_AVS,
        self::RESPONSE_CODE_AVSPIN,
        self::RESPONSE_CODE_DECLF,
        self::RESPONSE_CODE_DECLR,
        self::RESPONSE_CODE_DECL,
        self::RESPONSE_CODE_PAYMENTPROCESSORTIMEOUT,
        self::RESPONSE_CODE_PIN,
        self::RESPONSE_CODE_NOK,
        self::RESPONSE_CODE_OK,
    ];

    /**
     * @param IValidatorIterator
     * @param ISchemaValidator
     * @param IPayloadMap
     * @param LoggerInterface
     * @param IPayload
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function __construct(
        IValidatorIterator $validators,
        ISchemaValidator $schemaValidator,
        IPayloadMap $payloadMap,
        LoggerInterface $logger,
        IPayload $parentPayload = null
    ) {
        $this->logger = $logger;

        $this->validators = $validators;
        $this->schemaValidator = $schemaValidator;
        $this->payloadMap = $payloadMap;
        $this->parentPayload = $parentPayload;
        $this->payloadFactory = new PayloadFactory;

        $this->extractionPaths = [
            'responseCode' => 'string(x:Authorization/x:ResponseCode)',
            'bankAuthorizationCode' => 'string(x:Authorization/x:BankAuthorizationCode)',
            'cvv2ResponseCode' => 'string(x:Authorization/x:CVV2ResponseCode)',
            'avsResponseCode' => 'string(x:Authorization/x:AVSResponseCode)',
            'orderId' => 'string(x:PaymentContext/x:PaymentSessionId)',
            'tenderType' => 'string(x:PaymentContext/x:TenderType)',
            'accountUniqueId' => 'string(x:PaymentContext/x:PaymentAccountUniqueId)',
            'paymentRequestId' => 'string(x:PaymentRequestId)',
        ];
        $this->optionalExtractionPaths = [
            'amount' => 'x:Amount',
            'phoneResponseCode' => 'x:Authorization/x:PhoneResponseCode',
            'nameResponseCode' => 'x:Authorization/x:NameResponseCode',
            'emailResponseCode' => 'x:Authorization/x:EmailResponseCode',
            'extendedAuthDescription' => 'x:Authorization/x:ExtendedAuthorizationResponseCodes/x:ResponseCodeDescription',
            'extendedAuthReasonCode' => 'x:Authorization/x:ExtendedAuthorizationResponseCodes/x:ReasonCode',
            'amountAuthorized' => 'x:Authorization/x:AmountAuthorized',
            'issueNumber' => 'x:IssueNumber',
            'authenticationAvailable' => 'x:SecureVerificationData/x:AuthenticationAvailable',
            'authenticationStatus' => 'x:SecureVerificationData/x:AuthenticationStatus',
            'cavvUcaf' => 'x:SecureVerificationData/x:CavvUcaf',
            'transactionId' => 'x:SecureVerificationData/x:TransactionId',
            'eci' => 'x:SecureVerificationData/x:ECI',
            'payerAuthenticationResponse' => 'x:SecureVerificationData/x:PayerAuthenticationResponse',
            'purchasePlanCode' => 'x:PurchasePlanCode',
            'purchasePlanDescription' => 'x:PurchasePlanDescription',
        ];
        $this->booleanExtractionPaths = [
            'isMockPayment' => 'string(@isMockPayment)',
            'panIsToken' => 'string(x:PaymentContext/x:PaymentAccountUniqueId/@isToken)'
        ];
        $this->subpayloadExtractionPaths = [
            'customAttributes' => 'x:CustomAttributes',
        ];

        $this->customAttributes = $this->buildPayloadForInterface(self::CUSTOM_ATTRIBUTE_ITERABLE_INTERFACE);
    }

    public function getCreateTimeStamp()
    {
        return $this->createTimeStamp;
    }

    public function setCreateTimeStamp(DateTime $createTimeStamp)
    {
        $this->createTimeStamp = $createTimeStamp;
        return $this;
    }

    public function getAmount()
    {
        return $this->amount;
    }

    public function setAmount($amount)
    {
        $this->amount = $this->sanitizeAmount($amount);
        return $this;
    }

    public function getResponseCode()
    {
        return $this->responseCode;
    }

    public function setResponseCode($responseCode)
    {
        $this->responseCode = in_array($responseCode, $this->allowedResponseCodes)
            ? $responseCode
            : null;
        return $this;
    }

    public function getBankAuthorizationCode()
    {
        return $this->bankAuthorizationCode;
    }

    public function setBankAuthorizationCode($bankAuthorizationCode)
    {
        $this->bankAuthorizationCode = $bankAuthorizationCode;
        return $this;
    }

    public function getCVV2ResponseCode()
    {
        return $this->cvv2ResponseCode;
    }

    public function setCVV2ResponseCode($cvv2ResponseCode)
    {
        $this->cvv2ResponseCode = $cvv2ResponseCode;
        return $this;
    }

    public function getAVSResponseCode()
    {
        return $this->avsResponseCode;
    }

    public function setAVSResponseCode($avsResponseCode)
    {
        $this->avsResponseCode = $avsResponseCode;
        return $this;
    }

    public function getPhoneResponseCode()
    {
        return $this->phoneResponseCode;
    }

    public function setPhoneResponseCode($phoneResponseCode)
    {
        $this->phoneResponseCode = $phoneResponseCode;
        return $this;
    }

    public function getNameResponseCode()
    {
        return $this->nameResponseCode;
    }

    public function setNameResponseCode($nameResponseCode)
    {
        $this->nameResponseCode = $nameResponseCode;
        return $this;
    }

    public function getEmailResponseCode()
    {
        return $this->emailResponseCode;
    }

    public function setEmailResponseCode($emailResponseCode)
    {
        $this->emailResponseCode = $emailResponseCode;
        return $this;
    }

    public function getExtendedAuthDescription()
    {
        return $this->extendedAuthDescription;
    }

    public function setExtendedAuthDescription($extendedAuthDescription)
    {
        $this->extendedAuthDescription = $extendedAuthDescription;
        return $this;
    }

    public function getExtendedAuthReasonCode()
    {
        return $this->extendedAuthReasonCode;
    }

    public function setExtendedAuthReasonCode($extendedAuthReasonCode)
    {
        $this->extendedAuthReasonCode = $extendedAuthReasonCode;
        return $this;
    }

    public function getAmountAuthorized()
    {
        return $this->amountAuthorized;
    }

    public function setAmountAuthorized($amountAuthorized)
    {
        $this->amountAuthorized = $this->sanitizeAmount($amountAuthorized);
        return $this;
    }

    public function getExpirationDate()
    {
        return $this->expirationDate;
    }

    public function setExpirationDate(DateTime $expirationDate)
    {
        $this->expirationDate = $expirationDate;
        return $this;
    }

    public function getStartDate()
    {
        return $this->startDate;
    }

    public function setStartDate(DateTime $startDate)
    {
        $this->startDate = $startDate;
        return $this;
    }

    public function getIssueNumber()
    {
        return $this->issueNumber;
    }

    public function setIssueNumber($issueNumber)
    {
        $this->issueNumber = $issueNumber;
        return $this;
    }

    public function getAuthenticationAvailable()
    {
        return $this->authenticationAvailable;
    }

    public function setAuthenticationAvailable($authenticationAvailable)
    {
        $this->authenticationAvailable = $authenticationAvailable;
        return $this;
    }

    public function getAuthenticationStatus()
    {
        return $this->authenticationStatus;
    }

    public function setAuthenticationStatus($authenticationStatus)
    {
        $this->authenticationStatus = $authenticationStatus;
        return $this;
    }

    public function getCavvUcaf()
    {
        return $this->cavvUcaf;
    }

    public function setCavvUcaf($cavvUcaf)
    {
        $this->cavvUcaf = $this->cleanString($cavvUcaf, 64);
        return $this;
    }

    public function getTransactionId()
    {
        return $this->transactionId;
    }

    public function setTransactionId($transactionId)
    {
        $this->transactionId = $this->cleanString($transactionId, 64);
        return $this;
    }

    public function getECI()
    {
        return $this->eci;
    }

    public function setECI($eci)
    {
        $this->eci = $eci;
        return $this;
    }

    public function getPayerAuthenticationResponse()
    {
        return $this->payerAuthenticationResponse;
    }

    public function setPayerAuthenticationResponse($payerAuthenticationResponse)
    {
        $this->payerAuthenticationResponse = $this->cleanString($payerAuthenticationResponse, 10000);
        return $this;
    }

    public function getPurchasePlanCode()
    {
        return $this->purchasePlanCode;
    }

    public function setPurchasePlanCode($purchasePlanCode)
    {
        $this->purchasePlanCode = $purchasePlanCode;
        return $this;
    }

    public function getPurchasePlanDescription()
    {
        return $this->purchasePlanDescription;
    }

    public function setPurchasePlanDescription($purchasePlanDescription)
    {
        $this->purchasePlanDescription = $purchasePlanDescription;
        return $this;
    }

    protected function serializeContents()
    {
        return $this->serializePaymentContext()
            . $this->serializePaymentRequestId()
            . "<CreateTimeStamp>{$this->getCreateTimeStamp()->format('c')}</CreateTimeStamp>"
            . $this->serializeOptionalAmount('Amount', $this->getAmount())
            . $this->serializeAuthorizations()
            . $this->serializeOptionalDateValue('ExpirationDate', 'Y-m', $this->getExpirationDate())
            . $this->serializeOptionalDateValue('StartDate', 'Y-m', $this->getStartDate())
            . $this->serializeOptionalValue('IssueNumber', $this->xmlEncode($this->getIssueNumber()))
            . $this->serializeSecureVerificationData()
            . $this->serializeOptionalValue('PurchasePlanCode', $this->xmlEncode($this->getPurchasePlanCode()))
            . $this->serializeOptionalValue('PurchasePlanDescription', $this->xmlEncode($this->getPurchasePlanDescription()))
            . $this->getCustomAttributes()->serialize();
    }

    /**
     * Serialize the credit card authorizations.
     *
     * @return string
     */
    protected function serializeAuthorizations()
    {
        return '<Authorization>'
            . "<ResponseCode>{$this->xmlEncode($this->getResponseCode())}</ResponseCode>"
            . "<BankAuthorizationCode>{$this->xmlEncode($this->getBankAuthorizationCode())}</BankAuthorizationCode>"
            . "<CVV2ResponseCode>{$this->xmlEncode($this->getCVV2ResponseCode())}</CVV2ResponseCode>"
            . "<AVSResponseCode>{$this->xmlEncode($this->getAVSResponseCode())}</AVSResponseCode>"
            . $this->serializeOptionalValue('PhoneResponseCode', $this->xmlEncode($this->getPhoneResponseCode()))
            . $this->serializeOptionalValue('NameResponseCode', $this->xmlEncode($this->getNameResponseCode()))
            . $this->serializeOptionalValue('EmailResponseCode', $this->xmlEncode($this->getEmailResponseCode()))
            . $this->serializeExtendedAuthorizations()
            . $this->serializeOptionalAmount('AmountAuthorized', $this->getAmountAuthorized())
            . '</Authorization>';
    }

    /**
     * Serialize the extended authorizations. Only include if both the extended
     * auth reason code and extended auth response code description are included.
     * Return an empty string, no serialization, if either is missing.
     *
     * @return string
     */
    protected function serializeExtendedAuthorizations()
    {
        $code = $this->getExtendedAuthReasonCode();
        $description = $this->getExtendedAuthDescription();
        return $code && $description
            ? '<ExtendedAuthorizationResponseCodes>'
                . "<ResponseCodeDescription>{$this->xmlEncode($description)}</ResponseCodeDescription>"
                . "<ReasonCode>{$this->xmlEncode($code)}</ReasonCode>"
                . '</ExtendedAuthorizationResponseCodes>'
            : '';
    }

    /**
     * Serialize sercure verification data (Verified by VISA). Will only be
     * included if a payer authentication response is included.
     *
     * @return string
     */
    protected function serializeSecureVerificationData()
    {
        $payerAuthResponse = $this->getPayerAuthenticationResponse();
        if ($payerAuthResponse) {
            return '<SecureVerificationData>'
                . $this->serializeOptionalValue('AuthenticationAvailable', $this->xmlEncode($this->getAuthenticationAvailable()))
                . $this->serializeOptionalValue('AuthenticationStatus', $this->xmlEncode($this->getAuthenticationStatus()))
                . $this->serializeOptionalValue('CavvUcaf', $this->xmlEncode($this->getCavvUcaf()))
                . $this->serializeOptionalValue('TransactionId', $this->xmlEncode($this->getTransactionId()))
                . $this->serializeOptionalValue('ECI', $this->xmlEncode($this->getECI()))
                . "<PayerAuthenticationResponse>{$this->xmlEncode($this->getPayerAuthenticationResponse())}</PayerAuthenticationResponse>"
                . '</SecureVerificationData>';
        }
        return '';
    }

    /**
     * Deserialize date time fields as DateTime objects instead of plain string
     * values.
     *
     * @return self
     */
    protected function deserializeExtra($serializedPayload)
    {
        $xpath = $this->getPayloadAsXPath($serializedPayload);
        $dateTimePaths = [
            'createTimeStamp' => 'string(x:CreateTimeStamp)',
            'expirationDate' => 'string(x:ExpirationDate)',
            'startDate' => 'string(x:StartDate)',
        ];
        foreach ($dateTimePaths as $prop => $extractionPath) {
            $value = $xpath->evaluate($extractionPath);
            $this->$prop = $value ? new DateTime($value) : null;
        }
        return $this;
    }

    protected function getRootAttributes()

    {
        $isMockPayment = $this->getIsMockPayment();
        return !is_null($isMockPayment)
            ? ['isMockPayment' => $this->convertBooleanToString($isMockPayment)]
            : [];
    }

    protected function getRootNodeName()
    {
        return static::ROOT_NODE;
    }

    protected function getXmlNamespace()
    {
        return self::XML_NS;
    }
}


1		<?php
2		/**
3		* Copyright (c) 2013-2014 eBay Enterprise, Inc.
4		*
5		* NOTICE OF LICENSE
6		*
7		* This source file is subject to the Open Software License (OSL 3.0)
8		* that is bundled with this package in the file LICENSE.md.
9		* It is also available through the world-wide-web at this URL:
10		* http://opensource.org/licenses/osl-3.0.php
11		*
12		* @copyright Copyright (c) 2013-2015 eBay Enterprise, Inc. (http://www.ebayenterprise.com/)
13		* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
14		*/
15
16		namespace eBayEnterprise\RetailOrderManagement\Payload\Order;
17
18		use DateTime;
19		use eBayEnterprise\RetailOrderManagement\Payload\IPayload;
20		use eBayEnterprise\RetailOrderManagement\Payload\IPayloadMap;
21		use eBayEnterprise\RetailOrderManagement\Payload\ISchemaValidator;
22		use eBayEnterprise\RetailOrderManagement\Payload\IValidatorIterator;
23		use eBayEnterprise\RetailOrderManagement\Payload\PayloadFactory;
24		use eBayEnterprise\RetailOrderManagement\Payload\Payment\TAmount;
25		use eBayEnterprise\RetailOrderManagement\Payload\TPayload;
26		use Psr\Log\LoggerInterface;
27		use Psr\Log\NullLogger;
28
29		class CreditCardPayment implements ICreditCardPayment
30		{
31		use TPayload, TAmount, TCustomAttributeContainer, TCardPayment;
32
33		const ROOT_NODE = 'CreditCard';
34
35		/** @var DateTime */
36		protected $createTimeStamp;
37		/** @var float */
38		protected $amount;
39		/** @var string */
40		protected $responseCode;
41		/** @var string */
42		protected $bankAuthorizationCode;
43		/** @var string */
44		protected $cvv2ResponseCode;
45		/** @var string */
46		protected $avsResponseCode;
47		/** @var string */
48		protected $phoneResponseCode;
49		/** @var string */
50		protected $nameResponseCode;
51		/** @var string */
52		protected $emailResponseCode;
53		/** @var string */
54		protected $extendedAuthDescription;
55		/** @var string */
56		protected $extendedAuthReasonCode;
57		/** @var float */
58		protected $amountAuthorized;
59		/** @var DateTime */
60		protected $expirationDate;
61		/** @var DateTime */
62		protected $startDate;
63		/** @var string */
64		protected $issueNumber;
65		/** @var string */
66		protected $authenticationAvailable;
67		/** @var string */
68		protected $authenticationStatus;
69		/** @var string */
70		protected $cavvUcaf;
71		/** @var string */
72		protected $transactionId;
73		/** @var string */
74		protected $eci;
75		/** @var string */
76		protected $payerAuthenticationResponse;
77		/** @var string */
78		protected $purchasePlanCode;
79		/** @var string */
80		protected $purchasePlanDescription;
81		/** @var array */
82		protected $allowedResponseCodes = [
83		self::RESPONSE_CODE_APPROVED,
84		self::RESPONSE_CODE_ACCEPTORDERWITHEXCEPTION,
85		self::RESPONSE_CODE_AVS,
86		self::RESPONSE_CODE_AVSPIN,
87		self::RESPONSE_CODE_DECLF,
88		self::RESPONSE_CODE_DECLR,
89		self::RESPONSE_CODE_DECL,
90		self::RESPONSE_CODE_PAYMENTPROCESSORTIMEOUT,
91		self::RESPONSE_CODE_PIN,
92		self::RESPONSE_CODE_NOK,
93		self::RESPONSE_CODE_OK,
94		];
95
96		/**
97		* @param IValidatorIterator
98		* @param ISchemaValidator
99		* @param IPayloadMap
100		* @param LoggerInterface
101		* @param IPayload
102		* @SuppressWarnings(PHPMD.UnusedFormalParameter)
103		*/
104		public function __construct(
105		IValidatorIterator $validators,
106		ISchemaValidator $schemaValidator,
107		IPayloadMap $payloadMap,
108		LoggerInterface $logger,
109		IPayload $parentPayload = null
110		) {
111		$this->logger = $logger;
		0 ignored issues – show Documentation Bug introduced 2015-11-25 17:00 UTC by Report Bug Copy Issue Report It seems like `$logger` of type `object<Psr\Log\LoggerInterface>` is incompatible with the declared type `object<eBayEnterprise\Re...ayload\LoggerInterface>` of property `$logger`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
112		$this->validators = $validators;
113		$this->schemaValidator = $schemaValidator;
114		$this->payloadMap = $payloadMap;
115		$this->parentPayload = $parentPayload;
116		$this->payloadFactory = new PayloadFactory;
117
118		$this->extractionPaths = [
119		'responseCode' => 'string(x:Authorization/x:ResponseCode)',
120		'bankAuthorizationCode' => 'string(x:Authorization/x:BankAuthorizationCode)',
121		'cvv2ResponseCode' => 'string(x:Authorization/x:CVV2ResponseCode)',
122		'avsResponseCode' => 'string(x:Authorization/x:AVSResponseCode)',
123		'orderId' => 'string(x:PaymentContext/x:PaymentSessionId)',
124		'tenderType' => 'string(x:PaymentContext/x:TenderType)',
125		'accountUniqueId' => 'string(x:PaymentContext/x:PaymentAccountUniqueId)',
126		'paymentRequestId' => 'string(x:PaymentRequestId)',
127		];
128		$this->optionalExtractionPaths = [
129		'amount' => 'x:Amount',
130		'phoneResponseCode' => 'x:Authorization/x:PhoneResponseCode',
131		'nameResponseCode' => 'x:Authorization/x:NameResponseCode',
132		'emailResponseCode' => 'x:Authorization/x:EmailResponseCode',
133		'extendedAuthDescription' => 'x:Authorization/x:ExtendedAuthorizationResponseCodes/x:ResponseCodeDescription',
134		'extendedAuthReasonCode' => 'x:Authorization/x:ExtendedAuthorizationResponseCodes/x:ReasonCode',
135		'amountAuthorized' => 'x:Authorization/x:AmountAuthorized',
136		'issueNumber' => 'x:IssueNumber',
137		'authenticationAvailable' => 'x:SecureVerificationData/x:AuthenticationAvailable',
138		'authenticationStatus' => 'x:SecureVerificationData/x:AuthenticationStatus',
139		'cavvUcaf' => 'x:SecureVerificationData/x:CavvUcaf',
140		'transactionId' => 'x:SecureVerificationData/x:TransactionId',
141		'eci' => 'x:SecureVerificationData/x:ECI',
142		'payerAuthenticationResponse' => 'x:SecureVerificationData/x:PayerAuthenticationResponse',
143		'purchasePlanCode' => 'x:PurchasePlanCode',
144		'purchasePlanDescription' => 'x:PurchasePlanDescription',
145		];
146		$this->booleanExtractionPaths = [
147		'isMockPayment' => 'string(@isMockPayment)',
148		'panIsToken' => 'string(x:PaymentContext/x:PaymentAccountUniqueId/@isToken)'
149		];
150		$this->subpayloadExtractionPaths = [
151		'customAttributes' => 'x:CustomAttributes',
152		];
153
154		$this->customAttributes = $this->buildPayloadForInterface(self::CUSTOM_ATTRIBUTE_ITERABLE_INTERFACE);
155		}
156
157		public function getCreateTimeStamp()
158		{
159		return $this->createTimeStamp;
160		}
161
162		public function setCreateTimeStamp(DateTime $createTimeStamp)
163		{
164		$this->createTimeStamp = $createTimeStamp;
165		return $this;
166		}
167
168		public function getAmount()
169		{
170		return $this->amount;
171		}
172
173		public function setAmount($amount)
174		{
175		$this->amount = $this->sanitizeAmount($amount);
176		return $this;
177		}
178
179		public function getResponseCode()
180		{
181		return $this->responseCode;
182		}
183
184		public function setResponseCode($responseCode)
185		{
186		$this->responseCode = in_array($responseCode, $this->allowedResponseCodes)
187		? $responseCode
188		: null;
189		return $this;
190		}
191
192		public function getBankAuthorizationCode()
193		{
194		return $this->bankAuthorizationCode;
195		}
196
197		public function setBankAuthorizationCode($bankAuthorizationCode)
198		{
199		$this->bankAuthorizationCode = $bankAuthorizationCode;
200		return $this;
201		}
202
203		public function getCVV2ResponseCode()
204		{
205		return $this->cvv2ResponseCode;
206		}
207
208		public function setCVV2ResponseCode($cvv2ResponseCode)
209		{
210		$this->cvv2ResponseCode = $cvv2ResponseCode;
211		return $this;
212		}
213
214		public function getAVSResponseCode()
215		{
216		return $this->avsResponseCode;
217		}
218
219		public function setAVSResponseCode($avsResponseCode)
220		{
221		$this->avsResponseCode = $avsResponseCode;
222		return $this;
223		}
224
225		public function getPhoneResponseCode()
226		{
227		return $this->phoneResponseCode;
228		}
229
230		public function setPhoneResponseCode($phoneResponseCode)
231		{
232		$this->phoneResponseCode = $phoneResponseCode;
233		return $this;
234		}
235
236		public function getNameResponseCode()
237		{
238		return $this->nameResponseCode;
239		}
240
241		public function setNameResponseCode($nameResponseCode)
242		{
243		$this->nameResponseCode = $nameResponseCode;
244		return $this;
245		}
246
247		public function getEmailResponseCode()
248		{
249		return $this->emailResponseCode;
250		}
251
252		public function setEmailResponseCode($emailResponseCode)
253		{
254		$this->emailResponseCode = $emailResponseCode;
255		return $this;
256		}
257
258		public function getExtendedAuthDescription()
259		{
260		return $this->extendedAuthDescription;
261		}
262
263		public function setExtendedAuthDescription($extendedAuthDescription)
264		{
265		$this->extendedAuthDescription = $extendedAuthDescription;
266		return $this;
267		}
268
269		public function getExtendedAuthReasonCode()
270		{
271		return $this->extendedAuthReasonCode;
272		}
273
274		public function setExtendedAuthReasonCode($extendedAuthReasonCode)
275		{
276		$this->extendedAuthReasonCode = $extendedAuthReasonCode;
277		return $this;
278		}
279
280		public function getAmountAuthorized()
281		{
282		return $this->amountAuthorized;
283		}
284
285		public function setAmountAuthorized($amountAuthorized)
286		{
287		$this->amountAuthorized = $this->sanitizeAmount($amountAuthorized);
288		return $this;
289		}
290
291		public function getExpirationDate()
292		{
293		return $this->expirationDate;
294		}
295
296		public function setExpirationDate(DateTime $expirationDate)
297		{
298		$this->expirationDate = $expirationDate;
299		return $this;
300		}
301
302		public function getStartDate()
303		{
304		return $this->startDate;
305		}
306
307		public function setStartDate(DateTime $startDate)
308		{
309		$this->startDate = $startDate;
310		return $this;
311		}
312
313		public function getIssueNumber()
314		{
315		return $this->issueNumber;
316		}
317
318		public function setIssueNumber($issueNumber)
319		{
320		$this->issueNumber = $issueNumber;
321		return $this;
322		}
323
324		public function getAuthenticationAvailable()
325		{
326		return $this->authenticationAvailable;
327		}
328
329		public function setAuthenticationAvailable($authenticationAvailable)
330		{
331		$this->authenticationAvailable = $authenticationAvailable;
332		return $this;
333		}
334
335		public function getAuthenticationStatus()
336		{
337		return $this->authenticationStatus;
338		}
339
340		public function setAuthenticationStatus($authenticationStatus)
341		{
342		$this->authenticationStatus = $authenticationStatus;
343		return $this;
344		}
345
346		public function getCavvUcaf()
347		{
348		return $this->cavvUcaf;
349		}
350
351		public function setCavvUcaf($cavvUcaf)
352		{
353		$this->cavvUcaf = $this->cleanString($cavvUcaf, 64);
354		return $this;
355		}
356
357		public function getTransactionId()
358		{
359		return $this->transactionId;
360		}
361
362		public function setTransactionId($transactionId)
363		{
364		$this->transactionId = $this->cleanString($transactionId, 64);
365		return $this;
366		}
367
368		public function getECI()
369		{
370		return $this->eci;
371		}
372
373		public function setECI($eci)
374		{
375		$this->eci = $eci;
376		return $this;
377		}
378
379		public function getPayerAuthenticationResponse()
380		{
381		return $this->payerAuthenticationResponse;
382		}
383
384		public function setPayerAuthenticationResponse($payerAuthenticationResponse)
385		{
386		$this->payerAuthenticationResponse = $this->cleanString($payerAuthenticationResponse, 10000);
387		return $this;
388		}
389
390		public function getPurchasePlanCode()
391		{
392		return $this->purchasePlanCode;
393		}
394
395		public function setPurchasePlanCode($purchasePlanCode)
396		{
397		$this->purchasePlanCode = $purchasePlanCode;
398		return $this;
399		}
400
401		public function getPurchasePlanDescription()
402		{
403		return $this->purchasePlanDescription;
404		}
405
406		public function setPurchasePlanDescription($purchasePlanDescription)
407		{
408		$this->purchasePlanDescription = $purchasePlanDescription;
409		return $this;
410		}
411
412		protected function serializeContents()
413		{
414		return $this->serializePaymentContext()
415		. $this->serializePaymentRequestId()
416		. "<CreateTimeStamp>{$this->getCreateTimeStamp()->format('c')}</CreateTimeStamp>"
417		. $this->serializeOptionalAmount('Amount', $this->getAmount())
418		. $this->serializeAuthorizations()
419		. $this->serializeOptionalDateValue('ExpirationDate', 'Y-m', $this->getExpirationDate())
420		. $this->serializeOptionalDateValue('StartDate', 'Y-m', $this->getStartDate())
421		. $this->serializeOptionalValue('IssueNumber', $this->xmlEncode($this->getIssueNumber()))
422		. $this->serializeSecureVerificationData()
423		. $this->serializeOptionalValue('PurchasePlanCode', $this->xmlEncode($this->getPurchasePlanCode()))
424		. $this->serializeOptionalValue('PurchasePlanDescription', $this->xmlEncode($this->getPurchasePlanDescription()))
425		. $this->getCustomAttributes()->serialize();
426		}
427
428		/**
429		* Serialize the credit card authorizations.
430		*
431		* @return string
432		*/
433		protected function serializeAuthorizations()
434		{
435		return '<Authorization>'
436		. "<ResponseCode>{$this->xmlEncode($this->getResponseCode())}</ResponseCode>"
437		. "<BankAuthorizationCode>{$this->xmlEncode($this->getBankAuthorizationCode())}</BankAuthorizationCode>"
438		. "<CVV2ResponseCode>{$this->xmlEncode($this->getCVV2ResponseCode())}</CVV2ResponseCode>"
439		. "<AVSResponseCode>{$this->xmlEncode($this->getAVSResponseCode())}</AVSResponseCode>"
440		. $this->serializeOptionalValue('PhoneResponseCode', $this->xmlEncode($this->getPhoneResponseCode()))
441		. $this->serializeOptionalValue('NameResponseCode', $this->xmlEncode($this->getNameResponseCode()))
442		. $this->serializeOptionalValue('EmailResponseCode', $this->xmlEncode($this->getEmailResponseCode()))
443		. $this->serializeExtendedAuthorizations()
444		. $this->serializeOptionalAmount('AmountAuthorized', $this->getAmountAuthorized())
445		. '</Authorization>';
446		}
447
448		/**
449		* Serialize the extended authorizations. Only include if both the extended
450		* auth reason code and extended auth response code description are included.
451		* Return an empty string, no serialization, if either is missing.
452		*
453		* @return string
454		*/
455		protected function serializeExtendedAuthorizations()
456		{
457		$code = $this->getExtendedAuthReasonCode();
458		$description = $this->getExtendedAuthDescription();
459		return $code && $description
460		? '<ExtendedAuthorizationResponseCodes>'
461		. "<ResponseCodeDescription>{$this->xmlEncode($description)}</ResponseCodeDescription>"
462		. "<ReasonCode>{$this->xmlEncode($code)}</ReasonCode>"
463		. '</ExtendedAuthorizationResponseCodes>'
464		: '';
465		}
466
467		/**
468		* Serialize sercure verification data (Verified by VISA). Will only be
469		* included if a payer authentication response is included.
470		*
471		* @return string
472		*/
473		protected function serializeSecureVerificationData()
474		{
475		$payerAuthResponse = $this->getPayerAuthenticationResponse();
476		if ($payerAuthResponse) {
477		return '<SecureVerificationData>'
478		. $this->serializeOptionalValue('AuthenticationAvailable', $this->xmlEncode($this->getAuthenticationAvailable()))
479		. $this->serializeOptionalValue('AuthenticationStatus', $this->xmlEncode($this->getAuthenticationStatus()))
480		. $this->serializeOptionalValue('CavvUcaf', $this->xmlEncode($this->getCavvUcaf()))
481		. $this->serializeOptionalValue('TransactionId', $this->xmlEncode($this->getTransactionId()))
482		. $this->serializeOptionalValue('ECI', $this->xmlEncode($this->getECI()))
483		. "<PayerAuthenticationResponse>{$this->xmlEncode($this->getPayerAuthenticationResponse())}</PayerAuthenticationResponse>"
484		. '</SecureVerificationData>';
485		}
486		return '';
487		}
488
489		/**
490		* Deserialize date time fields as DateTime objects instead of plain string
491		* values.
492		*
493		* @return self
494		*/
495		protected function deserializeExtra($serializedPayload)
496		{
497		$xpath = $this->getPayloadAsXPath($serializedPayload);
498		$dateTimePaths = [
499		'createTimeStamp' => 'string(x:CreateTimeStamp)',
500		'expirationDate' => 'string(x:ExpirationDate)',
501		'startDate' => 'string(x:StartDate)',
502		];
503		foreach ($dateTimePaths as $prop => $extractionPath) {
504		$value = $xpath->evaluate($extractionPath);
505		$this->$prop = $value ? new DateTime($value) : null;
506		}
507		return $this;
508		}
509
510	View Code Duplication	protected function getRootAttributes()
		0 ignored issues – show Duplication introduced 2015-11-25 17:00 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
511		{
512		$isMockPayment = $this->getIsMockPayment();
513		return !is_null($isMockPayment)
514		? ['isMockPayment' => $this->convertBooleanToString($isMockPayment)]
515		: [];
516		}
517
518		protected function getRootNodeName()
519		{
520		return static::ROOT_NODE;
521		}
522
523		protected function getXmlNamespace()
524		{
525		return self::XML_NS;
526		}
527		}
528

eBayEnterprise / RetailOrderManagement-SDK

GitHub Access Token became invalid

CreditCardPayment::serializeContents() A last analyzed 2016-01-20 19:07 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

CreditCardPayment::serializeContents() A
last analyzed 2016-01-20 19:07 UTC