KamranAhmed\Geocode\Location

Complexity

Total Complexity

48

Size/Duplication

Total Lines	364
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Test Coverage

Coverage

78.67%

Importance

Changes	3
Bugs	0	Features	0

20 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	isValid()	0	4	1
C	populateDetail()	0	43	12
A	getAddress()	0	4	2
A	getLatitude()	0	4	2
A	getLongitude()	0	4	2
A	getCountry()	0	4	2
A	getShortCountry()	0	4	2
A	getLocality()	0	4	2
A	getShortLocality()	0	4	2
A	getDistrict()	0	4	2
A	getShortDistrict()	0	4	2
A	getPostcode()	0	4	2
A	getTown()	0	4	2
A	getShortTown()	0	4	2
A	getStreetNumber()	0	4	2
A	getNeighborhood()	0	4	2
A	getShortNeighborhood()	0	4	2
A	getStreetAddress()	0	4	2
A	getShortStreetAddress()	0	4	2

<?php
namespace KamranAhmed\Geocode;

/**
 * Location
 *
 * Represents the location details obtained from the Geocoding
 * Service
 */
class Location
{
    /**
     * @var string Address to which the detail belong
     */
    private $address = '';

    /**
     * @var string Latitude of the location
     */
    private $latitude = '';

    /**
     * @var string Longitude of the location
     */
    private $longitude = '';

    /**
     * @var string Country of the location
     */
    private $country = '';

    /**
     * @var string Locality of the location
     */
    private $locality = '';

    /**
     * @var string District of the location
     */
    private $district = '';

    /**
     * @var string Postal code of the location
     */
    private $postcode = '';

    /**
     * @var string Town of the location
     */
    private $town = '';

    /**
     * @var string Street number
     */
    private $streetNumber = '';

    /**
     * @var string Street address
     */
    private $streetAddress = '';

    /**
     * @var string Neighborhood address
     */
    private $neighborhood = '';

    /**
     * @var string Short Country of the location
     */
    private $shortCountry = '';

    /**
     * @var string Short Locality of the location
     */
    private $shortLocality = '';

    /**
     * @var string Short District of the location
     */
    private $shortDistrict = '';

    /**
     * @var string Short Town of the location
     */
    private $shortTown = '';

    /**
     * @var string Short Street address
     */
    private $shortStreetAddress = '';

    /**
     * @var string Short Neighborhood address
     */
    private $shortNeighborhood = '';

    /**
     * @var boolean Whether the location is valid or not
     */
    private $isValid = true;

    /**
     * Create a new Location object
     *
     * @param string    $address         Address whose detail it is
     * @param \stdClass $dataFromService The data retrieved from the Geocoding service
     */
    public function __construct($address, \stdClass $dataFromService)
    {
        $this->address = $address;
        $this->populateDetail($dataFromService);
    }

    /**
     * Checks whether the data passed to the class was valid
     *
     * @return boolean True if the data is valid and false otherwise
     */
    public function isValid()
    {
        return $this->isValid;
    }

    /**
     * Populates the object with the detail from the service
     *
     * @param \stdClass $locationDetail The address detail i.e. which was retrieved from the API
     *
     * @return boolean          True if successfully populated the detail and false otherwise
     */
    private function populateDetail(\stdClass $locationDetail)
    {
        // The data from the API is returned under the `results` key
        if (!property_exists($locationDetail, 'results')) {
            $this->isValid = false;

            return false;
        }

        $this->latitude  = $locationDetail->results[0]->geometry->location->lat;
        $this->longitude = $locationDetail->results[0]->geometry->location->lng;

        foreach ($locationDetail->results[0]->address_components as $component) {
            if (in_array('street_number', $component->types)) {
                $this->streetNumber = $component->long_name;
            } elseif (in_array('locality', $component->types)) {
                $this->locality = $component->long_name;
                $this->shortLocality = $component->short_name;
            } elseif (in_array('postal_town', $component->types)) {
                $this->town = $component->long_name;
                $this->shortTown = $component->short_name;
            } elseif (in_array('administrative_area_level_2', $component->types)) {
                $this->country = $component->long_name;
                $this->shortCountry = $component->short_name;
            } elseif (in_array('country', $component->types)) {
                $this->country = $component->long_name;
                $this->shortCountry = $component->short_name;
            } elseif (in_array('administrative_area_level_1', $component->types)) {
                $this->district = $component->long_name;
                $this->shortDistrict = $component->short_name;
            } elseif (in_array('postal_code', $component->types)) {
                $this->postcode = $component->long_name;
            } elseif (in_array('route', $component->types)) {
                $this->streetAddress = $component->long_name;
                $this->shortStreetAddress = $component->short_name;
            } elseif (in_array('political', $component->types)) {
                $this->neighborhood = $component->long_name;
                $this->shortNeighborhood = $component->short_name;
            }
        }

        return true;
    }

