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

OrderDetailItem::getChainedFromOrderHeaderKey() A
last analyzed 2016-01-20 19:07 UTC

↳ Parent: OrderDetailItem

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
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-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\Order\Detail;

use DateTime;
use DOMXPath;
use eBayEnterprise\RetailOrderManagement\Payload\Exception\InvalidPayload;
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\TIdentity;
use eBayEnterprise\RetailOrderManagement\Payload\TPayload;
use eBayEnterprise\RetailOrderManagement\Payload\Order\OrderItem;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;

class OrderDetailItem extends OrderItem implements IOrderDetailItem
{
    use TStatusContainer, TChargeGroupContainer;

    /** @var bool */
    protected $hasChainedLines;
    /** @var bool */
    protected $hasDerivedChild;
    /** @var string */
    protected $chainedFromOrderHeaderKey;
    /** @var string */
    protected $derivedFromOrderHeaderKey;
    /** @var float */
    protected $shippedQuantity;
    /** @var string */
    protected $carrier;
    /** @var string */
    protected $carrierMode;
    /** @var string */
    protected $carrierDisplayText;
    /** @var DateTime */
    protected $originalExpectedShipmentDateFrom;
    /** @var DateTime */
    protected $originalExpectedShipmentDateTo;
    /** @var DateTime */
    protected $originalExpectedDeliveryDateFrom;
    /** @var DateTime */
    protected $originalExpectedDeliveryDateTo;
    /** @var string */
    protected $omsLineId;
    /** @var ICustomerCareOrderItemTotals */
    protected $customerCareOrderItemTotals;

    /**
     * @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
    ) {
        parent::__construct($validators, $schemaValidator, $payloadMap, $logger, $parentPayload);
        $this->initOptionalExtractPaths()
            ->initDatetimeExtractPaths()
            ->initSubPayloadExtractPaths()
            ->initSubPayloadProperties();
    }

    /**
     * Initialize the protected class property array self::optionalExtractionPaths with xpath
     * key/value pairs.
     *
     * @return self
     */
    protected function initOptionalExtractPaths()
    {
        $this->optionalExtractionPaths = array_merge($this->optionalExtractionPaths, [
            'chainedFromOrderHeaderKey' => '@chainedFromOrderHeaderKey',
            'derivedFromOrderHeaderKey' => '@derivedFromOrderHeaderKey',
            'hasChainedLines' => '@hasChainedLines',
            'hasDerivedChild' => '@hasDerivedChild',
            'shippedQuantity' => 'x:ShippedQuantity',
            'carrier' => 'x:Carrier',
            'carrierMode' => 'x:Carrier/@mode',
            'carrierDisplayText' => 'x:Carrier/@displayText',
            'omsLineId' => 'x:OMSLineId',
        ]);
        return $this;
    }

    /**
     * Initialize the protected class property array self::datetimeExtractionPaths with xpath
     * key/value pairs.
     *
     * @return self
     */
    protected function initDatetimeExtractPaths()
    {
        $this->datetimeExtractionPaths = array_merge($this->datetimeExtractionPaths, [
            'originalExpectedShipmentDateFrom' => 'string(x:EstimatedDeliveryDate/x:OriginalExpectedShipmentDate/x:From)',
            'originalExpectedShipmentDateTo' => 'string(x:EstimatedDeliveryDate/x:OriginalExpectedShipmentDate/x:To)',
            'originalExpectedDeliveryDateFrom' => 'string(x:EstimatedDeliveryDate/x:OriginalExpectedDeliveryDate/x:From)',
            'originalExpectedDeliveryDateTo' => 'string(x:EstimatedDeliveryDate/x:OriginalExpectedDeliveryDate/x:To)',
        ]);
        return $this;
    }

    /**
     * Initialize the protected class property array self::subpayloadExtractionPaths with xpath
     * key/value pairs.
     *
     * @return self
     */
    protected function initSubPayloadExtractPaths()
    {
        $this->subpayloadExtractionPaths = array_merge($this->subpayloadExtractionPaths, [
            'statuses' => 'x:Statuses',
            'customerCareOrderItemTotals' => 'x:CustomerCareOrderItemTotals',
            'chargeGroups' => 'x:ChargeGroups',
        ]);
        return $this;
    }

    /**
     * Initialize any sub-payload class properties with their concrete instance.
     *
     * @return self
     */
    protected function initSubPayloadProperties()
    {
        $this->setStatuses($this->buildPayloadForInterface(

            self::STATUS_ITERABLE_INTERFACE
        ));
        $this->setCustomerCareOrderItemTotals($this->buildPayloadForInterface(

            self::CUSTOMER_CARE_ORDER_ITEM_TOTALS_INTERFACE
        ));
        $this->setChargeGroups($this->buildPayloadForInterface(

            self::CHARGE_GROUP_ITERABLE_INTERFACE
        ));
        return $this;
    }

