Download the PHP package metasyntactical/google-directions-client without Composer
On this page you can find all versions of the php package metasyntactical/google-directions-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download metasyntactical/google-directions-client
More information about metasyntactical/google-directions-client
Files in metasyntactical/google-directions-client
Package google-directions-client
Short Description Client for Google Directions API to add interpolated points to a route consisting of given coordinates.
License MIT
Informations about the package google-directions-client
README
What is MetaSyntactical/GoogleDirections?
MetaSyntactical/GoogleDirections is a PHP client library for the Google Maps Directions API. Its purpose is to calculate a route between given geographical coordinates.
Prerequisites for using the Google Directions API
To use this library you will need a Google API key which can be obtained from Google. Usage of the Google API is subject to Terms and Conditions set out by Google. Depending on the way of you want to use Google's API and the amount of traffic/requests Google may charge fees. Please refer to Google Maps Directions API for further details.
Installation
The easiest way to install the library is adding it as a dependency to your project's composer.json file.
$ composer require metasyntactical/google-directions-client "^2"
If you use PHP version 5.5.x, 5.6.x or 7.0.x you can revert to an earlier compatible version of the library:
$ composer require metasyntactical/google-directions-client "^1"
Usage
To use the library create an instance of the client class:
The client class has a few dependencies that must be passed to the constructor:
- the GuzzleTransport object, which contains the HTTP client and is used by the Google API client to handle the HTTP communication
- the Polyline object, which has a method to decode Google Polylines (kudos to Peter Chng)
You can optionally set a logger on both the Google API Client object and the Polyline object to collect messages. The logger object you pass must implement the PSR-3 logger interface.
$googleApiClient->setLogger($logger);
$polylineDecoder->setLogger($logger);
The client uses a Route object as a value object to handle the geographical coordinates. The easiest way to obtain a route object is via the factory, which will take an array of comma-separated coordinates (lat,long) for which you want to calculate a route:
Note that the order of coordinates is relevant, meaning the route will start at the first given coordinate and pass through any additional coordinate in the given order up to the last given coordinate.
As with the Polyline object, you can pass a PSR-3 logger to the route factory to collect messages:
$routeFactory->setLogger($logger);
To get an interpolated route call the getDirections() method of the Google API client and pass the route object as an argument:
$resultRoute = $googleApiClient->getDirections($route);
The return value will be a Route object. Depending on the size of the route (number of coordinates), one API call (i.e. one call of the getDirections() method will only yield a partial result. This is due to the fact that the Google API handles only a limited number of waypoints per request.
You can check if there are coordinates left in the route for which additional calls to the Google API need to be made. In order to do so use the getRemainingCoordinateCount() method.
$resultRoute->getRemainingCoordinateCount();
If the count is greater than zero, just call the getDirections() method again with the result route as an argument and the Google API is called again yielding another portion of the route:
$resultRoute = $googleApiClient->getDirections($route);
Once there are no more remaining coordinates, all coordinates that make up the interpolated route can be retrieved by calling the getInterpolatedRoute() method on the result route object.
$resultRoute->getInterpolatedRoute();
Note that the getInterpolatedRoute() method returns an array of Coordinate objects, that have methods to get the values for latitude and longitude:
All versions of google-directions-client with dependencies
psr/log Version ^1.0
beberlei/assert Version ^2.9
metasyntactical/http-transport-guzzle Version ^1.1
guzzlehttp/guzzle Version ^6.3