Download the PHP package mfmbarber/hackpostcodes without Composer
On this page you can find all versions of the php package mfmbarber/hackpostcodes. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mfmbarber/hackpostcodes
More information about mfmbarber/hackpostcodes
Files in mfmbarber/hackpostcodes
Package hackpostcodes
Short Description A hack library for using postcodes.io
License GPL
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 hackpostcodes
HackPostcodes
HackPostcodes is a library written in Hack that wraps around the https://postcodes.io API.
Motivation
I've been learning the Hack programming language, and the Hip Hop Virtual Machine (HHVM) - so seemed like a good excuse to make something usable.
Dependancies
- This was written using HHVM v3.18, it's probably backwards compatible to a degree though
- PHPUnit 5.7.* - There isn't compatibility with HHVM above this yet
Installation
You can install this library using composer:
Usage
To use the Postcodes library you first need to ensure you instantiate the CurlRequest class, and inject this into Postcodes as a constructor dependancy. This allows you to swap out the CurlRequest class with your own implementation if required. It also allows us to mock our dependancy when testing.
Once you have instantiated the Postcodes class you can then call any of the following methods off of this:
-
lookup(string $postcode) : Map Use this to lookup a single postcode and get back a map of the result
-
lookupBulk(Vector
$postcodes) : Vector -
lookupLatLon(Pair<float, float> $geolocation) : Vector
Use this to look up at latitude / longitude point and return a vector of maps - where each map represents a local postcodes to that position -
lookupBulkLatLong(Vector<Pair<float, float>> $geolocations) : Vector<Vector
-
isValid(string $postcode) : bool Check to see if a postcode is valid (both regex and a UK postcode)
-
getNearest(string $postcode) : Vector
-
autocomplete(string $postcode, int $limit = 10) : Vector
Given part of a postcode, and the amount of results to return (limit is 100), return a Vector of potential full postcode strings - random() : Map Return a random postcode as a map
-getDistance(string $postcode1, string $postcode2) : num Return the shortest distance (straight line) between two postcodes, this uses the Haversine formula to calculate.
Tests
Tests have been written using PHPUnit, and can be run from the root of the project:
Contributing
To contribute to this project
- Create a fork of the project
- Create a feature/bugfix branch off of develop
- Commit your changes
- Write your tests
- Once you are happy - PR back into develop
- Once reviewed, the PR is accepted.
- Hurrah!
Ensure you comment your code!
License
This project is fully open sourced under MIT license
