nicolopignatelli / valueobjects

src/Geography/Street.php

<?php

namespace ValueObjects\Geography;

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

class Street implements ValueObjectInterface
{
    /** @var StringLiteral */
    protected $name;

    /** @var StringLiteral */
    protected $number;

    /** @var StringLiteral Building, floor and unit */
    protected $elements;

    /**
     * @var StringLiteral __toString() format
     * Use properties corresponding placeholders: %name%, %number%, %elements%
     */
    protected $format;

    /**
     * Returns a new Street from native PHP string name and number.
     *
     * @param string $name

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

     * @param string $number

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

     * @param string $elements

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

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

        if (\count($args) < 2) {
            throw new \BadMethodCallException('You must provide from 2 to 4 arguments: 1) street name, 2) street number, 3) elements, 4) format (optional)');
        }

        $nameString     = $args[0];
        $numberString   = $args[1];
        $elementsString = isset($args[2]) ? $args[2] : null;
        $formatString   = isset($args[3]) ? $args[3] : null;

        $name     = new StringLiteral($nameString);
        $number   = new StringLiteral($numberString);
        $elements = $elementsString ? new StringLiteral($elementsString) : null;
        $format   = $formatString ? new StringLiteral($formatString) : null;

        return new static($name, $number, $elements, $format);
    }

    /**
     * Returns a new Street object
     *
     * @param StringLiteral $name
     * @param StringLiteral $number
     */
    public function __construct(StringLiteral $name, StringLiteral $number, StringLiteral $elements = null, StringLiteral $format = null)
    {
        $this->name     = $name;
        $this->number   = $number;

        if ($elements === null) {
            $elements = new StringLiteral('');
        }
        $this->elements = $elements;

        if ($format === null) {
            $format = new StringLiteral('%number% %name%');
        }
        $this->format   = $format;
    }

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

        return $this->getName()->sameValueAs($street->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->getNumber()->sameValueAs($street->getNumber()) &&

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

               $this->getElements()->sameValueAs($street->getElements())

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

        ;
    }

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

    /**
     * Returns street number
     *
     * @return StringLiteral
     */
    public function getNumber()
    {
        return clone $this->number;
    }

    /**
     * Returns street elements
     * @return StringLiteral
     */
    public function getElements()
    {
        return clone $this->elements;
    }

    /**
     * Returns a string representation of the StringLiteral in the format defined in the constructor
     *
     * @return string
     */
    public function __toString()
    {
        $replacements = array(
            "%name%"     => $this->getName(),
            "%number%"   => $this->getNumber(),
            "%elements%" => $this->getElements()
        );

        $streetString = str_replace(array_keys($replacements), array_values($replacements), $this->format);

        return $streetString;
    }
}