squigg / ideal-postcodes-laravel by squigg

Laravel package for using the Ideal Postcodes API at https://ideal-postcodes.co.uk/

268

Package Data
Maintainer Username:	squigg
Maintainer Contact:	github@squigg.co.uk (Squigg)
Package Create Date:	2017-01-24
Package Last Update:	2017-01-28
Home Page:
Language:	PHP
License:	MIT
Last Refreshed:	2024-11-14 15:10:11

Package Statistics
Total Downloads:	268
Monthly Downloads:	0
Daily Downloads:	0
Total Stars:	0
Total Watchers:	2
Total Forks:	0
Total Open Issues:	0

ideal-postcodes-laravel

PHP Laravel 5 package for the Ideal Postcodes API.

Prerequisites

PHP 5.5+
Laravel 5.x
Ideal Postcodes Account and API Key

Installation

Install by composer

You can find this library on Packagist.

To install ideal-postcodes-laravel with Composer, run the following command:

$ composer require squigg/ideal-postcodes-laravel

Configuration

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 app.php:

'providers' => [

    ...

    'Squigg\IdealPostcodes\IdealPostcodesServiceProvider',

],

'aliases' => [

    ...

    'IdealPostcodes' => 'Squigg\IdealPostcodes\Facades\IdealPostcodesFacade',

],

Add an IDEALPOSTCODES_API_KEY to your .env file with your Ideal Postcodes API key

IDEALPOSTCODES_API_KEY=ak_abcdefghijklmnopqrstuvwxyz

Configuration File Settings

All available settings are documented within the config/ideal-postcodes.php configuration file.

Usage

Simply call the \IdealPostcodes Facade, or add a dependency in any constructor to IdealPostcodes

Change log

See changelog