README

A small package to use google's geocode look up of an address.

Installation

This package has been tested on Laravel 5.4 and up.

You can install the package via composer:

composer require tjefford/google-geo-code

In Laravel 5.5 the service provider will automatically get registered. In older versions of the framework just add the service provider and facade in config/app.php file:

'providers' => [
    // ...
    Tjefford\GoogleGeoCode\GoogleGeoCodeServiceProvider::class,
];

'aliases' => [
    // ...
    'Lookup' => Tjefford\GoogleGeoCode\Facades\Lookup::class,
];

Environment

This package uses an environment key to pull a secret API token from your .env file. You will need to get a API key from Google Geocode API and put that key in your environment file as:

GOOGLE_GEOCODE_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Usage

Using the lookup is very simple. All you need to provide is the address, city and state (for better accuracy). You will then be returned an array of data about that location from google.

Include the Lookup class in your file.

use Tjefford\GoogleGeoCode\Lookup;

Initiate the class and then call the locate method.

$lookup = new Lookup;
$lookup->locate('1901 W Madison St', 'Chicago', 'IL');

Your response should look similar to this

[
  "formatted_address" => "1901 W Madison St, Chicago, IL 60612, USA"
  "place_id" => "ChIJTeP2tz4tDogRADDUGhbXDB8"
  "neighborhood" => "Near West Side"
  "address" => "1901 West Madison Street"
  "city" => "Chicago"
  "state" => "Illinois"
  "postal_code" => "60612"
  "county" => "Cook County"
  "country" => "United States"
  "lat" => 41.8806285
  "lng" => -87.6740482
]

Methods

There is just 1 method that you can use, which is locate. It accepts 3 parameters, the first being the only required parameter.