eBayEnterprise\RetailOrderManagement\Payload\Payment\PayPalGetExpressCheckoutReply

Complexity

Total Complexity

41

Size/Duplication

Total Lines	496
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	12
Bugs	1	Features	3

40 Methods

Rating	Name	Duplication	Size	Complexity
A	isSuccess()	0	4	1
A	getResponseCode()	0	4	1
A	serializeResponseCode()	0	4	1
A	serializePayerEmail()	0	4	1
A	getPayerEmail()	0	4	1
A	serializePayerId()	0	4	1
A	getPayerId()	0	4	1
A	serializePayerStatus()	0	4	1
A	getPayerStatus()	0	4	1
A	getBillingAddressStatus()	0	4	1
A	getShippingAddressStatus()	0	4	1
A	getPayerNameHonorific()	0	4	1
A	getPayerLastName()	0	4	1
A	getPayerMiddleName()	0	4	1
A	getPayerFirstName()	0	4	1
A	serializePayerCountry()	0	4	1
A	getPayerCountry()	0	4	1
A	serializePayerPhone()	0	4	1
A	getPayerPhone()	0	4	1
A	getSchemaFile()	0	4	1
A	getXmlNamespace()	0	4	1
A	getRootNodeName()	0	4	1
A	serializeBillingAddressWithStatus()	0	4	1
A	serializeShippingAddressWithStatus()	0	4	1
A	__construct()	0	50	1
A	setResponseCode()	0	5	1
A	serializeContents()	0	13	1
A	setPayerEmail()	0	5	1
A	setPayerId()	0	5	1
A	setPayerStatus()	0	5	1
A	setBillingAddressStatus()	0	5	1
A	setShippingAddressStatus()	0	5	1
A	serializePayerName()	0	9	1
A	setPayerNameHonorific()	0	5	1
A	setPayerLastName()	0	5	1
A	setPayerMiddleName()	0	5	1
A	setPayerFirstName()	0	5	1
A	setPayerCountry()	0	5	1
A	setPayerPhone()	0	5	1
A	injectAddressStatus()	0	13	2

<?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-2014 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\Payment;

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\TTopLevelPayload;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;

class PayPalGetExpressCheckoutReply implements IPayPalGetExpressCheckoutReply
{
    use TTopLevelPayload, TOrderId, TBillingAddress, TShippingAddress;

    const ADDRESS_INTERFACE = '\eBayEnterprise\RetailOrderManagement\Payload\Payment\IPayPalAddress';
    const SUCCESS = 'Success';

    /** @var string */
    protected $responseCode;
    /** @var string */
    protected $payerEmail;
    /** @var string */
    protected $payerId;
    /** @var string */
    protected $payerStatus;
    /** @var string */
    protected $payerNameHonorific;
    /** @var string */
    protected $payerLastName;
    /** @var string */
    protected $payerMiddleName;
    /** @var string */
    protected $payerFirstName;
    /** @var string */
    protected $payerCountry;
    /** @var string */
    protected $payerPhone;
    /** @var string */
    protected $billingAddressStatus;
    /** @var string */
    protected $shippingAddressStatus;

    /**
     * @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;

It seems like $logger of type object<Psr\Log\LoggerInterface> is incompatible with the declared type object<eBayEnterprise\RetailOrderManagement\Payload\LoggerInterface> of property $logger.

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

        $this->extractionPaths = [
            'orderId' => 'string(x:OrderId)',
            'responseCode' => 'string(x:ResponseCode)',
            'payerEmail' => 'string(x:PayerEmail)',
            'payerId' => 'string(x:PayerId)',
            'payerStatus' => 'string(x:PayerStatus)',
            'payerNameHonorific' => 'string(x:PayerName/x:Honorific)',
            'payerLastName' => 'string(x:PayerName/x:LastName)',
            'payerMiddleName' => 'string(x:PayerName/x:MiddleName)',
            'payerFirstName' => 'string(x:PayerName/x:FirstName)',
            'payerCountry' => 'string(x:PayerCountry)',
            'payerPhone' => 'string(x:PayerPhone)',
            'billingCity' => 'string(x:BillingAddress/x:City)',
            'billingCountryCode' => 'string(x:BillingAddress/x:CountryCode)',
            'shipToCity' => 'string(x:ShippingAddress/x:City)',
            'shipToCountryCode' => 'string(x:ShippingAddress/x:CountryCode)',
        ];
        $this->optionalExtractionPaths = [
            'billingMainDivision' => 'x:BillingAddress/x:MainDivision',
            'billingPostalCode' => 'x:BillingAddress/x:PostalCode',
            'shipToMainDivision' => 'x:ShippingAddress/x:MainDivision',
            'shipToPostalCode' => 'x:ShippingAddress/x:PostalCode',
            'billingAddressStatus' => 'x:BillingAddress/x:AddressStatus',
            'shippingAddressStatus' => 'x:ShippingAddress/x:AddressStatus',
        ];
        $this->addressLinesExtractionMap = [
            [
                'property' => 'billingLines',
                'xPath' => "x:BillingAddress/*[starts-with(name(), 'Line')]"
            ],
            [
                'property' => 'shipToLines',
                'xPath' => "x:ShippingAddress/*[starts-with(name(), 'Line')]"
            ]
        ];
    }

    /**
     * Should downstream systems consider this reply a success?
     *
     * @return bool
     */
    public function isSuccess()
    {
        return $this->getResponseCode() === static::SUCCESS;
    }

