Geocoder for Laravel

If upgrading from a pre-1.x version, perform these steps:

1. Update Dependencies: Set "toin0u/geocoder-laravel": "^1.0" in composer.json.
2. Cleanup Config: Remove config/geocoder.php and remove any Geocoder aliases from config/app.php (the package now auto-registers aliases).
3. Update Service Provider: Ensure Geocoder\Laravel\Providers\GeocoderService::class is in your config/app.php providers array.
4. Update Facades: If using the facade, either replace Geocoder:: with app('geocoder')-> or update your use statements to use Geocoder\Laravel\Facades\Geocoder;.
5. Update Queries: Use ->get() to retrieve a collection of GeoCoder objects or ->all() to retrieve an array of arrays.

To prevent stale caches when upgrading or updating the package in both live and development environments, add the following artisan commands to your composer.json file under the scripts section:

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

Install the package using Composer.

Requirements:

• PHP >= 8.2
• Laravel >= 11.0

Note on Versioning: Starting with version 13.0.0, the major version tracks the highest supported Laravel version (e.g., 13.x supports Laravel 11, 12, and 13).

composer require toin0u/geocoder-laravel

To customize the default settings, publish the configuration file to your application's config/ directory using the following Artisan command:

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

To optimize performance and prevent cache pollution, it is recommended to use a dedicated cache store (e.g., a separate Redis database).

1. Add a new Redis connection in config/database.php.
2. Create a new cache store in config/cache.php pointing to that connection.
3. Update config/geocoder.php to use the new cache store name.

// 1. config/database.php
"redis" => [
    "geocode-cache" => [
        'host' => env('REDIS_HOST', '192.168.10.10'),
        'password' => env('REDIS_PASSWORD', null),
        'port' => env('REDIS_PORT', 6379),
        'database' => 1, // Use a unique database index
    ],
]

// 2. config/cache.php
"stores" => [
    "geocode" => [
        'driver' => 'redis',
        'connection' => 'geocode-cache',
    ],
],

// 3. config/geocoder.php
"cache" => [
    "store" => "geocode",
],

If you are using a version of Laravel older than 5.5 (though the current requirements specify Laravel >= 11.0), you must manually register the service provider in config/app.php within the providers array.

Note: For Laravel 5.5 and above, the package is auto-discovered and this step is unnecessary.

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

The GeocoderService is the core Laravel Service Provider that integrates the Geocoder library into your application. It performs the following tasks during the Laravel boot process:

1. Configuration Publishing: It allows you to publish the geocoder.php configuration file to your application's config/ directory using php artisan vendor:publish.
2. Dependency Injection: It registers the ProviderAndDumperAggregator as a singleton, which is responsible for instantiating the geocoding providers defined in your geocoder.providers configuration.
3. Aliasing: It aliases the Geocoder facade to the Geocoder class for easy access.
4. Cache Safety: It automatically discovers and registers Geocoder model classes into Laravel's cache.serializable_classes to prevent unserialization errors when using cache stores.

The providers configuration defines which services are used for geocoding.

• Chain Provider: A special provider that runs multiple providers in sequence. If the first provider fails, the next one in the list is executed.
• Default Setup: By default, the package uses a Chain containing GoogleMaps (for addresses and reverse lookups) and GeoPlugin (for IP addresses).
• Manual Selection: You can explicitly use a specific provider by its alias using app('geocoder')->using('alias').

// config/geocoder.php
'providers' => [
    \Geocoder\Provider\Chain\Chain::class => [
        \Geocoder\Provider\GoogleMaps\GoogleMaps::class => [
            env('GOOGLE_MAPS_LOCALE', 'us'),
            env('GOOGLE_MAPS_API_KEY'),
        ],
        \Geocoder\Provider\GeoPlugin\GeoPlugin::class => [],
    ],
],