    /**
     * @see IOrderDetailItem::getHasChainedLines()
     */
    public function getHasChainedLines()
    {
        return $this->hasChainedLines;
    }

    /**
     * @see IOrderDetailItem::setCustomerOrderId()
     * @codeCoverageIgnore
     */
    public function setHasChainedLines($hasChainedLines)
    {
        $this->hasChainedLines = $hasChainedLines;
        return $this;
    }

    /**
     * @see IOrderDetailItem::getHasDerivedChild()
     */
    public function getHasDerivedChild()
    {
        return $this->hasDerivedChild;
    }

    /**
     * @see IOrderDetailItem::setCustomerOrderId()
     * @codeCoverageIgnore
     */
    public function setHasDerivedChild($hasDerivedChild)
    {
        $this->hasDerivedChild = $hasDerivedChild;
        return $this;
    }

    /**
     * @see IOrderDetailItem::getChainedFromOrderHeaderKey()
     */
    public function getChainedFromOrderHeaderKey()
    {
        return $this->chainedFromOrderHeaderKey;
    }

    /**
     * @see IOrderDetailItem::setCustomerOrderId()
     * @codeCoverageIgnore
     */
    public function setChainedFromOrderHeaderKey($chainedFromOrderHeaderKey)
    {
        $this->chainedFromOrderHeaderKey = $chainedFromOrderHeaderKey;
        return $this;
    }

    /**
     * @see IOrderDetailItem::getDerivedFromOrderHeaderKey()
     */
    public function getDerivedFromOrderHeaderKey()
    {
        return $this->derivedFromOrderHeaderKey;
    }

    /**
     * @see IOrderDetailItem::setCustomerOrderId()
     * @codeCoverageIgnore
     */
    public function setDerivedFromOrderHeaderKey($derivedFromOrderHeaderKey)
    {
        $this->derivedFromOrderHeaderKey = $derivedFromOrderHeaderKey;
        return $this;
    }

    /**
     * @see IOrderDetailItem::getShippedQuantity()
     */
    public function getShippedQuantity()
    {
        return $this->shippedQuantity;
    }

    /**
     * @see IOrderDetailItem::setShippedQuantity()
     * @codeCoverageIgnore
     */
    public function setShippedQuantity($shippedQuantity)
    {
        $this->shippedQuantity = $shippedQuantity;
        return $this;
    }

    /**
     * @see IOrderDetailItem::getCarrier()
     */
    public function getCarrier()
    {
        return $this->carrier;
    }

    /**
     * @see IOrderDetailItem::setCarrier()
     * @codeCoverageIgnore
     */
    public function setCarrier($carrier)
    {
        $this->carrier = $carrier;
        return $this;
    }

    /**
     * @see IOrderDetailItem::getCarrierMode()
     */
    public function getCarrierMode()
    {
        return $this->carrierMode;
    }

    /**
     * @see IOrderDetailItem::setCarrierMode()
     * @codeCoverageIgnore
     */
    public function setCarrierMode($carrierMode)
    {
        $this->carrierMode = $carrierMode;
        return $this;
    }

    /**
     * @see IOrderDetailItem::getCarrierDisplayText()
     */
    public function getCarrierDisplayText()
    {
        return $this->carrierDisplayText;
    }

    /**
     * @see IOrderDetailItem::setCarrierDisplayText()
     * @codeCoverageIgnore
     */
    public function setCarrierDisplayText($carrierDisplayText)
    {
        $this->carrierDisplayText = $carrierDisplayText;
        return $this;
    }

    /**
     * @see IOrderDetailItem::getOriginalExpectedShipmentDateFrom()
     */
    public function getOriginalExpectedShipmentDateFrom()
    {
        return $this->originalExpectedShipmentDateFrom;
    }

    /**
     * @see IOrderDetailItem::setOriginalExpectedShipmentDateFrom()
     * @codeCoverageIgnore
     */
    public function setOriginalExpectedShipmentDateFrom(DateTime $originalExpectedShipmentDateFrom)
    {
        $this->originalExpectedShipmentDateFrom = $originalExpectedShipmentDateFrom;
        return $this;
    }

    /**
     * @see IOrderDetailItem::getOriginalExpectedShipmentDateTo()
     */
    public function getOriginalExpectedShipmentDateTo()
    {
        return $this->originalExpectedShipmentDateTo;
    }

    /**
     * @see IOrderDetailItem::setOriginalExpectedShipmentDateTo()
     * @codeCoverageIgnore
     */
    public function setOriginalExpectedShipmentDateTo(DateTime $originalExpectedShipmentDateTo)
    {
        $this->originalExpectedShipmentDateTo = $originalExpectedShipmentDateTo;
        return $this;
    }