    /**
     * Gets the address
     *
     * @param string $default
     *
     * @return string
     */
    public function getAddress($default = '')
    {
        return $this->address ?: $default;
    }

    /**
     * Gets the latitude of the location
     *
     * @param string $default
     *
     * @return string
     */
    public function getLatitude($default = '')
    {
        return $this->latitude ?: $default;
    }

    /**
     * Gets the longitude of the location
     *
     * @param string $default
     *
     * @return string
     */
    public function getLongitude($default = '')
    {
        return $this->longitude ?: $default;
    }

    /**
     * Gets the country of the location
     *
     * @param string $default
     *
     * @return string
     */
    public function getCountry($default = '')
    {
        return $this->country ?: $default;
    }

    /**
     * Gets the short country of the location
     *
     * @param string $default
     *
     * @return string
     */
    public function getShortCountry($default = '')
    {
        return $this->shortCountry ?: $default;
    }

    /**
     * Gets the locality of the location
     *
     * @param string $default
     *
     * @return string
     */
    public function getLocality($default = '')
    {
        return $this->locality ?: $default;
    }
    /**
     * Gets the short locality of the location
     *
     * @param string $default
     *
     * @return string
     */
    public function getShortLocality($default = '')
    {
        return $this->shortLocality ?: $default;
    }

    /**
     * Gets the district of the location
     *
     * @param string $default
     *
     * @return string
     */
    public function getDistrict($default = '')
    {
        return $this->district ?: $default;
    }
    /**
     * Gets the short district of the location
     *
     * @param string $default
     *
     * @return string
     */
    public function getShortDistrict($default = '')
    {
        return $this->shortDistrict ?: $default;
    }

    /**
     * Gets the post code for the location
     *
     * @param string $default
     *
     * @return string
     */
    public function getPostcode($default = '')
    {
        return $this->postcode ?: $default;
    }

    /**
     * Gets the town for the location
     *
     * @param string $default
     *
     * @return string
     */
    public function getTown($default = '')
    {
        return $this->town ?: $default;
    }
    /**
     * Gets the short town of the location
     *
     * @param string $default
     *
     * @return string
     */
    public function getShortTown($default = '')
    {
        return $this->shortTown ?: $default;
    }

    /**
     * Gets the street number for the location
     *
     * @param string $default
     *
     * @return string
     */
    public function getStreetNumber($default = '')
    {
        return $this->streetNumber ?: $default;
    }

    /**
     * Gets the street address
     *
     * @param string $default
     *
     * @return string
     */
    public function getStreetAddress($default = '')
    {
        return $this->streetAddress ?: $default;
    }
    /**
     * Gets the short street address of the location
     *
     * @param string $default
     *
     * @return string
     */
    public function getShortStreetAddress($default = '')
    {
        return $this->shortStreetAddress ?: $default;
    }

    /**
     * Gets the neighborhood address
     *
     * @param string $default
     *
     * @return string
     */
    public function getNeighborhood($default = '')
    {
        return $this->neighborhood ?: $default;
    }
    /**
     * Gets the short neighborhood address of the location
     *
     * @param string $default
     *
     * @return string
     */
    public function getShortNeighborhood($default = '')
    {
        return $this->shortNeighborhood ?: $default;
    }
}