library simple-google-maps-api

rapidwebltd/simple-google-maps-api

a simple api for the google maps services

This library allows a user to easily communicate with the Google Maps API and retrieve a set of coordinates from an address., _(*1)

Installation

To install, just run the following composer command., _(*2)

composer require rapidwebltd/simple-google-maps-api, _(*3)

Remember to include the vendor/autoload.php file if your framework does not do this for you., _(*4)

Usage

Creating the SimpleGoogleMaps Object can be done in one of two ways., _(*5)

The first way is to pass through just the API key that you are provided upon registering for the Google Maps API., _(*6)

use RapidWeb\SimpleGoogleMaps\Factories\SimpleGoogleMapsFactory;
$simpleGoogleMaps = SimpleGoogleMapsFactory::getByKey("[APIKEY]");

The second way is to provide your client name and the crypt key that you are provided with upon creating a Google enterprise account., _(*7)

use RapidWeb\SimpleGoogleMaps\Factories\SimpleGoogleMapsFactory;
$simpleGoogleMaps = SimpleGoogleMapsFactory::getByClientNameAndCryptKey("[CLIENTNAME]","[CRYPTKEY]");

Once you have created the object you can then get the coordinates from an address via the getByAddress method., _(*8)

$addressline = "10 Downing St, Westminster, London SW1A UK";
$homeCoords = $simpleGoogleMaps->getByAddress($addressline);

Optionally, you can allow partial matches to be returned if your input address is not highly accurate. You can do so with the allowPartialMatches method, as shown below., _(*9)

$simpleGoogleMaps->allowPartialMatches();
$homeCoords = $simpleGoogleMaps->getByAddress('test address');

The above method will return a object of type LatLong, this allows you to access the coordinates like so., _(*10)

$latitude = $homeCoords->lat;
$longitude = $homeCoords->long;

You can also calculate the distance between two LatLong objects by using the distanceTo method on the LatLong Object., _(*11)

$milesBetween = $homeCoords->distanceTo($toCoords);

By default this will return the answer in miles, you may also request the distance in kilometres by adding it to the method call., _(*12)

$milesBetween = $homeCoords->distanceTo($toCoords,"kilometres");