https://github.com/ixnode/php-coordinate

This library offers a collection of various PHP coordinate classes like Coordinate, etc. It converts various coordinate strings and values into a unique format.
https://github.com/ixnode/php-coordinate
Last synced: about 1 year ago
JSON representation
This library offers a collection of various PHP coordinate classes like Coordinate, etc. It converts various coordinate strings and values into a unique format.
Host: GitHub
URL: https://github.com/ixnode/php-coordinate
Owner: ixnode
License: mit
Created: 2023-07-03T18:52:35.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2024-12-07T11:56:11.000Z (over 1 year ago)
Last Synced: 2025-03-25T05:51:14.435Z (about 1 year ago)
Language: PHP
Size: 217 KB
Stars: 3
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project

README

          # PHP Coordinate

[![Release](https://img.shields.io/github/v/release/ixnode/php-coordinate)](https://github.com/ixnode/php-coordinate/releases)

[![](https://img.shields.io/github/release-date/ixnode/php-coordinate)](https://github.com/ixnode/php-coordinate/releases)

![](https://img.shields.io/github/repo-size/ixnode/php-coordinate.svg)

[![PHP](https://img.shields.io/badge/PHP-^8.2-777bb3.svg?logo=php&logoColor=white&labelColor=555555&style=flat)](https://www.php.net/supported-versions.php)

[![PHPStan](https://img.shields.io/badge/PHPStan-Level%20Max-777bb3.svg?style=flat)](https://phpstan.org/user-guide/rule-levels)

[![PHPUnit](https://img.shields.io/badge/PHPUnit-Unit%20Tests-6b9bd2.svg?style=flat)](https://phpunit.de)

[![PHPCS](https://img.shields.io/badge/PHPCS-PSR12-416d4e.svg?style=flat)](https://www.php-fig.org/psr/psr-12/)

[![PHPMD](https://img.shields.io/badge/PHPMD-ALL-364a83.svg?style=flat)](https://github.com/phpmd/phpmd)

[![Rector - Instant Upgrades and Automated Refactoring](https://img.shields.io/badge/Rector-PHP%208.2-73a165.svg?style=flat)](https://github.com/rectorphp/rector)

[![LICENSE](https://img.shields.io/github/license/ixnode/php-api-version-bundle)](https://github.com/ixnode/php-api-version-bundle/blob/master/LICENSE)

> This library offers a collection of various PHP coordinate classes like Coordinate, etc.

> It converts various coordinate strings and values into a unique format.

## 1. Usage

```php

use Ixnode\PhpCoordinate\Coordinate;

```

### 1.1 Converter example

```php

$coordinate = new Coordinate(51.0504, 13.7373);

print $coordinate->getLatitudeDMS();

// (string) 51°3′1.44″N

print $coordinate->getLongitudeDMS();

// (string) 13°44′14.28″E

```

### 1.2 Parser example

```php

$coordinate = new Coordinate('51°3′1.44″N 13°44′14.28″E');

print $coordinate->getLatitude();

// (float) 51.0504

print $coordinate->getLongitude();

// (float) 13.7373

```

### 1.3 Distance example

```php

$coordinateDresden = new Coordinate('51°3′1.44″N 13°44′14.28″E');

$coordinateCordoba = new Coordinate(-31.425299, -64.201743);

/* Distance between Dresden, Germany and Córdoba, Argentina */

print $coordinate->getDistance($coordinateCordoba, Coordinate::RETURN_KILOMETERS);

// (float) 11904.668

```

### 1.4 Direction example (degree)

```php

$coordinateDresden = new Coordinate('51°3′1.44″N 13°44′14.28″E');

$coordinateCordoba = new Coordinate(-31.425299, -64.201743);

/* Direction in degrees from Dresden, Germany to Córdoba, Argentina */

print $coordinateDresden->getDegree($coordinateCordoba);

// (float) -136.62°

```

### 1.5 Direction example (cardinal direction)

```php

$coordinateDresden = new Coordinate('51°3′1.44″N 13°44′14.28″E');

$coordinateCordoba = new Coordinate(-31.425299, -64.201743);

/* Direction in degrees from Dresden, Germany to Córdoba, Argentina */

print $coordinateDresden->getDirection($coordinateCordoba);

// (string) SW

```

## 2. Parser

### 2.1 Basic decimal degree parser

#### 2.1.1 Parser formats

| Given value (string)              | Latitude (float) | Longitude (float) | Place              |

|-----------------------------------|------------------|-------------------|--------------------|

| `"51.0504,13.7373"`               | _51.0504_        | _13.7373_         | Dresden, Germany   |

| `"51.0504, 13.7373"`              | _51.0504_        | _13.7373_         | Dresden, Germany   |

| `"51.0504 13.7373"`               | _51.0504_        | _13.7373_         | Dresden, Germany   |

| `"POINT(-31.425299, -64.201743)"` | _-31.425299_     | _-64.201743_      | Córdoba, Argentina |

| `"POINT(-31.425299 -64.201743)"`  | _-31.425299_     | _-64.201743_      | Córdoba, Argentina |

#### 2.1.2 Code example

```php

$coordinate = new Coordinate('51.0504 13.7373');

print $coordinate->getLatitude();

// (float) 51.0504

print $coordinate->getLongitude();

// (float) 13.7373

```

### 2.2 Basic DMS Parser

#### 2.2.1 Parser formats

| Given value (string)                       | Latitude (float) | Longitude (float) | Place              |

|--------------------------------------------|------------------|-------------------|--------------------|

| `"51°3′1.44″N,13°44′14.28″E"`              | _51.0504_        | _13.7373_         | Dresden, Germany   |

| `"51°3′1.44″N, 13°44′14.28″E"`             | _51.0504_        | _13.7373_         | Dresden, Germany   |

| `"51°3′1.44″N 13°44′14.28″E"`              | _51.0504_        | _13.7373_         | Dresden, Germany   |

| `"POINT(31°25′31.0764″S, 64°12′6.2748″W)"` | _-31.425299_     | _-64.201743_      | Córdoba, Argentina |

| `"POINT(31°25′31.0764″S 64°12′6.2748″W)"`  | _-31.425299_     | _-64.201743_      | Córdoba, Argentina |

#### 2.2.2 Code example

```php

$coordinate = new Coordinate('51°3′1.44″N 13°44′14.28″E');

print $coordinate->getLatitude();

// (float) 51.0504

print $coordinate->getLongitude();

// (float) 13.7373

```

### 2.3 Google Url Parser Parser

#### 2.3.1 Parser formats

| Given value (string)                                   | Latitude (float) | Longitude (float) | Place            |

|--------------------------------------------------------|------------------|-------------------|------------------|

| Copied Google Maps Short Url¹⁾ | _54.07304830_    | _18.992402_       | Malbork, Poland  |

| Copied Google Maps Link²⁾      | _51.31237_       | _12.4132924_      | Leipzig, Germany |

* ¹⁾ [Copied Google Maps Short Url](https://maps.app.goo.gl/PHq5axBaDdgRWj4T6)

* ²⁾ [Copied Google Maps Link](https://www.google.com/maps/place/V%C3%B6lkerschlachtdenkmal,+04277+Leipzig/@51.3123709,12.4132924,17z/data=!3m1!4b1!4m6!3m5!1s0x47a6f9a9d013ca23:0x277b49a142da988c!8m2!3d51.3123709!4d12.4132924!16s%2Fg%2F12ls2f87w?entry=ttu)

#### 2.3.2 Code example

```php

$coordinate = new Coordinate('https://maps.app.goo.gl/PHq5axBaDdgRWj4T6');

print $coordinate->getLatitude();

// (float) 54.07304830

print $coordinate->getLongitude();

// (float) 18.992402

```

## 3. Converter

### 3.1 Methods of class `Coordinate`

| Method                 | Type     | Parameter(s)                                           | Description                                                                                                      | Example                                                                                                                    |

|------------------------|----------|--------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|

| `getLatitude`          | _float_  | ---                                                    | Returns the decimal degree presentation of latitude value.                                                       | _-31.425299_                                                                                                               |

| `getLongitude`         | _float_  | ---                                                    | Returns the decimal degree presentation of longitude value.                                                      | _-64.201743_                                                                                                               |

| `getLatitudeDD`        | _float_  | ---                                                    | Alias of `getLatitude`.                                                                                          | _-31.425299_                                                                                                               |

| `getLongitudeDD`       | _float_  | ---                                                    | Alias of `getLongitude`.                                                                                         | _-64.201743_                                                                                                               |

| `getLatitudeDMS`       | _string_ | ---                                                    | Returns the dms representation of the latitude value.                                                            | `"31°25′31.0764″S"`                                                                                                        |

| `getLongitudeDMS`      | _string_ | ---                                                    | Returns the dms representation of the longitude value.                                                           | `"64°12′6.2748″W"`                                                                                                         |

| `getLatitudeDMS`       | _string_ | `CoordinateValue::FORMAT_DMS_SHORT_2`                  | Returns the dms representation of the latitude value (v2).                                                       | `"S31°25′31.0764″"`                                                                                                        |

| `getLongitudeDMS`      | _string_ | `CoordinateValue::FORMAT_DMS_SHORT_2`                  | Returns the dms representation of the longitude value (v2).                                                      | `"W64°12′6.2748″"`                                                                                                         |

| `getDistance`          | _float_  | `new Coordinate()`, `meters` (default) or `kilometers` | Returns the distance to given second Coordinate instance.                                                        | _11904.668_                                                                                                                |

| `getDegree`            | _float_  | `new Coordinate()`                                     | Returns the direction (degree) to given second Coordinate instance (0° - North, 90° - East, etc.).               | _-136.62_                                                                                                                  |

| `getDirection`         | _string_ | `new Coordinate()`                                     | Returns the cardinal direction to given second Coordinate instance (`N`, `NE`, `E`, `SE`, `S`, `SW`, `W`, `NW`). | `"SW"`                                                                                                                     |

| `getLinkGoogle`        | _string_ | `false` (default - as decimal) or `true` (as DMS)      | Returns the link to Google.                                                                                      | [Google](https://www.google.de/maps/place/51.050400+13.737300)                                                             |

| `getLinkOpenStreetMap` | _string_ | ---                                                    | Returns the link to OpenStreetMap.                                                                               | [OpenStreetMap](https://www.openstreetmap.org/?lat=51.050400&lon=13.737300&mlat=51.050400&mlon=13.737300&zoom=14&layers=M) |

### 3.2 Code example

```php

$coordinate = new Coordinate('-31.425299, -64.201743');

print $coordinate->getLatitudeDMS();

// (string) "31°25′31.0764″S"

print $coordinate->getLongitudeDMS();

// (string) "64°12′6.2748″W"

```

## 4. Installation

```bash

composer require ixnode/php-coordinate

```

```bash

vendor/bin/php-coordinate -V

```

```bash

php-coordinate 0.1.0 (03-07-2023 01:17:26) - Björn Hempel 

```

## 5. Command line tool

> Used to quickly check two given coordinates.

Check _Dresden, Germany_ and _New York, United States_:

```bash

bin/console pc "51°3′1.44″N, 13°44′14.28″E" "40.712784, -74.005941"

```

or within your composer project:

```bash

vendor/bin/php-coordinate pc "51°3′1.44″N, 13°44′14.28″E" "40.712784, -74.005941"

```

```bash

Source coordinate (51°3′1.44″N, 13°44′14.28″E):

+---------+------------------+--------------------+

| Value   | Latitude         | Longitude          |

+---------+------------------+--------------------+

| Decimal | 51.0504          | 13.7373            |

| DMS     | 51°3′1.44″N      | 13°44′14.28″E      |

+---------+------------------+--------------------+

Target coordinate (40.712784, -74.005941):

+---------+----------------------+---------------------+

| Value   | Latitude             | Longitude           |

+---------+----------------------+---------------------+

| Decimal | 40.712784            | -74.005941          |

| DMS     | 40°42′46.0224″N      | 74°0′21.3876″W      |

+---------+----------------------+---------------------+

Distance:

+-----------+-------------+

| Key       | Value       |

+-----------+-------------+

| Distance  | 6478.472 km |

| Degree    | -96.720°    |

| Direction | W           |

+-----------+-------------+

+--------------------------------------------------------------------------------+

|                                   World map                                    |

+--------------------------------------------------------------------------------+

|                                                                                |

|                     ▄▄▄▄▀▄▄▄▄▄▄▄▄▄▄                                            |

|       ▄▄    ▄▄▄▄▄▄▄▄▀▀▀▀▀▀▀▀▀▀▀▀▀▀                ▄▄▄▄▀▀▀▀▀▄▄▄▄▄▄▄▄▄▄          |

|  ▄▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀ ▀▀▀▀▀▀▀▀      ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀  |

| ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀  ▀▀▀▀   ▀▀          ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀   |

|       ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀           ▄▄▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▄ ▀▀    |

|     ▄▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀            ▄▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀       |

|     ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀               ▀▀▀▀▄▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▄        |

|     ▀▀▀▀▀▀▀▀▀▀▀▀                 ▀▀▀▀▀▀▀▀▀▀▄▄▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀        |

|      ▀▀▀▀▀▀▄▄ ▀                ▄▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀         |

|        ▀▀▀▀▀▀                  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀  ▀▀▀▀▀▀▀▀▀▀▀▀▀           |

|           ▀▀▀▄▄▀▀▄▄▄           ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀      ▀▀    ▀▀▀▀            |

|              ▀▀▀▀▀▀▀▀▀▄         ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀            ▀▄  ▄▀▀         |

|              ▀▀▀▀▀▀▀▀▀▀▀▄▄▄           ▀▀▀▀▀▀▀▀▀▀▀              ▀▀▀▀▀▀▀   ▀▄▄▄▄ |

|              ▀▀▀▀▀▀▀▀▀▀▀▀▀▀            ▀▀▀▀▀▀▀▀▀                 ▀        ▀▀▀▀▄|

|               ▀▀▀▀▀▀▀▀▀▀▀▀             ▀▀▀▀▀▀▀▀▀▄▀▀                   ▄▀▀▀▀▀▀  |

|                  ▀▀▀▀▀▀▀▀▀             ▀▀▀▀▀▀▀▀ ▀▀                 ▀▀▀▀▀▀▀▀▀▀▀ |

|                  ▀▀▀▀▀▀▀                ▀▀▀▀▀▀  ▀                  ▀▀▀▀▀▀▀▀▀▀▀ |

|                  ▀▀▀▀▀▀                  ▀▀▀                       ▀▀▀▀▀▀▀▀▀▀▀ |

|                  ▀▀▀▀                                                     ▀    |

|                   ▀▀▀                                                          |

+--------------------------------------------------------------------------------+

+------------------------------------+ 
|         Cardinal direction 
+--------------------- 
| 
|                  0° 
| 
|                 ___ 
|    -45°         ─── 
|          //      N      \\ 
|             NW       NE 
|                  | 
|  -90°  || W 
|                  | 
|             SW       SE 
|          \\      S      // 
|    -135°        ─── 
|                 ‾‾‾ 
| 
|                 180° 
| 
+---------------------

+---------------------------------------+ |   |         Longitude / Langitude         | ---------------|   +---------------------------------------| |   |          lat                          | |   |                                       | |   |       90° ⯅                           | |   |           |                           | 45°     |   |           |                           | |   |           |   • Oslo (59.91°, 10.75°) | |   |           | • London (51.51°, -0.13°) | |   |    • New York (40.71°, -74.01°)       | --+--    E ||  90°  |   |           |                           | |   |           |                           | |   |           |                           | |   |           | • Null Island (0°, 0°)    | 135°    |   |   ⯇-------+-------------------⯈  lon  | |   |  -180°    |                 180°      | |   |           |                           | |   |           |       • Cape Agulhas      | |   |      -90° ⯆         (-34.82°, 20.02°) | ---------------+   +---------------------------------------+

```



## 6. Library development

```bash

git clone git@github.com:ixnode/php-coordinate.git && cd php-coordinate

```

```bash

composer install

```

```bash

composer test

```

## 7. License

This library is licensed under the MIT License - see the [LICENSE](/LICENSE) file for details.
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/ixnode/php-coordinate

Awesome Lists containing this project

README