    /**
     * Response code like Success, Failure etc
     *
     * @return string
     */
    public function getResponseCode()
    {
        return $this->responseCode;
    }

    /**
     * @param string
     * @return self
     */
    public function setResponseCode($code)
    {
        $this->responseCode = $code;
        return $this;
    }

    /**
     * Serialize a complete reply
     * @return string
     */
    public function serializeContents()
    {
        return $this->serializeOrderId()
        . $this->serializeResponseCode()
        . $this->serializePayerEmail()
        . $this->serializePayerId()
        . $this->serializePayerStatus()
        . $this->serializePayerName()
        . $this->serializePayerCountry()
        . $this->serializeBillingAddressWithStatus()
        . $this->serializePayerPhone()
        . $this->serializeShippingAddressWithStatus();
    }

    /**
     * Serialize a ResponseCode
     * @return string
     */
    protected function serializeResponseCode()
    {
        return "<ResponseCode>{$this->xmlEncode($this->getResponseCode())}</ResponseCode>";
    }

    /**
     * Serialize a PayerEmail
     * @return string
     */
    protected function serializePayerEmail()
    {
        return "<PayerEmail>{$this->xmlEncode($this->getPayerEmail())}</PayerEmail>";
    }

    /**
     * Email address of the payer. Character length and limitations: 127 single-byte characters
     *
     * @return string
     */
    public function getPayerEmail()
    {
        return $this->payerEmail;
    }

    /**
     * @param string
     * @return self
     */
    public function setPayerEmail($email)
    {
        $this->payerEmail = $email;
        return $this;
    }

    /**
     * Serialize a PayerId
     * @return string
     */
    protected function serializePayerId()
    {
        return "<PayerId>{$this->xmlEncode($this->getPayerId())}</PayerId>";
    }

    /**
     * Unique identifier of the customer's PayPal account. Character length and limitations: 17 single-byte characters
     *
     * @return string
     */
    public function getPayerId()
    {
        return $this->payerId;
    }

    /**
     * @param string
     * @return self
     */
    public function setPayerId($id)
    {
        $this->payerId = $id;
        return $this;
    }

    /**
     * Serialize a PayerStatus
     * @return string
     */
    protected function serializePayerStatus()
    {
        return "<PayerStatus>{$this->xmlEncode($this->getPayerStatus())}</PayerStatus>";
    }

    /**
     * Status of payer's email address.
     * "verified" or "unverified"
     *
     * @return string
     */
    public function getPayerStatus()
    {
        return $this->payerStatus;
    }

    /**
     * @param string
     * @return self
     */
    public function setPayerStatus($payerStatus)
    {
        $this->payerStatus = $payerStatus;
        return $this;
    }

    /**
     * Billing address status to be sent to the Order Management System
     *
     * @return string
     */
    public function getBillingAddressStatus()
    {
        return $this->billingAddressStatus;
    }

    /**
     * @param string
     * @return self
     */
    public function setBillingAddressStatus($status)
    {
        $this->billingAddressStatus = $status;
        return $this;
    }

    /**
     * Shipping address status to be sent to the Order Management System
     *
     * @return string
     */
    public function getShippingAddressStatus()
    {
        return $this->shippingAddressStatus;
    }

    /**
     * @param string
     * @return self
     */
    public function setShippingAddressStatus($status)
    {
        $this->shippingAddressStatus = $status;
        return $this;
    }

