pendonl/laravel-pro6pp

Laravel interface to Pro6pp API PHP Wrapper

v1.0.1 2016-11-11 20:34 UTC

Requires

• php: >=5.6.0
• pendonl/pro6pp-php-wrapper: 1.*

Requires (Dev)

• phpunit/phpunit: ~5.0

MIT

• Joshua de Gier

README

The PendoNL/laravel-pro6pp package provides an easy to use way to communicate with Pro6PP's API to fetch location based data via a Facade. Of course you may also use the class without the Facade. More information on the class and it's methods can be found here.

Usage

You can use any method by using the Facade, your API key and preferred data type are used automatically with each request:

$getAddress = Pro6pp::autocomplete(6225, '7', c);
$suggestions = Pro6pp::suggest('Maast', 10);
$distanceBetweenCoordinates = Pro6pp::coordinateDistance(50.858030, 5.717376, 50.840078, 5.659258);

Installation

Install the package using composer:

composer require pendonl/laravel-pro6pp

Next, you must install the service provider (for L5.5 and up Auto-Discovery is enabled):

// config/app.php
'providers' => [
    ...
    PendoNL\LaravelPro6pp\LaravelPro6ppServiceProvider::class,
];

Optionally, register the facade:

// config/app.php
'aliases' => [
    ...
    'Pro6pp' => PendoNL\LaravelPro6pp\Facade::class,
];

To function properly, thise package requires pendonl/pro6pp-php-wrapper, this dependency will be installed automatically.

Then publish the configuration file using:

php artisan vendor:publish --provider="PendoNL\LaravelPro6pp\LaravelPro6ppServiceProvider"

If you're using an .env file, make sure these are added to the bottom of that file:

PRO6PP_API_KEY=
PRO6PP_FORMAT=json
PRO6PP_PRETTY=false

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

Thanks to Pro6PP for their efforts to create, maintain and update a postal database for a fair price.

About Pendo

Pendo is a webdevelopment agency based in Maastricht, Netherlands. If you'd like, you can visit our website.

License

The MIT License (MIT). Please see License File for more information.