    /**
     * @see IOrderDetailItem::getOriginalExpectedDeliveryDateFrom()
     */
    public function getOriginalExpectedDeliveryDateFrom()
    {
        return $this->originalExpectedDeliveryDateFrom;
    }

    /**
     * @see IOrderDetailItem::setOriginalExpectedDeliveryDateFrom()
     * @codeCoverageIgnore
     */
    public function setOriginalExpectedDeliveryDateFrom(DateTime $originalExpectedDeliveryDateFrom)
    {
        $this->originalExpectedDeliveryDateFrom = $originalExpectedDeliveryDateFrom;
        return $this;
    }

    /**
     * @see IOrderDetailItem::getOriginalExpectedDeliveryDateTo()
     */
    public function getOriginalExpectedDeliveryDateTo()
    {
        return $this->originalExpectedDeliveryDateTo;
    }

    /**
     * @see IOrderDetailItem::setOriginalExpectedDeliveryDateTo()
     * @codeCoverageIgnore
     */
    public function setOriginalExpectedDeliveryDateTo(DateTime $originalExpectedDeliveryDateTo)
    {
        $this->originalExpectedDeliveryDateTo = $originalExpectedDeliveryDateTo;
        return $this;
    }

    /**
     * @see IOrderDetailItem::getOmsLineId()
     */
    public function getOmsLineId()
    {
        return $this->omsLineId;
    }

    /**
     * @see IOrderDetailItem::setOmsLineId()
     * @codeCoverageIgnore
     */
    public function setOmsLineId($omsLineId)
    {
        $this->omsLineId = $omsLineId;
        return $this;
    }

    /**
     * @see IOrderDetailItem::getCustomerCareOrderItemTotals()
     */
    public function getCustomerCareOrderItemTotals()
    {
        return $this->customerCareOrderItemTotals;
    }

    /**
     * @see IOrderDetailItem::setCustomerCareOrderItemTotals()
     * @codeCoverageIgnore
     */
    public function setCustomerCareOrderItemTotals(ICustomerCareOrderItemTotals $customerCareOrderItemTotals)
    {
        $this->customerCareOrderItemTotals = $customerCareOrderItemTotals;
        return $this;
    }

    protected function getRootAttributes()

    {
        $hasChainedLines = $this->getHasChainedLines();
        $hasDerivedChild = $this->getHasDerivedChild();
        $chainedFromOrderHeaderKey = $this->getChainedFromOrderHeaderKey();
        $derivedFromOrderHeaderKey = $this->getDerivedFromOrderHeaderKey();
        return array_merge(
            parent::getRootAttributes(),
            !empty($hasChainedLines) ? ['hasChainedLines' => $hasChainedLines] : [],
            !empty($hasDerivedChild) ? ['hasDerivedChild' => $hasDerivedChild] : [],
            $chainedFromOrderHeaderKey ? ['chainedFromOrderHeaderKey' => $chainedFromOrderHeaderKey] : [],
            $derivedFromOrderHeaderKey ? ['derivedFromOrderHeaderKey' => $derivedFromOrderHeaderKey] : []
        );
    }

    protected function serializeContents()
    {
        return $this->serializeRequiredValue('ItemId', $this->xmlEncode($this->getItemId()))
            . $this->serializeRequiredValue('Quantity', $this->xmlEncode($this->getQuantity()))
            . $this->serializeOptionalXmlEncodedValue('ShippedQuantity', $this->getShippedQuantity())
            . $this->serializeDescription()
            . $this->serializeOptionalXmlEncodedValue('Department', $this->getDepartment())
            . $this->serializePricing()
            . $this->serializeShippingProgram()
            . $this->serializeCarrierValue('Carrier', $this->getCarrier())
            . $this->serializeShippingMethod()
            . $this->serializeOptionalSubpayload($this->getStoreFrontDetails())
            . $this->serializeOptionalXmlEncodedValue('FulfillmentChannel', $this->getFulfillmentChannel())
            . $this->serializeOptionalSubpayload($this->getProxyPickupDetails())
            . $this->serializeEstimatedDeliveryDate()
            . $this->serializeNamedDeliveryDate()
            . $this->serializeOptionalXmlEncodedValue('DeliveryInstructions', $this->getDeliveryInstructions())
            . $this->serializeOptionalXmlEncodedValue('VendorId', $this->getVendorId())
            . $this->serializeOptionalXmlEncodedValue('VendorName', $this->getVendorName())
            . $this->serializeGifting()
            . $this->serializeOptionalXmlEncodedValue('ShopRunnerMessage', $this->getShopRunnerMessage())
            . $this->serializeCustomizations()
            . $this->getStatuses()->serialize()
            . $this->serializeOptionalXmlEncodedValue('OMSLineId', $this->getOmsLineId())
            . $this->getCustomerCareOrderItemTotals()->serialize()
            . $this->serializeOptionalXmlEncodedValue('SerialNumber', $this->getSerialNumber())
            . $this->getCustomAttributes()->serialize()
            . $this->serializeOptionalXmlEncodedValue('GiftRegistryCancelUrl', $this->getGiftRegistryCancelUrl())
            . $this->serializeOptionalXmlEncodedValue('ReservationId', $this->getReservationId())
            . $this->getChargeGroups()->serialize();
    }

