Address.php

<?php

namespace CommerceGuys\Addressing;

/**
 * Default address implementation.
 *
 * Can be mapped and used by Doctrine (preferably as an embeddable).
 */
class Address implements ImmutableAddressInterface
{
    /**
     * The two-letter country code.
     *
     * @var string
     */
    protected string $countryCode;

    /**
     * The top-level administrative subdivision of the country.
     *
     * @var string
     */
    protected string $administrativeArea;

    /**
     * The locality (i.e. city).
     *
     * @var string
     */
    protected string $locality;

    /**
     * The dependent locality (i.e. neighbourhood).
     *
     * @var string
     */
    protected string $dependentLocality;

    /**
     * The postal code.
     *
     * @var string
     */
    protected string $postalCode;

    /**
     * The sorting code.
     *
     * @var string
     */
    protected string $sortingCode;

    /**
     * The first line of the address block.
     *
     * @var string
     */
    protected string $addressLine1;

    /**
     * The second line of the address block.
     *
     * @var string
     */
    protected string $addressLine2;

    /**
     * The third line of the address block.
     *
     * @var string
     */
    protected string $addressLine3;

    /**
     * The organization.
     *
     * @var string
     */
    protected string $organization;

    /**
     * The given name.
     *
     * @var string
     */
    protected string $givenName;

    /**
     * The additional name
     *
     * @var string
     */
    protected string $additionalName;

    /**
     * The family name.
     *
     * @var string
     */
    protected string $familyName;

    /**
     * The locale.
     *
     * @var string
     */
    protected string $locale;

    /**
     * Creates an Address instance.
     *
     * @param string $countryCode        The two-letter country code.
     * @param string $administrativeArea The administrative area.
     * @param string $locality           The locality.
     * @param string $dependentLocality  The dependent locality.
     * @param string $postalCode         The postal code.
     * @param string $sortingCode        The sorting code
     * @param string $addressLine1       The first line of the address block.
     * @param string $addressLine2       The second line of the address block.
     * @param string $addressLine3       The third line of the address block.
     * @param string $organization       The organization.
     * @param string $givenName          The given name.
     * @param string $additionalName     The additional name.
     * @param string $familyName         The family name.
     * @param string $locale             The locale. Defaults to 'und'.
     */
    public function __construct(
        string $countryCode = '',
        string $administrativeArea = '',
        string $locality = '',
        string $dependentLocality = '',
        string $postalCode = '',
        string $sortingCode = '',
        string $addressLine1 = '',
        string $addressLine2 = '',
        string $addressLine3 = '',
        string $organization = '',
        string $givenName = '',
        string $additionalName = '',
        string $familyName = '',
        string $locale = 'und'
    ) {
        $this->countryCode = $countryCode;
        $this->administrativeArea = $administrativeArea;
        $this->locality = $locality;
        $this->dependentLocality = $dependentLocality;
        $this->postalCode = $postalCode;
        $this->sortingCode = $sortingCode;
        $this->addressLine1 = $addressLine1;
        $this->addressLine2 = $addressLine2;
        $this->addressLine3 = $addressLine3;
        $this->organization = $organization;
        $this->givenName = $givenName;
        $this->additionalName = $additionalName;
        $this->familyName = $familyName;
        $this->locale = $locale;
    }

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

    /**
     * {@inheritdoc}
     */
    public function withCountryCode(string $countryCode): ImmutableAddressInterface|Address
    {
        $new = clone $this;
        $new->countryCode = $countryCode;

        return $new;
    }

    /**
     * {@inheritdoc}
     */
    public function getAdministrativeArea(): string
    {
        return $this->administrativeArea;
    }

    /**
     * {@inheritdoc}
     */
    public function withAdministrativeArea(string $administrativeArea): ImmutableAddressInterface|Address
    {
        $new = clone $this;
        $new->administrativeArea = $administrativeArea;

        return $new;
    }

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