    /**
     * Serialize Payer Name Details
     * @return string
     */
    protected function serializePayerName()
    {
        return "<PayerName>"
        . "<Honorific>{$this->xmlEncode($this->getPayerNameHonorific())}</Honorific>"
        . "<LastName>{$this->xmlEncode($this->getPayerLastName())}</LastName>"
        . "<MiddleName>{$this->xmlEncode($this->getPayerMiddleName())}</MiddleName>"
        . "<FirstName>{$this->xmlEncode($this->getPayerFirstName())}</FirstName>"
        . "</PayerName>";
    }

    /**
     * A title you can assign to the payer. Typically "Dr.", "Mr.", "Ms." etc.
     *
     * @return string
     */
    public function getPayerNameHonorific()
    {
        return $this->payerNameHonorific;
    }

    /**
     * @param string
     * @return self
     */
    public function setPayerNameHonorific($hon)
    {
        $this->payerNameHonorific = $hon;
        return $this;
    }

    /**
     * The surname of the payer.
     *
     * @return string
     */
    public function getPayerLastName()
    {
        return $this->payerLastName;
    }

    /**
     * @param string
     * @return self
     */
    public function setPayerLastName($name)
    {
        $this->payerLastName = $name;
        return $this;
    }

    /**
     * The payer's middle name.
     *
     * @return string
     */
    public function getPayerMiddleName()
    {
        return $this->payerMiddleName;
    }

    /**
     * @param string
     * @return self
     */
    public function setPayerMiddleName($name)
    {
        $this->payerMiddleName = $name;
        return $this;
    }

    /**
     * The payer's first name.
     *
     * @return string
     */
    public function getPayerFirstName()
    {
        return $this->payerFirstName;
    }

    /**
     * @param string
     * @return self
     */
    public function setPayerFirstName($name)
    {
        $this->payerFirstName = $name;
        return $this;
    }

    /**
     * Serialize Payer Country
     * @return string
     */
    protected function serializePayerCountry()
    {
        return "<PayerCountry>{$this->xmlEncode($this->getPayerCountry())}</PayerCountry>";
    }

    /**
     * Payment sender's country of residence using standard two-character ISO 3166 country codes.
     * Character length and limitations: Two single-byte characters.
     *
     * @link http://countrycode.org/
     * @return string
     */
    public function getPayerCountry()
    {
        return $this->payerCountry;
    }

    /**
     * @param string
     * @return self
     */
    public function setPayerCountry($country)
    {
        $this->payerCountry = $country;
        return $this;
    }

    /**
     * Serialize Payer Phone
     * @return string
     */
    protected function serializePayerPhone()
    {
        return "<PayerPhone>{$this->xmlEncode($this->getPayerPhone())}</PayerPhone>";
    }

    /**
     * Payer's phone on file with PayPal.
     *
     * @return string
     */
    public function getPayerPhone()
    {
        return $this->payerPhone;
    }

    /**
     * @param string
     * @return self
     */
    public function setPayerPhone($phone)
    {
        $this->payerPhone = $phone;
        return $this;
    }

    protected function getSchemaFile()
    {
        return $this->getSchemaDir() . self::XSD;
    }

    /**
     * The XML namespace for the payload.
     *
     * @return string
     */
    protected function getXmlNamespace()
    {
        return static::XML_NS;
    }

    /**
     * Return the name of the xml root node.
     *
     * @return string
     */
    protected function getRootNodeName()
    {
        return static::ROOT_NODE;
    }

    /**
     * add the address status element to a serialized IBillingAddress or
     * IShippingAddress
     * @param  string $status
     * @param  string $serializedAddress
     * @return string
     */
    protected function injectAddressStatus($status, $serializedAddress)
    {
        if ($status) {
            $closeTagPos = strrpos($serializedAddress, '</');
            $serializedAddress = substr_replace(
                $serializedAddress,
                "<AddressStatus>{$this->xmlEncode($status)}</AddressStatus>",
                $closeTagPos,
                0
            );
        }
        return $serializedAddress;
    }

    /**
     * serialize the billing address along with the address
     * status
     * @return string
     */
    protected function serializeBillingAddressWithStatus()
    {
        return $this->injectAddressStatus($this->getBillingAddressStatus(), $this->serializeBillingAddress());
    }

    /**
     * serialize the shipping address along with the address
     * status
     * @return string
     */
    protected function serializeShippingAddressWithStatus()
    {
        return $this->injectAddressStatus($this->getShippingAddressStatus(), $this->serializeShippingAddress());
    }
}