    /**
     * Create an XML serialization of the estimated deliver date data. Will
     * only include any data when there is useful EDD data to include.
     *
     * @return string
     */
    protected function serializeEstimatedDeliveryDate()
    {
        if ($this->hasAnyEstimatedDeliveryDateData()) {
            return '<EstimatedDeliveryDate>'
                . $this->serializeEstimatedWindow(
                    'DeliveryWindow',
                    $this->getEstimatedDeliveryWindowFrom(),
                    $this->getEstimatedDeliveryWindowTo()
                )
                . $this->serializeEstimatedWindow(
                    'ShippingWindow',
                    $this->getEstimatedShippingWindowFrom(),
                    $this->getEstimatedShippingWindowTo()
                )
                . $this->serializeOptionalXmlEncodedValue('Mode', $this->getEstimatedDeliveryMode())
                . $this->serializeRequiredValue('MessageType', $this->xmlEncode($this->getEstimatedDeliveryMessageType()))
                . $this->serializeOptionalXmlEncodedValue('Template', $this->getEstimatedDeliveryTemplate())
                . $this->serializeEstimatedWindow(
                    'OriginalExpectedShipmentDate',
                    $this->getOriginalExpectedShipmentDateFrom(),
                    $this->getOriginalExpectedShipmentDateTo()
                )
                . $this->serializeEstimatedWindow(
                    'OriginalExpectedDeliveryDate',
                    $this->getOriginalExpectedDeliveryDateFrom(),
                    $this->getOriginalExpectedDeliveryDateTo()
                )
                . '</EstimatedDeliveryDate>';
        }
        return '';
    }

    /**
     * Serialize the carrier XML node.
     *
     * @param  string
     * @param  string
     * @return string | null
     */
    protected function serializeCarrierValue($nodeName, $value)

