DDD\Embeddable\GeoPoint

Complexity

Total Complexity

14

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	13	7
A	toArray()	0	4	2
A	jsonSerialize()	0	4	1
A	__toString()	0	8	2
A	toElastic()	0	11	2

<?php
/**
 * Represents a latitude and longitude pair.
 * 
 * @author  M. Yilmaz SUSLU <yilmazsuslu@gmail.com>
 * @license MIT
 *
 * @since   Sep 2016
 */
namespace DDD\Embeddable;

use Doctrine\ORM\Mapping as ORM;
use JsonSerializable;

/**
 * @ORM\Embeddable
 */
class GeoPoint implements JsonSerializable
{
    /**
     * geo point value, stored as associative array
     *
     * @ORM\Column(type="array", nullable=true)
     * 
     * @var array
     */
    private $point;

    /**
     * Constructor
     *
     * @param float $lat Latitude
     * @param float $lng Longitude
     */
    public function __construct($lat = null, $lng = null)
    {
        if ($lat && $lng) {
            if ($lat < -90.0 || $lat > 90.0 || $lng < -180.0 || $lng > 180.0) {
                throw new \InvalidArgumentException('Given latitude longitude pair is invalid.');
            }

            $this->point = [
                'lat' => (float) $lat,
                'lng' => (float) $lng,
            ];
        }
    }

    /**
     * return elasticsearch-friendly geo point format.
     *
     * Beware: Elastic uses lat/lon as keys. Google uses lat/lng.
     * 
     * @return array
     */
    public function toElastic()
    {
        if (empty($this->point)) {
            return [];
        }

        return [
            'lat' => $this->point['lat'],
            'lon' => $this->point['lng'],
        ];
    }

    /**
     * Array representation of the geo point
     * 
     * @return array
     */
    public function toArray()
    {
        return $this->point ?: [];
    }

    /**
     * Implement json serializable interface.
     * 
     * @return array
     */
    public function jsonSerialize()
    {
        return $this->toArray();
    }

    /**
     * String representation of the point, lat lng order, separated by a space.
     * 
     * @return string
     */
    public function __toString()
    {
        if (empty($this->point)) {
            return '';
        }

        return $this->point['lat'].' '.$this->point['lng'];
    }
}