2017 © Pedro Peláez
 

library postcodes

UK Postcode API Facade for Laravel

image

codescheme/postcodes

UK Postcode API Facade for Laravel

  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 1 Forks
  • 0 Open issues
  • 4 Versions
  • 14 % Grown

The README.md

Postcodes

A Laravel 5+ facade/service provider for the API methods at postcodes.io - useful for UK postcode validation and reverse geocoding: that is, determining postcode from lat, long coordinates. No fiddling around with api keys, authentication, necessary..., (*1)

With thanks to https://postcodes.io, (*2)

Installation

composer require codescheme/postcodes

For Laravel 5.5 Postcodes will be automatically discovered., (*3)

Edit /config/app.php and add the service provider to your providers array., (*4)

'providers' => [
    Codescheme\Postcodes\PostcodeServiceProvider::class,
]

Also here, add the alias:, (*5)

'aliases' => [
    'Postcode' => Codescheme\Postcodes\Facades\Postcode::class,
]

Basic Example Laravel Usage

Return data for a given postcode, (*6)

Route::get('/postcode', function(){
    $data = Postcode::postcodeLookup('SE21 8JL');
    print_r($data);
    return null;      
}); 

Methods

Postcode::validate('SE31 9AX'); //returns boolean
Postcode::postcodeLookup('SE21 8JL');
Postcode::nearest('SE21 8JL');
Postcode::reverseGeocode(-0.397913, 51.44015); // long,lat
Postcode::autocomplete('RG1 3');
Postcode::outcodeLookup('SE21');

$postcodes = ['OX49 5NU', 'M32 0JG', 'NE30 1DP'];
Postcode::postcodeLookupBulk($postcodes);

$coordinates = [
    ['longitude' =>  0.629834723775309, 'latitude' => 51.7923246977375],
    ['longitude' => -2.49690382054704,  'latitude' => 53.5351312861402]
    ];
Postcode::reverseGeocodeBulk($coordinates);

Testing

bash $ composer test, (*7)

The Versions

25/10 2017

dev-master

9999999-dev

UK Postcode API Facade for Laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

laravel api json laravel5 postcodes postcode

25/10 2017

v1.4

1.4.0.0

UK Postcode API Facade for Laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

laravel api json laravel5 postcodes postcode

20/02 2017

v1.3

1.3.0.0

UK Postcode API Facade for Laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

laravel api json laravel5 postcodes postcode

09/02 2017

v1.2

1.2.0.0

UK Postcode API Facade for Laravel

  Sources   Download

MIT

The Requires

 

laravel api json laravel5 postcodes postcode