Location\Factory\CoordinateFactory

Complexity

Total Complexity

24

Size/Duplication

Total Lines	151
Duplicated Lines	7.95 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	3
Bugs	1	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
B	fromString()	0	30	5
A	parseDecimalMinutesWithoutCardinalLetters()	0	14	4
B	parseDecimalMinutesWithCardinalLetters()	6	20	6
A	parseDecimalDegreesWithoutCardinalLetters()	0	10	2
B	parseDecimalDegreesWithCardinalLetters()	6	19	6
A	mergeSecondsToMinutes()	0	6	1

<?php
declare(strict_types=1);

/**
 * Coordinate Factory
 *
 * @author   Marcus Jaschen <mjaschen@gmail.com>
 * @license  https://opensource.org/licenses/MIT
 * @link     https://github.com/mjaschen/phpgeo
 */

namespace Location\Factory;

use Location\Coordinate;
use Location\Ellipsoid;

/**
 * Coordinate Factory
 *
 * @author   Marcus Jaschen <mjaschen@gmail.com>
 * @license  https://opensource.org/licenses/MIT
 * @link     https://github.com/mjaschen/phpgeo
 */
class CoordinateFactory implements GeometryFactoryInterface
{
    /**
     * Creates a Coordinate instance from the given string.
     *
     * The string is parsed by a regular expression for a known
     * format of geographical coordinates.
     *
     * @param string $string formatted geographical coordinate
     * @param \Location\Ellipsoid $ellipsoid
     *
     * @return Coordinate
     * @throws \InvalidArgumentException
     */
    public static function fromString(string $string, Ellipsoid $ellipsoid = null): Coordinate
    {
        $string = self::mergeSecondsToMinutes($string);

        $result = self::parseDecimalMinutesWithoutCardinalLetters($string, $ellipsoid);

It seems like $string defined by self::mergeSecondsToMinutes($string) on line 40 can also be of type array<integer,string> or null; however, Location\Factory\CoordinateFactory::parseDecimalMinutesWithoutCardinalLetters() does only seem to accept string, maybe add an additional type check?

        if ($result instanceof Coordinate) {
            return $result;
        }

        $result = self::parseDecimalMinutesWithCardinalLetters($string, $ellipsoid);

It seems like $string defined by self::mergeSecondsToMinutes($string) on line 40 can also be of type array<integer,string> or null; however, Location\Factory\CoordinateFactory::parseDecimalMinutesWithCardinalLetters() does only seem to accept string, maybe add an additional type check?

        if ($result instanceof Coordinate) {
            return $result;
        }

        $result = self::parseDecimalDegreesWithoutCardinalLetters($string, $ellipsoid);

It seems like $string defined by self::mergeSecondsToMinutes($string) on line 40 can also be of type array<integer,string> or null; however, Location\Factory\CoordinateFactory::parseDecimalDegreesWithoutCardinalLetters() does only seem to accept string, maybe add an additional type check?

        if ($result instanceof Coordinate) {
            return $result;
        }

        $result = self::parseDecimalDegreesWithCardinalLetters($string, $ellipsoid);

It seems like $string defined by self::mergeSecondsToMinutes($string) on line 40 can also be of type array<integer,string> or null; however, Location\Factory\CoordinateFactory::parseDecimalDegreesWithCardinalLetters() does only seem to accept string, maybe add an additional type check?

        if ($result instanceof Coordinate) {
            return $result;
        }

        throw new \InvalidArgumentException('Format of coordinates was not recognized');
    }

    /**
     * @param $string
     * @param $ellipsoid
     *
     * @return Coordinate|null
     * @throws \InvalidArgumentException
     */
    private static function parseDecimalMinutesWithoutCardinalLetters(string $string, Ellipsoid $ellipsoid = null)
    {
        // Decimal minutes without cardinal letters, e. g. "52 12.345, 13 23.456",
        // "52° 12.345, 13° 23.456", "52° 12.345′, 13° 23.456′", "52 12.345 N, 13 23.456 E",
        // "N52° 12.345′ E13° 23.456′"
        if (preg_match('/(-?\d{1,2})°?\s+(\d{1,2}\.?\d*)[\'′]?[, ]\s*(-?\d{1,3})°?\s+(\d{1,2}\.?\d*)[\'′]?/ui', $string, $match)) {
            $latitude = $match[1] >= 0 ? $match[1] + $match[2] / 60 : $match[1] - $match[2] / 60;
            $longitude = $match[3] >= 0 ? $match[3] + $match[4] / 60 : $match[3] - $match[4] / 60;

            return new Coordinate((float)$latitude, (float)$longitude, $ellipsoid);
        }

        return null;
    }

