altrozero/get-address-io-php

There is no license information available for the latest version (1.1.2) of this package.

Quick interface for using getAddress.io find functionality

1.1.2 2019-09-16 08:10 UTC

Requires

• php: ^7.1
• altrozero/postcode-uk: >= 1
• phpunit/phpunit: ^8

Unknown License

README

Repo for using GetAddress.io within PHP

Currently only implements find.

Requires an API key!

How to Use

<?php
    $apiKey = '';

    $getAddress = new GetAddress($apiKey);

    // Get a list of addresses in a postcode
    $getAddress->find('SR51NA');

    // Get detailed information about an address
    $getAddress->find('SR51NA', 132, false, true, true);

Unit Testing

To setup PHPUnit to test everything you'll need to add your API key.

You can configure your suite by adding a global var of GETADDRESS_API_KEY and calling test/GetAddressTest.php

<php>
    <var name="GETADDRESS_API_KEY" value="" />
</php>
<testsuites>
    <testsuite name="get-address-io-php test">
        <file>test/GetAddressTest.php</file>
    </testsuite>
</testsuites>

To implement

• Parse addresses in to objects before returning
• Add admin functionality
• Long & Lat functionaility