Download the PHP package codificar/geocoder-laravel without Composer
On this page you can find all versions of the php package codificar/geocoder-laravel. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download codificar/geocoder-laravel
More information about codificar/geocoder-laravel
Files in codificar/geocoder-laravel
Package geocoder-laravel
Short Description Geocoder Service Provider for Laravel
License MIT
Homepage http://geocoder-php.org/
Informations about the package geocoder-laravel
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:
-
If you are running Laravel 5.5 (the package will be auto-discovered), skip this step. Find the
providers
array key inconfig/app.php
and register the Geocoder Service Provider: - 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:
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:
You will also need to add an entry in config/cache.php
to point to this redis
database:
Finally, configure Geocoder for Laraver to use this store. Edit
config/geocoder.php
:
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 the default configuration provided by the package:
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:
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
Get IP Address Information
Reverse-Geocoding
Dumping Results
Dependency Injection
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):
1.x to 4.x
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 AddressCollection
methods should map strait 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 usingget()
, which will return a Laravel Collection. You can then runall()
on that. This method will be removed in version 5.0.0. - the
getProvider()
method on the geocoder is being deprecated in favor of usinggetProviders()
, which will return a Laravel Collection. You can then runfirst()
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:
- 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: -
If you are using the facade in your code, you have two options:
- Replace the facades
Geocoder::
(and remove the correspondinguse
statements) withapp('geocoder')->
. - Update the
use
statements to the following:
- Replace the facades
- 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.
All versions of geocoder-laravel with dependencies
geocoder-php/geo-plugin-provider Version ^4.0
geocoder-php/google-maps-provider Version ^4.0
guzzlehttp/psr7 Version *
http-interop/http-factory-guzzle Version ^1.0
illuminate/cache Version ^5.0|^6.0
illuminate/support Version ^5.0|^6.0
php-http/curl-client Version *
php Version >=7.1.3
willdurand/geocoder Version ^4.0