    /**
     * {@inheritdoc}
     */
    public function withLocality(string $locality): ImmutableAddressInterface|Address
    {
        $new = clone $this;
        $new->locality = $locality;

        return $new;
    }

    /**
     * {@inheritdoc}
     */
    public function getDependentLocality(): string
    {
        return $this->dependentLocality;
    }

    /**
     * {@inheritdoc}
     */
    public function withDependentLocality(string $dependentLocality): ImmutableAddressInterface|Address
    {
        $new = clone $this;
        $new->dependentLocality = $dependentLocality;

        return $new;
    }

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

    /**
     * {@inheritdoc}
     */
    public function withPostalCode(string $postalCode): ImmutableAddressInterface|Address
    {
        $new = clone $this;
        $new->postalCode = $postalCode;

        return $new;
    }

    /**
     * {@inheritdoc}
     */
    public function getSortingCode(): string
    {
        return $this->sortingCode;
    }

    /**
     * {@inheritdoc}
     */
    public function withSortingCode(string $sortingCode): ImmutableAddressInterface|Address
    {
        $new = clone $this;
        $new->sortingCode = $sortingCode;

        return $new;
    }

    /**
     * {@inheritdoc}
     */
    public function getAddressLine1(): string
    {
        return $this->addressLine1;
    }

    /**
     * {@inheritdoc}
     */
    public function withAddressLine1(string $addressLine1): ImmutableAddressInterface|Address
    {
        $new = clone $this;
        $new->addressLine1 = $addressLine1;

        return $new;
    }

    /**
     * {@inheritdoc}
     */
    public function getAddressLine2(): string
    {
        return $this->addressLine2;
    }

    /**
     * {@inheritdoc}
     */
    public function withAddressLine2(string $addressLine2): ImmutableAddressInterface|Address
    {
        $new = clone $this;
        $new->addressLine2 = $addressLine2;

        return $new;
    }

    /**
     * {@inheritdoc}
     */
    public function getAddressLine3(): string
    {
        return $this->addressLine3;
    }

    /**
     * {@inheritdoc}
     */
    public function withAddressLine3(string $addressLine3): ImmutableAddressInterface|Address
    {
        $new = clone $this;
        $new->addressLine3 = $addressLine3;

        return $new;
    }

    /**
     * {@inheritdoc}
     */
    public function getOrganization(): string
    {
        return $this->organization;
    }

    /**
     * {@inheritdoc}
     */
    public function withOrganization(string $organization): ImmutableAddressInterface|Address
    {
        $new = clone $this;
        $new->organization = $organization;

        return $new;
    }

    /**
     * {@inheritdoc}
     */
    public function getGivenName(): string
    {
        return $this->givenName;
    }

    /**
     * {@inheritdoc}
     */
    public function withGivenName(string $givenName): ImmutableAddressInterface|Address
    {
        $new = clone $this;
        $new->givenName = $givenName;

        return $new;
    }

    /**
     * {@inheritdoc}
     */
    public function getAdditionalName(): string
    {
        return $this->additionalName;
    }

    /**
     * {@inheritdoc}
     */
    public function withAdditionalName(string $additionalName): ImmutableAddressInterface|Address
    {
        $new = clone $this;
        $new->additionalName = $additionalName;

        return $new;
    }

    /**
     * {@inheritdoc}
     */
    public function getFamilyName(): string
    {
        return $this->familyName;
    }

    /**
     * {@inheritdoc}
     */
    public function withFamilyName(string $familyName): ImmutableAddressInterface|Address
    {
        $new = clone $this;
        $new->familyName = $familyName;

        return $new;
    }

    /**
     * {@inheritdoc}
     */
    public function getLocale(): string
    {
        return $this->locale;
    }

    /**
     * {@inheritdoc}
     */
    public function withLocale(string $locale): ImmutableAddressInterface|Address
    {
        $new = clone $this;
        $new->locale = $locale;

        return $new;
    }
}