Talentify / php-value-objects

src/Geography/Address/Physical/ByCountry/Br/BrPhysicalAddress.php

<?php

declare(strict_types=1);

namespace Talentify\ValueObject\Geography\Address\Physical\ByCountry\Br;

use Talentify\ValueObject\Geography\Address\ByCountry\Br\CEP as BrPostalCode;
use Talentify\ValueObject\Geography\Address\ByCountry\Br\Municipality;
use Talentify\ValueObject\Geography\Address\ByCountry\Br\Neighbourhood as BrNeighbourhood;
use Talentify\ValueObject\Geography\Address\ByCountry\Br\State as BrState;
use Talentify\ValueObject\Geography\Address\ByCountry\Br\Street as BrStreet;
use Talentify\ValueObject\Geography\Address\City;
use Talentify\ValueObject\Geography\Address\Country;
use Talentify\ValueObject\Geography\Address\Physical\PhysicalAddress;
use Talentify\ValueObject\Geography\Address\PostalCode;
use Talentify\ValueObject\Geography\Address\Region;
use Talentify\ValueObject\Geography\Address\Street as BaseStreet;
use Talentify\ValueObject\Geography\CountryList;
use Talentify\ValueObject\StringUtils;
use Talentify\ValueObject\ValueObject;

/**
 * Represents an address on Brazil (BRA).
 *
 * @see https://en.wikipedia.org/wiki/Address#Brazil
 */
final class BrPhysicalAddress implements PhysicalAddress
{
    /** @var \Talentify\ValueObject\Geography\Address\ByCountry\Br\Street|null */
    private $street;
    /** @var \Talentify\ValueObject\Geography\Address\ByCountry\Br\Neighbourhood|null */
    private $neighbourhood;
    /** @var \Talentify\ValueObject\Geography\Address\ByCountry\Br\Municipality|null */
    private $municipality;
    /** @var \Talentify\ValueObject\Geography\Address\ByCountry\Br\State|null */
    private $state;
    /** @var \Talentify\ValueObject\Geography\Address\ByCountry\Br\CEP|null */
    private $postalCode;
    /** @var \Talentify\ValueObject\Geography\Address\Country */
    private $country;
    /** @var string */
    private $formattedAddress;

    /**
     * @throws \InvalidArgumentException
     */
    public function __construct(
        ?BrStreet $street = null,
        ?BrNeighbourhood $neighbourhood = null,
        ?Municipality $municipality = null,
        ?BrState $state = null,
        ?BrPostalCode $postalCode = null,
        ?string $formattedAddress = null
    ) {
        $this->street           = $street;
        $this->neighbourhood    = $neighbourhood;
        $this->municipality     = $municipality;
        $this->state            = $state;
        $this->postalCode       = $postalCode;
        $this->country          = CountryList::BR();
        $this->formattedAddress = $formattedAddress;
    }

    /**
     * @return \Talentify\ValueObject\Geography\Address\ByCountry\Br\Street
     */
    public function getStreet() : ?BaseStreet
    {
        return $this->street;
    }

    public function getNeighbourhood() : ?BrNeighbourhood
    {
        return $this->neighbourhood;
    }

    public function getMunicipality() : ?Municipality
    {
        return $this->municipality;
    }

    /**
     * @return \Talentify\ValueObject\Geography\Address\ByCountry\Br\Municipality|null
     */
    public function getCity() : ?City
    {
        return $this->municipality;
    }

    /**
     * @return \Talentify\ValueObject\Geography\Address\ByCountry\Br\State|null
     */
    public function getRegion() : ?Region
    {
        return $this->state;
    }

    /**
     * @return \Talentify\ValueObject\Geography\Address\ByCountry\Br\State|null
     */
    public function getState() : ?BrState
    {
        return $this->state;
    }

    /**
     * @return \Talentify\ValueObject\Geography\Address\ByCountry\Br\CEP|null
     */
    public function getPostalCode() : ?PostalCode
    {
        return $this->postalCode;
    }

    /**
     * @return \Talentify\ValueObject\Geography\Address\ByCountry\Br\CEP|null
     */
    public function getCep() : ? BrPostalCode
    {
        return $this->postalCode;
    }

    public function getCountry() : Country
    {
        return $this->country;
    }

    public function equals(?ValueObject $object) : bool
    {
        if (!$object instanceof self) {
            return false;
        }

        return (
            (
                (null === $this->getStreet() && null === $object->getStreet()) ||
                (\is_object($this->getStreet()) && $this->getStreet()->equals($object->getStreet())) ||
                (\is_object($object->getStreet()) && $object->getStreet()->equals($this->getStreet()))
            ) &&
            (
                (null === $this->getMunicipality() && null === $object->getMunicipality()) ||
                (\is_object($this->getMunicipality()) && $this->getMunicipality()->equals($object->getMunicipality())) ||
                (\is_object($object->getMunicipality()) && $object->getMunicipality()->equals($this->getMunicipality()))
            ) &&
            (
                (null === $this->getState() && null === $object->getState()) ||
                (\is_object($this->getState()) && $this->getState()->equals($object->getState())) ||
                (\is_object($object->getState()) && $object->getState()->equals($this->getState()))
            ) &&
            (
                (null === $this->getCep() && null === $object->getCep()) ||
                (\is_object($this->getCep()) && $this->getCep()->equals($object->getCep())) ||
                (\is_object($object->getCep()) && $object->getCep()->equals($this->getCep()))
            ) &&
            (
                (null === $this->getCountry() && null === $object->getCountry()) ||
                (\is_object($this->getCountry()) && $this->getCountry()->equals($object->getCountry())) ||
                (\is_object($object->getCountry()) && $object->getCountry()->equals($this->getCountry()))
            )
        );
    }

    public function getAddress() : string
    {
        if ($this->formattedAddress !== null) {
            return $this->formattedAddress;
        }

        $street       = $this->getStreet() ? $this->getStreet()->getFormatted() : '';
        $municipality = $this->getMunicipality() ? $this->getMunicipality()->getFormatted() : '';
        $state        = $this->getState() ? $this->getState()->__toString() : '';
        $postalCode   = $this->getPostalCode() ? $this->getPostalCode()->getFormatted() : '';
        $country      = $this->getCountry() ? $this->getCountry()->__toString() : '';

        $values = [$street, $municipality, $state, $postalCode, $country];
        $nonEmptyValues = [];
        foreach ($values as $value) {
            if($value !== ''){
                $nonEmptyValues[] = $value;
            }
        }

        $formatted = implode(', ', $nonEmptyValues);

        return StringUtils::trimSpacesWisely($formatted);

The expression return Talentify\ValueObject\StringUtils::trimSpacesWisely($formatted) could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    public function __toString() : string
    {
        return $this->getAddress();
    }
}