    {
        $modeAttribute = $this->serializeOptionalAttribute('mode', $this->xmlEncode($this->getCarrierMode()));
        $displayTextAttribute = $this->serializeOptionalAttribute('displayText', $this->xmlEncode($this->getCarrierDisplayText()));
        return $value
            ? sprintf('<%s %s %s>%s</%1$s>', $nodeName, $modeAttribute, $displayTextAttribute, $this->xmlEncode($value)) : null;
    }
}


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-2014 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\Detail;
17
18		use DateTime;
19		use DOMXPath;
20		use eBayEnterprise\RetailOrderManagement\Payload\Exception\InvalidPayload;
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\TIdentity;
27		use eBayEnterprise\RetailOrderManagement\Payload\TPayload;
28		use eBayEnterprise\RetailOrderManagement\Payload\Order\OrderItem;
29		use Psr\Log\LoggerInterface;
30		use Psr\Log\NullLogger;
31
32		class OrderDetailItem extends OrderItem implements IOrderDetailItem
33		{
34		use TStatusContainer, TChargeGroupContainer;
35
36		/** @var bool */
37		protected $hasChainedLines;
38		/** @var bool */
39		protected $hasDerivedChild;
40		/** @var string */
41		protected $chainedFromOrderHeaderKey;
42		/** @var string */
43		protected $derivedFromOrderHeaderKey;
44		/** @var float */
45		protected $shippedQuantity;
46		/** @var string */
47		protected $carrier;
48		/** @var string */
49		protected $carrierMode;
50		/** @var string */
51		protected $carrierDisplayText;
52		/** @var DateTime */
53		protected $originalExpectedShipmentDateFrom;
54		/** @var DateTime */
55		protected $originalExpectedShipmentDateTo;
56		/** @var DateTime */
57		protected $originalExpectedDeliveryDateFrom;
58		/** @var DateTime */
59		protected $originalExpectedDeliveryDateTo;
60		/** @var string */
61		protected $omsLineId;
62		/** @var ICustomerCareOrderItemTotals */
63		protected $customerCareOrderItemTotals;
64
65		/**
66		* @param IValidatorIterator
67		* @param ISchemaValidator
68		* @param IPayloadMap
69		* @param LoggerInterface
70		* @param IPayload
71		* @SuppressWarnings(PHPMD.UnusedFormalParameter)
72		*/
73	View Code Duplication	public function __construct(
		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...
74		IValidatorIterator $validators,
75		ISchemaValidator $schemaValidator,
76		IPayloadMap $payloadMap,
77		LoggerInterface $logger,
78		IPayload $parentPayload = null
79		) {
80		parent::__construct($validators, $schemaValidator, $payloadMap, $logger, $parentPayload);
81		$this->initOptionalExtractPaths()
82		->initDatetimeExtractPaths()
83		->initSubPayloadExtractPaths()
84		->initSubPayloadProperties();
85		}
86
87		/**
88		* Initialize the protected class property array self::optionalExtractionPaths with xpath
89		* key/value pairs.
90		*
91		* @return self
92		*/
93		protected function initOptionalExtractPaths()
94		{
95		$this->optionalExtractionPaths = array_merge($this->optionalExtractionPaths, [
96		'chainedFromOrderHeaderKey' => '@chainedFromOrderHeaderKey',
97		'derivedFromOrderHeaderKey' => '@derivedFromOrderHeaderKey',
98		'hasChainedLines' => '@hasChainedLines',
99		'hasDerivedChild' => '@hasDerivedChild',
100		'shippedQuantity' => 'x:ShippedQuantity',
101		'carrier' => 'x:Carrier',
102		'carrierMode' => 'x:Carrier/@mode',
103		'carrierDisplayText' => 'x:Carrier/@displayText',
104		'omsLineId' => 'x:OMSLineId',
105		]);
106		return $this;
107		}
108
109		/**
110		* Initialize the protected class property array self::datetimeExtractionPaths with xpath
111		* key/value pairs.
112		*
113		* @return self
114		*/
115		protected function initDatetimeExtractPaths()
116		{
117		$this->datetimeExtractionPaths = array_merge($this->datetimeExtractionPaths, [
118		'originalExpectedShipmentDateFrom' => 'string(x:EstimatedDeliveryDate/x:OriginalExpectedShipmentDate/x:From)',
119		'originalExpectedShipmentDateTo' => 'string(x:EstimatedDeliveryDate/x:OriginalExpectedShipmentDate/x:To)',
120		'originalExpectedDeliveryDateFrom' => 'string(x:EstimatedDeliveryDate/x:OriginalExpectedDeliveryDate/x:From)',
121		'originalExpectedDeliveryDateTo' => 'string(x:EstimatedDeliveryDate/x:OriginalExpectedDeliveryDate/x:To)',
122		]);
123		return $this;
124		}
125
126		/**
127		* Initialize the protected class property array self::subpayloadExtractionPaths with xpath
128		* key/value pairs.
129		*
130		* @return self
131		*/
132		protected function initSubPayloadExtractPaths()
133		{
134		$this->subpayloadExtractionPaths = array_merge($this->subpayloadExtractionPaths, [
135		'statuses' => 'x:Statuses',
136		'customerCareOrderItemTotals' => 'x:CustomerCareOrderItemTotals',
137		'chargeGroups' => 'x:ChargeGroups',
138		]);
139		return $this;
140		}
141
142		/**
143		* Initialize any sub-payload class properties with their concrete instance.
144		*
145		* @return self
146		*/
147		protected function initSubPayloadProperties()
148		{
149		$this->setStatuses($this->buildPayloadForInterface(
		0 ignored issues – show Compatibility introduced 2015-11-25 17:00 UTC by Report Bug Copy Issue Report `$this->buildPayloadForIn...TUS_ITERABLE_INTERFACE)` of type `object<eBayEnterprise\Re...ement\Payload\IPayload>` is not a sub-type of `object<eBayEnterprise\Re...Detail\IStatusIterable>`. It seems like you assume a child interface of the interface `eBayEnterprise\RetailOrd...gement\Payload\IPayload` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
150		self::STATUS_ITERABLE_INTERFACE
151		));
152		$this->setCustomerCareOrderItemTotals($this->buildPayloadForInterface(
		0 ignored issues – show Compatibility introduced 2015-11-25 17:00 UTC by Report Bug Copy Issue Report `$this->buildPayloadForIn..._ITEM_TOTALS_INTERFACE)` of type `object<eBayEnterprise\Re...ement\Payload\IPayload>` is not a sub-type of `object<eBayEnterprise\Re...merCareOrderItemTotals>`. It seems like you assume a child interface of the interface `eBayEnterprise\RetailOrd...gement\Payload\IPayload` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
153		self::CUSTOMER_CARE_ORDER_ITEM_TOTALS_INTERFACE
154		));
155		$this->setChargeGroups($this->buildPayloadForInterface(
		0 ignored issues – show Compatibility introduced 2015-11-25 17:00 UTC by Report Bug Copy Issue Report `$this->buildPayloadForIn...OUP_ITERABLE_INTERFACE)` of type `object<eBayEnterprise\Re...ement\Payload\IPayload>` is not a sub-type of `object<eBayEnterprise\Re...l\IChargeGroupIterable>`. It seems like you assume a child interface of the interface `eBayEnterprise\RetailOrd...gement\Payload\IPayload` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
156		self::CHARGE_GROUP_ITERABLE_INTERFACE
157		));
158		return $this;
159		}
160
161		/**
162		* @see IOrderDetailItem::getHasChainedLines()
163		*/
164		public function getHasChainedLines()
165		{
166		return $this->hasChainedLines;
167		}
168
169		/**
170		* @see IOrderDetailItem::setCustomerOrderId()
171		* @codeCoverageIgnore
172		*/
173		public function setHasChainedLines($hasChainedLines)
174		{
175		$this->hasChainedLines = $hasChainedLines;
176		return $this;
177		}
178
179		/**
180		* @see IOrderDetailItem::getHasDerivedChild()
181		*/
182		public function getHasDerivedChild()
183		{
184		return $this->hasDerivedChild;
185		}
186
187		/**
188		* @see IOrderDetailItem::setCustomerOrderId()
189		* @codeCoverageIgnore
190		*/
191		public function setHasDerivedChild($hasDerivedChild)
192		{
193		$this->hasDerivedChild = $hasDerivedChild;
194		return $this;
195		}
196
197		/**
198		* @see IOrderDetailItem::getChainedFromOrderHeaderKey()
199		*/
200		public function getChainedFromOrderHeaderKey()
201		{
202		return $this->chainedFromOrderHeaderKey;
203		}
204
205		/**
206		* @see IOrderDetailItem::setCustomerOrderId()
207		* @codeCoverageIgnore
208		*/
209		public function setChainedFromOrderHeaderKey($chainedFromOrderHeaderKey)
210		{
211		$this->chainedFromOrderHeaderKey = $chainedFromOrderHeaderKey;
212		return $this;
213		}
214
215		/**
216		* @see IOrderDetailItem::getDerivedFromOrderHeaderKey()
217		*/
218		public function getDerivedFromOrderHeaderKey()
219		{
220		return $this->derivedFromOrderHeaderKey;
221		}
222
223		/**
224		* @see IOrderDetailItem::setCustomerOrderId()
225		* @codeCoverageIgnore
226		*/
227		public function setDerivedFromOrderHeaderKey($derivedFromOrderHeaderKey)
228		{
229		$this->derivedFromOrderHeaderKey = $derivedFromOrderHeaderKey;
230		return $this;
231		}
232
233		/**
234		* @see IOrderDetailItem::getShippedQuantity()
235		*/
236		public function getShippedQuantity()
237		{
238		return $this->shippedQuantity;
239		}
240
241		/**
242		* @see IOrderDetailItem::setShippedQuantity()
243		* @codeCoverageIgnore
244		*/
245		public function setShippedQuantity($shippedQuantity)
246		{
247		$this->shippedQuantity = $shippedQuantity;
248		return $this;
249		}
250
251		/**
252		* @see IOrderDetailItem::getCarrier()
253		*/
254		public function getCarrier()
255		{
256		return $this->carrier;
257		}
258
259		/**
260		* @see IOrderDetailItem::setCarrier()
261		* @codeCoverageIgnore
262		*/
263		public function setCarrier($carrier)
264		{
265		$this->carrier = $carrier;
266		return $this;
267		}
268
269		/**
270		* @see IOrderDetailItem::getCarrierMode()
271		*/
272		public function getCarrierMode()
273		{
274		return $this->carrierMode;
275		}
276
277		/**
278		* @see IOrderDetailItem::setCarrierMode()
279		* @codeCoverageIgnore
280		*/
281		public function setCarrierMode($carrierMode)
282		{
283		$this->carrierMode = $carrierMode;
284		return $this;
285		}
286
287		/**
288		* @see IOrderDetailItem::getCarrierDisplayText()
289		*/
290		public function getCarrierDisplayText()
291		{
292		return $this->carrierDisplayText;
293		}
294
295		/**
296		* @see IOrderDetailItem::setCarrierDisplayText()
297		* @codeCoverageIgnore
298		*/
299		public function setCarrierDisplayText($carrierDisplayText)
300		{
301		$this->carrierDisplayText = $carrierDisplayText;
302		return $this;
303		}
304
305		/**
306		* @see IOrderDetailItem::getOriginalExpectedShipmentDateFrom()
307		*/
308		public function getOriginalExpectedShipmentDateFrom()
309		{
310		return $this->originalExpectedShipmentDateFrom;
311		}
312
313		/**
314		* @see IOrderDetailItem::setOriginalExpectedShipmentDateFrom()
315		* @codeCoverageIgnore
316		*/
317		public function setOriginalExpectedShipmentDateFrom(DateTime $originalExpectedShipmentDateFrom)
318		{
319		$this->originalExpectedShipmentDateFrom = $originalExpectedShipmentDateFrom;
320		return $this;
321		}
322
323		/**
324		* @see IOrderDetailItem::getOriginalExpectedShipmentDateTo()
325		*/
326		public function getOriginalExpectedShipmentDateTo()
327		{
328		return $this->originalExpectedShipmentDateTo;
329		}
330
331		/**
332		* @see IOrderDetailItem::setOriginalExpectedShipmentDateTo()
333		* @codeCoverageIgnore
334		*/
335		public function setOriginalExpectedShipmentDateTo(DateTime $originalExpectedShipmentDateTo)
336		{
337		$this->originalExpectedShipmentDateTo = $originalExpectedShipmentDateTo;
338		return $this;
339		}
340
341		/**
342		* @see IOrderDetailItem::getOriginalExpectedDeliveryDateFrom()
343		*/
344		public function getOriginalExpectedDeliveryDateFrom()
345		{
346		return $this->originalExpectedDeliveryDateFrom;
347		}
348
349		/**
350		* @see IOrderDetailItem::setOriginalExpectedDeliveryDateFrom()
351		* @codeCoverageIgnore
352		*/
353		public function setOriginalExpectedDeliveryDateFrom(DateTime $originalExpectedDeliveryDateFrom)
354		{
355		$this->originalExpectedDeliveryDateFrom = $originalExpectedDeliveryDateFrom;
356		return $this;
357		}
358
359		/**
360		* @see IOrderDetailItem::getOriginalExpectedDeliveryDateTo()
361		*/
362		public function getOriginalExpectedDeliveryDateTo()
363		{
364		return $this->originalExpectedDeliveryDateTo;
365		}
366
367		/**
368		* @see IOrderDetailItem::setOriginalExpectedDeliveryDateTo()
369		* @codeCoverageIgnore
370		*/
371		public function setOriginalExpectedDeliveryDateTo(DateTime $originalExpectedDeliveryDateTo)
372		{
373		$this->originalExpectedDeliveryDateTo = $originalExpectedDeliveryDateTo;
374		return $this;
375		}
376
377		/**
378		* @see IOrderDetailItem::getOmsLineId()
379		*/
380		public function getOmsLineId()
381		{
382		return $this->omsLineId;
383		}
384
385		/**
386		* @see IOrderDetailItem::setOmsLineId()
387		* @codeCoverageIgnore
388		*/
389		public function setOmsLineId($omsLineId)
390		{
391		$this->omsLineId = $omsLineId;
392		return $this;
393		}
394
395		/**
396		* @see IOrderDetailItem::getCustomerCareOrderItemTotals()
397		*/
398		public function getCustomerCareOrderItemTotals()
399		{
400		return $this->customerCareOrderItemTotals;
401		}
402
403		/**
404		* @see IOrderDetailItem::setCustomerCareOrderItemTotals()
405		* @codeCoverageIgnore
406		*/
407		public function setCustomerCareOrderItemTotals(ICustomerCareOrderItemTotals $customerCareOrderItemTotals)
408		{
409		$this->customerCareOrderItemTotals = $customerCareOrderItemTotals;
410		return $this;
411		}
412
413	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...
414		{
415		$hasChainedLines = $this->getHasChainedLines();
416		$hasDerivedChild = $this->getHasDerivedChild();
417		$chainedFromOrderHeaderKey = $this->getChainedFromOrderHeaderKey();
418		$derivedFromOrderHeaderKey = $this->getDerivedFromOrderHeaderKey();
419		return array_merge(
420		parent::getRootAttributes(),
421		!empty($hasChainedLines) ? ['hasChainedLines' => $hasChainedLines] : [],
422		!empty($hasDerivedChild) ? ['hasDerivedChild' => $hasDerivedChild] : [],
423		$chainedFromOrderHeaderKey ? ['chainedFromOrderHeaderKey' => $chainedFromOrderHeaderKey] : [],
424		$derivedFromOrderHeaderKey ? ['derivedFromOrderHeaderKey' => $derivedFromOrderHeaderKey] : []
425		);
426		}
427
428		protected function serializeContents()
429		{
430		return $this->serializeRequiredValue('ItemId', $this->xmlEncode($this->getItemId()))
431		. $this->serializeRequiredValue('Quantity', $this->xmlEncode($this->getQuantity()))
432		. $this->serializeOptionalXmlEncodedValue('ShippedQuantity', $this->getShippedQuantity())
433		. $this->serializeDescription()
434		. $this->serializeOptionalXmlEncodedValue('Department', $this->getDepartment())
435		. $this->serializePricing()
436		. $this->serializeShippingProgram()
437		. $this->serializeCarrierValue('Carrier', $this->getCarrier())
438		. $this->serializeShippingMethod()
439		. $this->serializeOptionalSubpayload($this->getStoreFrontDetails())
440		. $this->serializeOptionalXmlEncodedValue('FulfillmentChannel', $this->getFulfillmentChannel())
441		. $this->serializeOptionalSubpayload($this->getProxyPickupDetails())
442		. $this->serializeEstimatedDeliveryDate()
443		. $this->serializeNamedDeliveryDate()
444		. $this->serializeOptionalXmlEncodedValue('DeliveryInstructions', $this->getDeliveryInstructions())
445		. $this->serializeOptionalXmlEncodedValue('VendorId', $this->getVendorId())
446		. $this->serializeOptionalXmlEncodedValue('VendorName', $this->getVendorName())
447		. $this->serializeGifting()
448		. $this->serializeOptionalXmlEncodedValue('ShopRunnerMessage', $this->getShopRunnerMessage())
449		. $this->serializeCustomizations()
450		. $this->getStatuses()->serialize()
451		. $this->serializeOptionalXmlEncodedValue('OMSLineId', $this->getOmsLineId())
452		. $this->getCustomerCareOrderItemTotals()->serialize()
453		. $this->serializeOptionalXmlEncodedValue('SerialNumber', $this->getSerialNumber())
454		. $this->getCustomAttributes()->serialize()
455		. $this->serializeOptionalXmlEncodedValue('GiftRegistryCancelUrl', $this->getGiftRegistryCancelUrl())
456		. $this->serializeOptionalXmlEncodedValue('ReservationId', $this->getReservationId())
457		. $this->getChargeGroups()->serialize();
458		}
459
460		/**
461		* Create an XML serialization of the estimated deliver date data. Will
462		* only include any data when there is useful EDD data to include.
463		*
464		* @return string
465		*/
466		protected function serializeEstimatedDeliveryDate()
467		{
468		if ($this->hasAnyEstimatedDeliveryDateData()) {
469		return '<EstimatedDeliveryDate>'
470		. $this->serializeEstimatedWindow(
471		'DeliveryWindow',
472		$this->getEstimatedDeliveryWindowFrom(),
473		$this->getEstimatedDeliveryWindowTo()
474		)
475		. $this->serializeEstimatedWindow(
476		'ShippingWindow',
477		$this->getEstimatedShippingWindowFrom(),
478		$this->getEstimatedShippingWindowTo()
479		)
480		. $this->serializeOptionalXmlEncodedValue('Mode', $this->getEstimatedDeliveryMode())
481		. $this->serializeRequiredValue('MessageType', $this->xmlEncode($this->getEstimatedDeliveryMessageType()))
482		. $this->serializeOptionalXmlEncodedValue('Template', $this->getEstimatedDeliveryTemplate())
483		. $this->serializeEstimatedWindow(
484		'OriginalExpectedShipmentDate',
485		$this->getOriginalExpectedShipmentDateFrom(),
486		$this->getOriginalExpectedShipmentDateTo()
487		)
488		. $this->serializeEstimatedWindow(
489		'OriginalExpectedDeliveryDate',
490		$this->getOriginalExpectedDeliveryDateFrom(),
491		$this->getOriginalExpectedDeliveryDateTo()
492		)
493		. '</EstimatedDeliveryDate>';
494		}
495		return '';
496		}
497
498		/**
499		* Serialize the carrier XML node.
500		*
501		* @param string
502		* @param string
503		* @return string \| null
504		*/
505	View Code Duplication	protected function serializeCarrierValue($nodeName, $value)
		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...
506		{
507		$modeAttribute = $this->serializeOptionalAttribute('mode', $this->xmlEncode($this->getCarrierMode()));
508		$displayTextAttribute = $this->serializeOptionalAttribute('displayText', $this->xmlEncode($this->getCarrierDisplayText()));
509		return $value
510		? sprintf('<%s %s %s>%s</%1$s>', $nodeName, $modeAttribute, $displayTextAttribute, $this->xmlEncode($value)) : null;
511		}
512		}
513

eBayEnterprise / RetailOrderManagement-SDK

GitHub Access Token became invalid

OrderDetailItem::getChainedFromOrderHeaderKey() A last analyzed 2016-01-20 19:07 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

OrderDetailItem::getChainedFromOrderHeaderKey() A
last analyzed 2016-01-20 19:07 UTC