nicolopignatelli / valueobjects

src/Geography/Address.php

<?php

namespace ValueObjects\Geography;

use ValueObjects\Util\Util;
use ValueObjects\ValueObjectInterface;
use ValueObjects\StringLiteral\StringLiteral;

class Address implements ValueObjectInterface
{
    /**
     * Name of the addressee (natural person or company)
     * @var StringLiteral
     */
    protected $name;

    /** @var Street */
    protected $street;

    /**
     * District/City area
     * @var StringLiteral
     */
    protected $district;

    /**
     * City/Town/Village
     * @var StringLiteral
     */
    protected $city;

    /**
     * Region/County/State
     * @var StringLiteral
     */
    protected $region;

    /**
     * Postal code/P.O. Box/ZIP code
     * @var StringLiteral
     */
    protected $postalCode;

    /** @var Country */
    protected $country;

    /**
     * Returns a new Address from native PHP arguments
     *
     * @param string $name

There is no parameter named $name. Was it maybe removed?

     * @param string $street_name

There is no parameter named $street_name. Was it maybe removed?

     * @param string $street_number

There is no parameter named $street_number. Was it maybe removed?

     * @param string $district

There is no parameter named $district. Was it maybe removed?

     * @param string $city

There is no parameter named $city. Was it maybe removed?

     * @param string $region

There is no parameter named $region. Was it maybe removed?

     * @param string $postal_code

There is no parameter named $postal_code. Was it maybe removed?

     * @param string $country_code

There is no parameter named $country_code. Was it maybe removed?

     * @return self
     * @throws \BadMethodCallException
     */
    public static function fromNative()
    {
        $args = \func_get_args();

        if (\count($args) != 8) {
            throw new \BadMethodCallException('You must provide exactly 8 arguments: 1) addressee name, 2) street name, 3) street number, 4) district, 5) city, 6) region, 7) postal code, 8) country code.');
        }

        $name       = new StringLiteral($args[0]);
        $street     = new Street(new StringLiteral($args[1]), new StringLiteral($args[2]));
        $district   = new StringLiteral($args[3]);
        $city       = new StringLiteral($args[4]);
        $region     = new StringLiteral($args[5]);
        $postalCode = new StringLiteral($args[6]);
        $country    = Country::fromNative($args[7]);

        return new static($name, $street, $district, $city, $region, $postalCode, $country);
    }

    /**
     * Returns a new Address object
     *
     * @param StringLiteral $name
     * @param Street        $street
     * @param StringLiteral $district
     * @param StringLiteral $city
     * @param StringLiteral $region
     * @param StringLiteral $postalCode
     * @param Country $country
     */
    public function __construct(StringLiteral $name, Street $street, StringLiteral $district, StringLiteral $city, StringLiteral $region, StringLiteral $postalCode, Country $country)
    {
        $this->name       = $name;
        $this->street     = $street;
        $this->district   = $district;
        $this->city       = $city;
        $this->region     = $region;
        $this->postalCode = $postalCode;
        $this->country    = $country;
    }

    /**
     * Tells whether two Address are equal
     *
     * @param  ValueObjectInterface $address
     * @return bool
     */
    public function sameValueAs(ValueObjectInterface $address)
    {
        if (false === Util::classEquals($this, $address)) {
            return false;
        }

        return $this->getName()->sameValueAs($address->getName())             &&

It seems like you code against a concrete implementation and not the interface ValueObjects\ValueObjectInterface as the method getName() does only exist in the following implementations of said interface: ValueObjects\DateTime\Month, ValueObjects\DateTime\TimeZone, ValueObjects\DateTime\WeekDay, ValueObjects\Enum\Enum, ValueObjects\Geography\Address, ValueObjects\Geography\Continent, ValueObjects\Geography\Country, ValueObjects\Geography\CountryCode, ValueObjects\Geography\DistanceFormula, ValueObjects\Geography\DistanceUnit, ValueObjects\Geography\Ellipsoid, ValueObjects\Geography\Street, ValueObjects\Money\CurrencyCode, ValueObjects\Number\RoundingMode, ValueObjects\Person\Gender, ValueObjects\Web\IPAddressVersion.

               $this->getStreet()->sameValueAs($address->getStreet())         &&

It seems like you code against a concrete implementation and not the interface ValueObjects\ValueObjectInterface as the method getStreet() does only exist in the following implementations of said interface: ValueObjects\Geography\Address.

               $this->getDistrict()->sameValueAs($address->getDistrict())     &&

It seems like you code against a concrete implementation and not the interface ValueObjects\ValueObjectInterface as the method getDistrict() does only exist in the following implementations of said interface: ValueObjects\Geography\Address.

               $this->getCity()->sameValueAs($address->getCity())             &&

It seems like you code against a concrete implementation and not the interface ValueObjects\ValueObjectInterface as the method getCity() does only exist in the following implementations of said interface: ValueObjects\Geography\Address.

               $this->getRegion()->sameValueAs($address->getRegion())         &&

It seems like you code against a concrete implementation and not the interface ValueObjects\ValueObjectInterface as the method getRegion() does only exist in the following implementations of said interface: ValueObjects\Geography\Address.

               $this->getPostalCode()->sameValueAs($address->getPostalCode()) &&

It seems like you code against a concrete implementation and not the interface ValueObjects\ValueObjectInterface as the method getPostalCode() does only exist in the following implementations of said interface: ValueObjects\Geography\Address.

               $this->getCountry()->sameValueAs($address->getCountry())

It seems like you code against a concrete implementation and not the interface ValueObjects\ValueObjectInterface as the method getCountry() does only exist in the following implementations of said interface: ValueObjects\Geography\Address.

        ;
    }

    /**
     * Returns addressee name
     *
     * @return StringLiteral
     */
    public function getName()
    {
        return clone $this->name;
    }

    /**
     * Returns street
     *
     * @return Street
     */
    public function getStreet()
    {
        return clone $this->street;
    }

    /**
     * Returns district
     *
     * @return StringLiteral
     */
    public function getDistrict()
    {
        return clone $this->district;
    }

    /**
     * Returns city
     *
     * @return StringLiteral
     */
    public function getCity()
    {
        return clone $this->city;
    }

    /**
     * Returns region
     *
     * @return StringLiteral
     */
    public function getRegion()
    {
        return clone $this->region;
    }

    /**
     * Returns postal code
     *
     * @return StringLiteral
     */
    public function getPostalCode()
    {
        return clone $this->postalCode;
    }

    /**
     * Returns country
     *
     * @return Country
     */
    public function getCountry()
    {
        return clone $this->country;
    }

    /**
     * Returns a string representation of the Address in US standard format.
     *
     * @return string
     */
    public function __toString()
    {
        $format = <<<ADDR
%s
%s
%s %s %s
%s
ADDR;

        $addressString = \sprintf($format, $this->getName(), $this->getStreet(), $this->getCity(), $this->getRegion(), $this->getPostalCode(), $this->getCountry());

        return $addressString;
    }
}