eBayEnterprise\RetailOrderManagement\Payload\Order\TGifting

Complexity

Total Complexity

46

Size/Duplication

Total Lines	338
Duplicated Lines	2.96 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	4
Bugs	0	Features	1

38 Methods

Rating	Name	Duplication	Size	Complexity
A	getEmptyGiftingPriceGroup()	0	4	1
A	getGiftItemId()	0	4	1
A	getGiftPricing()	0	4	1
A	getIncludeGiftWrapping()	0	4	1
A	getGiftMessageTo()	0	4	1
A	getGiftMessageFrom()	0	4	1
A	getGiftMessageContent()	0	4	1
A	getGiftCardTo()	0	4	1
A	getGiftCardFrom()	0	4	1
A	getGiftCardMessage()	0	4	1
A	getPackslipTo()	0	4	1
A	getPackslipFrom()	0	4	1
A	getPackslipMessage()	0	4	1
A	getLocalizedFromLabel()	0	4	1
A	getLocalizedToLabel()	0	4	1
	serializeOptionalXmlEncodedValue()	0	1	?
	xmlEncode()	0	1	?
A	setGiftItemId()	0	5	1
A	setGiftPricing()	0	5	1
A	setIncludeGiftWrapping()	0	5	1
A	setGiftMessageTo()	0	5	1
A	setGiftMessageFrom()	0	5	1
A	setGiftMessageContent()	0	5	1
A	setGiftCardTo()	0	5	1
A	setGiftCardFrom()	0	5	1
A	setGiftCardMessage()	0	5	1
A	setPackslipTo()	0	5	1
A	setPackslipFrom()	0	5	1
A	setPackslipMessage()	0	5	1
A	setLocalizedFromLabel()	0	5	1
A	setLocalizedToLabel()	0	5	1
A	serializeGifting()	0	7	2
A	serializeGift()	0	12	3
A	serializeGiftingGiftMessage()	0	9	2
A	serializeGiftingGiftCard()	0	13	3
A	serializeGiftingPackslip()	0	9	2
A	serializeGiftingMessage()	0	18	3
A	deserializeGiftPricing()	10	10	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\Order;

use DOMXPath;

trait TGifting
{
    /** @var string */
    protected $giftItemId;
    /** @var IPriceGroup */
    protected $giftPricing;
    /** @var bool */
    protected $includeGiftWrapping;
    /** @var string */
    protected $giftMessageTo;
    /** @var string */
    protected $giftMessageFrom;
    /** @var string */
    protected $giftMessageContent;
    /** @var string */
    protected $giftCardTo;
    /** @var string */
    protected $giftCardFrom;
    /** @var string */
    protected $giftCardMessage;
    /** @var string */
    protected $packslipTo;
    /** @var string */
    protected $packslipFrom;
    /** @var string */
    protected $packslipMessage;
    /** @var string */
    protected $localizedFromLabel;
    /** @var string */
    protected $localizedToLabel;

