Geocoder Service Provider for Laravel
If you still use Laravel 4, please check out the
Version 4.0.0 is a backwards-compatibility-breaking update. Please review this documentation, especially the Usage section before installing.
- PHP >= 7.0.0
- Laravel >= 5.0
- 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
providersarray key in
config/app.phpand register the Geocoder Service Provider:
// 'providers' => [ Geocoder\Laravel\Providers\GeocoderService::class, // ];
- Optional I recommend adding the following lines to your
composer.jsonfile 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", ]
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.
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 minutes, 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 an example config with additional providers we use for testing:
use Http\Client\Curl\Client; use Geocoder\Provider\BingMaps\BingMaps; use Geocoder\Provider\Chain\Chain; use Geocoder\Provider\FreeGeoIp\FreeGeoIp; use Geocoder\Provider\GoogleMaps\GoogleMaps; return [ 'cache-duration' => 999999999, 'providers' => [ Chain::class => [ GoogleMaps::class => [ 'en-US', env('GOOGLE_MAPS_API_KEY'), ], FreeGeoIp::class => , ], BingMaps::class => [ 'en-US', env('BING_MAPS_API_KEY'), ], GoogleMaps::class => [ 'us', env('GOOGLE_MAPS_API_KEY'), ], ], 'adapter' => Client::class, ];
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.
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"
The service provider initializes the
geocoder service, accessible via the
Geocoder::... or the application helper
app('geocoder')->geocode('Los Angeles, CA')->get();
app('geocoder')->geocode('Los Angeles, CA')->dump('kml');
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
Update your composer.json file:
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
methods should map strait over to Laravel's
Collection methods. But be sure
to double-check your results, if you have been using
all() on your results.
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
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.
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:
Please see the Geocoder documentation for more details.
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:
config/geocoder.phpconfiguration 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
If you are using the facade in your code, you have two options:
Replace the facades
Geocoder::(and remove the corresponding
usestatements to the following:
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.
- 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.
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.
GeocoderLaravel is released under the MIT License. See the bundled LICENSE file for details.