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

OrderCreateRequest::setupSubPayloads() B
last analyzed 2016-01-20 19:07 UTC

↳ Parent: OrderCreateRequest

Complexity

Conditions	1
Paths	1

Size

Total Lines	33
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	33
rs	8.8571
cc	1
eloc	21
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 DOMXPath;
use eBayEnterprise\RetailOrderManagement\Payload\Checkout\TDestinationContainer;
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\TTopLevelPayload;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;

class OrderCreateRequest implements IOrderCreateRequest
{
    use TTopLevelPayload, TOrderCustomer, TOrderItemContainer, TShipGroupContainer,
        TDestinationContainer, TPaymentContainer, TItemRelationshipContainer, TOrderHoldContainer,
        TCustomAttributeContainer, TTemplateContainer, TOrderContext, TAmount;

    /** @var string */
    protected $orderType;
    /** @var string */
    protected $requestId;
    /** @var string */
    protected $testType;
    /** @var string */
    protected $orderId;
    /** @var string */
    protected $levelOfService;
    /** @var DateTime */
    protected $createTime;
    /** @var IMailingAddress */
    protected $billingAddress;
    /** @var string */
    protected $billingAddressIdRef;
    /** @var string */
    protected $shopRunnerMessage;
    /** @var string */
    protected $currency;
    /** @var string */
    protected $associateName;
    /** @var string */
    protected $associateNumber;
    /** @var string */
    protected $associateStore;
    /** @var bool */
    protected $taxHeader;
    /** @var string */
    protected $printedCatalogCode;
    /** @var string */
    protected $locale;
    /** @var string */
    protected $dashboardRepId;
    /** @var string */
    protected $orderSource;
    /** @var string */
    protected $orderSourceType;
    /** @var string */
    protected $orderHistoryUrl;
    /** @var bool */
    protected $vatInclusivePricing;
    /** @var string */
    protected $orderTotal;

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

