Ups\Entity\InternationalForms

Complexity

Total Complexity

59

Size/Duplication

Total Lines	539
Duplicated Lines	1.86 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

42.14%

Importance

Changes	1
Bugs	0	Features	0

32 Methods

Rating	Name	Duplication	Size	Complexity
A	getTypes()	0	4	1
A	getTypeName()	0	4	1
F	__construct()	0	32	11
A	setType()	0	6	1
A	getType()	0	4	1
A	setFreightCharges()	0	6	1
A	getFreightCharges()	0	4	1
A	setDiscount()	0	6	1
A	getDiscount()	0	4	1
A	addProduct()	0	6	1
A	getProducts()	0	4	1
F	toNode()	0	53	16
A	setInvoiceNumber()	0	6	1
A	getInvoiceNumber()	0	4	1
A	setInvoiceDate()	0	6	1
A	getInvoiceDate()	0	4	1
A	setPurchaseOrderNumber()	0	6	1
A	getPurchaseOrderNumber()	0	4	1
A	setTermsOfShipment()	0	6	1
A	getTermsOfShipment()	0	4	1
A	setReasonForExport()	0	10	2
A	getReasonForExport()	0	4	1
A	setComments()	10	10	2
A	getComments()	0	4	1
A	setDeclarationStatement()	0	6	1
A	getDeclarationStatement()	0	4	1
A	setCurrencyCode()	0	6	1
A	getCurrencyCode()	0	4	1
A	setAdditionalDocumentIndicator()	0	4	1
A	getAdditionalDocumentIndicator()	0	4	1
A	setEEIFilingOption()	0	6	1
A	getEEIFilingOption()	0	4	1

<?php

namespace Ups\Entity;

use DateTime;
use DOMDocument;
use DOMElement;
use Ups\NodeInterface;

class InternationalForms implements NodeInterface
{
    /**
     * @var string
     */
    private $type = self::TYPE_INVOICE;

    /**
     * Form Types.
     */
    const TYPE_INVOICE = '01';
    const TYPE_CO = '03';
    const TYPE_NAFTA_CO = '04';
    const TYPE_PARTIAL_INVOICE = '05';
    const TYPE_PACKINGLIST = '06';
    const TYPE_CUSTOMER_GENERATED_FORMS = '07';
    const TYPE_AIR_FREIGHT_PACKING_LIST = '08';
    const TYPE_CN22_FORMS = '09';
    const TYPE_UPS_PREMIUM_CARE = '10';
    const TYPE_EEI_SHIPMENT_WITH_RETURN_SERVICE = '11';

    private static $typeNames = [
        '01' => 'Invoice',
        '03' => 'CO',
        '04' => 'NAFTA CO',
        '05' => 'Partial Invoice',
        '06' => 'Packinglist',
        '07' => 'Customer Generated Forms',
        '08' => 'Air Freight Packing List',
        '09' => 'CN22 Forms',
        '10' => 'UPS Premium Care',
        '11' => 'EEI. For shipment with return service',
    ];

    /**
     * @var string
     */
    private $termsOfShipment;

    /**
     * Terms of Shipment.
     */
    const TOS_COST_AND_FREIGHT = 'CFR';
    const TOS_COST_INSURANCE_AND_FREIGHT = 'CIF';
    const TOS_CARRIAGE_AND_INSURANCE_PAID = 'CIP';
    const TOS_CARRIAGE_PAID_TO = 'CPT';
    const TOS_DELIVERED_AT_FRONTIER = 'DAF';
    const TOS_DELIVERY_DUTY_PAID = 'DDP';
    const TOS_DELIVERY_DUTY_UNPAID = 'DDU';
    const TOS_DELIVERED_EX_QUAY = 'DEQ';
    const TOS_DELIVERED_EX_SHIP = 'DES';
    const TOS_EX_WORKS = 'EXW';
    const TOS_FREE_ALONGSIDE_SHIP = 'FAS';
    const TOS_FREE_CARRIER = 'FCA';
    const TOS_FREE_ON_BOARD = 'FOB';

    private static $termsOfShipmentNames = [

The property $termsOfShipmentNames is not used and could be removed.

        'CFR' => 'Cost and Freight',
        'CIF' => 'Cost, Insurance and Freight',
        'CIP' => 'Carriage and Insurance Paid',
        'CPT' => 'Carriage Paid To',
        'DAF' => 'Delivered at Frontier',
        'DDP' => 'Delivery Duty Paid',
        'DDU' => 'Delivery Duty Unpaid',
        'DEQ' => 'Delivered Ex Quay',
        'DES' => 'Delivered Ex Ship',
        'EXW' => 'Ex Works',
        'FAS' => 'Free Alongside Ship',
        'FCA' => 'Free Carrier',
        'FOB' => 'Free On Board',
    ];