    public function getEmptyGiftingPriceGroup()
    {
        return $this->buildPayloadForInterface(self::GIFTING_PRICE_GROUP_INTERFACE);

It seems like buildPayloadForInterface() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    public function getGiftItemId()
    {
        return $this->giftItemId;
    }

    public function setGiftItemId($giftItemId)
    {
        $this->giftItemId = $this->cleanString($giftItemId, 20);

It seems like cleanString() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    public function getGiftPricing()
    {
        return $this->giftPricing;
    }

    public function setGiftPricing(IPriceGroup $giftPricing)
    {
        $this->giftPricing = $giftPricing;
        return $this;
    }

    public function getIncludeGiftWrapping()
    {
        return $this->includeGiftWrapping;
    }

    public function setIncludeGiftWrapping($includeGiftWrapping)
    {
        $this->includeGiftWrapping = (bool) $includeGiftWrapping;
        return $this;
    }

    public function getGiftMessageTo()
    {
        return $this->giftMessageTo;
    }

    public function setGiftMessageTo($giftMessageTo)
    {
        $this->giftMessageTo = $giftMessageTo;
        return $this;
    }

    public function getGiftMessageFrom()
    {
        return $this->giftMessageFrom;
    }

    public function setGiftMessageFrom($giftMessageFrom)
    {
        $this->giftMessageFrom = $giftMessageFrom;
        return $this;
    }

    public function getGiftMessageContent()
    {
        return $this->giftMessageContent;
    }

    public function setGiftMessageContent($giftMessageContent)
    {
        $this->giftMessageContent = $this->normalizeWhitespace($giftMessageContent);

It seems like normalizeWhitespace() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    public function getGiftCardTo()
    {
        return $this->giftCardTo;
    }

    public function setGiftCardTo($giftCardTo)
    {
        $this->giftCardTo = $giftCardTo;
        return $this;
    }

    public function getGiftCardFrom()
    {
        return $this->giftCardFrom;
    }

    public function setGiftCardFrom($giftCardFrom)
    {
        $this->giftCardFrom = $giftCardFrom;
        return $this;
    }

    public function getGiftCardMessage()
    {
        return $this->giftCardMessage;
    }

    public function setGiftCardMessage($giftCardMessage)
    {
        $this->giftCardMessage = $this->normalizeWhitespace($giftCardMessage);

It seems like normalizeWhitespace() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    public function getPackslipTo()
    {
        return $this->packslipTo;
    }

    public function setPackslipTo($packslipTo)
    {
        $this->packslipTo = $packslipTo;
        return $this;
    }

    public function getPackslipFrom()
    {
        return $this->packslipFrom;
    }

    public function setPackslipFrom($packslipFrom)
    {
        $this->packslipFrom = $packslipFrom;
        return $this;
    }

    public function getPackslipMessage()
    {
        return $this->packslipMessage;
    }

    public function setPackslipMessage($packslipMessage)
    {
        $this->packslipMessage = $this->normalizeWhitespace($packslipMessage);

It seems like normalizeWhitespace() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    public function getLocalizedFromLabel()
    {
        return $this->localizedFromLabel;
    }

    public function setLocalizedFromLabel($localizedFromLabel)
    {
        $this->localizedFromLabel = $localizedFromLabel;
        return $this;
    }

    public function getLocalizedToLabel()
    {
        return $this->localizedToLabel;
    }

    public function setLocalizedToLabel($localizedToLabel)
    {
        $this->localizedToLabel = $localizedToLabel;
        return $this;
    }

    /**
     * Serialize gifting data.
     *
     * @return string
     */
    protected function serializeGifting()
    {
        $serializedData = $this->serializeGift()
            . $this->serializeGiftingGiftCard()
            . $this->serializeGiftingPackslip();
        return $serializedData ? "<Gifting>$serializedData</Gifting>" : '';
    }

    /**
     * Serialize the "Gift" gifting data. Will only be included if there is
     * a gift item id set.
     *
     * @return string
     */
    protected function serializeGift()
    {
        if ($this->getGiftItemId()) {
            $pricing = $this->getGiftPricing();
            return '<Gift>'
                . "<ItemId>{$this->xmlEncode($this->getGiftItemId())}</ItemId>"
                . ($pricing ? $pricing->setRootNodeName('Pricing')->serialize() : '')
                . $this->serializeGiftingGiftMessage()
                . '</Gift>';
        }
        return '';
    }

    /**
     * Serialize the gift message data. Will only be included if there
     * are valid to and from fields.
     *
     * @return string
     */
    protected function serializeGiftingGiftMessage()
    {
        $messageSerialization = $this->serializeGiftingMessage(
            $this->getGiftMessageTo(),
            $this->getGiftMessageFrom(),
            $this->getGiftMessageContent()
        );
        return $messageSerialization ? $messageSerialization : '';
    }

    /**
     * Serialize the gift card message data. Will only be included if there
     * are valid to and from fields.
     *
     * @return string
     */
    protected function serializeGiftingGiftCard()
    {
        $messageSerialization = $this->serializeGiftingMessage(
            $this->getGiftCardTo(),
            $this->getGiftCardFrom(),
            $this->getGiftCardMessage()
        );
        // If the gifting includes gift wrapping, the gift card node
        // must always be included.
        return ($messageSerialization || $this->getIncludeGiftWrapping())
            ? "<GiftCard>$messageSerialization</GiftCard>"
            : '';
    }

    /**
     * Serialize the packslip message data. Will only be included if there
     * are valid to and from fields.
     *
     * @return string
     */
    protected function serializeGiftingPackslip()
    {
        $messageSerialization = $this->serializeGiftingMessage(
            $this->getPackslipTo(),
            $this->getPackslipFrom(),
            $this->getPackslipMessage()
        );
        return $messageSerialization ? "<Packslip>$messageSerialization</Packslip>" : '';
    }

    /**
     * Serialize a gifting message from, to and message. Will only return a
     * serialization if at least a from and to name are given.
     *
     * @param string
     * @param string
     * @param string
     * @return string
     */
    protected function serializeGiftingMessage($toName, $fromName, $messageText)
    {
        $localizedTo = $this->serializeOptionalAttribute(

It seems like serializeOptionalAttribute() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            'localizedDisplayText',
            $this->xmlEncode($this->getLocalizedToLabel())
        );
        $localizedFrom = $this->serializeOptionalAttribute(

It seems like serializeOptionalAttribute() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            'localizedDisplayText',
            $this->xmlEncode($this->getLocalizedFromLabel())
        );
        return $toName && $fromName
            ? '<Message>'
                . "<To $localizedTo>{$this->xmlEncode($toName)}</To>"
                . "<From $localizedFrom>{$this->xmlEncode($fromName)}</From>"
                . $this->serializeOptionalXmlEncodedValue('Message', $messageText)
                . '</Message>'
            : '';
    }

    /**
     * Extract gifting pricing from the payload in the DOMXPath and, if it is
     * included in the serialized data, deserialize it into a new price group.
     *
     * @return self
     */
    protected function deserializeGiftPricing(DOMXPath $xpath)

This method seems to be duplicated in your project.

    {
        $priceNode = $xpath->query('x:Gifting/x:Gift/x:Pricing')->item(0);
        if ($priceNode) {
            $this->setGiftPricing(
                $this->getEmptyGiftingPriceGroup()->deserialize($priceNode->C14N())
            );
        }
        return $this;
    }

    /**
     * Serialize an optional element containing a string. The value will be
     * xml-encoded if is not null.
     *
     * @param string
     * @param string
     * @return string
     */
    abstract protected function serializeOptionalXmlEncodedValue($name, $value);

    /**
     * encode the passed in string to be safe for xml if it is not null,
     * otherwise simply return the null parameter.
     *
     * @param string|null
     * @return string|null
     */
    abstract protected function xmlEncode($value = null);
}