zangra-dev / bpost-api-library

src/Bpost/Order/Address.php

<?php

namespace Bpost\BpostApiClient\Bpost\Order;

use Bpost\BpostApiClient\Common\XmlHelper;
use Bpost\BpostApiClient\Exception\BpostLogicException\BpostInvalidLengthException;
use DOMDocument;
use DOMElement;
use SimpleXMLElement;

/**
 * bPost Address class
 *
 * @author Tijs Verkoyen <php-bpost@verkoyen.eu>
 */
class Address
{
    const TAG_NAME = 'common:address';

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

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

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

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

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

    /**
     * @var string
     */
    private $countryCode = 'BE';

    /**
     * @param string $box
     *
     * @throws BpostInvalidLengthException
     */
    public function setBox($box)
    {
        $length = 8;
        if (mb_strlen($box) > $length) {
            throw new BpostInvalidLengthException('box', mb_strlen($box), $length);
        }
        $this->box = $box;
    }

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

    /**
     * @param string $countryCode
     *
     * @throws BpostInvalidLengthException
     */
    public function setCountryCode($countryCode)
    {
        $length = 2;
        if (mb_strlen($countryCode) > $length) {
            throw new BpostInvalidLengthException('countryCode', mb_strlen($countryCode), $length);
        }
        $this->countryCode = strtoupper($countryCode);
    }

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

    /**
     * @param string $locality
     *
     * @throws BpostInvalidLengthException
     */
    public function setLocality($locality)
    {
        $length = 40;
        if (mb_strlen($locality) > $length) {
            throw new BpostInvalidLengthException('locality', mb_strlen($locality), $length);
        }
        $this->locality = $locality;
    }

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

    /**
     * @param string $number
     *
     * @throws BpostInvalidLengthException
     */
    public function setNumber($number)
    {
        $length = 8;
        if (mb_strlen($number) > $length) {
            throw new BpostInvalidLengthException('number', mb_strlen($number), $length);
        }
        $this->number = $number;
    }

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

    /**
     * @param string $postalCode
     *
     * @throws BpostInvalidLengthException
     */
    public function setPostalCode($postalCode)
    {
        $length = 40;
        if (mb_strlen($postalCode) > $length) {
            throw new BpostInvalidLengthException('postalCode', mb_strlen($postalCode), $length);
        }
        $this->postalCode = $postalCode;
    }

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

    /**
     * @param string $streetName
     *
     * @throws BpostInvalidLengthException
     */
    public function setStreetName($streetName)
    {
        $length = 40;
        if (mb_strlen($streetName) > $length) {
            throw new BpostInvalidLengthException('streetName', mb_strlen($streetName), $length);
        }
        $this->streetName = $streetName;
    }

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

    /**
     * @param string $streetName
     * @param string $number
     * @param string $box
     * @param string $postalCode
     * @param string $locality
     * @param string $countryCode
     *
     * @throws BpostInvalidLengthException
     */
    public function __construct(
        $streetName = null,
        $number = null,
        $box = null,
        $postalCode = null,
        $locality = null,
        $countryCode = null
    ) {
        if ($streetName !== null) {
            $this->setStreetName($streetName);
        }
        if ($number !== null) {
            $this->setNumber($number);
        }
        if ($box !== null) {
            $this->setBox($box);
        }
        if ($postalCode !== null) {
            $this->setPostalCode($postalCode);
        }
        if ($locality !== null) {
            $this->setLocality($locality);
        }
        if ($countryCode !== null) {
            $this->setCountryCode($countryCode);
        }
    }

    /**
     * Return the object as an array for usage in the XML
     *
     * @param DOMDocument $document
     * @param string      $prefix
     *
     * @return DOMElement
     */
    public function toXML(DOMDocument $document, $prefix = 'common')
    {
        $tagName = static::TAG_NAME;
        $address = $document->createElement($tagName);
        $document->appendChild($address);

        $this->streetToXML($document, $prefix, $address);
        $this->streetNumbersToXML($document, $prefix, $address);
        $this->localityToXML($document, $prefix, $address);
        $this->countryToXML($document, $prefix, $address);

        return $address;
    }

    /**
     * @param SimpleXMLElement $xml
     *
     * @return Address
     *
     * @throws BpostInvalidLengthException
     */
    public static function createFromXML(SimpleXMLElement $xml)
    {
        $address = new Address();

        if (isset($xml->streetName) && $xml->streetName != '') {
            $address->setStreetName((string) $xml->streetName);
        }
        if (isset($xml->number) && $xml->number != '') {
            $address->setNumber((string) $xml->number);
        }
        if (isset($xml->box) && $xml->box != '') {
            $address->setBox((string) $xml->box);
        }
        if (isset($xml->postalCode) && $xml->postalCode != '') {
            $address->setPostalCode((string) $xml->postalCode);
        }
        if (isset($xml->locality) && $xml->locality != '') {
            $address->setLocality((string) $xml->locality);
        }
        if (isset($xml->countryCode) && $xml->countryCode != '') {
            $address->setCountryCode((string) $xml->countryCode);
        }

        return $address;
    }

    /**
     * @param DOMDocument $document
     * @param $prefix
     * @param DOMElement $address
     */
    private function streetToXML(DOMDocument $document, $prefix, DOMElement $address)
    {
        if ($this->getStreetName() !== null) {

The condition $this->getStreetName() !== null is always true.

            $address->appendChild(
                $document->createElement(
                    XmlHelper::getPrefixedTagName('streetName', $prefix),
                    $this->getStreetName()
                )
            );
        }
    }

    /**
     * @param DOMDocument $document
     * @param $prefix
     * @param DOMElement $address
     */
    private function localityToXML(DOMDocument $document, $prefix, DOMElement $address)
    {
        if ($this->getPostalCode() !== null) {

The condition $this->getPostalCode() !== null is always true.

            $address->appendChild(
                $document->createElement(
                    XmlHelper::getPrefixedTagName('postalCode', $prefix),
                    $this->getPostalCode()
                )
            );
        }
        if ($this->getLocality() !== null) {

The condition $this->getLocality() !== null is always true.

            $address->appendChild(
                $document->createElement(
                    XmlHelper::getPrefixedTagName('locality', $prefix),
                    $this->getLocality()
                )
            );
        }
    }

    /**
     * @param DOMDocument $document
     * @param $prefix
     * @param DOMElement $address
     */
    private function countryToXML(DOMDocument $document, $prefix, DOMElement $address)
    {
        if ($this->getCountryCode() !== null) {

The condition $this->getCountryCode() !== null is always true.

            $address->appendChild(
                $document->createElement(
                    XmlHelper::getPrefixedTagName('countryCode', $prefix),
                    $this->getCountryCode()
                )
            );
        }
    }

    /**
     * @param DOMDocument $document
     * @param $prefix
     * @param DOMElement $address
     */
    private function streetNumbersToXML(DOMDocument $document, $prefix, DOMElement $address)
    {
        if ($this->getNumber() !== null) {

The condition $this->getNumber() !== null is always true.

            $address->appendChild(
                $document->createElement(
                    XmlHelper::getPrefixedTagName('number', $prefix),
                    $this->getNumber()
                )
            );
        }
        if ($this->getBox() !== null) {

The condition $this->getBox() !== null is always true.

            $address->appendChild(
                $document->createElement(
                    XmlHelper::getPrefixedTagName('box', $prefix),
                    $this->getBox()
                )
            );
        }
    }
}