        $this->extractionPaths = array_merge(
            [
                'requestId' => 'string(@requestId)',
                'orderId' => 'string(x:Order/@customerOrderId)',
                'billingAddressIdRef' => 'string(x:Order/x:Payment/x:BillingAddress/@ref)',
                'currency' => 'string(x:Order/x:Currency)',
                'locale' => 'string(x:Order/x:Locale)',
                'orderTotal' => 'number(x:Order/x:OrderTotal)',
                'firstName' => 'string(x:Order/x:Customer/x:Name/x:FirstName)',
                'lastName' => 'string(x:Order/x:Customer/x:Name/x:LastName)',
            ],
            $this->getOrderContextExtractionPaths()
        );
        $this->optionalExtractionPaths = array_merge(
            [
                'orderType' => '@orderType',
                'testType' => '@testType',
                'levelOfService' => 'x:Order/@levelOfService',
                'shopRunnerMessage' => 'x:Order/x:ShopRunnerMessage',
                'associateName' => 'x:Order/x:Associate/x:Name',
                'associateNumber' => 'x:Order/x:Associate/x:Number',
                'associateStore' => 'x:Order/x:Associate/x:Store',
                'printedCatalogCode' => 'x:Order/x:PrintedCatalogCode',
                'dashboardRepId' => 'x:Order/x:DashboardRepId',
                'orderSource' => 'x:Order/x:OrderSource',
                'orderSourceType' => 'x:Order/x:OrderSource/@type',
                'orderHistoryUrl' => 'x:Order/x:OrderHistoryUrl',
                'customerId' => 'x:Order/x:Customer/@customerId',
                'gender' => 'x:Order/x:Customer/x:Gender',
                'emailAddress' => 'x:Order/x:Customer/x:EmailAddress',
                'taxId' => 'x:Order/x:Customer/x:CustomerTaxId',
                'middleName' => 'x:Order/x:Customer/x:Name/x:MiddleName',
                'honorificName' => 'x:Order/x:Customer/x:Name/x:Honorific',
            ],
            $this->getOrderContextOptionalExtractionPaths()
        );
        $this->booleanExtractionPaths = [
            'taxHeader' => 'string(x:Order/x:TaxHeader/x:Error)',
            'vatInclusivePricing' => 'string(x:Order/x:VATInclusivePricing)',
            'taxExempt' => 'string(x:Order/x:Customer/x:TaxExemptFlag)',
        ];
        $this->subpayloadExtractionPaths = array_merge(
            [
                'loyaltyPrograms' => 'x:Order/x:Customer/x:LoyaltyPrograms',
                'orderItems' => 'x:Order/x:OrderItems',
                'payments' => 'x:Order/x:Payment/x:Payments',
                'shipGroups' => 'x:Order/x:Shipping/x:ShipGroups',
                'destinations' => 'x:Order/x:Shipping/x:Destinations',
                'itemRelationships' => 'x:Order/x:Relationships',
                'holds' => 'x:Order/x:Holds',
                'customAttributes' => 'x:Order/x:CustomAttributes',
                'templates' => 'x:Order/x:Templates',
            ],
            $this->getOrderContextSubpayloadExtractionPaths()
        );
    }

    public function getOrderType()
    {
        return $this->orderType;
    }

    public function setOrderType($orderType)
    {
        if ($orderType === self::ORDER_TYPE_SALES ||
            $orderType === self::ORDER_TYPE_RETURN ||
            $orderType === self::ORDER_TYPE_PURCHASE ||
            $orderType === self::ORDER_TYPE_TRANSFER
        ) {
            $this->orderType = $orderType;
        }
        return $this;
    }

    public function getRequestId()
    {
        return $this->requestId;
    }

    public function setRequestId($requestId)
    {
        $this->requestId = $this->cleanString($requestId, 40);
        return $this;
    }

    public function getTestType()
    {
        return $this->testType;
    }

    public function setTestType($testType)
    {
        if ($testType === self::TEST_TYPE_WEBONLY ||
            $testType === self::TEST_TYPE_AUTOCANCEL ||
            $testType === self::TEST_TYPE_NORELEASE ||
            $testType === self::TEST_TYPE_AUTOSHIP
        ) {
            $this->testType = $testType;
        }
        return $this;
    }

    public function getOrderId()
    {
        return $this->orderId;
    }

    public function setOrderId($orderId)
    {
        $this->orderId = $this->cleanString($orderId, 24);
        return $this;
    }

    public function getLevelOfService()
    {
        return $this->levelOfService;
    }

    public function setLevelOfService($levelOfService)
    {
        if ($levelOfService === self::LEVEL_OF_SERVICE_REGULAR ||
            $levelOfService === self::LEVEL_OF_SERVICE_RUSH
        ) {
            $this->levelOfService = $levelOfService;
        }
        return $this;
    }

    public function getCreateTime()
    {
        return $this->createTime;
    }

    public function setCreateTime(DateTime $createTime)
    {
        $this->createTime = $createTime;
        return $this;
    }

    public function getBillingAddress()
    {
        if (!$this->billingAddress && $this->billingAddressIdRef) {
            foreach ($this->getDestinations() as $destination) {
                if ($destination->getId() === $this->billingAddressIdRef) {
                    $this->billingAddress = $destination;
                    break;
                }
            }
        }
        return $this->billingAddress;
    }

    public function setBillingAddress(IMailingAddress $billingAddress)
    {
        $this->billingAddress = $billingAddress;
        $this->billingAddressIdRef = $billingAddress->getId();
        // Add the billing address to the collection of destinations
        $this->getDestinations()->offsetSet($billingAddress);
        return $this;
    }

    public function getShopRunnerMessage()
    {
        return $this->shopRunnerMessage;
    }

    public function setShopRunnerMessage($shopRunnerMessage)
    {
        $this->shopRunnerMessage = $this->normalizeWhitespace($shopRunnerMessage);
        return $this;
    }

    public function getCurrency()
    {
        return $this->currency;
    }

    public function setCurrency($currency)
    {
        $cleaned = $this->cleanString($currency, 3);
        if (strlen($cleaned) === 3) {
            $this->currency = $currency;
        }
        return $this;
    }

    public function getAssociateName()
    {
        return $this->associateName;
    }

    public function setAssociateName($associateName)
    {
        $this->associateName = $associateName;
        return $this;
    }

    public function getAssociateNumber()
    {
        return $this->associateNumber;
    }

    public function setAssociateNumber($associateNumber)
    {
        $this->associateNumber = $associateNumber;
        return $this;
    }

    public function getAssociateStore()
    {
        return $this->associateStore;
    }

    public function setAssociateStore($associateStore)
    {
        $this->associateStore = $associateStore;
        return $this;
    }

    public function getTaxHasErrors()
    {
        return $this->taxHeader;
    }

    public function setTaxHasErrors($taxHeader)
    {
        $this->taxHeader = (bool) $taxHeader;
        return $this;
    }

    public function getPrintedCatalogCode()
    {
        return $this->printedCatalogCode;
    }

    public function setPrintedCatalogCode($printedCatalogCode)
    {
        $this->printedCatalogCode = $printedCatalogCode;
        return $this;
    }

    public function getLocale()
    {
        return $this->locale;
    }

    public function setLocale($locale)
    {
        $cleaned = $this->cleanString($locale, 5);
        // local must match pattern two character language code, and underscore (_),
        // two character country code
        $this->locale = (preg_match('#^[a-z]{2}_[a-z]{2}$#i', $cleaned)) ? $cleaned : null;
        return $this;
    }

    public function getDashboardRepId()
    {
        return $this->dashboardRepId;
    }

    public function setDashboardRepId($dashboardRepId)
    {
        $this->dashboardRepId = $dashboardRepId;
        return $this;
    }

    public function getOrderSource()
    {
        return $this->orderSource;
    }

    public function setOrderSource($orderSource)
    {
        $this->orderSource = $orderSource;
        return $this;
    }

    public function getOrderSourceType()
    {
        return $this->orderSourceType;
    }

    public function setOrderSourceType($orderSourceType)
    {
        $this->orderSourceType = $orderSourceType;
        return $this;
    }

    public function getOrderHistoryUrl()
    {
        return $this->orderHistoryUrl;
    }

    public function setOrderHistoryUrl($orderHistoryUrl)
    {
        $this->orderHistoryUrl = $orderHistoryUrl;
        return $this;
    }

    public function getVatInclusivePricing()
    {
        return $this->vatInclusivePricing;
    }

    public function setVatInclusivePricing($vatInclusivePricing)
    {
        $this->vatInclusivePricing = (bool) $vatInclusivePricing;
        return $this;
    }
    public function getOrderTotal()
    {
        return $this->orderTotal;
    }

    public function setOrderTotal($orderTotal)
    {
        $this->orderTotal = $this->sanitizeAmount($orderTotal);
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        return $this;
    }

    protected function setupSubPayloads()
    {
        $this->loyaltyPrograms = $this->buildPayloadForInterface(
            static::LOYALTY_PROGRAM_ITERABLE_INTERFACE
        );
        $this->orderItems = $this->buildPayloadForInterface(
            static::ORDER_ITEM_ITERABLE_INTERFACE
        );
        $this->payments = $this->buildPayloadForInterface(
            static::PAYMENT_ITERABLE_INTERFACE
        );
        $this->shipGroups = $this->buildPayloadForInterface(
            static::SHIP_GROUP_ITERABLE_INTERFACE
        );
        $this->destinations = $this->buildPayloadForInterface(
            static::DESTINATION_ITERABLE_INTERFACE
        );
        $this->itemRelationships = $this->buildPayloadForInterface(
            static::ITEM_RELATIONSHIP_ITERABLE_INTERFACE
        );
        $this->holds = $this->buildPayloadForInterface(
            static::ORDER_HOLD_ITERABLE_INTERFACE
        );
        $this->customAttributes = $this->buildPayloadForInterface(
            static::CUSTOM_ATTRIBUTE_ITERABLE_INTERFACE
        );
        $this->templates = $this->buildPayloadForInterface(
            static::TEMPLATE_ITERABLE_INTERFACE
        );
        $this->orderContextCustomAttributes = $this->buildPayloadForInterface(
            static::ORDER_CONTEXT_CUSTOM_ATTRIBUTE_ITERABLE_INTERFACE
        );
    }

    protected function deserializeExtra($serializedPayload)
    {
        $xpath = $this->getPayloadAsXPath($serializedPayload);
        return $this->deserializeDateTimeValues($xpath)->deserializeExtraOrderContext($xpath);
    }

    /**
     * Deserialize date time values as DateTime objects.
     *
     * @param DOMXPath
     * @return self
     */
    protected function deserializeDateTimeValues(DOMXPath $xpath)
    {
        $dateProperties = [
            'createTime' => 'string(x:Order/x:CreateTime)',
            'dateOfBirth' => 'string(x:Order/x:Customer/x:DateOfBirth)',
        ];
        foreach ($dateProperties as $prop => $extractPath) {

            $value = $xpath->evaluate($extractPath);
            $this->$prop = $value ? new DateTime($value) : null;
        }
        return $this;
    }

    protected function serializeContents()
    {
        return $this->serializeOrder() . $this->serializeOrderContext();
    }

    /**
     * Serialize the order details.
     *
     * @return string
     */
    protected function serializeOrder()
    {
        return "<Order customerOrderId='{$this->xmlEncode($this->getOrderId())}' levelOfService='{$this->xmlEncode($this->getLevelOfService())}'>"
            . $this->serializeOrderCustomer()
            . "<CreateTime>{$this->getCreateTime()->format('c')}</CreateTime>"
            . $this->getOrderItems()->serialize()
            . '<Shipping>'
            . $this->getShipGroups()->serialize()
            . $this->getDestinations()->serialize()
            . '</Shipping>'
            . '<Payment>'
            . "<BillingAddress ref='{$this->xmlEncode($this->getBillingAddress()->getId())}' />"
            . $this->getPayments()->serialize()
            . '</Payment>'
            . $this->serializeOptionalXmlEncodedValue('ShopRunnerMessage', $this->getShopRunnerMessage())
            . "<Currency>{$this->xmlEncode($this->getCurrency())}</Currency>"
            . $this->serializeAssociate()
            . $this->serializeTaxHeader()
            . $this->serializeOptionalXmlEncodedValue('PrintedCatalogCode', $this->getPrintedCatalogCode())
            . "<Locale>{$this->xmlEncode($this->getLocale())}</Locale>"
            . $this->getItemRelationships()->serialize()
            . $this->serializeOptionalXmlEncodedValue('DashboardRepId', $this->getDashboardRepId())
            . $this->serializeOrderSource()
            . $this->getHolds()->serialize()
            . $this->getCustomAttributes()->serialize()
            . $this->getTemplates()->serialize()
            . ($this->getOrderHistoryUrl() ? "<OrderHistoryUrl>{$this->xmlEncode($this->getOrderHistoryUrl())}</OrderHistoryUrl>" : "")
            . $this->serializeVatInclusivePricing()
            . $this->serializeOptionalAmount('OrderTotal', $this->getOrderTotal())
            . '</Order>';
    }

    /**
     * Serialize store associate details.
     *
     * @return string
     */
    protected function serializeAssociate()
    {
        if (!is_null($this->getAssociateNumber())) {
            return '<Associate>'
                 . "<Name>{$this->xmlEncode($this->getAssociateName())}</Name>"
                 . "<Number>{$this->xmlEncode($this->getAssociateNumber())}</Number>"
                 . "<Store>{$this->xmlEncode($this->getAssociateStore())}</Store>"
                 . '</Associate>';
        }
        return '';
    }

    /**
     * Serialize tax headers.
     *
     * @return string
     */
    protected function serializeTaxHeader()
    {
        $taxHasErrors = $this->getTaxHasErrors();
        if (!is_null($taxHasErrors)) {
            return "<TaxHeader><Error>{$this->convertBooleanToString($taxHasErrors)}</Error></TaxHeader>";
        }
        return '';
    }

    /**
     * Serialize the order source and order source type.
     *
     * @return string
     */
    protected function serializeOrderSource()
    {
        $orso = $this->getOrderSource();
        if (!is_null($orso)) {
            return sprintf('<OrderSource type="%s">', $this->xmlEncode($this->getOrderSourceType()))
                . $this->xmlEncode($orso)
                . '</OrderSource>';
        }
        return '';
    }

    /**
     * Serialize if the order uses vat inclusive pricing.
     *
     * @return string
     */
    protected function serializeVatInclusivePricing()
    {
        $vatInclusive = $this->getVatInclusivePricing();
        if (!is_null($vatInclusive)) {
            return "<VATInclusivePricing>{$this->convertBooleanToString($vatInclusive)}</VATInclusivePricing>";
        }
        return '';
    }

    protected function getRootAttributes()
    {
        return array_filter([
            'orderType' => $this->getOrderType(),
            'requestId' => $this->getRequestId(),
            'testType' => $this->getTestType(),
            'xmlns' => $this->getXmlNamespace(),
        ]);
    }

    protected function getPersonNameRootNodeName()
    {
        return self::PERSON_NAME_ROOT_NODE;
    }

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

    protected function getRootNodeName()
    {
        return self::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 DOMXPath;
20		use eBayEnterprise\RetailOrderManagement\Payload\Checkout\TDestinationContainer;
21		use eBayEnterprise\RetailOrderManagement\Payload\IPayload;
22		use eBayEnterprise\RetailOrderManagement\Payload\IPayloadMap;
23		use eBayEnterprise\RetailOrderManagement\Payload\ISchemaValidator;
24		use eBayEnterprise\RetailOrderManagement\Payload\IValidatorIterator;
25		use eBayEnterprise\RetailOrderManagement\Payload\PayloadFactory;
26		use eBayEnterprise\RetailOrderManagement\Payload\Payment\TAmount;
27		use eBayEnterprise\RetailOrderManagement\Payload\TTopLevelPayload;
28		use Psr\Log\LoggerInterface;
29		use Psr\Log\NullLogger;
30
31		class OrderCreateRequest implements IOrderCreateRequest
32		{
33		use TTopLevelPayload, TOrderCustomer, TOrderItemContainer, TShipGroupContainer,
34		TDestinationContainer, TPaymentContainer, TItemRelationshipContainer, TOrderHoldContainer,
35		TCustomAttributeContainer, TTemplateContainer, TOrderContext, TAmount;
36
37		/** @var string */
38		protected $orderType;
39		/** @var string */
40		protected $requestId;
41		/** @var string */
42		protected $testType;
43		/** @var string */
44		protected $orderId;
45		/** @var string */
46		protected $levelOfService;
47		/** @var DateTime */
48		protected $createTime;
49		/** @var IMailingAddress */
50		protected $billingAddress;
51		/** @var string */
52		protected $billingAddressIdRef;
53		/** @var string */
54		protected $shopRunnerMessage;
55		/** @var string */
56		protected $currency;
57		/** @var string */
58		protected $associateName;
59		/** @var string */
60		protected $associateNumber;
61		/** @var string */
62		protected $associateStore;
63		/** @var bool */
64		protected $taxHeader;
65		/** @var string */
66		protected $printedCatalogCode;
67		/** @var string */
68		protected $locale;
69		/** @var string */
70		protected $dashboardRepId;
71		/** @var string */
72		protected $orderSource;
73		/** @var string */
74		protected $orderSourceType;
75		/** @var string */
76		protected $orderHistoryUrl;
77		/** @var bool */
78		protected $vatInclusivePricing;
79		/** @var string */
80		protected $orderTotal;
81
82		/**
83		* @param IValidatorIterator
84		* @param ISchemaValidator
85		* @param IPayloadMap
86		* @param LoggerInterface
87		* @param IPayload
88		* @SuppressWarnings(PHPMD.UnusedFormalParameter)
89		*/
90		public function __construct(
91		IValidatorIterator $validators,
92		ISchemaValidator $schemaValidator,
93		IPayloadMap $payloadMap,
94		LoggerInterface $logger,
95		IPayload $parentPayload = null
96		) {
97		$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...
98		$this->validators = $validators;
99		$this->schemaValidator = $schemaValidator;
100		$this->payloadMap = $payloadMap;
101		$this->parentPayload = $parentPayload;
102		$this->payloadFactory = new PayloadFactory;
103
104		$this->setupSubPayloads();
105
106		$this->extractionPaths = array_merge(
107		[
108		'requestId' => 'string(@requestId)',
109		'orderId' => 'string(x:Order/@customerOrderId)',
110		'billingAddressIdRef' => 'string(x:Order/x:Payment/x:BillingAddress/@ref)',
111		'currency' => 'string(x:Order/x:Currency)',
112		'locale' => 'string(x:Order/x:Locale)',
113		'orderTotal' => 'number(x:Order/x:OrderTotal)',
114		'firstName' => 'string(x:Order/x:Customer/x:Name/x:FirstName)',
115		'lastName' => 'string(x:Order/x:Customer/x:Name/x:LastName)',
116		],
117		$this->getOrderContextExtractionPaths()
118		);
119		$this->optionalExtractionPaths = array_merge(
120		[
121		'orderType' => '@orderType',
122		'testType' => '@testType',
123		'levelOfService' => 'x:Order/@levelOfService',
124		'shopRunnerMessage' => 'x:Order/x:ShopRunnerMessage',
125		'associateName' => 'x:Order/x:Associate/x:Name',
126		'associateNumber' => 'x:Order/x:Associate/x:Number',
127		'associateStore' => 'x:Order/x:Associate/x:Store',
128		'printedCatalogCode' => 'x:Order/x:PrintedCatalogCode',
129		'dashboardRepId' => 'x:Order/x:DashboardRepId',
130		'orderSource' => 'x:Order/x:OrderSource',
131		'orderSourceType' => 'x:Order/x:OrderSource/@type',
132		'orderHistoryUrl' => 'x:Order/x:OrderHistoryUrl',
133		'customerId' => 'x:Order/x:Customer/@customerId',
134		'gender' => 'x:Order/x:Customer/x:Gender',
135		'emailAddress' => 'x:Order/x:Customer/x:EmailAddress',
136		'taxId' => 'x:Order/x:Customer/x:CustomerTaxId',
137		'middleName' => 'x:Order/x:Customer/x:Name/x:MiddleName',
138		'honorificName' => 'x:Order/x:Customer/x:Name/x:Honorific',
139		],
140		$this->getOrderContextOptionalExtractionPaths()
141		);
142		$this->booleanExtractionPaths = [
143		'taxHeader' => 'string(x:Order/x:TaxHeader/x:Error)',
144		'vatInclusivePricing' => 'string(x:Order/x:VATInclusivePricing)',
145		'taxExempt' => 'string(x:Order/x:Customer/x:TaxExemptFlag)',
146		];
147		$this->subpayloadExtractionPaths = array_merge(
148		[
149		'loyaltyPrograms' => 'x:Order/x:Customer/x:LoyaltyPrograms',
150		'orderItems' => 'x:Order/x:OrderItems',
151		'payments' => 'x:Order/x:Payment/x:Payments',
152		'shipGroups' => 'x:Order/x:Shipping/x:ShipGroups',
153		'destinations' => 'x:Order/x:Shipping/x:Destinations',
154		'itemRelationships' => 'x:Order/x:Relationships',
155		'holds' => 'x:Order/x:Holds',
156		'customAttributes' => 'x:Order/x:CustomAttributes',
157		'templates' => 'x:Order/x:Templates',
158		],
159		$this->getOrderContextSubpayloadExtractionPaths()
160		);
161		}
162
163		public function getOrderType()
164		{
165		return $this->orderType;
166		}
167
168		public function setOrderType($orderType)
169		{
170		if ($orderType === self::ORDER_TYPE_SALES \|\|
171		$orderType === self::ORDER_TYPE_RETURN \|\|
172		$orderType === self::ORDER_TYPE_PURCHASE \|\|
173		$orderType === self::ORDER_TYPE_TRANSFER
174		) {
175		$this->orderType = $orderType;
176		}
177		return $this;
178		}
179
180		public function getRequestId()
181		{
182		return $this->requestId;
183		}
184
185		public function setRequestId($requestId)
186		{
187		$this->requestId = $this->cleanString($requestId, 40);
188		return $this;
189		}
190
191		public function getTestType()
192		{
193		return $this->testType;
194		}
195
196		public function setTestType($testType)
197		{
198		if ($testType === self::TEST_TYPE_WEBONLY \|\|
199		$testType === self::TEST_TYPE_AUTOCANCEL \|\|
200		$testType === self::TEST_TYPE_NORELEASE \|\|
201		$testType === self::TEST_TYPE_AUTOSHIP
202		) {
203		$this->testType = $testType;
204		}
205		return $this;
206		}
207
208		public function getOrderId()
209		{
210		return $this->orderId;
211		}
212
213		public function setOrderId($orderId)
214		{
215		$this->orderId = $this->cleanString($orderId, 24);
216		return $this;
217		}
218
219		public function getLevelOfService()
220		{
221		return $this->levelOfService;
222		}
223
224		public function setLevelOfService($levelOfService)
225		{
226		if ($levelOfService === self::LEVEL_OF_SERVICE_REGULAR \|\|
227		$levelOfService === self::LEVEL_OF_SERVICE_RUSH
228		) {
229		$this->levelOfService = $levelOfService;
230		}
231		return $this;
232		}
233
234		public function getCreateTime()
235		{
236		return $this->createTime;
237		}
238
239		public function setCreateTime(DateTime $createTime)
240		{
241		$this->createTime = $createTime;
242		return $this;
243		}
244
245		public function getBillingAddress()
246		{
247		if (!$this->billingAddress && $this->billingAddressIdRef) {
248		foreach ($this->getDestinations() as $destination) {
249		if ($destination->getId() === $this->billingAddressIdRef) {
250		$this->billingAddress = $destination;
251		break;
252		}
253		}
254		}
255		return $this->billingAddress;
256		}
257
258		public function setBillingAddress(IMailingAddress $billingAddress)
259		{
260		$this->billingAddress = $billingAddress;
261		$this->billingAddressIdRef = $billingAddress->getId();
262		// Add the billing address to the collection of destinations
263		$this->getDestinations()->offsetSet($billingAddress);
264		return $this;
265		}
266
267		public function getShopRunnerMessage()
268		{
269		return $this->shopRunnerMessage;
270		}
271
272		public function setShopRunnerMessage($shopRunnerMessage)
273		{
274		$this->shopRunnerMessage = $this->normalizeWhitespace($shopRunnerMessage);
275		return $this;
276		}
277
278		public function getCurrency()
279		{
280		return $this->currency;
281		}
282
283		public function setCurrency($currency)
284		{
285		$cleaned = $this->cleanString($currency, 3);
286		if (strlen($cleaned) === 3) {
287		$this->currency = $currency;
288		}
289		return $this;
290		}
291
292		public function getAssociateName()
293		{
294		return $this->associateName;
295		}
296
297		public function setAssociateName($associateName)
298		{
299		$this->associateName = $associateName;
300		return $this;
301		}
302
303		public function getAssociateNumber()
304		{
305		return $this->associateNumber;
306		}
307
308		public function setAssociateNumber($associateNumber)
309		{
310		$this->associateNumber = $associateNumber;
311		return $this;
312		}
313
314		public function getAssociateStore()
315		{
316		return $this->associateStore;
317		}
318
319		public function setAssociateStore($associateStore)
320		{
321		$this->associateStore = $associateStore;
322		return $this;
323		}
324
325		public function getTaxHasErrors()
326		{
327		return $this->taxHeader;
328		}
329
330		public function setTaxHasErrors($taxHeader)
331		{
332		$this->taxHeader = (bool) $taxHeader;
333		return $this;
334		}
335
336		public function getPrintedCatalogCode()
337		{
338		return $this->printedCatalogCode;
339		}
340
341		public function setPrintedCatalogCode($printedCatalogCode)
342		{
343		$this->printedCatalogCode = $printedCatalogCode;
344		return $this;
345		}
346
347		public function getLocale()
348		{
349		return $this->locale;
350		}
351
352		public function setLocale($locale)
353		{
354		$cleaned = $this->cleanString($locale, 5);
355		// local must match pattern two character language code, and underscore (_),
356		// two character country code
357		$this->locale = (preg_match('#^[a-z]{2}_[a-z]{2}$#i', $cleaned)) ? $cleaned : null;
358		return $this;
359		}
360
361		public function getDashboardRepId()
362		{
363		return $this->dashboardRepId;
364		}
365
366		public function setDashboardRepId($dashboardRepId)
367		{
368		$this->dashboardRepId = $dashboardRepId;
369		return $this;
370		}
371
372		public function getOrderSource()
373		{
374		return $this->orderSource;
375		}
376
377		public function setOrderSource($orderSource)
378		{
379		$this->orderSource = $orderSource;
380		return $this;
381		}
382
383		public function getOrderSourceType()
384		{
385		return $this->orderSourceType;
386		}
387
388		public function setOrderSourceType($orderSourceType)
389		{
390		$this->orderSourceType = $orderSourceType;
391		return $this;
392		}
393
394		public function getOrderHistoryUrl()
395		{
396		return $this->orderHistoryUrl;
397		}
398
399		public function setOrderHistoryUrl($orderHistoryUrl)
400		{
401		$this->orderHistoryUrl = $orderHistoryUrl;
402		return $this;
403		}
404
405		public function getVatInclusivePricing()
406		{
407		return $this->vatInclusivePricing;
408		}
409
410		public function setVatInclusivePricing($vatInclusivePricing)
411		{
412		$this->vatInclusivePricing = (bool) $vatInclusivePricing;
413		return $this;
414		}
415		public function getOrderTotal()
416		{
417		return $this->orderTotal;
418		}
419
420		public function setOrderTotal($orderTotal)
421		{
422		$this->orderTotal = $this->sanitizeAmount($orderTotal);
		0 ignored issues – show Documentation Bug introduced 2015-11-25 17:00 UTC by Report Bug Copy Issue Report It seems like `$this->sanitizeAmount($orderTotal)` can also be of type `double`. However, the property `$orderTotal` is declared as type `string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
423		return $this;
424		}
425
426		protected function setupSubPayloads()
427		{
428		$this->loyaltyPrograms = $this->buildPayloadForInterface(
429		static::LOYALTY_PROGRAM_ITERABLE_INTERFACE
430		);
431		$this->orderItems = $this->buildPayloadForInterface(
432		static::ORDER_ITEM_ITERABLE_INTERFACE
433		);
434		$this->payments = $this->buildPayloadForInterface(
435		static::PAYMENT_ITERABLE_INTERFACE
436		);
437		$this->shipGroups = $this->buildPayloadForInterface(
438		static::SHIP_GROUP_ITERABLE_INTERFACE
439		);
440		$this->destinations = $this->buildPayloadForInterface(
441		static::DESTINATION_ITERABLE_INTERFACE
442		);
443		$this->itemRelationships = $this->buildPayloadForInterface(
444		static::ITEM_RELATIONSHIP_ITERABLE_INTERFACE
445		);
446		$this->holds = $this->buildPayloadForInterface(
447		static::ORDER_HOLD_ITERABLE_INTERFACE
448		);
449		$this->customAttributes = $this->buildPayloadForInterface(
450		static::CUSTOM_ATTRIBUTE_ITERABLE_INTERFACE
451		);
452		$this->templates = $this->buildPayloadForInterface(
453		static::TEMPLATE_ITERABLE_INTERFACE
454		);
455		$this->orderContextCustomAttributes = $this->buildPayloadForInterface(
456		static::ORDER_CONTEXT_CUSTOM_ATTRIBUTE_ITERABLE_INTERFACE
457		);
458		}
459
460		protected function deserializeExtra($serializedPayload)
461		{
462		$xpath = $this->getPayloadAsXPath($serializedPayload);
463		return $this->deserializeDateTimeValues($xpath)->deserializeExtraOrderContext($xpath);
464		}
465
466		/**
467		* Deserialize date time values as DateTime objects.
468		*
469		* @param DOMXPath
470		* @return self
471		*/
472		protected function deserializeDateTimeValues(DOMXPath $xpath)
473		{
474		$dateProperties = [
475		'createTime' => 'string(x:Order/x:CreateTime)',
476		'dateOfBirth' => 'string(x:Order/x:Customer/x:DateOfBirth)',
477		];
478	View Code Duplication	foreach ($dateProperties as $prop => $extractPath) {
		0 ignored issues – show Duplication introduced 2015-11-25 17:00 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
479		$value = $xpath->evaluate($extractPath);
480		$this->$prop = $value ? new DateTime($value) : null;
481		}
482		return $this;
483		}
484
485		protected function serializeContents()
486		{
487		return $this->serializeOrder() . $this->serializeOrderContext();
488		}
489
490		/**
491		* Serialize the order details.
492		*
493		* @return string
494		*/
495		protected function serializeOrder()
496		{
497		return "<Order customerOrderId='{$this->xmlEncode($this->getOrderId())}' levelOfService='{$this->xmlEncode($this->getLevelOfService())}'>"
498		. $this->serializeOrderCustomer()
499		. "<CreateTime>{$this->getCreateTime()->format('c')}</CreateTime>"
500		. $this->getOrderItems()->serialize()
501		. '<Shipping>'
502		. $this->getShipGroups()->serialize()
503		. $this->getDestinations()->serialize()
504		. '</Shipping>'
505		. '<Payment>'
506		. "<BillingAddress ref='{$this->xmlEncode($this->getBillingAddress()->getId())}' />"
507		. $this->getPayments()->serialize()
508		. '</Payment>'
509		. $this->serializeOptionalXmlEncodedValue('ShopRunnerMessage', $this->getShopRunnerMessage())
510		. "<Currency>{$this->xmlEncode($this->getCurrency())}</Currency>"
511		. $this->serializeAssociate()
512		. $this->serializeTaxHeader()
513		. $this->serializeOptionalXmlEncodedValue('PrintedCatalogCode', $this->getPrintedCatalogCode())
514		. "<Locale>{$this->xmlEncode($this->getLocale())}</Locale>"
515		. $this->getItemRelationships()->serialize()
516		. $this->serializeOptionalXmlEncodedValue('DashboardRepId', $this->getDashboardRepId())
517		. $this->serializeOrderSource()
518		. $this->getHolds()->serialize()
519		. $this->getCustomAttributes()->serialize()
520		. $this->getTemplates()->serialize()
521		. ($this->getOrderHistoryUrl() ? "<OrderHistoryUrl>{$this->xmlEncode($this->getOrderHistoryUrl())}</OrderHistoryUrl>" : "")
522		. $this->serializeVatInclusivePricing()
523		. $this->serializeOptionalAmount('OrderTotal', $this->getOrderTotal())
524		. '</Order>';
525		}
526
527		/**
528		* Serialize store associate details.
529		*
530		* @return string
531		*/
532		protected function serializeAssociate()
533		{
534		if (!is_null($this->getAssociateNumber())) {
535		return '<Associate>'
536		. "<Name>{$this->xmlEncode($this->getAssociateName())}</Name>"
537		. "<Number>{$this->xmlEncode($this->getAssociateNumber())}</Number>"
538		. "<Store>{$this->xmlEncode($this->getAssociateStore())}</Store>"
539		. '</Associate>';
540		}
541		return '';
542		}
543
544		/**
545		* Serialize tax headers.
546		*
547		* @return string
548		*/
549		protected function serializeTaxHeader()
550		{
551		$taxHasErrors = $this->getTaxHasErrors();
552		if (!is_null($taxHasErrors)) {
553		return "<TaxHeader><Error>{$this->convertBooleanToString($taxHasErrors)}</Error></TaxHeader>";
554		}
555		return '';
556		}
557
558		/**
559		* Serialize the order source and order source type.
560		*
561		* @return string
562		*/
563		protected function serializeOrderSource()
564		{
565		$orso = $this->getOrderSource();
566		if (!is_null($orso)) {
567		return sprintf('<OrderSource type="%s">', $this->xmlEncode($this->getOrderSourceType()))
568		. $this->xmlEncode($orso)
569		. '</OrderSource>';
570		}
571		return '';
572		}
573
574		/**
575		* Serialize if the order uses vat inclusive pricing.
576		*
577		* @return string
578		*/
579		protected function serializeVatInclusivePricing()
580		{
581		$vatInclusive = $this->getVatInclusivePricing();
582		if (!is_null($vatInclusive)) {
583		return "<VATInclusivePricing>{$this->convertBooleanToString($vatInclusive)}</VATInclusivePricing>";
584		}
585		return '';
586		}
587
588		protected function getRootAttributes()
589		{
590		return array_filter([
591		'orderType' => $this->getOrderType(),
592		'requestId' => $this->getRequestId(),
593		'testType' => $this->getTestType(),
594		'xmlns' => $this->getXmlNamespace(),
595		]);
596		}
597
598		protected function getPersonNameRootNodeName()
599		{
600		return self::PERSON_NAME_ROOT_NODE;
601		}
602
603		protected function getSchemaFile()
604		{
605		return $this->getSchemaDir() . self::XSD;
606		}
607
608		protected function getRootNodeName()
609		{
610		return self::ROOT_NODE;
611		}
612
613		protected function getXmlNamespace()
614		{
615		return self::XML_NS;
616		}
617		}
618

eBayEnterprise / RetailOrderManagement-SDK

GitHub Access Token became invalid

OrderCreateRequest::setupSubPayloads() B last analyzed 2016-01-20 19:07 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

OrderCreateRequest::setupSubPayloads() B
last analyzed 2016-01-20 19:07 UTC