HOME

<?php
	//Put together by Ryan Hart 2016
	//Class to use the API provided by http://postcodes.io
	
	class Postcode{
		
		public function lookup($postcode){
			$jsonurl = "https://api.postcodes.io/postcodes/".$postcode;
			$json = $this->request($jsonurl);
			$decoded = json_decode($json);
			if($decoded->status == 200){
				return $decoded->result;
			}
			else{
				return false;
			}
			return false;
		}
		public function bulkLookup($postcodes){
			$data_string = json_encode(array('postcodes' => $postcodes));
			$ch = curl_init('https://api.postcodes.io/postcodes');
			curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
			curl_setopt($ch, CURLOPT_POSTFIELDS, $data_string);
			curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
			curl_setopt($ch, CURLOPT_HTTPHEADER, array(
			        'Content-Type: application/json',
			        'Content-Length: ' . strlen($data_string))
			);
			
			$result = curl_exec($ch);
			curl_close($ch);
			$decoded = json_decode($result);
			if($decoded->status == 200){
				return $decoded->result;
			}
			else{
				return false;
			}
			return false;
		}
		public function nearestPostcodesFromLongLat($longitude, $latitude){
			$jsonurl = "https://api.postcodes.io/postcodes?lon=".$longitude."&lat=".$latitude;
			$json = $this->request($jsonurl);
			
			$decoded = json_decode($json);
			if($decoded->status == 200){
				return $decoded->result;
			}
			else{
				return false;
			}
			return false;
		}
		public function bulkReverseGeocoding($geolocations){
			$data_string = json_encode(array('geolocations' => $geolocations));
			
			$ch = curl_init('https://api.postcodes.io/postcodes');
			curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
			curl_setopt($ch, CURLOPT_POSTFIELDS, $data_string);
			curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
			curl_setopt($ch, CURLOPT_HTTPHEADER, array(
			        'Content-Type: application/json',
			        'Content-Length: ' . strlen($data_string))
			);
			
			$result = curl_exec($ch);
			curl_close($ch);
			$decoded = json_decode($result);
			if($decoded->status == 200){
				return $decoded->result;
			}
			else{
				return false;
			}
			return false;
		}
		public function random(){
			$jsonurl = "https://api.postcodes.io/random/postcodes/";
			$json = $this->request($jsonurl);
			
			$decoded = json_decode($json);
			if($decoded->status == 200){
				return $decoded->result;
			}
			else{
				return false;
			}
			return false;
		}
		public function validate($postcode){
			$jsonurl = "https://api.postcodes.io/postcodes/".$postcode."/validate";
			$json = $this->request($jsonurl);
			
			$decoded = json_decode($json);
			if($decoded->status == 200){
				if($decoded->result == 1){
					return true;	
				}
				else{
					return false;
				}
			}
			else{
				return false;
			}
			return false;
		}
		public function nearest($postcode){
			$jsonurl = "https://api.postcodes.io/postcodes/".$postcode."/nearest";
			$json = $this->request($jsonurl);
			
			$decoded = json_decode($json);
			if($decoded->status == 200){
				return $decoded->result;
			}
			else{
				return false;
			}
			return false;
		}
		public function partial($postcode){
			$jsonurl = "https://api.postcodes.io/postcodes/".$postcode."/autocomplete";
			$json = $this->request($jsonurl);
			
			$decoded = json_decode($json);
			if($decoded->status == 200){
				return $decoded->result;
			}
			else{
				return false;
			}
			return false;
		}
		public function query($postcode){
			$jsonurl = "https://api.postcodes.io/postcodes?q=".$postcode;
			$json = $this->request($jsonurl);
			
			$decoded = json_decode($json);
			if($decoded->status == 200){
				return $decoded->result;
			}
			else{
				return false;
			}
			return false;
		}
		public function lookupTerminated($postcode){
			$jsonurl = "https://api.postcodes.io/terminated_postcodes/".$postcode;
			$json = $this->request($jsonurl);
			
			$decoded = json_decode($json);
			if($decoded->status == 200){
				return $decoded->result;
			}
			else{
				return false;
			}
			return false;
		}
		public function lookupOutwardCode($code){
			$jsonurl = "https://api.postcodes.io/outcodes/".$code;
			$json = $this->request($jsonurl);
			
			$decoded = json_decode($json);
			if($decoded->status == 200){
				return $decoded->result;
			}
			else{
				return false;
			}
			return false;
		}
		public function nearestOutwardCode($code){
			$jsonurl = "https://api.postcodes.io/outcodes/".$code."/nearest";
			$json = $this->request($jsonurl);
			
			$decoded = json_decode($json);
			if($decoded->status == 200){
				return $decoded->result;
			}
			else{
				return false;
			}
			return false;
		}
		public function nearestOutwardCodeFromLongLat($longitude, $latitude){
			$jsonurl = "https://api.postcodes.io/outcodes?lon=".$longitude."&lat=".$latitude;
			$json = $this->request($jsonurl);
			
			$decoded = json_decode($json);
			if($decoded->status == 200){
				return $decoded->result;
			}
			else{
				return false;
			}
			return false;
		}
		public function distance($postcode1, $postcode2, $unit){
			//adapted from http://www.geodatasource.com/developers/php
			/*
				Units:
				M = Miles
				N = Nautical Miles
				K = Kilometers
			*/
			$postcode1 = $this->lookup($postcode1);
			$postcode2 = $this->lookup($postcode2);
			
			if($postcode1 == null || $postcode2 == null){
				return false;
			}
			
			$theta = $postcode1->longitude - $postcode2->longitude;
			$dist = sin(deg2rad($postcode1->latitude)) * sin(deg2rad($postcode2->latitude)) +  cos(deg2rad($postcode1->latitude)) * cos(deg2rad($postcode2->latitude)) * cos(deg2rad($theta));
			$dist = acos($dist);
			$dist = rad2deg($dist);
			$miles = $dist * 60 * 1.1515;
			$unit = strtoupper($unit);
			
			if ($unit == "K") {
			    return ($miles * 1.609344);
			} else if ($unit == "N") {
			    return ($miles * 0.8684);
			} else {
			    return $miles;
			}	
		}
		public function request($jsonurl){
			$ch = curl_init();
			curl_setopt($ch, CURLOPT_URL, str_replace(' ', '%20', $jsonurl));
			curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
			curl_setopt($ch, CURLOPT_HTTPHEADER, [
			  'Content-Type: application/json',
			]);
			curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
			$response = curl_exec($ch);
			curl_close($ch);
			return $response;
		}
	}
?>