README

Geocoder for Laravel

If you still use Laravel 4, please check out the 0.4.x branch here.

Version 4.0.0 is a backwards-compatibility-breaking update. Please review this documentation, especially the Usage section before installing.

This package allows you to use Geocoder in Laravel 5.

Requirements

PHP >= 7.1.3
Laravel >= 5.0

Installation

Install the package via composer:

composer require toin0u/geocoder-laravel

If you are running Laravel 5.5 (the package will be auto-discovered), skip this step. Find the providers array key in config/app.php and register the Geocoder Service Provider:

// 'providers' => [
    Geocoder\Laravel\Providers\GeocoderService::class,
// ];

Optional I recommend adding the following lines to your composer.json file to prevent stale caches when upgrading or updating the package, both in your live and dev environments:

        "post-update-cmd": [
            "@php artisan cache:clear",
        ],
        "post-install-cmd": [
            "@php artisan cache:clear",
        ]

Configuration

Pay special attention to the language and region values if you are using them. For example, the GoogleMaps provider uses TLDs for region values, and the following for language values: https://developers.google.com/maps/faq#languagesupport.

Further, a special note on the GoogleMaps provider: if you are using an API key, you must also use set HTTPS to true. (Best is to leave it true always, unless there is a special requirement not to.)

See the Geocoder documentation for a list of available adapters and providers.

Dedicated Cache Store Recommended

To implement the dedicated cache store, add another redis store entry in config/database.php, something like the following:

    "redis" => [
        // ...

        "geocode-cache" => [ // choose an appropriate name
            'host' => env('REDIS_HOST', '192.168.10.10'),
            'password' => env('REDIS_PASSWORD', null),
            'port' => env('REDIS_PORT', 6379),
            'database' => 1, // be sure this number differs from your other redis databases
        ],
    ]

You will also need to add an entry in config/cache.php to point to this redis database:

    "stores" => [
        // ...

        "geocode" => [
            'driver' => 'redis',
            'connection' => 'geocode-cache',
        ],
    ],

Finally, configure Geocoder for Laravel to use this store. Edit config/geocoder.php:

    "cache" => [
        "store" => "geocode",

        // ...
    ],

Disabling Caching on a Query-Basis

You can disable caching on a query-by-query basis as needed, like so:

    $results = app("geocoder")
        ->doNotCache()
        ->geocode('Los Angeles, CA')
        ->get();

Providers

If you are upgrading and have previously published the geocoder config file, you need to add the cache-duration variable, otherwise cache will be disabled (it will default to a 0 cache duration). The default cache duration provided by the config file is 999999999 seconds, essentially forever.

By default, the configuration specifies a Chain provider, containing the GoogleMaps provider for addresses as well as reverse lookups with lat/long, and the GeoIP provider for IP addresses. The first to return a result will be returned, and subsequent providers will not be executed. The default config file is kept lean with only those two providers.

However, you are free to add or remove providers as needed, both inside the Chain provider, as well as along-side it. The following is the default configuration provided by the package:

use Geocoder\Provider\Chain\Chain;
use Geocoder\Provider\GeoPlugin\GeoPlugin;
use Geocoder\Provider\GoogleMaps\GoogleMaps;
use Http\Client\Curl\Client;

return [

    /*
    |--------------------------------------------------------------------------
    | Cache Duration
    |--------------------------------------------------------------------------
    |
    | Specify the cache duration in seconds. The default approximates a forever
    | cache, but there are certain issues with Laravel's forever caching
    | methods that prevent us from using them in this project.
    |
    | Default: 9999999 (integer)
    |
    */
    'cache-duration' => 9999999,

    /*
    |--------------------------------------------------------------------------
    | Providers
    |--------------------------------------------------------------------------
    |
    | Here you may specify any number of providers that should be used to
    | perform geocaching operations. The `chain` provider is special,
    | in that it can contain multiple providers that will be run in
    | the sequence listed, should the previous provider fail. By
    | default the first provider listed will be used, but you
    | can explicitly call subsequently listed providers by
    | alias: `app('geocoder')->using('google_maps')`.
    |
    | Please consult the official Geocoder documentation for more info.
    | https://github.com/geocoder-php/Geocoder#providers
    |
    */
    'providers' => [
        Chain::class => [
            GoogleMaps::class => [
                env('GOOGLE_MAPS_LOCALE', 'us'),
                env('GOOGLE_MAPS_API_KEY'),
            ],
            GeoPlugin::class  => [],
        ],
    ],

    /*
    |--------------------------------------------------------------------------
    | Adapter
    |--------------------------------------------------------------------------
    |
    | You can specify which PSR-7-compliant HTTP adapter you would like to use.
    | There are multiple options at your disposal: CURL, Guzzle, and others.
    |
    | Please consult the official Geocoder documentation for more info.
    | https://github.com/geocoder-php/Geocoder#usage
    |
    | Default: Client::class (FQCN for CURL adapter)
    |
    */
    'adapter'  => Client::class,

    /*
    |--------------------------------------------------------------------------
    | Reader
    |--------------------------------------------------------------------------
    |
    | You can specify a reader for specific providers, like GeoIp2, which
    | connect to a local file-database. The reader should be set to an
    | instance of the required reader class or an array containing the reader
    | class and arguments.
    |
    | Please consult the official Geocoder documentation for more info.
    | https://github.com/geocoder-php/geoip2-provider
    |
    | Default: null
    |
    */
    'reader' => null,

];

