README

The Google Distance Matrix API is a service that provides travel distance and time for a matrix of origins and destinations. The information returned is based on the recommended route between start and end points, as calculated by the Google Maps API, and consists of rows containing duration and distance values for each pair.

Please refer to Google Distance Matrix API documentation for further details on request parameters and response format.

Installation

composer require volk/php-google-matrix-distance-api-client

Basic Usage

   $distanceMatrix = new DistanceMatrix();
   
    $distanceMatrix->setOrigins('Vancouver, BC, Canada | Seattle, État de Washington, États-Unis')
        ->setDestinations('San Francisco, Californie | États-Unis,Victoria, BC, Canada')
        ->setUnits(Unit::IMPERIAL);

    $matrixClient = new GoogleMapsMatrixApiClient(self::API_KEY);
    $result = $matrixClient->request($distanceMatrix)->getResults();
           
            $result->getStatus();
            $result->getDestinationAddresses();
            $result->getOriginAddresses();
    
            /** @var Item $item */
            foreach ($result->getItems() as $item){
                
                    $item->getStatus();
                    $item->getDestinationAddress();
                    $item->getOriginAddress();
                    $item->getDistance()->getValue();
                    $item->getDistance()->getUnitValue();
                    $item->getDuration()->getValue();
                    $item->getDuration()->getUnitValue();
            }

Request Parameters Options

Field	Type	Description	Required
origins	string	Origin Point Coordinate or Place Name	True
destinations	string	Destinations Point Coordinate or Place Name	True
mode	string	Travel Mode (driving,walking etc.)	False
language	string	Response Language	False
unit	string	Distance unit	False
trafficModel	string	Traffic Type (best_guess,pessimistic)	False

Response Fields

Field	Type	Description
status	string	Api response status type OK , FAILED etc.
originAddresses	array	Origin Addresses list
destinationsAddresses	array	Destinations Addresses list
items	array	Response Items

Response Item Fields

Field	Type	Description
distance	object	Distance unformatted value and unit value
duration	object	Durations unformatted value and unit value
status	string	Status OK , FAILED
originAddress	string	Single Origin Address
destinationAddress	string	Single Destination Address

Example Response

TODO

Exception Response Structure must be created

volk / php-google-matrix-distance-api-client

Maintainers

Details