    /**
     * @param $string
     * @param $ellipsoid
     *
     * @return Coordinate|null
     * @throws \InvalidArgumentException
     */
    private static function parseDecimalMinutesWithCardinalLetters(string $string, Ellipsoid $ellipsoid = null)
    {
        // Decimal minutes with cardinal letters, e. g. "52 12.345, 13 23.456",
        // "52° 12.345, 13° 23.456", "52° 12.345′, 13° 23.456′", "52 12.345 N, 13 23.456 E",
        // "N52° 12.345′ E13° 23.456′"
        if (preg_match('/([NS]?\s*)(\d{1,2})°?\s+(\d{1,2}\.?\d*)[\'′]?(\s*[NS]?)[, ]\s*([EW]?\s*)(\d{1,3})°?\s+(\d{1,2}\.?\d*)[\'′]?(\s*[EW]?)/ui', $string, $match)) {
            $latitude = $match[2] + $match[3] / 60;
            if (strtoupper(trim($match[1])) === 'S' || strtoupper(trim($match[4])) === 'S') {

This code seems to be duplicated across your project.

                $latitude = - $latitude;
            }
            $longitude = $match[6] + $match[7] / 60;
            if (strtoupper(trim($match[5])) === 'W' || strtoupper(trim($match[8])) === 'W') {

This code seems to be duplicated across your project.

                $longitude = - $longitude;
            }

            return new Coordinate((float)$latitude, (float)$longitude, $ellipsoid);
        }

        return null;
    }

    /**
     * @param $string
     * @param $ellipsoid
     *
     * @return Coordinate|null
     * @throws \InvalidArgumentException
     */
    private static function parseDecimalDegreesWithoutCardinalLetters(string $string, Ellipsoid $ellipsoid = null)
    {
        // The most simple format: decimal degrees without cardinal letters,
        // e. g. "52.5, 13.5" or "53.25732 14.24984"
        if (preg_match('/(-?\d{1,2}\.?\d*)°?[, ]\s*(-?\d{1,3}\.?\d*)°?/u', $string, $match)) {
            return new Coordinate((float)$match[1], (float)$match[2], $ellipsoid);
        }

        return null;
    }

    /**
     * @param $string
     * @param $ellipsoid
     *
     * @return Coordinate|null
     * @throws \InvalidArgumentException
     */
    private static function parseDecimalDegreesWithCardinalLetters(string $string, Ellipsoid $ellipsoid = null)
    {
        // Decimal degrees with cardinal letters, e. g. "N52.5, E13.5",
        // "40.2S, 135.3485W", or "56.234°N, 157.245°W"
        if (preg_match('/([NS]?\s*)(\d{1,2}\.?\d*)°?(\s*[NS]?)[, ]\s*([EW]?\s*)(\d{1,3}\.?\d*)°?(\s*[EW]?)/ui', $string, $match)) {
            $latitude = $match[2];
            if (strtoupper(trim($match[1])) === 'S' || strtoupper(trim($match[3])) === 'S') {

This code seems to be duplicated across your project.

                $latitude = - $latitude;
            }
            $longitude = $match[5];
            if (strtoupper(trim($match[4])) === 'W' || strtoupper(trim($match[6])) === 'W') {

This code seems to be duplicated across your project.

                $longitude = - $longitude;
            }

            return new Coordinate((float)$latitude, (float)$longitude, $ellipsoid);
        }

        return null;
    }

    /**
     * @param string $string
     * @return null|string|string[]
     */
    private static function mergeSecondsToMinutes(string $string)
    {
        return preg_replace_callback('/(\d+)(°|\s)\s*(\d+)(\'|′|\s)(\s*([0-9\.]*))("|\'\'|′′)?/', function (array $matches) {
            return sprintf('%d %d.%s', $matches[1], $matches[3], substr(sprintf('%f', floatval($matches[6]) / 60), 2));
        }, $string);
    }
}