SimpleUPS\AddressValidate\Request

Complexity

Total Complexity

14

Size/Duplication

Total Lines	115
Duplicated Lines	7.83 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	2
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getUrl()	0	4	2
C	buildXml()	0	52	8
A	sendRequest()	9	9	1
A	setAddress()	0	5	1
A	getAddress()	0	4	1

<?php namespace SimpleUPS\AddressValidate;

use \SimpleUPS\Api\MissingParameterException;

use \SimpleUPS\UPS;

/**
 * A request/response handler for validating a street address
 * @internal
 * @link https://www.ups.com/upsdeveloperkit/downloadresource?loc=en_US
 */
class Request extends \SimpleUPS\Api\Request
{
    private
        /* @var Address $address */
        $address;

    /**
     * @param null $debug
     */
    public function __construct($debug = null)
    {
        parent::__construct($debug);

        $this->responseClass = false;
    }

    /**
     * Determine which API call will be made
     * @return string
     */
    public function getUrl()
    {
        return $this->getDebug() ? 'https://wwwcie.ups.com/ups.app/xml/XAV' : 'https://onlinetools.ups.com/ups.app/xml/XAV';
    }

    /**
     * Build the validate address request
     * @return string
     * @throws \SimpleUPS\Api\MissingParameterException
     */
    public function buildXml()
    {
        if (serialize($this->getAddress()) == serialize(new Address())) {
            throw new MissingParameterException(
                'Address requires a Country code and a City, a State\Province code or a Postal code'
            );
        }

        if ($this->getAddress()->getCountryCode() === null) {
            throw new MissingParameterException('Address requires a Country code');
        }

        $dom = new \DomDocument('1.0');
        $dom->formatOutput = $this->getDebug();
        $dom->appendChild($addressRequest = $dom->createElement('AddressValidationRequest'));
        $addressRequestLang = $dom->createAttribute('xml:lang');
        $addressRequestLang->value = parent::getXmlLang();

It seems like you call parent on a different method (getXmlLang() instead of buildXml()). Are you sure this is correct? If so, you might want to change this to $this->getXmlLang().

        $addressRequest->appendChild($request = $dom->createElement('Request'));
        $request->appendChild($transactionReference = $dom->createElement('TransactionReference'));
        $transactionReference->appendChild($dom->createElement('CustomerContext', $this->getCustomerContext()));

        $request->appendChild($dom->createElement('RequestAction', 'XAV'));
        $request->appendChild($dom->createElement('RequestOption', '3'));

        $addressRequest->appendChild($address = $dom->createElement('AddressKeyFormat'));

        $address->appendChild($dom->createElement('AddressLine', $this->getAddress()->getStreet()));
        if ($this->getAddress()->getAddressLine2()) {
            $address->appendChild($dom->createElement('AddressLine', $this->getAddress()->getAddressLine2()));
            if ($this->getAddress()->getAddressLine3()) {
                $address->appendChild($dom->createElement('AddressLine', $this->getAddress()->getAddressLine3()));
            }
        }
        if ($this->getAddress()->getCity() != null) {
            $address->appendChild($dom->createElement('PoliticalDivision2', $this->getAddress()->getCity()));
        }

        if ($this->getAddress()->getStateProvinceCode() != null) {
            $address->appendChild(
                $dom->createElement('PoliticalDivision1', $this->getAddress()->getStateProvinceCode())
            );
        }

        if ($this->getAddress()->getPostalCode() != null) {
            $address->appendChild($dom->createElement('PostcodePrimaryLow', $this->getAddress()->getPostalCode()));
        }

        $address->appendChild($dom->createElement('CountryCode', $this->getAddress()->getCountryCode()));
        $xml = parent::buildAuthenticationXml() . $dom->saveXML();

It seems like you call parent on a different method (buildAuthenticationXml() instead of buildXml()). Are you sure this is correct? If so, you might want to change this to $this->buildAuthenticationXml().

        return $xml;
    }

    /**
     * @return Response|\SimpleUPS\Api\Response|\SimpleXMLElement
     */
    public function sendRequest()

This method seems to be duplicated in your project.

    {
        $xml = parent::sendRequest();

        $responseClass = new \SimpleUPS\AddressValidate\Response($this->getAddress());
        $response = $responseClass->fromXml($xml);

It seems like $xml defined by parent::sendRequest() on line 100 can also be of type object<SimpleUPS\Api\Response>; however, SimpleUPS\AddressValidate\Response::fromXml() does only seem to accept object<SimpleXMLElement>, maybe add an additional type check?

        return $response;
    }

    /**
     * @param Address $address
     *
     * @return Request
     */
    public function setAddress(Address $address)
    {
        $this->address = $address;
        return $this;
    }

    /**
     * @return Address
     */
    public function getAddress()
    {
        return $this->address;
    }
}