/php-osm-static-api

PHP library to easily get static image from OpenStreetMap (OSM) with markers, lines, circles and polygons.

Primary LanguagePHPMIT LicenseMIT

Packagist Latest Stable Version GitHub license

PHP OpenStreetMap Static API

PHP library to easily get static image from OpenStreetMap with markers, lines, circles and polygons.

This project uses the Tile Server of the OpenStreetMap Foundation which runs entirely on donated resources, see Tile Usage Policy for more information.

✨ Supporting

⭐ Star this repository to support this project. You will contribute to increase the visibility of this library 🙂

Installation

Install this library easily with composer :

composer require dantsu/php-osm-static-api

How to use

Generate OpenStreetMap static image with marker and line :

use \DantSu\OpenStreetMapStaticAPI\OpenStreetMap;
use \DantSu\OpenStreetMapStaticAPI\LatLng;
use \DantSu\OpenStreetMapStaticAPI\Polygon;
use \DantSu\OpenStreetMapStaticAPI\Markers;

\header('Content-type: image/png');
(new OpenStreetMap(new LatLng(44.351933, 2.568113), 17, 600, 400))
    ->addMarkers(
        (new Markers(__DIR__ . '/resources/marker.png'))
            ->setAnchor(Markers::ANCHOR_CENTER, Markers::ANCHOR_BOTTOM)
            ->addMarker(new LatLng(44.351933, 2.568113))
            ->addMarker(new LatLng(44.351510, 2.570020))
            ->addMarker(new LatLng(44.351873, 2.566250))
    )
    ->addDraw(
        (new Polygon('FF0000', 2, 'FF0000DD'))
            ->addPoint(new LatLng(44.351172, 2.571092))
            ->addPoint(new LatLng(44.352097, 2.570045))
            ->addPoint(new LatLng(44.352665, 2.568107))
            ->addPoint(new LatLng(44.352887, 2.566503))
            ->addPoint(new LatLng(44.352806, 2.565972))
            ->addPoint(new LatLng(44.351517, 2.565672))
    )
    ->getImage()
    ->displayPNG();

Exported OpenStreetMap image

Documentation

Class Description
Circle DantSu\OpenStreetMapStaticAPI\Circle draw circle on the map.
LatLng DantSu\OpenStreetMapStaticAPI\LatLng define latitude and longitude for map, lines, markers.
Line DantSu\OpenStreetMapStaticAPI\Line draw line on the map.
MapData DantSu\OpenStreetMapStaticAPI\MapData convert latitude and longitude to image pixel position.
Markers DantSu\OpenStreetMapStaticAPI\Markers display markers on the map.
OpenStreetMap DantSu\OpenStreetMapStaticAPI\OpenStreetMap is a PHP library created for easily get static image from OpenStreetMap with markers, lines, polygons and circles.
Polygon DantSu\OpenStreetMapStaticAPI\Polygon draw polygon on the map.
TileLayer DantSu\OpenStreetMapStaticAPI\TileLayer define tile server url and related configuration
XY DantSu\OpenStreetMapStaticAPI\XY define X and Y pixel position for map, lines, markers.

Contributing

Please fork this repository and contribute back using pull requests.

Any contributions, large or small, major features, bug fixes, are welcomed and appreciated but will be thoroughly reviewed.