direction.md

Direction

The Google Direction API is a service that calculates direction between locations using an HTTP request. You can search for direction for several modes of transportation, include transit, driving, walking or cycling. Direction may specify origins, destinations and waypoints either as text strings (e.g. "Chicago, IL" or "Darwin, NT, Australia") or as latitude/longitude coordinates. The Direction API can return multi-part direction using a series of waypoints.

Dependencies

The Direction API requires an http client and a serializer. The library relies respectively on Httplug which is an http client abstraction library and the Ivory Serializer which is an advanced (de)-serialization library.

To install them, read this documentation.

Configuration

By default, the direction service is disabled. In order to enable the service, you need to configure it.

Http client and message factory

The http client and message factory are mandatory. They define which http client and message factory the direction service will use for issuing http requests.

First, configure the Httplug bundle.

httplug:
    classes:
        client: Http\Adapter\Guzzle7\Client
        message_factory: Http\Message\MessageFactory\GuzzleMessageFactory
    clients:
        acme:
            factory: httplug.factory.guzzle7

Then, configure the Google Map bundle:

ivory_google_map:
    direction:
        client: httplug.client.default
        message_factory: httplug.message_factory.default

Format

The format allows you to use json/xml format for your http request:

ivory_google_map:
    direction:
        format: json

Api key

The API key allows you to bypass Google limitation according to your account plan:

ivory_google_map:
    direction:
        api_key: ~

Business account

The business account allows you to use Google Premium account:

ivory_google_map:
    direction:
        business_account:
            client_id: ~
            secret: ~
            channel: ~

Usage

Once you have configured your direction service, you can fetch it from the container and use it as explained in the documentation

use Ivory\GoogleMap\Service\Base\Location\AddressLocation;
use Ivory\GoogleMap\Service\Direction\Request\DirectionRequest;

$request = new DirectionRequest(
   new AddressLocation('New York'), 
   new AddressLocation('Washington')
);

$response = $this->container->get('ivory.google_map.direction')->route($request);