Geocoder\Provider\OpenCage\Model\OpenCageAddress

Complexity

Total Complexity

10

Size/Duplication

Total Lines	140
Duplicated Lines	0 %

Coupling/Cohesion

Components	5
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	withMGRS()	0	7	1
A	getMGRS()	0	4	1
A	withMaidenhead()	0	7	1
A	getMaidenhead()	0	4	1
A	withGeohash()	0	7	1
A	getGeohash()	0	4	1
A	withWhat3words()	0	7	1
A	getWhat3words()	0	4	1
A	withFormattedAddress()	0	7	1
A	getFormattedAddress()	0	4	1

<?php

declare(strict_types=1);

/*
 * This file is part of the Geocoder package.
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @license    MIT License
 */

namespace Geocoder\Provider\OpenCage\Model;

use Geocoder\Model\Address;

final class OpenCageAddress extends Address
{
    /**
     * @var string|null
     *
     * @see https://en.wikipedia.org/wiki/Military_Grid_Reference_System
     */
    private $mgrs;

    /**
     * @var string|null
     *
     * @see https://en.wikipedia.org/wiki/Maidenhead_Locator_System
     */
    private $maidenhead;

    /**
     * @var string|null
     *
     * @see https://en.wikipedia.org/wiki/Geohash
     */
    private $geohash;

    /**
     * @var string|null
     *
     * @see https://what3words.com/
     */
    private $what3words;

    /**
     * @var string|null
     */
    private $formattedAddress;

    /**
     * @param null|string $mgrs
     *
     * @return OpenCageAddress
     */
    public function withMGRS(string $mgrs = null): self
    {
        $new = clone $this;
        $new->mgrs = $mgrs;

        return $new;
    }

    /**
     * @return null|string
     */
    public function getMGRS()
    {
        return $this->mgrs;
    }

    /**
     * @param null|string $maidenhead
     *
     * @return OpenCageAddress
     */
    public function withMaidenhead(string $maidenhead = null): self
    {
        $new = clone $this;
        $new->maidenhead = $maidenhead;

        return $new;
    }

    /**
     * @return null|string
     */
    public function getMaidenhead()
    {
        return $this->maidenhead;
    }

    /**
     * @param null|string $geohash
     *
     * @return OpenCageAddress
     */
    public function withGeohash(string $geohash = null): self
    {
        $new = clone $this;
        $new->geohash = $geohash;

        return $new;
    }

    /**
     * @return null|string
     */
    public function getGeohash()
    {
        return $this->geohash;
    }

    /**
     * @param null|string $what3words
     *
     * @return OpenCageAddress
     */
    public function withWhat3words(string $what3words = null): self
    {
        $new = clone $this;
        $new->what3words = $what3words;

        return $new;
    }

    /**
     * @return null|string
     */
    public function getWhat3words()
    {
        return $this->what3words;
    }

    /**
     * @param string|null $formattedAddress
     *
     * @return OpenCageAddress
     */
    public function withFormattedAddress(string $formattedAddress = null): self
    {
        $new = clone $this;
        $new->formattedAddress = $formattedAddress;

        return $new;
    }

    /**
     * @return null|string
     */
    public function getFormattedAddress()
    {
        return $this->formattedAddress;
    }
}