CheckVatResponse.php

<?php
/**
 * \DragonBe\Vies
 *
 * Component using the European Commission (EC) VAT Information Exchange System (VIES) to verify and validate VAT
 * registration numbers in the EU, using PHP and Composer.
 *
 * @author Michelangelo van Dam <dragonbe+github@gmail.com>
 * @license MIT
 *
 */
namespace DragonBe\Vies;

/**
 * CheckVatResponse
 *
 * This is the response object from the VIES web service for validation of
 * VAT numbers of companies registered in the European Union.
 *
 * @see \DragonBe\Vies\Exception
 * @category DragonBe
 * @package \DragonBe\Vies
 */
class CheckVatResponse
{
    public const VIES_DATETIME_FORMAT = 'Y-m-dP';

    /**
     * @var string The country code for a member of the European Union
     */
    protected $countryCode;
    /**
     * @var string The VAT number of a registered European company
     */
    protected $vatNumber;
    /**
     * @var \DateTime The date of the request
     */
    protected $requestDate;
    /**
     * @var bool Flag indicating the VAT number is valid
     */
    protected $valid;
    /**
     * @var string The registered name of a validated company (optional)
     */
    protected $name;
    /**
     * @var string The registered address of a validated company (optional)
     */
    protected $address;
    /**
     * @var string The request Identifier (optional)
     */
    protected $identifier;

    /**
     * Constructor for this response object
     *
     * @param null|array|\StdClass $params
     */
    public function __construct($params = null)
    {
        if (null !== $params) {
            $this->populate($params);
        }
    }
    /**
     * Sets the two-character country code for a member of the European Union
     *
     * @param string $countryCode
     * @return \DragonBe\Vies\CheckVatResponse
     */
    public function setCountryCode(string $countryCode): CheckVatResponse
    {
        $this->countryCode = (string) $countryCode;
        return $this;
    }
    /**
     * Retrieves the two-character country code from a member of the European
     * Union.
     *
     * @return string
     */
    public function getCountryCode(): string
    {
        return $this->countryCode;
    }
    /**
     * Sets the VAT number of a company within the European Union
     *
     * @param string $vatNumber
     * @return \DragonBe\Vies\CheckVatResponse
     */
    public function setVatNumber(string $vatNumber): CheckVatResponse
    {
        $this->vatNumber = (string) $vatNumber;
        return $this;
    }
    /**
     * Retrieves the VAT number from a company within the European Union
     *
     * @return string
     */
    public function getVatNumber(): string
    {
        return $this->vatNumber;
    }
    /**
     * Sets the date- and timestamp when the VIES service response was created
     *
     * @param \DateTime $requestDate
     * @return \DragonBe\Vies\CheckVatResponse
     */
    public function setRequestDate(\DateTime $requestDate): CheckVatResponse
    {
        if (! $requestDate instanceof \DateTime) {
            $date = substr($requestDate, 0, 10);
            $timezone = substr($requestDate, -6);
            $requestDate = new \DateTime($date, \DateTime::createFromFormat('O', $timezone)->getTimezone());
        }
        $this->requestDate = $requestDate;
        return $this;
    }
    /**
     * Retrieves the date- and timestamp the VIES service response was created
     *
     * @return \DateTime
     */
    public function getRequestDate(): \DateTime
    {
        if (null === $this->requestDate) {
            $this->requestDate = new \DateTime();
        }
        return $this->requestDate;
    }
    /**
     * Sets the flag to indicate the provided details were valid or not
     *
     * @param bool $flag
     * @return \DragonBe\Vies\CheckVatResponse
     */
    public function setValid(bool $flag): CheckVatResponse
    {
        $this->valid = (boolean) $flag;
        return $this;
    }
    /**
     * Checks to see if a request is valid with given parameters
     *
     * @return bool
     */
    public function isValid(): bool
    {
        return $this->valid;
    }
    /**
     * Sets optionally the registered name of the company
     *
     * @param string $name
     * @return \DragonBe\Vies\CheckVatResponse
     */
    public function setName(string $name): CheckVatResponse
    {
        $this->name = (string) $name;
        return $this;
    }
    /**
     * Retrieves the registered name of the company
     *
     * @return string
     */
    public function getName(): string
    {
        return $this->name;
    }
    /**
     * Sets the registered address of a company
     *
     * @param string $address
     * @return \DragonBe\Vies\CheckVatResponse
     */
    public function setAddress(string $address): CheckVatResponse
    {
        $this->address = (string) $address;
        return $this;
    }
    /**
     * Retrieves the registered address of a company
     *
     * @return string
     */
    public function getAddress(): string
    {
        return $this->address;
    }

    /**
     * Sets request Identifier
     *
     * @param string $identifier
     * @return \DragonBe\Vies\CheckVatResponse
     */
    public function setIdentifier(string $identifier): CheckVatResponse
    {
        $this->identifier = (string)$identifier;
        return $this;
    }
    /**
     * get requerst Identifier
     *
     * @return string
     */
    public function getIdentifier(): string
    {
        return $this->identifier;
    }
    /**
     * Populates this response object with external data
     *
     * @param array|\stdClass $row
     */
    public function populate($row)
    {
        if (is_array($row)) {
            $row = new \ArrayObject($row, \ArrayObject::ARRAY_AS_PROPS);
        }

        $requiredFields = ['countryCode', 'vatNumber', 'requestDate', 'valid'];
        foreach ($requiredFields as $requiredField) {
            if (! isset ($row->$requiredField)) {
                throw new \InvalidArgumentException('Required field "' . $requiredField . '" is missing');
            }
        }

        // required parameters
        $this->setCountryCode($row->countryCode)
             ->setVatNumber($row->vatNumber)
             ->setRequestDate($row->requestDate)
             ->setValid($row->valid);

        // optional parameters
        isset($row->traderName) ?
            $this->setName($row->traderName) :
            $this->setName('---');

        isset($row->traderAddress)
            ? $this->setAddress($row->traderAddress)
            : $this->setAddress('---');

        isset($row->requestIdentifier)
            ? $this->setIdentifier($row->requestIdentifier)
            : $this->setIdentifier('');
    }

    /**
     * Return this object as an array
     *
     * @return array
     */
    public function toArray(): array
    {
        return  [
            'countryCode' => $this->getCountryCode(),
            'vatNumber'   => $this->getVatNumber(),
            'requestDate' => $this->getRequestDate()->format('Y-m-d'),
            'valid'       => $this->isValid(),
            'name'        => $this->getName(),
            'address'     => $this->getAddress(),
            'identifier'  => $this->getIdentifier()
        ];
    }
}