Laravel package for using the Ideal Postcodes API at https://ideal-postcodes.co.uk/
This package is auto-updated.
Last update: 2022-01-13 06:36:45 UTC
PHP Laravel 5 package for the Ideal Postcodes API.
- PHP 5.5+
- Laravel 5.x
- Ideal Postcodes Account and API Key
You can find this library on Packagist.
To install ideal-postcodes-laravel with Composer, run the following command:
$ composer require squigg/ideal-postcodes-laravel
The package publishes a configuration file to your config directory where you can update the configuration for your app.
$ php artisan vendor:publish --tag=config
Add the IdealPostcodesServiceProvider and (if desired) the Facade alias to your
'providers' => [ ... 'Squigg\IdealPostcodes\IdealPostcodesServiceProvider', ], 'aliases' => [ ... 'IdealPostcodes' => 'Squigg\IdealPostcodes\Facades\IdealPostcodesFacade', ],
IDEALPOSTCODES_API_KEY to your
.env file with your Ideal Postcodes API key
All available settings are documented within the config/ideal-postcodes.php configuration file.
Simply call the
\IdealPostcodes Facade, or add a dependency in any constructor to IdealPostcodes
Copyright © 2016 Steve Strugnell. Released under the
MIT License <docs/license.rst>_.