Adapters

By default we provide a CURL adapter to get you running out of the box. However, if you have already installed Guzzle or any other PSR-7-compatible HTTP adapter, you are encouraged to replace the CURL adapter with it. Please see the Geocoder Documentation for specific implementation details.

Customization

If you would like to make changes to the default configuration, publish and edit the configuration file:

php artisan vendor:publish --provider="Geocoder\Laravel\Providers\GeocoderService" --tag="config"

Usage

The service provider initializes the geocoder service, accessible via the facade Geocoder::... or the application helper app('geocoder')->....

Geocoding Addresses

Get Collection of Addresses

app('geocoder')->geocode('Los Angeles, CA')->get();

Get IP Address Information

app('geocoder')->geocode('8.8.8.8')->get();

Reverse-Geocoding

app('geocoder')->reverse(43.882587,-103.454067)->get();

Dumping Results

app('geocoder')->geocode('Los Angeles, CA')->dump('kml');

Dependency Injection

use Geocoder\Laravel\ProviderAndDumperAggregator as Geocoder;

class GeocoderController extends Controller
{
    public function getGeocode(Geocoder $geocoder)
    {
       $geocoder->geocode('Los Angeles, CA')->get()
    }
}

Upgrading

Anytime you upgrade this package, please remember to clear your cache, to prevent incompatible cached responses when breaking changes are introduced (this should hopefully only be necessary in major versions):

php artisan cache:clear

1.x to 4.x

Update your composer.json file:

    "toin0u/geocoder-laravel": "^4.0",

The one change to keep in mind here is that the results returned from Geocoder for Laravel are now using the Laravel-native Collections class instead of returning an instance of AddressCollection. This should provide greater versatility in manipulation of the results, and be inline with expectations for working with Laravel. The existing AddressCollection methods should map straight over to Laravel's Collection methods. But be sure to double-check your results, if you have been using count(), first(), isEmpty(), slice(), has(), get(), or all() on your results.

Also, getProviders() now returns a Laravel Collection instead of an array.

Alert: if you have been using the getIterator() method, it is no longer needed. Simply iterate over your results as you would any other Laravel collection.

Deprecated:

the all() method on the geocoder is being deprecated in favor of using get(), which will return a Laravel Collection. You can then run all() on that. This method will be removed in version 5.0.0.
the getProvider() method on the geocoder is being deprecated in favor of using getProviders(), which will return a Laravel Collection. You can then run first() on that to get the same result. This method will be removed in version 5.0.0.

Added: this version introduces a new way to create more complex queries:

geocodeQuery()
reverseQuery()

Please see the Geocoder documentation for more details.

0.x to 1.x

If you are upgrading from a pre-1.x version of this package, please keep the following things in mind:

Update your composer.json file as follows:
```
"toin0u/geocoder-laravel": "^1.0",
```
Remove your config/geocoder.php configuration file. (If you need to customize it, follow the configuration instructions below.)
Remove any Geocoder alias in the aliases section of your config/app.php. (This package auto-registers the aliases.)
Update the service provider entry in your config/app.php to read:
```
Geocoder\Laravel\Providers\GeocoderService::class,
```
If you are using the facade in your code, you have two options:
1. Replace the facades Geocoder:: (and remove the corresponding use statements) with app('geocoder')->.
2. Update the use statements to the following:
```
use Geocoder\Laravel\Facades\Geocoder;
```
Update your query statements to use ->get() (to retrieve a collection of GeoCoder objects) or ->all() (to retrieve an array of arrays), then iterate to process each result.

Troubleshooting

Clear cache: php artisan cache:clear.
If you are still experiencing difficulties, please please open an issue on GitHub: https://github.com/geocoder-php/GeocoderLaravel/issues.

Changelog

https://github.com/geocoder-php/GeocoderLaravel/blob/master/CHANGELOG.md

Contributor Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

GeocoderLaravel is released under the MIT License. See the bundled LICENSE file for details.

toin0u / geocoder-laravel

Maintainers

Details