    /**
     * @var string
     */
    private $reasonForExport;

    /**
     * Reasons for export.
     */
    const RFE_SALE = 'SALE';
    const RFE_GIFT = 'GIFT';
    const RFE_SAMPLE = 'SAMPLE';
    const RFE_RETURN = 'RETURN';
    const RFE_REPAIR = 'REPAIR';
    const RFE_INTERCOMPANYDATA = 'INTERCOMPANYDATA';

    /**
     * @var string
     */
    private $comments;

    /**
     * @var string
     */
    private $declarationStatement;

    /**
     * @var string
     */
    private $currencyCode;

    /**
     * @var string
     */
    private $invoiceNumber;

    /**
     * @var DateTime
     */
    private $invoiceDate;

    /**
     * @var string
     */
    private $purchaseOrderNumber;

    /**
     * @var array
     */
    private $products = [];

    /**
     * @var Discount
     */
    private $discount;

    /**
     * @var FreightCharges
     */
    private $freightCharges;

    /**
     * @var bool
     */
    private $additionalDocumentIndicator;

    /**
     * @var EEIFilingOption
     */
    private $eeiFilingOption;

    /**
     * @return array
     */
    public static function getTypes()
    {
        return self::$typeNames;
    }

    /**
     * @return string
     */
    public function getTypeName()
    {
        return self::$typeNames[$this->getType()];
    }

    /**
     * @param null|object $attributes
     */
    public function __construct($attributes = null)
    {
        if (null !== $attributes) {
            if (isset($attributes->FormType)) {
                $this->setType($attributes->FormType);
            }
            if (isset($attributes->InvoiceNumber)) {
                $this->setInvoiceNumber($attributes->InvoiceNumber);
            }
            if (isset($attributes->InvoiceDate)) {
                $this->setInvoiceDate(new DateTime($attributes->InvoiceDate));
            }
            if (isset($attributes->PurchaseOrderNumber)) {
                $this->setPurchaseOrderNumber($attributes->PurchaseOrderNumber);
            }
            if (isset($attributes->TermsOfShipment)) {
                $this->setTermsOfShipment($attributes->TermsOfShipment);
            }
            if (isset($attributes->Comments)) {
                $this->setComments($attributes->Comments);
            }
            if (isset($attributes->DeclarationStatement)) {
                $this->setDeclarationStatement($attributes->DeclarationStatement);
            }
            if (isset($attributes->CurrencyCode)) {
                $this->setCurrencyCode($attributes->CurrencyCode);
            }
            if (isset($attributes->EEIFilingOption)) {
                $this->setEEIFilingOption(new EEIFilingOption($attributes->EEIFilingOption));
            }
        }
    }

    /**
     * @param $type string
     *
     * @return $this
     */
    public function setType($type)
    {
        $this->type = $type;

        return $this;
    }

    /**
     * @return string
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * @param $freightCharges FreightCharges
     *
     * @return $this
     */
    public function setFreightCharges(FreightCharges $freightCharges)
    {
        $this->freightCharges = $freightCharges;

        return $this;
    }

    /**
     * @return FreightCharges
     */
    public function getFreightCharges()
    {
        return $this->freightCharges;
    }

    /**
     * @param $discount Discount
     *
     * @return $this
     */
    public function setDiscount(Discount $discount)
    {
        $this->discount = $discount;

        return $this;
    }

    /**
     * @return Discount
     */
    public function getDiscount()
    {
        return $this->discount;
    }

    /**
     * @param Product $product
     *
     * @return $this
     */
    public function addProduct(Product $product)
    {
        array_push($this->products, $product);

        return $this;
    }

    /**
     * @return array
     */
    public function getProducts()
    {
        return $this->products;
    }

