Download the PHP package boxuk/postcodes-io-bundle without Composer
On this page you can find all versions of the php package boxuk/postcodes-io-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download boxuk/postcodes-io-bundle
More information about boxuk/postcodes-io-bundle
Files in boxuk/postcodes-io-bundle
Package postcodes-io-bundle
Short Description A Symfony2 bundle for interaction with the postcodes.io service.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package postcodes-io-bundle
PostcodesIoBundle
A bundle for querying the postcodes.io web service.
https://github.com/BoxUk/postcodes-io-bundle
License
Installation
Installation is handled via Composer.
-
Run the following command:
This should add the following to your project's
composer.jsonfile: - Add the bundle to your
app/AppKernel.phpfile:
Services
This bundle adds two services to your container:
box_uk_postcodes_io.clientA GuzzleHttp\Client configured to query the postcodes.io service.box_uk_postcodes_io.client_factoryA factory used to create instances of the client.
Usage
Inject the box_uk_postcodes_io.client service into your controller/class as you would any other service. Once you have the instance of the client, you can call the methods documented below on it, passing any parameters as an associative array.
The response will be a GuzzleHttp\Command\Model object, which you can access as an array, e.g. echo $response['result']['latitude']. Alternatively, you can just call $response->toArray() to get an array representation of the response. For further documentation on the structure of the response, please see the postcodes.io documentation.
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:
All versions of postcodes-io-bundle with dependencies
symfony/framework-bundle Version 2.*
guzzlehttp/guzzle-services Version ~0.1