Arcanedev\GeoLocation\Calculators\DistanceCalculator

Complexity

Total Complexity

5

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	create()	0	4	2
A	distance()	0	4	1
A	calculate()	0	23	1

<?php namespace Arcanedev\GeoLocation\Calculators;

use Arcanedev\GeoLocation\Contracts\Calculators\DistanceCalculator as DistanceCalculatorContract;
use Arcanedev\GeoLocation\Contracts\Entities\Coordinates\Position;
use Arcanedev\GeoLocation\Contracts\Entities\Sphere;
use Arcanedev\GeoLocation\Entities\Measures\Distance;
use Arcanedev\GeoLocation\Entities\Spheres\Earth;

/**
 * Class     DistanceCalculator
 *
 * @package  Arcanedev\GeoLocation
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
class DistanceCalculator implements DistanceCalculatorContract
{
    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /** @var  \Arcanedev\GeoLocation\Contracts\Entities\Sphere */
    private $sphere;

    /* -----------------------------------------------------------------
     |  Constructor
     | -----------------------------------------------------------------
     */

    /**
     * DistanceCalculator constructor.
     *
     * @param  \Arcanedev\GeoLocation\Contracts\Entities\Sphere  $sphere
     */
    public function __construct(Sphere $sphere)
    {
        $this->sphere = $sphere;
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Create a metric distance calculator, using earth as base sphere.
     *
     * @param  \Arcanedev\GeoLocation\Contracts\Entities\Sphere|null  $sphere
     *
     * @return self
     */
    public static function create($sphere = null)
    {
        return new static($sphere ?: new Earth);
    }

    /**
     * Calculate the distance between two positions.
     *
     * @param  \Arcanedev\GeoLocation\Contracts\Entities\Coordinates\Position  $start
     * @param  \Arcanedev\GeoLocation\Contracts\Entities\Coordinates\Position  $end
     *
     * @return \Arcanedev\GeoLocation\Entities\Measures\Distance
     */
    public function calculate(Position $start, Position $end)
    {
        $deltaLatitude = deg2rad(
            $start->lat()->value() - $end->lat()->value()
        );

        $deltaLongitude = deg2rad(
            $start->lng()->value() - $end->lng()->value()
        );

        $angle = asin(
            sqrt(
                pow(sin($deltaLatitude * 0.5), 2)
                + cos(deg2rad($start->lat()->value()))
                * cos(deg2rad($end->lat()->value()))
                * pow(sin($deltaLongitude * 0.5), 2)
            )
        ) * 2;

        $value = $angle * $this->sphere->radius();

        return new Distance("{$value} meters", $value);
    }

    /**
     * Calculate the numeric distance between two positions.
     *
     * @param  \Arcanedev\GeoLocation\Contracts\Entities\Coordinates\Position  $start
     * @param  \Arcanedev\GeoLocation\Contracts\Entities\Coordinates\Position  $end
     * @param  int                                                             $precision
     *
     * @return float
     */
    public function distance(Position $start, Position $end, $precision = 2)
    {
        return round($this->calculate($start, $end)->value(), $precision);
    }
}