    /**
     * @param null|DOMDocument $document
     *
     * @return DOMElement
     */
    public function toNode(DOMDocument $document = null)
    {
        if (null === $document) {
            $document = new DOMDocument();
        }

        $node = $document->createElement('InternationalForms');

        if ($this->getType()) {
            $node->appendChild($document->createElement('FormType', $this->getType()));
        }
        if ($this->getInvoiceNumber() !== null) {
            $node->appendChild($document->createElement('InvoiceNumber', $this->getInvoiceNumber()));
        }
        if ($this->getInvoiceDate() !== null) {
            $node->appendChild($document->createElement('InvoiceDate', $this->getInvoiceDate()->format('Ymd')));
        }
        if ($this->getPurchaseOrderNumber() !== null) {
            $node->appendChild($document->createElement('PurchaseOrderNumber', $this->getPurchaseOrderNumber()));
        }
        if ($this->getTermsOfShipment() !== null) {
            $node->appendChild($document->createElement('TermsOfShipment', $this->getTermsOfShipment()));
        }
        if ($this->getReasonForExport() !== null) {
            $node->appendChild($document->createElement('ReasonForExport', $this->getReasonForExport()));
        }
        if ($this->getComments() !== null) {
            $node->appendChild($document->createElement('Comments', $this->getComments()));
        }
        if ($this->getDeclarationStatement() !== null) {
            $node->appendChild($document->createElement('DeclarationStatement', $this->getDeclarationStatement()));
        }
        if ($this->getCurrencyCode() !== null) {
            $node->appendChild($document->createElement('CurrencyCode', $this->getCurrencyCode()));
        }
        if ($this->getDiscount() !== null) {
            $node->appendChild($this->getDiscount()->toNode($document));
        }
        if ($this->getFreightCharges() !== null) {
            $node->appendChild($this->getFreightCharges()->toNode($document));
        }
        if ($this->getAdditionalDocumentIndicator() !== null) {
            $node->appendChild($document->createElement('AdditionalDocumentIndicator'));
        }
        if ($this->getEEIFilingOption() !== null) {
            $node->appendChild($this->getEEIFilingOption()->toNode($document));
        }
        foreach ($this->products as $product) {
            $node->appendChild($product->toNode($document));
        }

        return $node;
    }

    /**
     * @param $number string
     *
     * @return $this
     */
    public function setInvoiceNumber($number)
    {
        $this->invoiceNumber = $number;

        return $this;
    }

    /**
     * @return string
     */
    public function getInvoiceNumber()
    {
        return $this->invoiceNumber;
    }

    /**
     * @param DateTime $date
     *
     * @return $this
     */
    public function setInvoiceDate(DateTime $date)
    {
        $this->invoiceDate = $date;

        return $this;
    }

    /**
     * @return DateTime
     */
    public function getInvoiceDate()
    {
        return $this->invoiceDate;
    }

    /**
     * @param $number
     *
     * @return $this
     */
    public function setPurchaseOrderNumber($number)
    {
        $this->purchaseOrderNumber = $number;

        return $this;
    }

    /**
     * @return string
     */
    public function getPurchaseOrderNumber()
    {
        return $this->purchaseOrderNumber;
    }

    /**
     * @param $terms
     *
     * @return $this
     */
    public function setTermsOfShipment($terms)
    {
        $this->termsOfShipment = $terms;

        return $this;
    }

    /**
     * @return string
     */
    public function getTermsOfShipment()
    {
        return $this->termsOfShipment;
    }

    /**
     * @param $reason
     *
     * @return $this
     */
    public function setReasonForExport($reason)
    {
        if (strlen($reason) > 20) {
            $reason = substr($reason, 0, 20);
        }

        $this->reasonForExport = $reason;

        return $this;
    }

    /**
     * @return string
     */
    public function getReasonForExport()
    {
        return $this->reasonForExport;
    }

    /**
     * @param $comments
     *
     * @return $this
     */
    public function setComments($comments)

This method seems to be duplicated in your project.

    {
        if (strlen($comments) > 150) {
            $comments = substr($comments, 0, 150);
        }

        $this->comments = $comments;

        return $this;
    }

    /**
     * @return string
     */
    public function getComments()
    {
        return $this->comments;
    }

    /**
     * @param string $statement
     *
     * @return $this
     */
    public function setDeclarationStatement($statement)
    {
        $this->declarationStatement = $statement;

        return $this;
    }

    /**
     * @return string
     */
    public function getDeclarationStatement()
    {
        return $this->declarationStatement;
    }

    /**
     * @param $code
     *
     * @return $this
     */
    public function setCurrencyCode($code)
    {
        $this->currencyCode = $code;

        return $this;
    }

    /**
     * @return string
     */
    public function getCurrencyCode()
    {
        return $this->currencyCode;
    }

    /**
     * @param $additionalDocumentIndicator
     *
     * @return $this
     */
    public function setAdditionalDocumentIndicator($additionalDocumentIndicator)
    {
        $this->additionalDocumentIndicator = $additionalDocumentIndicator;
    }

    /**
     * @return bool
     */
    public function getAdditionalDocumentIndicator()
    {
        return $this->additionalDocumentIndicator;
    }

    /**
     * @param EEIFilingOption $eeiFilingOption
     *
     * @return $this
     */
    public function setEEIFilingOption(EEIFilingOption $eeiFilingOption)
    {
        $this->eeiFilingOption = $eeiFilingOption;

        return $this;
    }

    /**
     * @return EEIFilingOption
     */
    public function getEEIFilingOption()
    {
        return $this->eeiFilingOption;
    }
}