Download the PHP package chadanuk/postcodes-io-laravel without Composer
On this page you can find all versions of the php package chadanuk/postcodes-io-laravel. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package postcodes-io-laravel
PostcodesIo Laravel Package
This is a fork of https://travis-ci.org/adityamenon/postcodes-io-laravel.svg to work on Laravel 5.
A laravel package for querying the postcodes.io web service.
Most of the Guzzle layer code was taken from @BoxUk's Symfony bundle, many props!
License
Installation
Installation is handled via Composer.
-
Run the following command:
This should add the following to your project's
composer.json
file: -
Add the Service Provider to your
app/config/app.php
file: - Add the Facade in the same file:
Usage
Use the PostcodesIo
facade with any of the methods below to get data from the service. For example: PostcodesIo::lookup('CF10 1DD')
.
Methods
lookup()
Lookup data about a particular postcode.
Parameters:
postcode
(Required): The postcode.
Example:
bulkLookup()
Lookup data about a set of postcodes.
Parameters:
postcodes
(Required): An array of postcodes (max 100).
Example:
reverseGeocode()
Get data for postcodes nearest a given latitude/longitude coordinate.
Parameters:
latitude
(Required): The latitude.longitude
(Required): The longitude.limit
(Optional): The maximum number of postcodes to return (default 10, max 100).radius
(Optional): The radius in metres in which to find postcodes (default 100, max 1000).
Example:
bulkReverseGeocode()
Bulk translation of latitude/longitude coordinates into postcode data.
Parameters:
-
geolocations
(Required): The geolocations to look up (maximum 100). This parameter should be an array, each element with the following keys:latitude
(Required): The latitude.longitude
(Required): The longitude.limit
(Optional): The maximum number of postcodes to return (default 10, max 100).radius
(Optional): The radius in metres in which to find postcodes (default 100, max 1000).
Example:
matching()
Find postcodes matching a given query.
Parameters:
query
(Optional): The postcode query, e.g. 'CF10'.limit
(Optional): The maximum number of postcodes to return (default 10, max 100).
Example:
validate()
Validate a postcode.
Parameters:
postcode
(Required): The postcode to validate.
Example:
autocomplete()
Get a list of postcodes to autocomplete a partial postcode.
Parameters:
postcode
(Required): The postcode to autocomplete.limit
(Optional): The maximum number of postcodes to return (default 10, max 100).
Example:
random()
Get data for a random postcode.
Parameters: None.
Example:
outwardCodeLookup()
Get data for the specified "outward code" (first half of postcode).
Parameters:
outcode
(Required): The outward code (first half of postcode) to get location data for.
Example: